Salesforce

WebSphere MQ - Methods (Magic xpi 4.7)

« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

WebSphere MQ - Methods

The following methods are used to configure the WebSphere MQ component:

The following table lists the methods and parameters that can be used. Parameters in bold are mandatory.

Name

Parameters

Description

Advanced Get gets a message in the same way as the Get method, but uses additional parameters.

Queue Handle

Enter the numeric value returned as the queue handle in the Open parameter.

Time Out

Enter the amount of time (in milliseconds) that the component will wait to receive a message before moving to the next step in the flow. If you enter -1, the component will wait indefinitely until a message is received before moving to the next step in the flow.

Data Type

Select a data type from the drop-down list:

  • Alpha

  • Numeric

  • Date

  • Time

  • Logical

  • BLOB

Save to File

Determines whether to save the data type to a file (enabled only if BLOB is the selected data type). Select one of the following from the drop-down list:

  • No (default)

  • Yes

File Path

Specifies the file path where you want to save the BLOB data type (enabled only if Save to File is set to Yes).

Transaction Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Message ID

The message ID.

Correlation ID

Enter a filter to limit the messages sent to subscribers in the queue. This parameter searches for queues that have the same correlation ID and only sends the messages to those queues.

This Correlation ID correlates to the Correlation ID in the Open method.

Group ID

Enter an ID number to identify a group of messages to be processed together.

Sequence Number

Enter the sequence number of the message in the group. For example, if this is the fourth message in the group, enter 4.

If you enter 0 and the Group ID has a value, WebSphere MQ will increase the sequence number of each message that enters the group automatically.

Message Type

Select the message type from the drop-down list:

  • Request: This is a message to which a reply is expected.

  • Response: This is a reply to a request message.

  • Message: (WebSphere MQ Datagram).

Message Encoding

Select the type of encoding used for the messages from the drop-down list:

  • ANSI

  • EBCDIC

  • UNICODE

Get First Message

Select one of the following from the drop-down list to indicate whether to fetch the first message from the queue:

  • Yes: WebSphere MQ will return to the first message in the queue.

  • No: The next message will be fetched.

Message Life Time

Enter the amount of time (in tenths of a second) that messages remain in the queue. A value of 0 indicates that messages are never dropped from the queue, and a value of -1 causes messages to be removed from the queue immediately.

MSG Priority

Message priority can range from 0, the lowest priority, to 9, the highest priority. The default message priority is 0.

Start Sequence ID

Enter the starting sequence number for the message in the queue.

Message Fetch Order

Select the fetch order for messages fetched from the queue from the drop-down list when the order is different from the open queue mode:

  • Physical (FIFO): Messages are fetched in the order they are entered in the queue.

  • Logical: Messages are fetched according to group or location

Message Fetch Mode

Select one of the following from the drop-down list to indicate how messages are handled after they are read:

  • Remove: Messages are deleted from the server after they are read.

  • Browse: Messages are left for browsing and are not deleted from the server.

Message

Select where the message data is received.

Return Description

Optional information to be returned with message. The information must be comma delimited.

For example, Reply 2Q, Format, Sent Date, Sent Time.

Code Page

Enter the code page used for message encoding.

Header Exists

Reports whether the received message has an RFH2 header.

Message Header

Returns the RFH2 header if one exists. Header content is parsed by the GetRFH2Header method.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Advanced Quick Get gets a message in the same way as the Quick Get method, but uses additional parameters.

Queue Name

Enter the name of the Message Queue.

Time Out

Enter the amount of time (in milliseconds) that the component will wait to receive a message before moving to the next step in the flow. If you enter -1, the component will wait indefinitely until a message is received before moving to the next step in the flow.

Data Type

Select a data type from the drop-down list:

  • Alpha

  • Numeric

  • Date

  • Time

  • Logical

  • BLOB

Save to File

Determines whether to save the data type to a file (enabled only if BLOB is the selected data type). Select one of the following from the drop-down list:

  • No (default)

  • Yes

File Path

Specifies the file path where you want to save the BLOB data type (enabled only if Save to File is set to Yes).

Message ID

The message ID.

Correlation ID

Enter a filter to limit the messages sent to subscribers in the queue. This parameter searches for queues that have the same correlation ID and only sends the messages to those queues.

