Alert Notification

Use the Alert Notification technical accelerator to send a message whenever an integration error or failure occurs. The notification can be sent by email, to a pager, in a JIRA ticket, or through a custom handler.

Topics:

Description

You can use the Alert Notification technical accelerator in all your integrations to customize the way in which you receive error notifications.

By adding this accelerator to all your integrations, you have a single consistent method for receiving notifications when an integration error or failure occurs. The turnaround time to resolve an issue is reduced, the issue gets directed to the right person, and maintenance is both streamlined and simplified.

You need to configure the REST connection (type, URL, and security policy). You'll also want to customize the values for the message ID, message subject, and notification type (for example, email or pager) for your organization,

You can't replace the connections or edit the integration in a technical accelerator developed by Oracle.

Key Parameters

The Alert Notification technical accelerator has several required fields or key parameters.

Field Name	Description
instanceID	Instance ID of the calling service
instanceID_string	Instance ID (for future use)
IntgCode_Version	Integration code and version of the calling service
messageID	A specific notification for an integration
messageDetail	Information about the message corresponding to the message ID
tracking_Var_1	Primary tracking variable of the calling service
tracking_Var_2	Secondary tracking variable of the calling service
tracking_Var_3	Third tracking variable of the calling service
faultCode	Fault code of the calling service
faultReason	Fault reason of the calling service
faultDetails	Fault details of the calling service

Supported Notification Types

The Alert Notification technical accelerator supports the following types of notifications:

Email – You provide a valid email address to send the error details to.
PagerDuty – You provide the ServiceID, EmailID, APIToken, and Assignee.
JIRA Ticket – You provide the JIRA user name, access token, project-key, assignee ID, and base URL.
Custom Error Handler – If you want your own error notification service, then you need to build a REST interface and provide the REST URL and credentials.

Connections

The Alert Notification technical accelerator uses two connections:

Oracle Alerting Service Trigger – This REST connection handles the trigger operation. The connection details are already configured. The connection is ready to be used.
Oracle Alerting Service Invoke – This REST connection handles the invoke operation. You must configure the following parameters:
- Connection Type: REST API Base URL
- Connection URL: Any valid URL
- Security Policy: No Security Policy

Lookups

The Alert Notification technical accelerator uses three lookups. Edit the lookup values to customize the notification service for your organization.

The ORCL-T-GENRIC_ENS_NOTIFICATION_SELECTOR_MSGID lookup accepts these parameters:

Message_ID
Message_Subject
Notification_Type

The ORCL-T-GENRIC_ENS_NOTIFICATION_DATA lookup stores the actual parameters for each notification type.

The ORCL-T-GENRIC_ENS_NOTIFICATION_SELECTOR accepts two parameters that define the notification type for the calling service.

IntegrationCode_Version – Specifies the integration code and version combination of the calling service.
Notification_Type – Specifies the kind of notification. For example, PAGERDUTY or Email.

Here are the values required for each notification type.

Notification Type	Parameter	Value To Be Provided
Email	param1	Email of the user to whom the notification will be sent
PagerDuty	param1 param2 param3 param4	PagerDuty Admin Email ID PagerDuty API token PagerDuty Service ID PagerDuty Assignee
JIRA	param1 param2 param3 param4 param5 param6	JIRA Admin Username JIRA Access token JIRA Project Name JIRA Issue Type Name JIRA Assignee ID JIRA Base URL
CUSTOM	param1 param2	Custom values

Usage

Every integration should call the GenericErrorNotification Service from the Global Fault Handler.

You must configure the following parameters for the GenericErrorNotification Service:

IntegrationCode_Version: For example, ORCL-BA-NS2SFDC_INVENITEM_CREATE::01.00.0000.
InstanceID: Use the mapper function to get the instance ID of the calling service. For example, fn:format-number(nsmpr2:getFlowId(), "#").
FaultCode: Map the errorCode from GlobalFaultObject.
FaultReason: Map the reason from GlobalFaultObject.
FaultDetails: Map the details from GlobalFaultObject.