Install and configure Sentinel

The procedure to use for installing and configuring Sentinel with B2Bi depends on the current status of your installation. While you can complete most installation and configuration tasks through the installer programs, in some cases you need to complete additional manual steps.

The following are possible installation scenarios:

Installation requirements

B2Bi and Sentinel are distributed through separate installer files, so regardless of the installation scenario you choose, you will execute a two-step installation procedure (and some post-installation configuration steps) to install the two products and fully configure their interoperability.

Installations with Sentinel and Composer installed in different directories or on different machines (optional)

Composer is an optional application that may be used with Sentinel for Sentinel object editing and deployment.

  • Start Sentinel before you start the installation of B2Bi Visibility on the Composer machine. This enables the installer to automatically send pre-built B2Bi Sentinel Dashboards to production on the Sentinel Server.
  • On the Composer machine, copy the contents of the folder Composer\composer\web\sentinel\background\solution\ to the Sentinel machine in the folder Sentinel\www\web\sentinel\background\.
  • On the Composer machine, copy the file Composer\sentinel.properties to the Sentinel machine in the folder Sentinel\conf\.
  • On the Composer machine, copy the file Composer\*.ivl to the Sentinel machine in the folder Sentinel\www\web\sentinel\bgolib\basic\.
  • On the Composer machine, copy the file Composer\*.css to the Sentinel machine in the folder Sentinel\www\web\sentinel\Chartcss\Flat\.

Installation scenario 1: New installation of both B2Bi and Sentinel

Schematic of installation and configuration sequence:

Task 1: Pre-installation and planning

  1. Review prerequisites for both B2Bi and Sentinel installations. See the B2Bi Installation Guide (this guide) and the Axway Installation and Prerequisites Guide.
  2. Plan for your database.
  3. Plan for the DMZ if users are to access either B2Bi or the Sentinel UI through a DMZ.
  4. Collect the necessary server network locations, ports and access credentials. You need to provide this information during the installation.

Task 2: Install Sentinel

  1. Run the Sentinel installer in Standard installation mode.
  2. Select to install Sentinel.
  3. After you install Sentinel, check the B2Bi Release Notes for any service pack and patch requirements. If necessary, run the installer in Update mode and apply the latest B2Bi compatible service packs that are available for Sentinel. Service packs and patches can be downloaded from https://support.axway.com.

Task 3: Install B2Bi from the B2Bi Server installer

Sentinel must be installed before you begin this task. Working in the B2Bi installer:

  1. In the B2Bi Server configuration page, select the option Use Sentinel.
  2. Complete the installation.

Task 4: Deploy the B2Bi Sentinel objects to Sentinel

When you install B2Bi, the installer places a set of files for use with Sentinel in sub-folders of the directory:

<B2Bi_install_directory>\Integrator\solutions\extras\Sentinel\B2Bi

The following table describes the content of this directory:

Sub-folder File name File content
\B2Bi b2bi_system.xml

Tracked Object:

  • B2Bi System
\B2Bi b2bi_message.xml

Tracked Object:

  • B2Bi Message
\B2Bi HeartBeat.xml

Tracked Object:

  • HeartBeat

Deploy to Sentinel

There are several methods for deploying the B2Bi Tracked Objects to Sentinel:

  • Manual deployment – Copy the Tracked object XML files to a Sentinel folder
  • Deployment using Composer – If you have installed the Axway Composer product you can use Composer to create, edit and deploy Tracked Objects.
  • Deployment via the Sentinel REST API

Deploy manually

To manually copy and paste:

  1. Go to <B2Bi_install_directory>\Integrator\solutions\extras\Sentinel\B2Bi and copy all of the Tracked Object XML files contained in this folder.
  2. Go <Sentinel_install_directory>\broadcast\commit\TrackedObject and paste the Tracked Object XML files.
  3. Restart the Sentinel Server.
  4. Review the following Sentinel logs to ensure your Tracked Objects are successfully deployed:
    • log/sentinel.log
    • log/TrackingObjects.html
    • log/InvalidTrackingObjects.html