This Correlation ID correlates to the Correlation ID in the Open method.

Group ID

Enter an ID number to identify a group of messages to be processed together.

Sequence Number

Enter the sequence number of the message in the group. For example, if this is the fourth message in the group, enter 4.

If you enter 0 and the Group ID has a value, WebSphere MQ will increase the sequence number of each message that enters the group automatically.

Message Type

Select the message type from the drop-down list:

  • Request: This is a message to which a reply is expected.

  • Response: This is a reply to a request message.

  • Message (WebSphere MQ Datagram).

Message Encoding

Select the type of encoding used for the messages from the drop-down list:

  • ANSI

  • EBCDIC

  • UNICODE

Get First Message

Select one of the following from the drop-down list to indicate whether to fetch the first message from the queue:

  • Yes: WebSphere MQ will return to the first message in the queue.

  • No: The next message will be fetched.

Start Sequence ID

Enter the starting sequence number for the message in the queue.

Message Fetch Order

Select the fetch order for messages fetched from the queue from the drop-down list when the order is different from the open queue mode:

  • Physical (FIFO): Messages are fetched in the order they are entered in the queue.

  • Logical: Messages are fetched according to group or location.

Message Fetch Mode

Select one of the following from the drop-down list to indicate how messages are handled after they are read:

  • Remove: Messages are deleted from the server after they are read.

  • Browse: Messages are left for browsing and are not deleted from the server.

Client/Server

Select Client or Server from the drop-down list to indicate the type of computer where the queue resides.

Dynamic Connection

If the value is Yes, then the Channel Name, Host URL, and Port will be taken from the configuration. If the value is No, it will refer to the MQSERVER system variable.

This is applicable in Client mode.

Channel Name

Enter the name of the channel defined in the WebSphere MQ server. This parameter is available only when the Dynamic Connection parameter (above) is set to Yes.

Host URL

Enter the URL to the WebSphere MQ server that is the machine name. This parameter is available only when the Dynamic Connection parameter (above) is set to Yes.

Port

Enter the port number defined for the channel in the WebSphere MQ server. This parameter is available only when the Dynamic Connection parameter (above) is set to Yes.

Transacted Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Message

Select where the message data is received.

Return Description

Optional information to be returned with message. The information must be comma delimited.

For example, Reply 2Q, Format, Sent Date, Sent Time.

Code Page

Enter the code page used for message encoding.

Disconnect on Close

Defines whether the connection to the WebSphere MQ server will be closed when the queue closes. Select one of the following from the drop-down list:

  • No

  • Yes

Header Exists

Reports whether the received message has an RFH2 header.

Message Header

Returns the RFH2 header if one exists. Header content is parsed by the GetRFH2Header method.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Advanced Quick Send sends a message in the same way as the Quick Send method, but uses additional parameters.

Queue Name

Enter the name of the Message Queue.

Data Type

Select a message data type from the drop-down list:

  • Alpha

  • Numeric (This data type cannot contain more than 15 characters)

  • Date

  • Time

  • Logical

  • BLOB

Get From File

Determines whether to get a message from a file (enabled only if BLOB is the selected data type). Select one of the following from the drop-down list:

  • No (default)

  • Yes

File Path

Specifies the file path where you want to send a message (enabled only if Get From File is set to Yes).

Message

Enter the message data or an expression that will build the data.

Persistence

Select one of the following from the drop-down list to indicate the queue connection is always open. Persistent indicates that the connection is always open:

  • Persistent: Messages are recovered.

  • Not persistent: Messages are lost.

  • As defined by the queue: The queue defines whether messages are recovered.

Message ID

The message ID.

Correlation ID

Enter a filter to limit the subscribed messages received in the queue. For example, you can limit messages to those that come from a specific source.

Group ID

Enter an ID number to identify a group of messages to be processed together.

Start Sequence ID

Enter the starting sequence for the message in the queue.

MSG Priority

Enter a number to indicate the message priority. The default is 0.

Message Life Time

Enter the amount of time (in tenths of a second) that messages remain in the queue. A value of 0 indicates that messages are never dropped from the queue, and a value of -1 causes messages to be removed from the queue immediately.

Transacted Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Message Format

