Configuring Lookups, Error Handling, and Email
Notifications
This chapter focuses on the lookups configuration, handling business and technical errors, sending email notifications, and customizations in this integration. It includes the following sections:
Configuring Lookups
The following table lists the lookups used by this integration and their purposes. Most lookups define mappings between CCS and CX field types or values. The OUTL-BRT-CCS_CX_BusinessConfigProps and OUTL-BRT-CCS_CX_TechnicalConfigProps lookups define integration configuration settings which will be described afterwards.
Some lookups include sample entries out of the box, for reference. Review and update the entries to match the values configured in your CCS and CX environments.
Lookup Name |
Integration Name |
Purpose |
|---|---|---|
OUTL-BRT-CCS_CX_BusinessConfigProps |
| Defines functional configuration settings, including business-user email recipients and notification flags. |
OUTL-BRT-CCS_CX_TechnicalConfigProps |
| Defines technical configuration settings, including the notification sender, technical-user email recipients, and technical-error notification flag. For OIC Embedded implementations, these settings are maintained by the technical support team. |
OUTL-BRT-CCS_CX_CaseCharacteristicType |
| Maps CCS Case Characteristic Types to corresponding CX field names. Types not listed are excluded from synchronization. |
OUTL-BRT-CCS_CX_CaseCondition |
| Maps CCS Case Condition to corresponding CX Service Request Status values. |
OUTL-BRT-CCS_CX_CaseStatus |
| Maps CCS Case Status to corresponding CX Service Request Status values. |
OUTL-BRT-CCS_CX_CaseType |
| Maps CCS Case Types to corresponding CX Service Request Category Codes. |
OUTL-BRT-CCS_CX_CharacteristicValue |
| Maps CCS characteristic values to corresponding CX field values. If no matching entry is found, the original CCS value is used. Works with OUTL-BRT-CCS_CX_CaseCharacteristicType for Case synchronization and OUTL-BRT-CCS_CX_PersonCharacteristicType for Person and Contact/Account synchronization. |
OUTL-BRT-CCS_CX_CommunicationType |
| Maps CCS Contact Routing values (Communication Types) associated with Person Contact Types to CX Contact Point Types. Valid CX target values are EMAIL, PHONE, and WEB. |
OUTL-BRT-CCS_CX_ContactTypeEmailPurpose |
| Maps CCS email Contact Types to corresponding CX Email Purpose values. Valid CX values are configured through standard lookups. See Chapter 4 for details. |
OUTL-BRT-CCS_CX_ContactTypePhonePurpose |
| Maps CCS phone Contact Types to corresponding CX Phone Purpose values. Valid CX values are configured through standard lookups. See Chapter 4 for details. |
OUTL-BRT-CCS_CX_ContactTypeWebPurpose |
| Maps CCS web Contact Types to corresponding CX Web Purpose values. Valid CX values are configured through standard lookups. See Chapter 4 for details. |
OUTL-BRT-CCS_CX_PersonCharacteristicType |
| Defines which CCS Person Characteristic Types are synchronized with CX. Types not listed are excluded from synchronization. If PersonBusinessBoth is blank or set to BOTH, the mapping applies to both Person and Business. An invalid value raises a business error. If CX_ElementName is blank or does not identify a valid standard or extended CX field, CX returns HTTP 400 (Bad Request). |
Editing Lookups
To edit a lookup:
-
Login to Oracle Integration for Cloud.
-
Navigate to Projects > OU CCS CX > Lookups.
-
Select the lookup to edit.
-
Make the necessary changes.
-
Click Save and Close.
Configuration Properties
OUTL-BRT-CCS_CX_BusinessConfigProps contains the properties that can be defaulted in the integration. It also contains a flag to enable email notifications for business faults.
Property Name |
Sample Value |
Description |
Used in Integration Process Name |
|---|---|---|---|
business.error.to.email | The email address(es) who should receive notification when a business or functional error is encountered. Multiple emails can be configured by putting comma to separate the email IDs. | OU Common Notification Handler | |
notif.email.business.error.flag | true | Indicates whether email notifications are enabled for business error cases. Set to true, to receive email notifications for business errors. otherwise, set to false. If this flag is set to true, email is sent to mail Id(s) configured in business.error.to.email property. | OU Common Notification Handler |
notif.email.techerror.info.flag | true | Indicates whether email notifications are enabled for information related to technical error cases. Set to true, to receive email notifications for technical error information. otherwise, set to false. If this flag is set to true, email is sent to mail Id(s) configured in business.error.to.email property. | OU Common Notification Handler |
notification.channel | Hardcoded value for the integrations to send to the 'common notification handler' to decide how to send the notifications out. | OU Common Notification Handler |
OUTL-BRT-CCS_CX_TechnicalConfigProps contains the properties that can be defaulted in the integration. It also contains a flag to enable email notifications for technical faults.
Property Name |
Sample Value |
Description |
Used in Integration Process Name |
|---|---|---|---|
from.email | The email address used to identify who is sending the notification. This value is the default email address for all outgoing emails for this project. | OU Common Notification Handler | |
technical.error.to.email | technical_team@email.com | The email address(es) who should receive notification when a technical error is encountered in OIC. Multiple emails can be configured by putting comma to separate the email IDs. | OU Common Notification Handler |
notif.email.technical.error.flag | true | Indicates whether email notifications are enabled for technical error cases. Set to true, to receive email notifications for technical errors. Otherwise, set to false. If this flag is true, sends email to email Ids configured in technical.error.to.email property. | OU Common Notification Handler |
integration.service.account | FUSION_INTEGRATION_USER | Identifies records created in this integration so that CX can discards events triggered when CX receives updates from CCS through the REST API, preventing infinite synchronization loops. | OU CX CCS Contact Account Sync |
source.system.in.CX | CIS | Identifies the source system that created the record in CX. A value of CIS indicates that the record was created in CCS and synchronized to CX. | OU CCS CX Person Sync OU CX CCS Contact Account Sync |
Error Handling
This section provides information about the different ways used to handle errors in the integration and also resubmitting the instances after rectifying the errors.
Error Handling Types
The integration classifies errors as technical faults or business faults. Error notifications are sent through the OU Common Notification Handler integration only when the corresponding notification flag is set to true.
Technical Fault
A technical fault occurs when an integration cannot complete processing because of an execution or connectivity issue. Examples include:
-
Assignment, XPath, or data transformation errors.
-
Authentication or authorization failures.
-
Unavailable services or connection failures.
-
Request timeouts.
Remote Fault
A remote fault is a type of technical fault that occurs when an invocation of a target service fails, for example, because the target system is unavailable or the request times out.
Technical faults are processed by the integration’s fault handlers. Depending on the integration flow, fault details are also returned to the source system.
Detailed technical error notifications can be sent to technical users, while simplified technical error notifications can be sent to functional users. Each notification is controlled independently by its corresponding flag.
Business Fault
A business fault occurs when CCS or CX rejects a request because of invalid data or configuration. Examples include:
-
Requests to CCS: Invalid or missing Person Contact Types, invalid Characteristic Types, or invalid phone formats.
-
Requests to CX: Invalid CX field names or unrecognized phone, email, or web purposes.
Business faults are processed by the applicable integration’s error-handling logic. HTTP 400 errors are classified as business faults; other error responses are classified as technical faults. The OIC Instance will end in an error state, while the local fault handler propagates the fault to the Global Fault Handler, which requests the notification email.
Errors in Integration Process
The following tables describe example error scenarios for each integration process.
Integration Process: OU CCS CX Person Sync
| Type of Error | Action | Notification Type | Retry |
|---|---|---|---|
| Business fault: Invalid or missing Person Contact Type. | CX rejects the request. The notification handler is invoked, and the OIC instance is marked Failed. | Business Error Email | Correct the Person Contact Type OIC lookup, resubmit the message in CCS. |
| Business fault: Invalid or empty CX field name. | CX rejects the request. The notification handler is invoked, and the OIC instance is marked Failed | Business Error Email | Correct the Person Characteristic Type lookup in OIC, resubmit the message in CCS. |
| Business fault: Unknown Phone/Email/Web purpose | CX rejects the request. The notification handler is invoked, and the OIC instance is marked Failed. | Business Error Email | Correct the lookup value in the corresponding lookup. Resubmit the message in CCS. |
| Business fault: Invalid phone format. | CX rejects the request, and the notification handler is invoked. | Business Error Email | Correct the phone format in CCS and save the change to trigger a new synchronization |
| Technical fault: Authentication failure. | The technical error is routed to the notification handler. | Technical Error Email | Correct the authentication configuration. Retry: Resubmit the message in CCS. |
| Remote fault: CX, CCS or a required service is unavailable. | The technical error is routed to the notification handler. | Technical Error Email | Restore service availability or connectivity. Retry: Resubmit the message in CCS. |
| Technical fault: Request timeout. | The technical error is routed to the notification handler. | Technical Error Email | Retry: Resubmit the message in CCS |
Integration Process: OU CX CCS Contact Account Sync
Type of Error |
Action |
Notification Type |
Retry |
|---|---|---|---|
Business fault: Invalid CCS field name. | CCS rejects the request, and the notification handler is invoked. | Business Error Email | Correct the field name in the corresponding OIC Lookup. Retry: Resend message from OIC or save new update in CX to trigger a new update. |
Business fault: Unrecognized phone purpose, email or web purpose. | CX rejects the request, and the notification handler is invoked. | Business Error Email | Configure a valid CX phone, email or web purpose. Retry: Resend message from OIC or save new update in CX to trigger a new update. |
Technical fault: Authentication failure. | The technical error is routed to the notification handler. | Technical Error Email | Correct the authentication configuration. Retry: Resubmit the message in OIC. |
Remote fault: CX, CCS or a required service is unavailable. | The technical error is routed to the notification handler. | Technical Error Email | Restore service availability or connectivity. Retry: Resubmit the message in OIC |
Technical fault: Request timeout. | The technical error is routed to the notification handler. | Technical Error Email | Retry: Resubmit the message in OIC. |
Integration Processes: OU CX Contact Update Event, OU CX Contact Delete Event, OU CX Account Update Event, and OU CX Account Delete Event
These event integrations handle technical faults directly. Business faults are handled by the shared OU CX CCS Contact Account Sync integration.
| Type of Error | Action | Notification Type | Retry |
|---|---|---|---|
| Technical fault: Authentication failure. | The technical error is routed to the notification handler. | Technical Error Email | Correct the authentication configuration. Retry: Resubmit message in OIC or generate a new message from CX. |
| Remote fault: A required service like the OU Common Notification Handler is unavailable. | The technical error is routed to the notification handler. | Technical Error Email | Verify service availability and connectivity. Retry procedure: Resubmit message in OIC or generate a new message from CX. |
Integration Process: OU CCS CX Case Sync
This integration classifies HTTP 400 errors as business faults. Other errors are classified as technical faults.
| Type of Error | Action | Notification Type | Retry |
|---|---|---|---|
| Business fault: Target service returns HTTP 400. | Classified as a business fault and propagated to the Global Fault Handler. | Business Error Email | Correct the data or configuration identified in the error. Retry: Resend message from CCS. |
| Technical fault: Target service returns an HTTP error other than 400. | Classified as a technical fault and propagated to the Global Fault Handler. | Technical Error Email | Resolve the issue identified in the error. Retry: Resend message from CCS. |
| Remote fault: Service unavailable, connection failure, or timeout. | Propagated to the Global Fault Handler as a technical fault. | Technical Error Email | Retry: Resubmit the message in CCS |
Email Notifications
This pre-built integration provides configurable email notifications for business and technical faults. Notifications are sent through the OU Common Notification Handler integration only when the corresponding flag is set to true.
To configure email notifications:
-
Login to Oracle Integration Cloud.
-
Navigate to Projects > OU CCS CX > Lookups.
-
Edit the applicable lookups to configure recipients and enable the required notifications:
| Notification | Configuration lookup | Recipient property | Enable flag |
|---|---|---|---|
| Business error | OUTL-BRT-CCS_CX_BusinessConfigProps | functional.error.email.address | notification.email.business.error.flag |
| Simplified technical error for functional users | OUTL-BRT-CCS_CX_BusinessConfigProps | functional.error.email.address | notification.email.informative.error.flag |
| Detailed technical error for technical users | OUTL-BRT-CCS_CX_TechnicalConfigProps | technical.error.email.address | notification.email.technical.error.flag |
Set each required notification flag to true and enter the intended recipients in the corresponding recipient property. Recipient properties accept comma separated email addresses.
In OUTL-BRT-CCS_CX_TechnicalConfigProps, set from.email to the sender email address used for notifications.
Technical-error notifications for technical users and business users are controlled independently. Enable both flags to notify both groups.