4.2 Create Event and Promote to Case
This service creates a new case for the event generated from the source system. For example, if an event is created for a customer in the Customer Screening application, on triggering this service, a case is created for the event on the ECM layer.
The defaulted priority for the cases created through the Real Time Case Creation service will be Low. The system will not determine the priority of the cases created through the service based on the Case Priority configuration.
Due date is updated when a case is created using a real-time API.
The following topics explain how to configure and use the Create Event and Promote to Case service in JSON:
- HTTP Link
- Service Type
- Request Parameters
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http:// <Application
URL>/restapi/CMRestService/RealTimeCaseCreationService/
saveEventsAndPromoteToCase
Service Type
The service type is POST.
Request Parameters
Table 4-3 Create Event and Promote to Case - Request
First Level | Second Level | Third Level | Details |
---|---|---|---|
events | - | - | This accepts basic information about the Event. |
events | eventCode | - | This accepts event ID information. |
events | eventScore | - | This accepts information about the event score. |
events | dataOrigin | - | This accepts information about the Data Origin of the event. It stores the source system from where data is extracted. |
events | jurisdictionCode | - | This accepts information about the Jurisdiction code of the event. It represents geographic or legal entity monitoring or data restrictions. |
events | businessDomain | - | This accepts information about the Business Domain of the event. Business Domain represents the Customer’s operational data restrictions (that is, potential Chinese walls between business units). |
events | type | - | This accepts information about the 'Type' of the event. For example, AML, KYC, and so on. |
events | priority | - | This accepts information about the 'Priority' of the event. It is the Priority of the Event and the risk it poses to a customer or an institution. List of values: Low Medium High |
events | scenarioClass | - | This accepts information about the 'Scenario Class' of the event. For example, ML, FR, and so on. |
events | comments | - | This accepts the additional comments provided, which are related to the generated Event, and details of the event or assignment that led to the creation of an external event that is formatted for display. |
events | entities | - | This is a second-level tag under JSON. It accepts basic information-related event and entity mapping. |
events | entities | entityCode | This accepts the entity code of the entity. It is the Entity identifier on whom the event is generated from the external system. It can be alphanumeric. For Example, The Customer identifier or Account identifier on whom the event is generated. |
events | entities | entityType | This accepts the entity type of the entity. For Example, Account, Customer, Employee, External_ Entity, and Household. |
events | entities | entityTypeCode | This accepts the entity type code of the entity. |
events | entities | entityName | This accepts the name of the entity. |
events | entities | focusFlag | This accepts whether the entity is the Primary Focus of the event or not. List of Values are Y or N. Only one entity of an event will have the value of Y. All others will have N. |
events | entities | actId | This accepts the account internal ID of the Account. |
events | entities | genericEntityInformation | This accepts the generic entity information in the form of a JSON value. Note that a generic entity can never be a focal entity. Hence, there must be some other entity also specified in the entities array which is the focal entity for the event. For more samples, see Supported JSON Structures for Generic Event Information |
events | details | - | This is a second-level tag under JSON. It accepts additional details related to the event. |
events | details | reason | This accepts event highlights. |
events | details | scenarioName | This accepts the event scenarioName. |
events | bindings | bindingName | This accepts the event binding name. |
events | bindings | bindingActualValue | This accepts the actual binding value. |
events | bindings | bindingBaseValue | This accepts the binding base value. |
events | bindings | bindingType | This accepts the binding type. |
casePriority | - | - | This accepts the priority of the case. |
To configure the case title, see the Configuring Case Title for Case Creation (Create Event and Promote to Case) API section in OFS ECM Administration and Configuration Guide 8.1.2.7.0.
Request JSON Sample
This section contains a request JSON sample for creating an event and promoting to case:. The entries in this sample are only for reference purposes.
{
"events": [{
"eventCode": "655867843",
"eventScore": "",
"dataOrigin": "DLY",
"jurisdictionCode": "AMEA",
"businessDomain": "a",
"type": "AML_SURV",
"priority": "",
"scenarioClass": "AML",
"comments": "",
"entities": [{
"entityCode": "1412",
"entityType": "CLIENT_BANK",
"entityTypeCode":
"ECM_CLIENT_BANK",
"entityName": "JADEJ",
"focusFlag": "Y",
"actId": "XXXACFTNEXTENAC-123007"
}
{
"genericEntityInformation": {
"Customer Details": {
"Victim Name": "ABC XYZ",
"Victim SSN": "123-12-1234",
"Phone Number": "123-123-1234"
},
"Enterprise Customer
Complaint": {
"Was a complaint filed?": "No"
},
"Incident Details": {
"Incident Type": "Fradulent Transaction",
"Account Type": "Consumer",
"Market": "Southwest Mumbai"
}
}
}],
"details": [{
"reason": "INR7890 TEST - CORRESPONDENT BANK",
"scenarioName": "User Defined
Event"
}]
}],
"entities": [{
"entityCode": "1412",
"entityType": "CLIENT_BANK",
"entityTypeCode": "ECM_CLIENT_BANK",
"entityName": "JADEJ",
"instId": "HSINDI-001",
"instTypeCd": "BIC",
"dataOrigin": "DLY",
"city": "",
"country": "",
"postalCode": "",
"state": "",
"address": "",
"instituteCountry": "",
"instituteName": "JADEJ",
"largeInstitution": "N",
"selfInstitution": "N"
}, {
"skey": "1412",
"entityType": "CLIENT_BANK",
"entityTypeCode": "ECM_CLIENT_BANK_SEC",
"dataOriginCb": "DLY",
"cbEfctvRiskNb": "0",
"cbListSrcCd": "",
"cbMatchTx": "",
"busUnitCd": "",
"acctMgrNm": "",
"lastActDate": "31-12-2014 00:00:00",
"cbListRiskNb": "0",
"cbMatchTypecd": "",
"instSeqId": "102",
"jurisdiction": "AMEA",
"busList": "a"
}]
"casePriority":"High"
}
Note:
From Oracle Financial Services Enterprise Case Management Release 8.1.2.2.0, capture of Generic information about entities such as Customer, Account and External entity are supported as part of Event Creation. See Sample JSONs for Sample JSONs.Response Parameters
Table 4-4 Create Event and Promote to Case - Request Parameters
First Level | Details |
---|---|
CaseId | Displays the case ID. |
Message | Displays the message of service execution. |
Status | Displays the status as Success or Fail. |
Event Id(s) | Displays all Event IDs that were passed in the request JSON. Will show multiple event IDs if more than one was passed in input JSON. |
CaseType | Displays the type of case. |
Response JSON Sample
{
"caseId": "CA354",
"message": "Events are saved successfully and promoted to case ",
"status": "SUCCESS",
"Event Id(s)": "655867843",
"caseType": "AML_SURV"
}