Deploy using Composer

To deploy Tracked Objects via Composer:

  1. Open a session in Composer.
  2. In the Integration Services workbench select Tools>Import object...
  3. Import the following files to Composer (described in the preceding table):
    • b2bi_system.xml
    • b2bi_message.xml
    • heartbeat.xml
  4. From Composer, deploy the imported B2Bi Tracked Objects to Sentinel. For additional deployment details see the Axway Composer 3.8 Deployment Guide.

Deploy using the Sentinel REST API

For details of how to use the Sentinel REST API, see the Sentinel API Developer Guide.

Task 5: Activate the Sentinel interface in B2Bi

  1. Open a session in the B2Bi user interface.
  2. From the System management menu, select System management to open the System management page.
  3. From the Relate tasks list at the bottom of the page, select Integrate with Sentinel to open the Integrate with Sentinel page.
  4. Select the option Enable Sentinel interface.
  5. Configure the Sentinel connection:
    • Primary host – The fully-qualified domain name or IP address of the computer running Sentinel. If the trading engine and Sentinel are running on the same computer, you can use the short computer name instead of the fully-qualified domain name. By default the interface displays the machine name where B2Bi is running. Be sure to enter the correct machine name for Sentinel.
    • Primary port – The port Sentinel uses to listen to connections from B2Bi. 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 instance is used for fail-over. If B2Bi cannot communicate with the primary Sentinel host, it tries to connect to the secondary Sentinel host.
    • Secondary port – The port the secondary Sentinel uses to listen to connections from B2Bi. The default port is 1305.
    • Send mode – Select one of the following modes for sending integration engine events to Sentinel:
      • Direct – Select this option if you want to send events directly to Sentinel without first writing them to the overflow file. This increases the rate of transfer of events to Sentinel, however, it can significantly reduce integration engine performance.
      • Batch – By default, the integration engine sends events to Sentinel in batch mode, first sending them to the overflow file. The integration engine then consumes these events from the overflow file and sends them to Sentinel as processing resources allow. This consume-and-send process can take several minutes, but reserves maximum integration engine performance for message-processing tasks.
    • Overflow file safety limit – Enter a percentage as a threshold for when the integration engine begins sending events to Sentinel from the overflow file. The default value is 80% of the overflow buffer size. If this threshold percentage is reached, the integration engine begins sending events to Sentinel, potentially reducing normal message-processing resources.
    • Send processing data about traded messages – Select this option if you want to have B2Bi send message metadata to Sentinel about messages exchanged between exchange endpoints.
      • Include additional states – By default, B2Bi sends a restricted set of state information to Sentinel. To enable the sending of an extended set of states (along with other processing data), select this option. For additional information about this feature, see the B2Bi Administrator Guide, Sentinel Message States chapter.
    • Send heartbeats for the trading engine cluster – Select this option if you want B2Bi to send node data at the specified interval to Sentinel. B2Bi sends heartbeat data for each processing node. 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.
    • Buffered connector mode for processing activity data – This section displays the options:
      • Discard the data and do not send it to Sentinel when the overflow buffer is full – Select this option if you prefer not to activate the system throttle. This option enables you to maintain a higher message processing rate, but introduces a risk of incomplete transaction reporting to Sentinel.
      • Engage System Throttle to allow all processing data to be sent to Sentinel – Select this option to enable the B2Bi 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.
      • Buffered data threshold % – When you select the System Throttle option, you must also specify a buffered data threshold. Enter a percentage as a threshold for when the B2Bi begins sending events to Sentinel from the overflow file. The default value is 20% of the overflow buffer size. If this threshold percentage is reached, B2Bi begins sending events to Sentinel, potentially reducing normal message-processing resources.
  6. Click Save changes.

Installation scenario 2: New installation of Sentinel integrated to an existing B2Bi

Schematic of installation and configuration sequence:

Task 1: Pre-installation and planning

  1. Review prerequisites for both B2Bi and Sentinel installations. See the B2Bi Installation Guide (this guide) and the Axway Installation and Prerequisites Guide.
  2. Plan for your database.
  3. Plan for the DMZ, if users are to access either B2Bi or the Sentinel UI through a DMZ.
  4. Collect the necessary server network locations, ports and access credentials. You need to provide this information during the installation.

Task 2: Install Sentinel

  1. Run the Sentinel installer in Standard installation mode.
  2. Select to install Sentinel.
  3. After you install Sentinel, check the B2Bi Release Notes for any service pack and patch requirements. If necessary, run the installer in Update mode and apply the latest B2Bi-compatible service packs that are available for Sentinel. Service packs and patches can be downloaded from https://support.axway.com.

Task 3: Configure B2Bi for Sentinel

  1. Run the B2Bi installer in configure mode.
  2. In the B2Bi Server configuration page, select the option to use Sentinel.
  3. In the B2Bi Server configuration page, select the option Use Sentinel.
  4. Complete the configuration update.

Task 4: Deploy the B2Bi Sentinel objects to Sentinel

When you install B2Bi, the installer places a set of files for use with Sentinel in sub-folders of the directory:

<B2Bi_install_directory>\Integrator\solutions\extras\Sentinel\B2Bi

The following table describes the content of this directory:

Sub-folder File name File content
\B2Bi b2bi_system.xml

Tracked Object:

  • B2Bi System
\B2Bi b2bi_message.xml

Tracked Object:

  • B2Bi Message
\B2Bi HeartBeat.xml

Tracked Object:

  • HeartBeat

Deploy to Sentinel

There are several methods for deploying the B2Bi Tracked Objects to Sentinel:

  • Manual deployment – Copy the Tracked object XML files to a Sentinel folder
  • Deployment using Composer – If you have installed the Axway Composer product you can use Composer to create, edit and deploy Tracked Objects.
  • Deployment via the Sentinel REST API

Deploy manually

To manually copy and paste:

  1. Go to <B2Bi_install_directory>\Integrator\solutions\extras\Sentinel\B2Bi and copy all of the Tracked Object XML files contained in this folder.
  2. Go <Sentinel_install_directory>\broadcast\commit\TrackedObject and paste the Tracked Object XML files.
  3. Restart the Sentinel Server.
  4. Review the following Sentinel logs to ensure your Tracked Objects are successfully deployed:
    • log/sentinel.log
    • log/TrackingObjects.html
    • log/InvalidTrackingObjects.html

Deploy using Composer

To deploy Tracked Objects via Composer:

  1. Open a session in Composer.
  2. In the Integration Services workbench select Tools>Import object...
  3. Import the following files to Composer (described in the preceding table):
    • b2bi_system.xml
    • b2bi_message.xml
    • heartbeat.xml
  4. From Composer, deploy the imported B2Bi Tracked Objects to Sentinel. For additional deployment details see the Axway Composer 3.8 Deployment Guide.

Deploy using the Sentinel REST API

For details of how to use the Sentinel REST API, see the Sentinel API Developer Guide.