Select one of the following from the drop-down list to indicate the message format:

  • No format (default).

  • MQSTR: WebSphere MQ performs a conversion to MQSTR.

  • MQRFH2: WebSphere MQ performs a conversion to MQRFH2.

Message Header

Provides an RFH2 header. The BLOB used to hold the header's variable content is built by the SetRFH2Header method.

This parameter is only available if you selected MQRFH2 in the Message Format parameter (above).

Client/Server

Select Client or Server from the drop-down list to indicate the type of computer where the queue resides.

Dynamic Connection

If the value is Yes, then the Channel Name, Host URL, and Port will be taken from the configuration. If the value is No, it will refer to the MQSERVER system variable.

This is applicable in Client mode.

Channel Name

Enter the name of the channel defined in the WebSphere MQ server. This parameter is available only when the Dynamic Connection parameter (above) is set to Yes.

Host URL

Enter the URL to the WebSphere MQ server that is the machine name. This parameter is available only when the Dynamic Connection parameter (above) is set to Yes.

Port

Enter the port number defined for the channel in the WebSphere MQ server. This parameter is available only when the Dynamic Connection parameter (above) is set to Yes.

Disconnect on Close

Defines whether the connection to the WebSphere MQ server will be closed when the queue closes. Select one of the following from the drop-down list:

  • No

  • Yes

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Advanced Send sends a message in the same way as the Send method, but uses additional parameters.

Queue Handle

Enter the numeric value returned as the queue handle in the Open parameter.

Data Type

Select a message data type from the drop-down list:

  • Alpha

  • Numeric (This data type cannot contain more than 15 characters)

  • Date

  • Time

  • Logical

  • BLOB

Get From File

Determines whether to get a message from a file (enabled only if BLOB is the selected data type). Select one of the following from the drop-down list:

  • No (default)

  • Yes

File Path

Specifies the file path where you want to send a message (enabled only if Get From File is set to Yes).

Message

Enter the message data or an expression that will build the data.

Transacted Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Message Type

Select the message type from the drop-down list:

  • Message (WebSphere MQ Datagram).

  • Request: This is a message to which a reply is expected.

  • Response: This is a reply to a request message.

Broadcast This Message

Select one of the following from the drop-down list to indicate whether to broadcast the message:

  • Yes: The message broadcast to all queues that are open for broadcast.

  • No: The message is not broadcast.

Retain

Select one of the following from the drop-down list to indicate whether to retain the message for future subscribers:

  • Yes: The message is retained for future subscribers. All subscribers who request to receive previously published messages when subscribing will receive the message.

  • No: The message is not retained. Future subscribers will not get the message even if they request to receive previously published messages.

Correlation ID

Enter a filter to limit the messages sent to subscribers in the queue. This parameter searches for queues that have the same correlation ID and only sends the messages to those queues.

This Correlation ID correlates to the Correlation ID in the Open method.

Message ID

The message ID.

Reply to Queue Manager

Enter the name of the queue manager where replies are sent.

Reply to Queue Name

Enter the name of the message queue where replies are sent.

Message Format

Select one of the following from the drop-down list to indicate the message format:

  • No format (default).

  • MQSTR: WebSphere MQ performs a conversion to MQSTR.

  • MQRFH2: WebSphere MQ performs a conversion to MQRFH2.

Message Header

Provides an RFH2 header. The BLOB used to hold the header's variable content is built by the SetRFH2Header method.

This parameter is only available if you selected MQRFH2 in the Message Format parameter (above).

Persistence

Select one of the following from the drop-down list to indicate the queue connection is always open. Persistent indicates that the connection is always open:

  • Persistent: Messages are recovered.

  • Not persistent: Messages are lost.

  • As defined by the queue: The queue defines whether messages are recovered.

Message Life Time

Enter the amount of time (in tenths of a second) that messages remain in the queue. A value of 0 indicates that messages are never dropped from the queue, and a value of -1 causes messages to be removed from the queue immediately.

Message Priority

Enter a number to indicate the message priority. The default is 0.

Group ID

Enter an ID number to identify a group of messages to be processed together.

Start Sequence ID

Enter the starting sequence for the message in the queue.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Close closes the queue when receiving a message using the WebSphere MQ protocol.

Queue Handle

