Configuring an Internal Emit Service

Reference:

Messages are sent to particular destinations at the completion of a workflow. The state of the document determines which particular destination is used. The order in which the destinations are used cannot be predicted.

To route an output document or error message to a protocol other than that of the outlet (listener), you must configure an emitter. For example, an application can send input over FTP, but want to route the output to an Internal Queue listener.

The associated emitter is used to place messages onto the internal queue. Enter the name of the queue as the destination. The queue you specify must be an Internal Queue listener that has already been defined.

It is also possible to emit to multiple queues in a single emit operation. To do this, list the queues, separated by commas. For example, internalqueue1, internalqueue2, internalqueue3. This will emit to three queues, which are handled by three Internal listeners.

To configure an Internal Emit service:

  1. Perform the steps as described in Configuring Services.
  2. Ensure that you select Internal Emit Agent {com.ibi.agents.XDInternalEmitAgent} as the service type you are configuring.

    For a complete description of the configuration parameters that are available for the Internal Emit service, see Internal Emit Service Parameters.

    For a complete description of the edges that are returned by the Internal Emit service, see Internal Emit Service Edges.


Top of page

x
Reference: Internal Emit Service Parameters

The following table lists and describes parameters for the Internal Emit service.

Note: Parameters that are common to emit services are described in Service Configuration Parameters.

Parameter

Description

Queue Name

The name of the internal queue to post messages to.

Priority

The priority is an integer between 0 and 9 inclusive. The lowest priority is 0. The highest most expedited priority is 9.

Request Context Namespace

For synchronous or asynchronous processing, namespace or list of namespaces containing registers that will be made available to the Internal Queue listener. Select Default for all registers in default (no prefix) namespace or None to send no registers at all. Enter an asterisk (*) for registers from all namespaces.

Response Context Namespace

In synchronous processing, registers set by Internal Queue listener in the return namespace will be made available to the calling process. If a value is supplied here, then response registers will be copied to the specified namespace. Leave this parameter blank to store response registers in the return namespace.

Return

Select one of the following options from the drop-down list:

  • status. The status document will be the output document
  • input. The input document will become the output document
  • response. Awaits synchronous output from the Internal Queue listener.

    Note: The response option is not compatible with local transactions.

Timeout

Determines how many seconds to wait for synchronous response. Set to 0 or leave blank to wait indefinitely.



x
Reference: Internal Emit Service Edges

The following table lists and describes the edges that are returned by the Internal Emit service.

Edge

Description

success

The message was enqueued for execution by the listener and channel that is servicing the internal queue.

fail_parse

The iFL used to configure this service contained an error.

fail_notfound

The internal queue was not available.

timeout

The message could not be placed onto the internal queue in the time period specified in the Put Timeout parameter. This signifies that the queue was inhibited and could not receive messages.

cancelled

A cancel order was received while the service was in operation.

fail_operation

The message could not be marshaled or could not be enqueued for some other reason.

notfound

The internal queue was not available. In some applications this may not be considered an error, so this edge is provided along with the fail_notfound edge.


iWay Software