Task 5: Activate the Sentinel interface in B2Bi

  1. Open a session in the B2Bi user interface.
  2. From the System management menu, select System management to open the System management page.
  3. From the Relate tasks list at the bottom of the page, select Integrate with Sentinel to open the Integrate with Sentinel page.
  4. Select the option Enable Sentinel interface.
  5. Configure the Sentinel connection:
    • Primary host – The fully-qualified domain name or IP address of the computer running Sentinel. If the trading engine and Sentinel are running on the same computer, you can use the short computer name instead of the fully-qualified domain name. By default the interface displays the machine name where B2Bi is running. Be sure to enter the correct machine name for Sentinel.
    • Primary port – The port Sentinel uses to listen to connections from B2Bi. 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 instance is used for fail-over. If B2Bi cannot communicate with the primary Sentinel host, it tries to connect to the secondary Sentinel host.
    • Secondary port – The port the secondary Sentinel uses to listen to connections from B2Bi. The default port is 1305.
    • Send mode – Select one of the following modes for sending integration engine events to Sentinel:
      • Direct – Select this option if you want to send events directly to Sentinel without first writing them to the overflow file. This increases the rate of transfer of events to Sentinel, however, it can significantly reduce integration engine performance.
      • Batch – By default, the integration engine sends events to Sentinel in batch mode, first sending them to the overflow file. The integration engine then consumes these events from the overflow file and sends them to Sentinel as processing resources allow. This consume-and-send process can take several minutes, but reserves maximum integration engine performance for message-processing tasks.
    • Overflow file safety limit – Enter a percentage as a threshold for when the integration engine begins sending events to Sentinel from the overflow file. The default value is 80% of the overflow buffer size. If this threshold percentage is reached, the integration engine begins sending events to Sentinel, potentially reducing normal message-processing resources.
    • Send processing data about traded messages – Select this option if you want to have B2Bi send message metadata to Sentinel about messages exchanged between exchange endpoints.
      • Include additional states – By default, B2Bi sends a restricted set of state information to Sentinel. To enable the sending of an extended set of states (along with other processing data), select this option. For additional information about this feature, see the B2Bi Administrator Guide, Sentinel Message States chapter.
    • Send heartbeats for the trading engine cluster – Select this option if you want B2Bi to send node data at the specified interval to Sentinel. B2Bi sends heartbeat data for each processing node. 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.
    • Buffered connector mode for processing activity data – This section displays the options:
      • Discard the data and do not send it to Sentinel when the overflow buffer is full – Select this option if you prefer not to activate the system throttle. This option enables you to maintain a higher message processing rate, but introduces a risk of incomplete transaction reporting to Sentinel.
      • Engage System Throttle to allow all processing data to be sent to Sentinel – Select this option to enable the B2Bi 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.
      • Buffered data threshold % – When you select the System Throttle option, you must also specify a buffered data threshold. Enter a percentage as a threshold for when the B2Bi begins sending events to Sentinel from the overflow file. The default value is 20% of the overflow buffer size. If this threshold percentage is reached, B2Bi begins sending events to Sentinel, potentially reducing normal message-processing resources.
  6. Click Save changes.

Installation scenario 3: New installation of B2Bi integrated to an existing Sentinel

Schematic of installation and configuration sequence:

Task 1: Pre-installation and planning

  1. Review prerequisites for both B2Bi and Sentinel installations. See the B2Bi Installation Guide (this guide) and the Sentinel Installation Guide.
  2. Plan for your database.
  3. Plan for the DMZ, if users are to access either B2Bi or the Sentinel UI through a DMZ.
  4. Collect the necessary server network locations, ports and access credentials. You will need to provide this information during the installation.

Task 2: Install B2Bi using the B2Bi Server installer

Sentinel must be installed before you begin this task.

  1. In the B2Bi Server configuration page, select the option Use Sentinel.
  2. Complete the installation.

Task 3: Deploy the B2Bi Sentinel objects to Sentinel

When you install B2Bi, the installer places a set of files for use with Sentinel in sub-folders of the directory:

<B2Bi_install_directory>\Integrator\solutions\extras\Sentinel\B2Bi

The following table describes the content of this directory:

Sub-folder File name File content
\B2Bi b2bi_system.xml

Tracked Object:

  • B2Bi System
\B2Bi b2bi_message.xml

Tracked Object:

  • B2Bi Message
\B2Bi HeartBeat.xml

Tracked Object:

  • HeartBeat

Deploy to Sentinel

There are several methods for deploying the B2Bi Tracked Objects to Sentinel:

  • Manual deployment – Copy the Tracked object XML files to a Sentinel folder
  • Deployment using Composer – If you have installed the Axway Composer product you can use Composer to create, edit and deploy Tracked Objects.
  • Deployment via the Sentinel REST API

Deploy manually

