Running an Outbound Integration Endpoint

After configuring an outbound endpoint, it must be enabled before it can run on schedule or be invoked manually.

The following three colored icons are used to indicate the status of the integration endpoint. The endpoint status is displayed in the System Setup OIEP hierarchy and on the endpoint editor in the Description flipper > Endpoint Status parameter.

Icon

Endpoint Status

Description

Enabled

The integration endpoint is active, connected, and running.

Disabled

The integration endpoint has stopped and no data is being exported. Newly created endpoints, and endpoints that have been manually disabled, will have this status.

Failed

An error occurred during processing that caused the integration endpoint background process to fail. No data will be exported until the endpoint has been manually resumed / reactivated. For more information, refer to Handling Failed IIEP Background Processes documentation here.

Enable and Invoke an Outbound Integration Endpoint

Both event-based and select objects OIEPs must be enabled and invoked before they can run. Additionally, event-based OIEP must have the proper setting for queue status.

For example, if the external system is down and cannot accept data, keep the endpoint enabled but do not invoke the endpoint until the external system is ready to consume the data. In this way, data is collected from STEP and is then pushed to the external system only when invoked.

Prerequisites for Event-Based OIEPs

For an event-based OIEP, verify the Queue Status is set correctly. For information about how the Endpoint Status and Queue Status settings work together on event-based endpoints, refer to the Event-Based OIEP Status and Queue Status documentation here.

For information about setting up an event processor, refer to Event Processors in the System Setup here.

Required Setup for All OIEPs

  1. On System Setup expand the Outbound Integrations Endpoints node to display all existing outbound endpoints.
  2. Select a disabled endpoint or a failed endpoint, right-click, and select Enable Integration Endpoint from the menu.

The tree navigator icon now shows enabled. On the Inbound Integration Endpoint tab, the Description flipper includes the 'Enabled' parameter, which now displays 'Yes.'

  1. On the Configuration tab, open the Configuration flipper to view the Schedule parameter.
  • If scheduled, the Schedule parameter shows when the IIEP will be invoked automatically.

  • If 'Not scheduled', or if the IIEP needs to be invoked on demand, right-click the enabled IIEP and click Invoke Endpoint.

  1. When invoked on schedule and manually, files or messages ready for export as identified by the OIEP configuration are processed. The Outbound Integration Endpoint tab Integration Endpoint Log flipper displays the time the endpoint was invoked. For scheduled OIEPs, the log includes a link to the background process that was started. For more information, refer to Maintaining an Outbound Integration Endpoint here.

Disable an Outbound Integration Endpoint

When an OIEP displaying the enabled icon () should be stopped from processing data, you can disable it. The configuration remains unchanged and no further data is processed. After selecting the OIEP, right-click and select Disable Integration Endpoint to set the OIEP to disabled and display the disabled icon ().

For example, disable an endpoint when running a data refresh activity on the system and the objects should not be published. Disabling an endpoint does not alter the configuration.

Once disabled, the outbound integration endpoint can be restarted using the Enable Integration Endpoint step defined above.

Additional information about restarting a failed endpoint, indicated by the failed icon (), can be found in the Handling Failed OIEP Background Processes documentation here.