Integrate with Axway Sentinel

After you install Interchange and Sentinel, you can use the Integrate the trading engine with Sentinel page to control how Interchange interoperates with Sentinel. From this page, you can enable and disable the Interchange / Sentinel interface, and control the types of metadata that are sent to Sentinel for events that are tracked in Interchange.

Open the Integrate the trading engine with Sentinel page

To open this page:

  1. Click Trading configuration on the toolbar to open the Communities page.
  2. Click Configure Sentinel integration to open the Integrate the trading engine with Sentinel page.

Organization of the page

The Integrate the trading engine with Sentinel page has three tabs:

  • Sentinel tab – Displays the primary controls for enabling Interchange to integrate with Sentinel.
  • Filters tab – Sets up conditions for which message events to send. Using this tab is optional. The default behavior is to send all events.
  • Custom objects tab – Allows adding names of your own custom tracked objects that can be referenced by filters.

Additionally, at the bottom of this page a Related tasks list is displayed.

Sentinel tab

Use the Sentinel tab to configure exchanges between Interchange and Sentinel:

  1. On the Sentinel tab, select Enable Sentinel interface to display the configuration fields.
  1. Complete the fields.
    • Primary host – The fully-qualified domain name or IP address of the computer running Sentinel. If Interchange and Sentinel are running on the same computer, you can use the short computer name instead of the fully-qualified domain name.
    • Primary port – The port Sentinel uses to listen to connections from Interchange. The default port is 1305.
    • Secondary host – The fully-qualified domain name or IP address of the computer running a second instance of Sentinel, if one has been installed and configured. The secondary Sentinel is used for fail-over. If Interchange cannot communicate with the primary Sentinel, it tries to connect to the secondary Sentinel.
    • Secondary port – The port the secondary Sentinel uses to listen to connections from Interchange. The default port is 1305.
    • Enable buffer congestion monitoring – Select this option to enable the Interchange system throttle to make sure events queued for sending to Sentinel are not lost if the backed-up volume exceeds the specified congestion threshold percentage. Enabling congestion monitoring is unnecessary unless recommended by technical support.
    • Send processing data about traded messages – Select this option if you want to have Interchange send message metadata to Sentinel about messages exchanged between exchange endpoints.
    • Send heartbeats for the trading engine cluster – Select this option if you want Interchange to send trading engine node and Secure Relay (DMZ) node data at the specified interval to Sentinel. Interchange sends heartbeat data for each processing node and for Secure Relay nodes if they are deployed. In the Sentinel user interface, a user can view summary information about all nodes or all events for a specific node.
      • Heartbeat interval (seconds) – Accept the default (60 seconds) or enter a preferred heartbeat reporting interval in seconds.
    • Send changes about the trading engine cluster – Select this option if you want Interchange to send each of its node’s events log file data to Sentinel. In Sentinel the events are reported in XFBLog.
    • Event levels are mapped as follows:
    • Interchange event level

      Sentinel event level

      Error

      EM

      Warning

      AV

      High

      IG

      Low

      IP

Filters tab

Use the Filters tab to set up conditions for selectively sending message events to Sentinel.

Configuring filters is optional. The default Interchange behavior is to send all events to Sentinel. You can set up filters to operate differently than the default send-all behavior. Selectively filtering events can be complex depending on what events you want to send.

For details about using this tab to manage filers, see:

Custom objects tab

The use of this tab is rarely required.

Interchange incorporates one Sentinel tracked object named XFBTransfer. This tracked object meets most needs. In special cases, you may need additional tracked objects. For example, you may want to forward more attributes and values to Sentinel than supported by the default tracked object.

If you have a custom tracked object, enter its name on the Custom objects tab. Integration filters can reference the custom tracked objects listed on this tab.

Publishing information to Sentinel with a custom tracked object requires more than entering a name on this tab. Implementing a custom tracked object requires Java development skills and experience using Interchange, Sentinel and Composer. You may want to engage Axway professional services consultants to complete the task.

To implement a custom tracked object you must:

  1. Add a tracked object in Axway Composer and export it to Sentinel.
  2. Develop Java code for gathering the events in Interchange to publish to Sentinel. The code can be implemented as a message action, inline process, event router or other plug-in.
  3. If selective filtering of events is desired, add the name of the custom tracked object to the Custom objects tab. Then add one or more integration filters to control the flow of events to Sentinel.

Related tasks list

At the bottom of the Integrate the trading engine with Sentinel page, two tasks are displayed:

  • Add an integration filter – Click this link to open the Add an integration filter page.
  • Manage trading configuration – Click this link to return to the Communities page.

About Sentinel filters

Use the Filters tab to set conditions for sending message events to Sentinel.

Filters let you approach Sentinel integration in two opposite ways:

  • You can send all or most events to Sentinel, but block specified events.
  • You can block all or most events from Sentinel, but send only specified events.

There are two types of integration filters: the default filter and custom filters. There is only one default filter. You can add as many custom filters as you need.

In the simplest case, only the default filter is required. This presumes that Sentinel integration is enabled and you want Interchange to send all events without exception. To do so, open the default filter and make sure Send all events is selected.

Another case is when you want Interchange to send only some events. This requires using the default filter and at least one custom filter. If filtering conditions are complex, you may need many custom filters. For example, you could set the default filter to Don’t send any events. Then you could add two filters, one allowing events related to purchase orders and the other to invoices. The effect of all three filters is Interchange sends only events related to purchase orders and invoices, but nothing else.