Enter the numeric value returned as the queue handle in the Open parameter.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Commit commits an open transaction. Any other transactions must begin a new transaction.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Get gets a message using the WebSphere MQ protocol.

Queue Handle

Enter the numeric value returned as the queue handle in the Open parameter.

Time Out

Enter the amount of time (in milliseconds) that the component will wait to receive a message before moving to the next step in the flow. If you enter -1, the component will wait indefinitely until a message is received before moving to the next step in the flow.

Data Type

Select a data type from the drop-down list:

  • Alpha

  • Numeric

  • Date

  • Time

  • Logical

  • BLOB

Transaction Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Message ID

The message ID.

Correlation ID

Enter a filter to limit the messages sent to subscribers in the queue. This parameter searches for queues that have the same correlation ID and only sends the messages to those queues.

This Correlation ID correlates to the Correlation ID in the Open method.

Group ID

Enter an ID number to identify a group of messages to be processed together.

Sequence Number

Enter the sequence number of the message in the group. For example, if this is the fourth message in the group, enter 4.

If you enter 0 and the Group ID has a value, WebSphere MQ will increase the sequence number of each message that enters the group automatically.

Message Type

Select the message type from the drop-down list:

  • Request: This is a message to which a reply is expected.

  • Response: This is a reply to a request message.

  • Message: (WebSphere MQ Datagram).

Message Encoding

Select the type of encoding used for the messages from the drop-down list:

  • ANSI

  • EBCDIC

  • UNICODE

Get First Message

Select one of the following from the drop-down list to indicate whether to fetch the first message from the queue:

  • Yes: WebSphere MQ will return to the first message in the queue.

  • No: The next message will be fetched.

Message

Select where the message data is received.

Return Description

Optional information to be returned with message. The information is comma delimited.

For example, Reply 2Q, Format, Sent Date, Sent Time.

Code Page

Enter the code page used for message encoding.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Get RFH2 Header parses the constituent parts of an RFH2 header into variables.

Client/Server

Determines whether a Client module or a Server module will be used for messaging. Select one of the following from the drop-down list:

  • Client (default)

  • Server

Header

The BLOB variable that holds the header.

Enter the name of the BLOB variable, or click to open the Expression Editor.

Encoding

Specifies how numeric values in any data that follows the header section will be returned.

Click to open the Variables List, and select a variable to hold the data.

Charset

Identifies the coded character set of the message's body.

Click to open the Variables List, and select the required variable.

Format

Sets the format of the message's body.

Click to open the Variables List, and select the required variable.

Sections CCSID

Returns the message's CCSID information.

Click to open the Variables List, and select the variable to hold the CCSID information.

mcd Folder

Returns the mcd section XML.

Click to open the Variables List, and select the variable to hold the returned XML data.

psc Folder

Returns the psc section XML.

Click to open the Variables List, and select the variable to hold the returned XML data.

pscr Folder

Returns the pscr section XML.

Click to open the Variables List, and select the variable to hold the returned XML data.

usr Folder

Returns the usr section XML.

Click to open the Variables List, and select the variable to hold the returned XML data.

jms Folder

Returns the jms section XML.

Click to open the Variables List, and select the variable to hold the returned XML data.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Open opens a queue to send a message using the WebSphere MQ protocol.

Queue Access Mode

Select the access mode available for messages in the queue from the drop-down list:

  • Read: Messages are read and removed from the queue.

  • Write: Messages are written to the queue.

  • Publish: Messages are published to a topic.

  • Subscribe: Messages are subscribed to a topic.

Queue Name

Enter the name of the Message Queue.

Topic Name

The name of the subscribed topic.

This parameter is available only if the Queue Access Mode parameter is set to Publish or Subscribe.

Broker Stream

The name of the broker stream. This parameter is mandatory if you select Publish (above), and contains the topic broker stream that is relevant for Publish and Subscribe.

This parameter is available only if the Queue Access Mode parameter is set to Publish or Subscribe.

Share Mode

Select whether other users have access to messages in the queue from the options in the drop-down list:

  • Available: Other users have access.

  • Exclusive: Other users do not have access.

Fetch Order

Select the fetch order for messages fetched from the queue from the drop-down list:

  • Physical (FIFO). Messages are fetched in the order they are entered in the queue.

  • Logical. Messages are fetched according to group or location.

