Create or Edit Event Consumer

Once an event queue exists, an event consumer is required to define where the data will be delivered via a background process.

Important: The functionality of this legacy feature is limited. Using an OIEP is preferred, as defined in the Creating an Outbound Integration Endpoint topic in the Data Exchange documentation here.

Prerequisites

Complete the steps defined in the following topics before creating an event consumer:

  1. Creating a New Event Queue here

  2. Maintaining Event Queues here

Creating or Editing an Event Consumer

  1. In System Setup, right-click an event queue and select the 'Create/Edit Event Consumer...' option to display the Create Event Consumer Process wizard.
  2. On the Notice step, the message indicates if you are creating a new event consumer or editing an existing one, click the Next button.
  3. On the Select Plugin step, choose a plugin from the dropdown and complete the additionally required parameters, then click the Next button.

Note: Hover over a parameter label to display information on the required data.

  • Step XML Consumer (default) delivers events as STEPXML. For more information on this format, refer to the STEPXML Format topic in the Data Exchange documentation here.
  • Demo Consumer (Firefox) uses a consumed event queue with a specific Firefox demo plugin to deliver XML that can be rendered by the Firefox browser.
  1. On the Schedule Process step, set the schedule as defined in Scheduled Data Export - Schedule Process topic (here) in the Data Exchange documentation, then click the Next button.

Important: Consider the time zone of the application server compared to that of the workbench (the client) where the schedule is created or viewed. When scheduling a job, the local time zone is displayed in the workbench, but the time zone of the server is used to run the background process. Although displayed, the time zone of the client is not included in the instruction to the server to run the job. This can cause confusion about when the job will run since the scheduled time is not automatically converted to accommodate potential differences in time zones.

  1. On the Select Delivery Method step, choose a method from the dropdown and complete the additionally required parameters as defined in the Export Manager - Select Delivery Method topic (here) in the Data Exchange documentation, then click the Next button.

  1. On the Batching step, select an option as defined in OIEP - Event-Based - Choose Data Source topic (here) in the Data Exchange documentation, then click the Finish button to start the background process.

  1. On the 'Starting process Consuming events from '[eventqueue]' dialog, make a selection.

  • Go to process displays the background process on the BG Processes tab under the 'Event Consumer' node.
  • Close starts the background and closes the 'Starting process...' dialog.

Output

The background process editor as shown below, displays details about the progress, success, or failure of the BGP. The Result flipper includes the location of the output based on the Delivery Method step selection.