Custom filters

To have only preferred synchronous response sent to Sentinel, use the default filter in combination with custom integration filters.

Custom filters act before the default filter. Despite whether you set up one or many custom filters, the default filter always triggers last. This sequence provides the control necessary for setting up exact filtering conditions.

You can set up simple or complex filter expressions with custom integration filters. It is the expressions – working in opposition to the default filter – that provide a high degree of control over the events sent to Sentinel.

Filter expressions can be used only with custom filters and are not applicable to the default filter. Although you can adjust some of the default filtering conditions, you cannot turn off or delete the default filter.

The following examples describe use of custom integration filters.

Filter example 1

To send to Sentinel only events associated with 850 documents (EDI purchase orders):

  1. In the Filters tab, click the name of the default filter (Sentinel Default) to open the filter modification page.
  2. In the default filter, select Don’t send any events.
  3. Click Save changes to return to the Filters tab.
  4. From the list of Related tasks, click Add an integration filter.
  5. Add a filter with a filter expression that requires events associated with DocumentType Equals 850 to be sent.

Because the custom filter triggers first, Interchange sends to Sentinel events related to 850 documents. The default filter then blocks all other events, including all events related to all other document types.

Filter example 2

The second example illustrates the opposite case of sending all events except events related to 850 documents.

  1. In the Filters tab, click the name of the default filter ( Sentinel Default) to open the filter modification page.
  2. In the default filter, select Send all events.
  3. From the list of Related tasks, click Add an integration filter.
  4. Add a filter with a filter expression that blocks events related to DocumentType Equals 850.

Because the custom filter triggers first, Interchange blocks events related to 850 documents. The default filter then sends all other events.

Add or modify Sentinel filters

The Filters tab of the Integrate the trading engine with Sentinel page lists available filters. If you add custom filters, the default filter always is listed last. This is to illustrate that the default filter runs last, after custom filters. The page also shows the filter expressions for custom filters.

Use the up and down arrows to set the sequence in which custom filters run. The filter at the top runs first, followed by the next filter on the list and so on.

The Mode column indicates whether or not a filter is set to send events. When the default filter is set to Don’t send any events, the Mode column shows Don’t send for the default filter and Send for all other filters. When the default filter is set to Send all events, the Mode column shows Send for the default filter and Don’t send for all other filters. The Send and Don’t send indicators are reminders of the opposite relationship between the default filter and custom filters.

On the Filters tab you can enable or disable any filter, except the default filter. This is useful if you want to suspend but not delete a filter.

To open a filter, click the filter name on the Filters tab. To add a filter, click Add an integration filter.

Before adjusting the default filter or adding custom filters, determine what you want Interchange to send or block. This affects how to set the default filter and how many custom filters and expressions to add.

The following topics describe the fields for changing the default filter and for adding or changing a custom filter:

Default filter fields

  • Name – The name of the filter. You cannot change the name of the default filter.
  • Description – A description of the filter.
  • Tracked object name – Unless you have a custom tracked object, select ALL or XFB Transfer. The default tracked object in use by Interchange is XFB Transfer. If you have a custom tracked object, selecting ALL engages all TOs, including XFB Transfer.
  • Don’t send any events – Select this option to block all events unless overridden by custom filters. This places the default filter in do-not-send mode and all custom filters in send mode.
  • Send all events – Select this option to send all events unless overridden by custom filters. This places the default filter in send mode and all custom filters in do-not-send mode.

Custom filter fields

  • Name – The name of the filter to add or change. After adding it, you can change the name of a custom filter.
  • Description – A description of the filter.
  • Tracked object name – Unless you have a custom tracked object, select ALL or XFB Transfer. The default tracked object in use by Interchange is XFB Transfer. If you have a custom tracked object, selecting ALL engages all TOs, including XFB Transfer.
  • Filter expression – Click the link to add or change a filter expression for tuning the operation of the filter. A custom filter must have at least one filter expression. For more information, see Filter expressions.
  • External class for metadata processing – Enter the java class to be used for processing the event metadata.
  • Enable this integration filter – Select to turn on the filter.
  • Disable this integration filter – Select to turn off the filter.

When adding a filter, the filter expression link displays only after you type a filter name and click Add. The link says Click here to define a filter expression.

After adding or changing a filter, click Save changes.

Filter expressions

Filter expressions can be used to set conditions for applying a custom filter. An expression can be one statement or multiple statements combining a complex string of and-or conditions.

A single expression consists of a metadata attribute, an operator ( equals or not equals) and a value.

Interchange recognizes many metadata attributes. To use a known attribute, type one or more letters in the When attribute field to display a list of autocomplete values that start with those letters. You can select an autocomplete value or type an attribute of your own.

After completing the expression, click Add. You can add another expression as an AND or OR condition. Click Save changes when done.

Note   To ensure a large pool of autocomplete attributes to choose from, attribute collection must be enabled. Users with administrative permissions can check this. Select Message tracker > Configure global message tracker settings. On the page titled Global message tracker settings, make sure the following is enabled: Collect attributes for use in message detail pop-up windows. In addition, an administrator may have to assign attributes as in-use attributes to make sure the proper attributes are available as autocomplete values. For more information see Manage Message Tracker default search settings.

Related topics

Related Links