Definition

Specify a label for this task.

Specify the reference to a valid MQ Session that was created using the Open MQ Session task (e.g. ${MQSession}).

Specify the name of queue or topic from which message(s) should be retrieved.

Select the type of source.

Specify the subscription ID for the topic. This is typically provided by your MQ server administrator. This is required if the specified Source Type is topic.

Specify the name of a variable to which the current message should be assigned. This can be used for example, to save the payload to a file using the message ID as the file name.

Specify the directory to which the retrieved messages, if any, should be saved.

Specify the name of the file to which the retrieved messages, if any, should be saved. You can use the Current Message Variable to name the file using one or more attributes of the retrieved message.

Select the action to take when the specified output file already exists.

Specify the filter criteria to use when retrieving messages. If a filter is specified, only messages that match the filter criteria are retrieved. Refer to the Help for more information on how to specify the filter criteria.

Specify the number of seconds to wait for the availability of the message.

Specify the maximum number of messages to be retrieved. A value of zero indicates that all available messages will be retrieved.

Specify the encoding or character set to use when saving the message to the output file. This option is used if and only if the type of message is determined to be text.

If desired, specify the name of a variable which will contain the file(s) that were saved to the output directory. The variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. The variable will be created if it does not exist.

Specify the name of a variable to which all the retrieved messages should be assigned.

The version of this task.

Specify the level of logging to use while executing this task. Valid options are - silent, normal, verbose and debug.

Specify a condition that must be satisfied before this task can be executed. This task will be skipped if the specified condition is not met.

Whether or not this task is disabled.

Specify the action to take when this task errors out. Valid options are - abort, continue, call:[module] and setVariable:[name]=[value]. For call:[module] replace [module] with the name of the module in the project (e.g. call:ErrorModule). For setVariable:[name]=[value] replace [name] with a variable name and [value] with the variable value (e.g. setVariable:error=true).