Perform Control Group Run

The Customer Sales Representative or Finance Department User wants to via CRM / Finance system GUI perform Control Billing Run for defined Control Group in the OCS.io. This operation is available in the CRM / Finance system GUI for users with correct privileges.

The CRM / Finance system via the RESTful API requests for performing of the Control Billing Run for defined Control Group in the OCS.io. The request body contains identification of the Control Group for which Control Billing Run should be performed.

The OCS.io schedules Control Billing Run, then returns the acknowledgment that operation will be performed.

The CRM / Finance system presents the result of the operation to the User in the GUI.

Primary Actor

Customer Sales Representative or Finance Department User.

Basic Flow

Perform Control Group Run Basic Flow

Perform Control Group Run

Step Actor Action Description

1.

CSR / FIN User

Request for Operation

Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for performing of Control Group Run.

2.

CRM / Finance

Call performControlGroupRun API

CRM / Finance System calls Perform Control Group Run API exposed by OCS.io.

3.

OCS.io

Request Validation

OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc.

4.

OCS.io

Schedule Billing Run for Control Group

OCS.io schedules Billing Run for Control Group which is performed asynchronously.

5.

OCS.io

Return Acknowledgment of the Operation Response

OCS.io returns Acknowledgment of the Operation Response to the CRM / Finance System.

Response codes are as follows:

  • 200 = OK

  • 400 = Request Validation failed

  • 500 = Internal error

6.

CRM / Finance

Result of Operation

CRM / Finance system displays result of the operation to the User.

Invoicing Process in Control Group Mode

Step Actor Action Description

11.

OCS.io

Start Billing Run for Control Group

OCS.io starts Billing Run for Control Group.

12.

OCS.io

Calculate Invoice

OCS.io for each Account in Control Group calculates Invoice. No updates are commit to the system.

13.

OCS.io

Publish Invoice

OCS.io for each calculated Invoice publish it to Streaming Platform.

Format Invoices

Step Actor Action Description

21.

CRM / Finance

Subscribe for Invoice

Formatter subscribes for Invoice created by Invoicing Process for Control Group.

22.

CRM / Finance

Request Format Invoice

CRM / Finance system call API on Formatter to format the Invoice.

23.

Formatter

Invoice formatted

Formatter returns formatted Invoice in the Response.

24.

CRM / Finance

Store Invoice

CRM / Finance system stores formatted Invoice internally.

Display Invoices

Step Actor Action Description

31.

CSR / FIN User

Request for Invoice

Customer Sales Representative or Finance Department User via CRM / Finance GUI requests for displaying of Invoice from Control Group Run.

32.

CRM / Finance

Display Invoice

CRM / Finance System displays Invoice from Control Group Run to the User.