Name
|
N
|
The name to be displayed as the label for the activity in the process.
|
Connection
|
Y
|
The connection resource which connects this activity with the queue manager that has access to the desired queue.
Click the
icon to select a usable connection for the activity.
|
Destination
|
Y
|
Enter the name of the queue on which this get operation is performed. This field can be dynamically provided in the input schema and is not required here.
|
Dynamic Destination
|
N
|
Select the
Dynamic Destination check box to enable dynamic destinations for this operation. This enables the
Dynamic Destination Model field.
|
Dynamic Destination Model
|
Y
|
Enter the name of the model queue which the queue manager uses as a template when constructing this dynamic destination.
|
Message Content Type
|
N
|
Choose the way that the message body is represented in the output schema.
- Binary: the message is an array of bytes suitable for use by the Data Conversion Palette activities.
- Text: the message is a string. The message is decoded using
characterSet for the message, or 819 if none is provided.
Characterset 819 is the Java API default.
- Schema: the message is formatted according to the schema provided in the Message Body Fields field. Values for this schema are displayed in the
Output tab.
|
Message Body Fields
|
Y
|
Provide the schema to be used in the
Output tab, and at run time to encode the contents of this message. This field is only available if
Schema is selected in the
Message Content Type field.
|
Close Option
|
N
|
Select the close option for this Get activity. These options are for use with permanent dynamic queues only.
- NONE: no action is taken.
- DELETE: deletes the queue, if it is empty. If the queue is not empty, no action is taken.
- PURGE: deletes the queue and any messages in it.
If the Get activity is being performed on a permanent dynamic queue and the intention is for the queue to be deleted, you can choose either
DELETE or
PURGE.
DELETE deletes the queue if it is empty, and
PURGE deletes the queue and any messages that are in it.
Note: Do not select
DELETE or
PURGE for permanently defined queues. Depending on your security access, this might delete them.
|
Access Mode
|
N
|
Select the access mode for the queue:
- QDEFAULT: it accepts the access mode established when the queue is created.
- SHARED: other listeners can access the queue in this mode.
- EXCLUSIVE: other listeners cannot access the queue in this mode. If another WebSphere MQ application has the queue open, this activity fails.
|
Fail If Quiescing
|
N
|
Select this check box to cause the activity to fail and exit if the queue manager attempts to quiesce. A failure to do so causes quiesce operations to take much longer. This check box is selected by default.
|
GMO Convert
|
N
|
Causes the get message option
MQGMO_CONVERT to be used for this get operation. It causes the queue manager to convert string and numeric fields using the
characterSet and
encoding elements before the data is copied to the message buffer.
|
Wait Forever
|
N
|
If the
Wait Forever check box is selected, the Get activity waits forever for a message in the queue. If the
Wait Forever check box is cleared, the
Wait Timeout field is enabled and the
waitinterval node of the input schema is observed and overrides the values in the
Wait Timeout field.
Note: If a Get activity is configured to wait forever, it does so even after the application is set to stop using the administrator or shell command. To release the connection and close the destination, it is necessary to stop the appNode on which this application is running.
|
Wait Timeout
|
Y
|
The number of milliseconds this activity waits for a message before failing.
This field is not available if the
Wait Forever check box is selected.
|
Application Properties
|
N
|
Select the application properties resource to be used to map the output of this Get activity. Application properties are similar to regular message header fields except that the name and type of the fields can be determined by a predefined schema. If the received message contains properties, they are mapped according to this schema.
To use application properties, create a generic XML schema composed of a node with simple elements inside it and map that schema to this field. See the IBM WebSphere documentation for property types supported by the level of client you have installed.
Note: A failure to observe cardinality results in errors processing the input or output schema.
|
Property Control
|
N
|
Select one of the following settings:
-
AS_Q_DEF
- COMPATIBILITY
- IN_HANDLE
- FORCE_MQRFH2
After selecting one of these options, you can use the Get activity to inter-operate with various versions of WebSphere MQ applications. Which option to use depends on the sending application. See the section entitled "MQGMO message property option setting" in the IBM WebSphere MQ documentation for detailed information.
|
Logger Name
|
Y
|
Enter the name of any logger which has been configured for the run time to write to. If no logger name is provided, then the default one is used. The activity writes informational messages to the log depending on how the logger is configured.
|