Configure SecureTransport to send events to Axway Sentinel

Use the SecureTransport Administration Tool to configure SecureTransport to send events to Sentinel.

The setting applies to all servers in your Enterprise Cluster (EC). Each server must have its own overflow file.

  1. Select Setup > Axway Sentinel/DI to open the Axway Sentinel/Decision Insights Events page.
  2. Select the check box for Send Events to Axway Sentinel or Decision Insight Server.
  3. The rest of the fields on the screen are enabled and SecureTransport sends events to Axway Sentinel as configured.
  4. In the Axway Sentinel/Decision Insight pane, specify the FQDN or IP address of the Axway Sentinel server in the Host field and a valid TCP port on the server to which events will be sent in the Port field.
  5. (Optional) Select the check box for Use Secure Connection to enable sending the selected event to Sentinel over a secured connection.
  6. (Optional) Select the check box for Verify Certificate to enable the SSL certificate verification. The Verify Certificate check box is selected by default.
  7. (Optional) Select the check box for Enable FIPS Transfer Mode to enable sending events to Sentinel over the secure connection in FIPS transfer mode.
  8. Note Changes to these settings in Step 3 through Step 6 take effect the next time you restart the Transaction Manager.
  9. (Optional) Click the Test Connection button. This test indicates whether the port specified on the Axway Sentinel host accepts connections.
  10. (Optional) Select Send Heartbeat to Axway Sentinel Every and set the heartbeat interval to send periodic messages to Axway Sentinel to tell it that SecureTransport is running and connected. The default interval is 10 seconds.
  11. In the Events pane, select the event states to send to Sentinel.
  12. An Event State specifies the current state of a file transfer. If an Event State is not selected to be sent, SecureTransport performs the processing represented by the state, but it does not send the event that reports the state to Axway Sentinel. For the available states, see Event states.
  13. In the Attribute mapping pane, click the Add Mapping button to create a Sentinel Attribute Name and Value attribute mapping rule. The attributes can also be updated or deleted.
  14. The Mapping Rules columns refer to:
    • Sentinel Attribute Name – The Sentinel column where the attribute is reported.
    • Value – The value which is reported in Sentinel under the related column. The value column accepts either real values or SecureTransport expressions.
  15. Note Subscription attributes can be accessed using the following expression: ${flow.attributes[‘userVars.ATTRIBUTE_NAME’]}
    Note The value of the DXAGENT_ROUTE_SOURCE_FULL_TARGET variable is the absolute path to the file triggered via Advanced Routing. When performing a push transfer via Advanced Routing over PeSIT, the DXAGENT_ROUTE_SOURCE_FULL_TARGET variable is not populated in ACK or ENDED_TO_ACK state.
  16. In the Overflow file pane, specify information about the file to be used to store SecureTransport event data when there is no connection between SecureTransport and Axway Sentinel. Changes to these settings take effect the next time the Transaction Manager is restarted. Specify the following information:
  17. Field Description
    Name The base name of the file to contain buffered SecureTransport event data.
    Path

    The path of the directory where the overflow file will be located. You can specify either a local absolute or relative path. If you specify a relative path, it is created within the <FILEDRIVEHOME> directory.

    Specify a local path, not one in shared storage, because each server in a cluster must have its own overflow file.

    Size (MB)

    The maximum overflow file size in MB. A 1 MB file can store events from about 150-200 transfers. With a fast and dependable connection between the SecureTransport Server and a dependable Sentinel server, 1-10 MB should be sufficient. If the connection is slow or the connection or the Sentinel server might be down, 10-50 MB is better.

    When the overflow file size exceeds this size, it invokes the action you configure under When Overflow File Exceeds Maximum Size.

    Warning Threshold Specify a percentage of the maximum file size that, when reached, triggers a warning. The value you enter must be an integer between 1 and 94. When a warning is triggered, an email is sent to the SecureTransport administrator. The email message is formatted using the standard email template, SentinelOverflowFileWarning.xhtml, located in <FILEDRIVEHOME>/conf/mailer-templates/. The recipient of any warning email is the administrator specified in the FTP/HTTP Startup Password Timeout Configuration pane of the Setup > Miscellaneous page. For details, see Set the administrator’s email.
    When Overflow File Exceeds Maximum Size

    Select the action to take when the overflow files exceed the maximum size you set. Choose one of the following:

    • Stop Collecting New Events – Stop tracking events for Sentinel, but continue to process transfers, run agents and run SecureTransport applications. Use this option in a clustered configuration so that the Sentinel server is not a potential single point of failure.
    • Pause All File Transfers – Stop tracking events for Sentinel and stop processing transfers, running agents and running SecureTransport applications. Use this option with care because it is operationally equivalent to stopping SecureTransport. To restart transfers, either clear the overflow file or select the other option.
  18. Click Save.
  19. Your settings are saved and SecureTransport transmits data about file transfer activities to the Axway Sentinel server you specified.
Note For XFB ST Info events, you must enable the dedicated Server Configuration option: StatisticsSummary.AutoReportAdditionalInfo. Periodically generate a Sentinel event with usage information on the SecureTransport instance. This includes count of active accounts, product version, enabled features, installed plugins, etc.

Related topics:

Related Links