Update Subscriber’s Segment

The CRM / Ordering system updates a Subscriber in the OCS.io via the RESTful API. The request body contains updated Subscriber details like External ID, Custom Name, etc. The OCS.io updates the instance of the Subscriber, then returns Business Transaction containing updated Subscriber as a payload of the response. Other systems may be notified about the Business Transaction via the Streaming Platform.

While a history is maintained for the Subscriber Segment attribute in OCS.io, the new value becomes effective immediately and is used in subsequent processes like rating & charging, billing & invoicing. Please note that historical values are not considered in these processes.

Primary Actor

CRM / Ordering system.

Basic Flow

Step	Actor	Action	Description
1.	CRM / Ordering	Call updateSubscriberSegment API	CRM / Ordering system calls Update Subscriber’s Segment API exposed by OCS.io.
2.	OCS.io	Request Validations	OCS.io validates Request whether all mandatory attributes are populated, all data types are valid, ENUMs match with definition, etc. Additionally, OCS.io validates Request against Business Logic. This typically includes, that referenced entity exists in the system, entity has proper state, etc.
3.	OCS.io	Perform Business Logic	OCS.io performs Business Logic implemented for the Use-Case.
4.	OCS.io	Publish Business Transaction	OCS.io publishes zero to many messages to Streaming Platform that impacted entities have been changed.
5.	OCS.io	Return updateSubscriberSegment Response	OCS.io returns Response to the CRM / Ordering System.
6.	DWH	Subscribe for Business Transactions	DWH subscribes for Business Transactions to be delivered by Streaming Platform.
7.	DWH	Process Business Transactions	DWH process Business Transactions internally. This typically includes storing of changed entities, update indexes, update metrics, etc.

Step

Actor

Action

Description

CRM / Ordering

Call updateSubscriberSegment API

CRM / Ordering system calls Update Subscriber’s Segment API exposed by OCS.io.

OCS.io

Request Validations

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

Additionally, OCS.io validates Request against Business Logic. This typically includes, that referenced entity exists in the system, entity has proper state, etc.

OCS.io

Perform Business Logic

OCS.io performs Business Logic implemented for the Use-Case.

OCS.io

Publish Business Transaction

OCS.io publishes zero to many messages to Streaming Platform that impacted entities have been changed.

OCS.io

Return updateSubscriberSegment Response

OCS.io returns Response to the CRM / Ordering System.

DWH

Subscribe for Business Transactions

DWH subscribes for Business Transactions to be delivered by Streaming Platform.

DWH

Process Business Transactions

DWH process Business Transactions internally. This typically includes storing of changed entities, update indexes, update metrics, etc.

Request Validations

The following validations are performed when updating a subscriber’s segment:

Subscriber must be provided in the request, it must be already created in the system and must not be in Deactivated State.
Subscriber Segment must be provided in the request, it must be configured in the system.

Perform Business Logic

System updates Subscriber’s Segment.

Publish Business Transaction

Following entities will be published to Streaming Platform as part of Business Transaction:

Subscriber