Open topic with navigation

Maintaining an Outbound Integration Endpoint

Outbound integration endpoint settings can be viewed and edited from the Outbound Integration Endpoint editor. For information about creating a new outbound endpoint, see the Creating an Outbound Integration Endpoint section here.

Each tab on the editor is defined below and includes parameters to maintain the OIEP.

Outbound Integration Endpoint Tab

This tab holds basic information within the following flippers:

Description Flipper

The Description flipper includes basic information to identify the OIEP. The name, user, description, and enabled parameters can be edited.

For information on the Endpoint Status, see Running an Outbound Integration Endpoint documentation here.

Integration Endpoint Log Flipper

The Integration Endpoint Log flipper contains information about the endpoint background process. An entry is generated each time the endpoint is invoked, when background processes generated by the endpoint are started, and when processing errors occur.

• The background process (BGP) link opens the individual Importer Background Processes.

Configuration Tab

This tab contains many parameters required to successfully run an outbound integration endpoint.

Configuration Flipper

Most of the parameters on this flipper can be edited. The type of editing available varies based on the parameter as defined below.

The Transactional setting parameter cannot be edited and does not have the same significance as for IIEPs. For information, see OIEP - Event-Based - Configure Endpoint (here) or OIEP - Select Objects - Configure Endpoint (here).

The following parameters can be edited within the OIEP editor as defined:

• Click the Process engine or Workspace parameter to display a dropdown button. Selections displayed depend on your system setup.

For information on the Process engine or Workspace, see OIEP - Event-Based - Configure Endpoint (here) or OIEP - Select Objects - Configure Endpoint (here).

• Click the Error reporter, Schedule, or Contexts parameter to display an ellipsis button. This opens a dialog for editing.

For information on the Error Reporter or Schedule, see the Error Reporter section of the OIEP - Configuration Flipper here.

• Click the Queue for endpoint, Queue for endpoint process, Number of threads, Maximum number of old processes, or Maximum age of old processes parameter to edit the text with the field.

For information on the Transactional settings, Number of threads, Contexts, and Workspace, see OIEP - Event-Based - Configure Endpoint (here) or OIEP - Select Objects - Configure Endpoint (here).

Event Queue Configuration Flipper

The additional configuration flipper displayed is determined by the type of OIEP being viewed. Event-based OIEPs include the Event Queue Configuration flipper.

• The Edit Configuration link allows modification to the parameters displayed.
• The Click to estimate button displays a list of unread events.
• For more information on the Event Action buttons, see Event-Based OIEP Forward, Rewind, Purge, and Republish here.

Object Selection Configuration Flipper

the Object Selection Configuration flipper is only displayed when the selected OIEP uses the Select Objects data source, as defined on the Choose Data Source step of the wizard. For more information, see OIEP - Select Objects - Choose Data Source here.

• The Edit Configuration link opens a dialog that allows modification to the objects selected for output. For details on the available options, see OIEP - Select Objects - Object Selection Configuration Flipper here.

Output Templates Flipper

This flipper allows selection of object or event types, in addition to the format required for output. Pre-processors and post-processors can also be set and availability is based on the system configuration.

• Click into a field to display an ellipsis button. Click the ellipsis button (…) to display the relevant editor.
• Click the Add configuration link to insert a new row in the table.

Delivery Method Flipper

Details about the delivery method selected are displayed.

• Click the Edit Delivery link to modify the parameters.

Background Processes Tab

This tab holds information about any related processes. Hover over an ID to display the background process (BGP) link, click it to open the individual Exporter Background Processes.

• Queued Processes are background processes that are started in the state 'waiting'. The maximum number of background processes that can be started in the state waiting is specified in the integration endpoint configuration.
• Active Processes are background processes that are currently being processed. If data is processed as strict or chained, the endpoint only has one active background process at a time. Otherwise, it is possible to apply more background process queues to work in parallel. In this case the endpoint can have more active background processes at a time.
• Failed Processes are background processes that are no longer running. For more information, see Handling Failed OIEP Background Processes here.
• Completed with errors have run, but an error has been detected.
• Ended Processes have completed successfully. The number of ended processes is determined by the configuration.

For more information, see the Monitoring an OIEP via Background Processes section here.

Statistics Tab

This tab provides statistics about the number of requests handled, run times, and wait times.

Error Log Excerpts Tab

This tab shows data from the main Java log file related to failed background processes with Log Level > 'Info'. Click a hyperlink to a failed background process and correct the cause of the failed background process. For more information, see Handling Failed OIEP Background Processes here.

Log Tab

This tab provides information about changes to the OIEP configuration.

Status Tab

This tab provides information about revisions, hidden values and diagnostics.

2017, Stibo Systems