Create Customer
The CRM / Ordering system creates a Customer in the OCS.io via the RESTful API. The request body contains the Customer details. The OCS.io creates the instance of the Customer, then returns Business Transaction containing created Customer as a payload of the response. Other systems may be notified about the Business Transaction via the Streaming Platform.
Basic Flow
| Step | Actor | Action | Description |
|---|---|---|---|
1. |
CRM / Ordering |
Call createCustomer API |
CRM / Ordering system calls Create Customer 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 createCustomer 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. |
Request Validations
The following validations are performed when creating a customer:
-
If Customer Profile is provided in the request, it must be configured in the system.
-
If Customer Segment is provided in the request, it must be configured in the system.
-
State Reason must be configured in the system for given State.
-
If Pending State is provided in the request, it will be ignored and Customer will be created without Pending.
-
If Customer Profile is not provided in the request, attributes State and State Reason must be provided in the request.
-
If External ID is provided in the request, it must be unique and must not be already assigned to another Customer even in Deactivated State.
Perform Business Logic
-
If Customer Profile is provided in the request, system sets Customer attributes like Customer Segment, State and State Reason from Customer Profile configuration.
-
If additional attributes like Customer Segment, State and State Reason are provided in the request, those override attributes from Customer Profile.
-
If External ID is provided, this is set to the newly created Customer.
-
System creates Customer.