To manually copy and paste:

  1. Go to <B2Bi_install_directory>\Integrator\solutions\extras\Sentinel\B2Bi and copy all of the Tracked Object XML files contained in this folder.
  2. Go <Sentinel_install_directory>\broadcast\commit\TrackedObject and paste the Tracked Object XML files.
  3. Restart the Sentinel Server.
  4. Review the following Sentinel logs to ensure your Tracked Objects are successfully deployed:
    • log/sentinel.log
    • log/TrackingObjects.html
    • log/InvalidTrackingObjects.html

Deploy using Composer

To deploy Tracked Objects via Composer:

  1. Open a session in Composer.
  2. In the Integration Services workbench select Tools>Import object...
  3. Import the following files to Composer (described in the preceding table):
    • b2bi_system.xml
    • b2bi_message.xml
    • heartbeat.xml
  4. From Composer, deploy the imported B2Bi Tracked Objects to Sentinel. For additional deployment details see the Axway Composer 3.8 Deployment Guide.

Deploy using the Sentinel REST API

For details of how to use the Sentinel REST API, see the Sentinel API Developer Guide.

Task 4: Activate the Sentinel interface in B2Bi

  1. Open a session in the B2Bi user interface.
  2. From the System management menu, select System management to open the System management page.
  3. From the Relate tasks list at the bottom of the page, select Integrate with Sentinel to open the Integrate with Sentinel page.
  4. Select the option Enable Sentinel interface.
  5. Configure the Sentinel connection:
    • Primary host – The fully-qualified domain name or IP address of the computer running Sentinel. If the trading engine and Sentinel are running on the same computer, you can use the short computer name instead of the fully-qualified domain name. By default the interface displays the machine name where B2Bi is running. Be sure to enter the correct machine name for Sentinel.
    • Primary port – The port Sentinel uses to listen to connections from B2Bi. 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 instance is used for fail-over. If B2Bi cannot communicate with the primary Sentinel host, it tries to connect to the secondary Sentinel host.
    • Secondary port – The port the secondary Sentinel uses to listen to connections from B2Bi. The default port is 1305.
    • Send mode – Select one of the following modes for sending integration engine events to Sentinel:
      • Direct – Select this option if you want to send events directly to Sentinel without first writing them to the overflow file. This increases the rate of transfer of events to Sentinel, however, it can significantly reduce integration engine performance.
      • Batch – By default, the integration engine sends events to Sentinel in batch mode, first sending them to the overflow file. The integration engine then consumes these events from the overflow file and sends them to Sentinel as processing resources allow. This consume-and-send process can take several minutes, but reserves maximum integration engine performance for message-processing tasks.
    • Overflow file safety limit – Enter a percentage as a threshold for when the integration engine begins sending events to Sentinel from the overflow file. The default value is 80% of the overflow buffer size. If this threshold percentage is reached, the integration engine begins sending events to Sentinel, potentially reducing normal message-processing resources.
    • Send processing data about traded messages – Select this option if you want to have B2Bi send message metadata to Sentinel about messages exchanged between exchange endpoints.
      • Include additional states – By default, B2Bi sends a restricted set of state information to Sentinel. To enable the sending of an extended set of states (along with other processing data), select this option. For additional information about this feature, see the B2Bi Administrator Guide, Sentinel Message States chapter.
    • Send heartbeats for the trading engine cluster – Select this option if you want B2Bi to send node data at the specified interval to Sentinel. B2Bi sends heartbeat data for each processing node. 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.
    • Buffered connector mode for processing activity data – This section displays the options:
      • Discard the data and do not send it to Sentinel when the overflow buffer is full – Select this option if you prefer not to activate the system throttle. This option enables you to maintain a higher message processing rate, but introduces a risk of incomplete transaction reporting to Sentinel.
      • Engage System Throttle to allow all processing data to be sent to Sentinel – Select this option to enable the B2Bi 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.
      • Buffered data threshold % – When you select the System Throttle option, you must also specify a buffered data threshold. Enter a percentage as a threshold for when the B2Bi begins sending events to Sentinel from the overflow file. The default value is 20% of the overflow buffer size. If this threshold percentage is reached, B2Bi begins sending events to Sentinel, potentially reducing normal message-processing resources.
  6. Click Save changes.

Related Links