Outbound Integration Endpoints

Outbound integration endpoint (OIEP) functionality can, in many ways, be thought of as a way to manage the standard STEP export functionality. Two types of OIEPs are available to meet the data export needs. As defined below, when creating either type of OIEP, you will use a wizard for the initial configuration, and then use the OIEP editor to manually further define your required OIEP.

Event-Based Outbound Integration Endpoint

OIEPs can be used for incremental output with an Event-Based OIEP which publishes data based on events occurring in STEP. An event, for example, could be generated when an object in STEP is approved. Multiple OIEPs can be configured to listen for such an event, and each will use the recommended simplified priority background queuing mechanism or will have an associated legacy event queue for registered events. The OIEP can then, with scheduled intervals (minimum interval being once every minute), check the event queue for new events and publish data accordingly. For details on events, refer to the Events section of the System Setup documentation. For information about setting up an event processor, refer to Event Processors in the System Setup documentation.

Setup Requirements for Event-Based OIEPs

Setting up and using a select object outbound integration endpoint involves the steps described in Creating an Event-Based OIEP:

  1. Create a setup group to hold the endpoint as described in Initial Setup for an Outbound Integration Endpoint.
  2. Launch the outbound integrations endpoint wizard as described in Creating an Event-Based Outbound Integration Endpoint.
  3. In the wizard, add an ID, name, description, and user as described in OIEP - Event Based - Identify Endpoint.
  4. In the wizard, choose Select Objects for the data source as described in OIEP - Event-Based - Choose Data Source.
  5. In the wizard, specify processing and context settings for the endpoint as described in OIEP - Event Based - Configure Endpoint.
  6. In the OIEP editor, configure to send an email if an endpoint-related background process fails as described in the 'Error Handling & Reporting' section of the OIEP - Configuration Section topic.
  7. In the OIEP editor, specify determine when the OIEP runs as described in the 'Schedule' section of the OIEP - Configuration Section topic.
  8. In the OIEP editor, specify the objects to be output, the format and pre- or post-processors (if any) as described in OIEP - Event-Based - Output Templates Section.
  9. In the OIEP editor, determine how data is delivered as described in OIEP - Delivery Method Section.
  10. In the OIEP editor, define what data changes will cause the OIEP to run as described in OIEP - Event-Based - Event Triggering Definitions Tab.
  11. In the OIEP editor, set the queue status as described in Event-Based OIEP Status and Queue Status.
  12. Enable the endpoint and invoke it as described in Running an Outbound Integration Endpoint, paying particular attention to the 'Prerequisites for Event-Based OIEPs' section.

Additional Information for Event-Based OIEPs

The following information is useful once an inbound integration endpoint is set up:

  1. Review use cases for an event-based OIEP as described in Event-Based OIEP Examples.
  2. Maintain or modify the endpoint from within STEP as described in Monitoring an OIEP via Background Process.
  3. Maintain or modify the endpoint outside of STEP as described in Monitoring an OIEP via External Systems.
  4. Understand the effects of batching on an OIEP as described in Event-Based OIEP Event Batching.
  5. Understand the effects of manipulating events on an OIEP as described in Event-Based OIEP Event Actions.
  6. Understand the multithreading functionality on an OIEP as described in Event-Based OIEP Multithreading Support.
  7. Understand queued events on an OIEP as described in Event-Based OIEP Queued Events.
  8. Understand the relationship between OIEP Status and Queue Status as described in Event-Based OIEP Status and Queue Status.
  9. Understand each element of an OIEP as described in Outbound Integration Endpoint Structure.
  10. Export an outbound integration endpoint definition and submit to an external source control system for comparison purposes as described in the Configuration Management documentation.

Select Objects Outbound Integration Endpoint

In the simplest form, a Select Object OIEP uses a static set of data and works exactly like a scheduled export (created in Export Manager). This type of OIEP publishes data non-incrementally from selected hierarchies to external systems on scheduled intervals. The only difference between a Select Objects OIEP and a scheduled export in Export Manager is that the OIEP has more standard delivery options than Export Manager and offers extended monitoring capabilities.

Setup Requirements for Select Objects OIEPs

Setting up and using a select object outbound integration endpoint involves the following steps:

  1. Create a setup group to hold the endpoint as described in Initial Setup for an Outbound Integration Endpoint.
  2. Launch the outbound integration endpoint wizard as described in Creating a Select Objects Outbound Integration Endpoint.
  3. In the wizard, add an ID, name, description, and user as described in OIEP - Select Objects - Identify Endpoint.
  4. In the wizard, choose Select Objects for the data source as described in OIEP - Select Objects - Choose Data Source.
  5. In the wizard, specify processing and context settings for the endpoint as described in OIEP - Select Objects - Configure Endpoint.
  6. In the OIEP editor, configure to send an email if an endpoint-related background process fails as described in the 'Error Handling & Reporting' section of the OIEP - Configuration Section topic.
  7. In the OIEP editor, determine when the OIEP runs as described in the 'Schedule' section of the OIEP - Configuration Section topic.
  8. In the OIEP editor, specify the objects to be output, the format, and pre- or post-processors (if any) as described in OIEP - Select Objects - Output Templates Section.
  9. In the OIEP editor, determine how data is delivered as described in OIEP - Delivery Method Section.
  10. Enable the endpoint and invoke it as described in Running an Outbound Integration Endpoint.

Additional Information for Select Objects OIEPs

The following information is useful once a select objects outbound integration endpoint is set up:

  1. Determine the progress of the endpoint from within STEP as described in Monitoring an OIEP via Background Process.
  2. Determine the progress of the endpoint outside of STEP as described in Monitoring an OIEP via External Systems.
  3. Maintain or modify the endpoint as described in Maintaining an Outbound Integration Endpoint.
  4. Understand each element of an OIEP as described in Outbound Integration Endpoint Structure.
  5. Export an outbound integration endpoint definition and submit to an external source control system for comparison purposes as described in the Configuration Management documentation.