ER Delivery Subscriptions

The Event/Response (ER) Subscription entity allows configuration based on the original web service name, operation name, message name, processing outcome, and so forth so that events and responses are routed, only if configured to do so. A subscription may have one or more endpoints of Endpoint type queue-broker or webhook.

The ER Delivery Subscriptions (CERDSUB) page allows a user to search for all configured subscriptions for the current tenant based on web service name, source application, and message name. It also allows the user to add, update, and delete subscriptions, configure optional content-based criteria, and one or more endpoints.

The following table provides detail on each field for an ER Delivery Subscription:

Field

Description

Event Response Delivery Subscription

Subscription Number

This is a unique auto-generated number for the Subscription.

ERD Subscription Name

A user-defined Subscription Name. This is not unique.

Source Application

The Source Application of the original service request or event.

Original Web Service Name

The Web Service Name of the original service request.

Original WS Operation

The Web Service Operation of the original service request.

Original Message Name

The Message Name corresponding to the original service request or event.

External Listener Name

External Listener on which the original service request was received. It is not applicable to the web service-based requests.

Processing Outcome

Processing Outcome (SUCCESS or FAILURE) of the original service request.

Transformation Active?

Gateway Out allows transformation of event/response payloads from the baseline JSON format to subscription specific JSON format using Camel Jolt.

  • Set this flag to true, if transformation needs to be done before sending the payload.

  • Set this flag to false, if transformation should not be used.  

Transformation (Jolt) Script

If Transformation Active flag is true, then the Camel Jolt script must be provided. This script is set by implementation teams or customers on an as-needed basis. It is specific to a payload.

ER Delivery Subscription Criteria

Criteria Number

This is a unique auto-generated number for the Criteria.

Field Name

The Field Name that should be present in either Gateway Out Metadata or in event / response payload.

Field Source

Indicates the source of the field name: METADATA or PAYLOAD.

Field Operator

This is an operator code. Valid values are Equals, CONTAINS and IN.

Criteria Value

Enter a value that will be used for matching purpose. At runtime, Connect uses value based on the Field Name / Field Source, Operator, and this Criteria Value to determine if this subscription criteria is true or not.

If checks for all criteria of a subscription are true, then the subscription is considered as matched.

ER Delivery Subscription Endpoints

Endpoint Name

The Endpoint Name to which the Event/Response needs to be sent.

Active?

  • If set to Yes, ER Delivery will be attempted for this Endpoint.

  • If set to No, ER Delivery will not be attempted for this Endpoint.

Retry wait seconds

In case of a failure in sending to a specific endpoint, Connect will try to re-send the event/response to the same endpoint after this many number of seconds. Default value is 300 seconds.

Max Tries

Indicates the number of times that Connect will attempt to send an event/response to this endpoint.

Please refer to the CGI Advantage Connect - Configuration & Management Guide for more information on this page.