Sonic Emit Service (com.ibi.agents.XDSonicEmitAgent)

Syntax:

com.ibi.agents.XDSonicEmitAgent

iIT Service Object:

misc: Sonic Emit Agent

Description:

This service emits data using the Sonic version of JMS to a queue or topic. For more information, see the iWay Service Manager Protocol Guide.

Parameters:

Parameter

Description

Queue Name *

The name of the receiver queue.

Broker URL *

URL (address) used by the listener to connect to the Sonic broker. The format of the URL is Protocol://host:port. If Service Manager is listening on a Sonic broker configured to listen on TCP, the format of the URL is tcp://host:port. The default TCP port on which Sonic listens is 2506. This value is configured in the Sonic broker.ini file. When Service Manager listens to Sonic, the URL is in the form of http://host:port where the HTTP port is defined in the Sonic broker.ini file.

The Sonic listener supports fail over if it is unable to reach a particular broker. You must provide a comma-separated list of broker URLs. The client attempts to connect to brokers in the list, for example, tcp://host:port, tcp://host:port.

User ID

User ID for challenges.

Password

Password for challenges.

Messaging type

The messaging type. Select one of the following options from the drop-down list:

  • queue
  • topic

Output Message Type

The output message type. Select one of the following options from the drop-down list:

  • bytes
  • text
  • dynamic

Ackmode

The acknowledgement mode, or transactional. Select one of the following options from the drop-down list:

  • auto
  • dupsok
  • client
  • trans

Send Persistently

Support for persistent and non-persistent messages. In the event of a network or system failure, the persistent option prevents messages from being lost.

In the event of a broker or Service Manager failure, non-persistent messages are volatile. Persistent messages are saved to disk.

Load balance

Determines whether to load balance among brokers. Select true or false.

Detect

Determines whether to detect for duplicates. Select true or false.

Priority

Priority of the message, which can also be specified using XPATH(). The default is 3.

Correlation ID

Correlation ID of the message, which can also be specified using XPATH().

Preserve undelivered

Determines whether to preserve undelivered documents. Select true or false.

Notify undelivered

Determines whether to notify if documents are undelivered. Select true or false.

Preemitter

Should any preemitter be avoided?

Fault Tolerant

Determines whether the listener is connecting to the Sonic Broker as a fault tolerant client or not. The default value is false, that is, the listener is not connecting as a fault tolerant client.

This feature is supported only when the Sonic Broker is installed with a Sonic Fault Tolerance license code.

Sequential

When multiple brokers listed, this parameter determines whether they are used sequentially or randomly. Select true or false.

Reconnect Fault Timeout

Determines how long to wait (in seconds) before trying to reconnect.

Initial Connect Timeout

Determines how long to wait (in seconds) after failing initially, before trying to reconnect.

Return document

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

  • status. Status document will be the output document.
  • input. Input document will become the output document.

Edges:

The following table lists the available line edges for the Sonic Emit Service (com.ibi.agents.XDSonicEmitAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure
  • fail_connect