This parameter is only available if you selected Read or Write in the Queue Access Mode parameter (above).

Message Fetch Mode

Select one of the following from the drop-down list to indicate how messages are handled after they are read.

  • Remove: Remove messages from the queue after reading.

  • Browse: Messages are not removed from the queue.

This parameter is only available if you selected Read or Write in the Queue Access Mode parameter (above).

Low Hi Order

Select one of the following from the drop-down list to indicate whether to read numbers in low to high order:

  • Yes: Read numbers in low to high order.

  • No: Do not read numbers in low to high order.

Encoding

Select the type of encoding used or the messages from the drop-down list:

  • ANSI

  • EBCDIC

  • UNICODE

Code Page

Enter the code page used for message encoding.

Correlation ID

Enter a filter to limit the messages received in the queue. For example, you can limit messages to those that come from a specific source.

Disconnect on Close

Select one of the following from the drop-down list to indicate whether to disconnect from the WebSphere MQ server when the message queue closes:

  • Yes: Disconnects from server on close

  • No: Does not disconnect

Client/Server

Select Client or Server from the drop-down list to indicate the type of computer where the queue resides.

Dynamic Connection

If the value is Yes, then the Channel Name, Host URL, and Port will be taken from the configuration. If the value is No, it will refer to the MQSERVER system variable.

This is applicable in Client mode.

Channel Name

Enter the name of the channel defined in the WebSphere MQ server. This is applicable when the Dynamic Connection parameter is set to Yes.

Host URL

Enter the URL to the WebSphere MQ server that is the machine name. This is applicable when the Dynamic Connection parameter is set to Yes.

Port

Enter the port number defined for the channel in the WebSphere MQ server. This is applicable when the Dynamic Connection parameter is set to Yes.

Queue Handle

When the connection is successful, the queue handler is returned. When the connection is not successful, a negative value is returned.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Quick Get opens the queue, receives a message using the WebSphere MQ protocol, and then closes the queue.

Queue Name

Enter the name of the Message Queue.

Share

Select Exclusive to not allow sharing the message in the message queue.

Select Available to allow sharing the message in the message queue.

Timeout

Enter the amount of time (in milliseconds seconds) that the component will wait to receive a message before moving to the next step in the flow. If you enter -1, the component will wait indefinitely until a message is received before moving to the next step in the flow.

Data Type

Select a data type from the drop-down list:

  • Alpha

  • Numeric

  • Date

  • Time

  • Logical

  • BLOB

Transaction Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Client/Server

Select Client or Server from the drop-down list to indicate the type of computer where the queue resides.

Dynamic Connection

If the value is Yes, then the Channel Name, Host URL, and Port will be taken from the configuration. If the value is No, it will refer to the MQSERVER system variable.

This is applicable in Client mode.

Channel Name

Enter the name of the channel defined in the WebSphere MQ server. This is applicable when the Dynamic Connection parameter is set to Yes.

Host URL

Enter the URL to the WebSphere MQ server that is the machine name. This is applicable when the Dynamic Connection parameter is set to Yes.

Port

Enter the port number defined for the channel in the WebSphere MQ server. This is applicable when the Dynamic Connection parameter is set to Yes.

Disconnect on Close

Defines whether the connection to the WebSphere MQ server will be closed when the queue closes. Select one of the following from the drop-down list:

  • No

  • Yes

Data

Enter the message data in the format selected in the Data Type parameter.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Quick Send opens the queue, sends a message using the WebSphere MQ protocol and then closes the queue.

Queue Name

Enter the name of the Message Queue.

Share

Select Exclusive to not allow sharing the message in the message queue.

Select Available to allow sharing the message in the message queue.

Data Type

Select a message data type from the drop-down list:

  • Alpha

  • Numeric (This data type cannot contain more than 15 characters)

  • Date

  • Time

  • Logical

  • BLOB

Data

Enter the message data in the format selected in the Data Type parameter.

Persistence

Select one of the following from the drop-down list to indicate the queue connection is always open. Persistent indicates that the connection is always open:

  • Persistent: Messages are recovered.

  • Not persistent: Messages are lost.

  • As defined by the queue: The queue defines whether messages are recovered.

Client/Server

Select Client or Server from the drop-down list to indicate the type of computer where the queue resides.

