MQ Read Service (com.ibi.agents.XDMQReadAgent)

Syntax:

com.ibi.agents.XDMQReadAgent

iIT Service Object:

Description:

This agent reads one message on an MQ queue. Optionally the message can be selected based on a correlation ID.

If the message read appears to be XML the agent will attempt to parse it. Otherwise it will be added as a flat document.

Parameters:

Parameter

Description

Manager

Name of the queue manager.

Queue Name

Name of the queue to read.

Correlation ID

If present, a message of this correlation ID will be read.

Host

MQ Host if using MQ Client.

Port

MQ Port if using MQ Client.

Channel

MQ Server Channel if using MQ Client.

Timeout

Timeout in seconds.

Browse

If true, this is a browse operation. If false, this is a destructive read.

Return

Description

success

Read was successful.

fail_connect

Could not connect to the queue.

fail_parse

Could not convert message to XML.

fail_operation

Could not read the message.

fail_timeout

The read timed out.

Edges:

The following table lists the available line edges for the MQ Read Service (com.ibi.agents.XDMQReadAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure
  • fail_connect
  • fail_parse
  • fail_operation
  • fail_timeout