Listener Configuration Parameters

The following table lists and describes common parameters used by the Internal, Ordered, and RVI Queue listeners.

Tuning Parameters

Parameter

Description

Multithreading

Indicates the number of worker threads (documents or requests) that iWay Service Manager can handle in parallel. Setting this to a value of greater than 1 enables the listener to handle a second request while an earlier request is still being processed. The total throughput of a system can be affected by the number of threads operating. Increasing the number of parallel operations may not necessarily improve throughput.

The default value is 1.

The maximum value is 99.

Maximum Threads

The parallel threads can grow to this count automatically on demand. Over time, the worker count will decrease back to the multithreading level. Use this parameter to respond to bursts of activity. The default value is 1.

Optimize Favoring

Use this option to customize how the listener performs. For smaller transactions, select performance. For large input documents that could monopolize the amount of memory used by iWay Service Manager, select memory. The default value is performance.

Polling Interval

The maximum wait interval (in seconds) between checks for new requests or commands. The higher this value, the longer the interval, and the fewer system resources that are used. The side effect of a high value is that the worker thread will not be able to respond to a stop command.

The default value is 2.0 seconds.

Events Parameters

Parameter

Description

Expired Retry Flow

Name of a published process flow to run if a message on the retry queue has expired.

Failed ReplyTo Flow

Name of a published process flow to run if a message cannot be emitted on an address in its reply address list.

Dead Letter Flow

Name of a published process flow to run if an error cannot be emitted on an address in its error address list.

Channel Failure Flow

Name of a published process flow to run if this channel cannot start or fails during message handling. iWay Service Manager will attempt to call this process flow during channel shut down due to the error.

Parse Failure Flow

Name of a published process flow to run if XML or JSON parsing fails for the incoming message.

Channel Startup Flow

Name of a published process flow to run prior to starting the channel.

Channel Shutdown Flow

Name of a published process flow to run when the channel is shut down.

Startup Dependencies

A comma-separated list of channel names that must be started before this one is called.

Other Parameters

Parameter

Description

Whitespace Normalization

Specifies how the parser treats whitespace in Element content. Choose preserve to turn off all normalization as prescribed by the XML Specification. Choose trim to remove extra whitespace in pretty printed documents and for compatibility with earlier versions. The default value is preserve.

Input Format

If set to true, the input data is sent directly to the business logic step. The data is not preparsed, parsed, or validated. This flag is used primarily to send non-XML to the business logic or replyTo without processing it. Select one of the following options from the drop-down list:

  • No parse, input is flat {flat}
  • Parse as JSON {json}
  • Parse as XML {xml)

The default value is XML.

Execution Time Limit

The maximum time that a request may take to complete. Used to prevent runaway requests. Any request that takes longer to complete than this value will be attempted to be terminated.

Default Java File Encoding

The default encoding if the incoming message is not self-declaring (that is, XML).

Agent Precedence

Sets the order by which iWay Service Manager selects agents. iWay Service Manager selects the agent or agents to process the document by searching through the configuration dictionary. Usually, it looks for a document entry in the configuration and when a match is found, the agent specified in that document entry is selected. If a matching document entry is not found, or no agent is specified, the engine looks in the input protocol configuration (listener). To have the processing agent taken directly from the listener (thus ignoring the document entry), use <listener> overrides <document>.

Possible values are <document> overrides <listener> and <listener> overrides <document>.

The default value is <document> overrides <listener> {1}.

Always reply to listener default

If set to true, the default reply definition is used in addition to defined reply-to and error-to destinations. The default value is false.

Error Documents treated normally

If set to true, error documents are processed by any configured preemitters. The default value is false.

Listener is Transaction Manager

If set to true, agents run within a local transaction. The default value is false.

Record in Activity Log(s)

If set to true, activity on this channel will be recorded in the activity logs, otherwise the activity will not be recorded. The default value is true.

AES Key

If the channel will receive encrypted AFTI messages, set the AES key (maximum 16 characters) to be used for decrypting.

Startup Dependencies

A comma-separated list of channel names that must be started before this one is called.