Dynamic Connection

If the value is Yes, then the Channel Name, Host URL, and Port will be taken from the configuration. If the value is No, it will refer to the MQSERVER system variable.

This is applicable in Client mode.

Channel Name

Enter the name of the channel defined in the WebSphere MQ server. This is applicable when the Dynamic Connection parameter is set to Yes.

Host URL

Enter the URL to the WebSphere MQ server that is the machine name. This is applicable when the Dynamic Connection parameter is set to Yes.

Port

Enter the port number defined for the channel in the WebSphereMQ server. This is applicable when the Dynamic Connection parameter is set to Yes.

Transacted Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Disconnect on Close

Defines whether the connection to the WebSphere MQ server will be closed when the queue closes. Select one of the following from the drop-down list:

  • No

  • Yes

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Rollback aborts an open transaction and rolls it back to the beginning of the transaction. Any other transactions must begin a new transaction.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Send sends a message using the WebSphere MQ protocol.

Queue Handle

Enter the numeric value returned as the queue handle in the Open parameter.

Data Type

Select a message data type from the drop-down list:

  • Alpha

  • Numeric (This data type cannot contain more than 15 characters)

  • Date

  • Time

  • Logical

  • BLOB

Message

Enter a BLOB with the message data.

Transacted Message

Select one of the following from the drop-down list to indicate whether the message is part of a transaction:

  • Yes: The message is part of a transaction.

  • No: The message is not part of a transaction.

If this parameter is true and there is no open transaction, WebSphere MQ automatically begins a transaction.

Message Type

Select the message type from the drop-down list:

  • Message (WebSphere MQ Datagram).

  • Request: This is a message to which a reply is expected.

  • Response: This is a reply to a request message.

Broadcast this Message

Select one of the following from the drop-down list to indicate whether to broadcast the message:

  • Yes: The message broadcast to all queues that are open for broadcast.

  • No: The message is not broadcast.

Retain

Select one of the following from the drop-down list to indicate whether to retain the message for future subscribers:

  • Yes: The message is retained for future subscribers. All subscribers who request to receive previously published messages when subscribing will receive the message.

  • No: The message is not retained. Future subscribers will not get the message even if they request to receive previously published messages.

Correlation ID

Enter a filter to limit the messages sent to subscribers in the queue. This parameter searches for queues that have the same correlation ID and only sends the messages to those queues.

This Correlation ID correlates to the Correlation ID in the Open method.

Message ID

The message ID.

Reply to Queue Manager

Enter the name of the queue manager where replies are sent.

Reply to Queue Name

Enter the name of the message queue where replies are sent.

Message Format

Select one of the following from the drop-down list to indicate the message format:

  • No format (default).

  • MQSTR: WebSphere MQ performs a conversion to MQSTR.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Set RFH2 Header sets a BLOB variable with the RFH2 header sections.

Client/Server

Determines whether a Client module or a Server module will be used for messaging. Select one of the following from the drop-down list:

  • Client (default)

  • Server

Encoding

Specifies how numeric values in any data that follows the header section will be returned.

Enter the required values, or click to open the Expression Editor.

Charset

Identifies the coded character set of the message's body.

Enter the required character details, or click to open the Expression Editor.

Format

Sets the format of the message's body.

Enter the required format, or click to open the Expression Editor.

Sections CCSID

Returns the message's CCSID information.

Enter the required CCSID information, or click to open the Expression Editor.

mcd Folder

Returns the mcd section XML.

Enter the required mcd folder details, or click to open the Expression Editor.

psc Folder

Returns the psc section XML.

Enter the required psc folder details, or click to open the Expression Editor.

pscr Folder

Returns the pscr section XML.

Enter the required pscr folder details, or click to open the Expression Editor.

usr Folder

Returns the usr section XML.

Enter the required usr folder details, or click to open the Expression Editor.

jms Folder

Returns the jms section XML.

Enter the required jms folder details, or click to open the Expression Editor.

Header

The BLOB variable that holds the header.

Click to open the Variables List, and select the variable to hold the returned XML data.

Error Code

Click to open the Variables List. Select a variable where the error code is returned, and then click Select.

Related Topics

How to Use Direct Access Methods

Reference
Attachment 
Attachment