Use the Endpoint Wizard to configure an endpoint connection for a WebSphere MQ session and transport. To access the Endpoint Wizard, from Endpoint Manager, right-click on an endpoint type and select Add Endpoint.
Note: WebSphere MQ has separate Client and Server endpoints for both session and transport. The difference between the two is the choice of libraries. Use MQ Client in a Unwired Orchestrator server environment when the MQ server is running on a remote machine. An Unwired Orchestrator server cluster requires the use of a MQ client/server environment. Other than the choice of libraries, you configure the two with the same wizard choices.
You must configure a session before you configure the transport because the session provides information used by the transport. WebSphere MQ sessions are configured to point to existing connection factories on a WebSphere MQ provider. A table of common transport keys is the third table. It contains keys that are used for all messaging configurations.
|
Session Key |
Description and Valid Values |
|
Name
|
Name and description of the new configuration object for use in the GUI to select the appropriate service. |
|
Queue Manager Name NNMQS_TIL_OPEN_QMGR |
Queue manager name (as set up in WebSphere MQ) to make the connection to the transport. |
|
Session Options NNMQS_SES_CONNECT_OPTIONS |
Options used when making a connection to the session MQCNO_Fastpath_Binding MQCNO_None MQCNO_Standard_Binding |
The configuration for WebSphere MQ includes a series of optional message options that can be added to the default parameters. The following table provides a brief description of the options presented in the configuration wizard.
Refer to WebSphere MQ documentation for additional descriptions of the keys.
|
Transport Key |
Description and Valid Values |
|
MQSI Map Mode NNMQS_TIL_MQSI_V2_MAP_MODE |
Flag to denote whether to map message headers to the mcd folder instead of the user folder. TRUE or FALSE |
|
Get Options NNMQS_TIL_GET_OPTIONS |
Options used when performing an MQGET call from a WebSphere MQ queue. MQGMO_ACCEPT_TRUNCATED_MSG - Allow truncation of message data. If the
message buffer is too small to hold the complete message, this allows
the MQGet to fill the buffer with as much of the messages as the buffer
can hold. MQGMO_ALL_MSGS_AVAILABLE - All messages in the group must be available.
This option specifies that messages in a group become available for retrieval
only when all messages in the group are available. This prevents messages
in incomplete groups from being retrieved. This implies MQGMO_ALL_SEGMENTS_AVAIALABLE
so that key need not be specified. MQGMO_ALL_SEGMENTS_AVAILABLE
- All segments in a message must be available. This option specifies that
segments of a logical message can be retrieved only when all segments
of the logical message are available. MQGMO_COMPLETE_MSG - Only complete logical messages are retrievable. This option specifies that only complete logical messages can be returned by the MQGET call. If the logical message is segmented, the queue manager reassembles the segments and returns the complete message to the application; the fact that the message was segmented is not apparent to the application. This implies MQGMO_ALL_SEGMENTS_AVAILABLE, which does not need to be specified. MQGMO_CONVERT - Convert message data. This option requests that the
application data in the message should be converted to CCSID and encoding
values before the data is copied. MQGMO_FAIL_IF_QUIESCING - Fail if the queue manager is quiescing (shutting
down). This option forces the MQGET call to fail if the queue manager
is in the quiescing state. MQGMO_LOGICAL_ORDER - Messages in groups and segments of logical messages
are returned in logical order. MQGMO_MARK_SKIP_BACKOUT - Mark the request as skipping backout. This
option allows a unit of work to be backed out without reinstating on the
queue the message that was marked with this option. When the application
requests the backout of a unit of work containing a get request, a message
that was retrieved using this option is not restored to this previous
state. Instead, the message is treated as though it had been retrieved
by a get request without this option in a new unit of work started by
the backout request. MQGMO_NO_SYNCPOINT - Get message without syncpoint control. The request is to operate outside the normal unit of work protocols. The message is deleted immediately (unless this is a browse request). The message cannot be made available again by backing out a unit of work. MQGMO_NO_WAIT - The application is not to wait if no suitable message is available and is the default if neither MQGMO_WAIT nor MQGMO_NO_WAIT is specified. MQGMO_NONE - No options are specified. This option can be used to indicate that no other options have been specified; all other options assume their default values. MQGMO_SYNCPOINT - The request is to operate within the normal unit of work protocols. The message is marked as being unavailable to other applications, but it is deleted from the queue only when the unit of work is committed. The message is made available again if the unit of work is backed out. MQGMO_SYNCPOINT_IF_PERSISTENT - Get message with syncpoint control if
the message is persistent. The
request is to operate within the normal unit of work protocols, but only
if the message is persistent. This
value is not valid with: MQGMO_COMPLETE_MSG,
MQGMO_MARK_SKIP_BACKOUT, MQGMO_NO_SYNCPOINT, MQGMO_ SYNCPOINT. |
|
Selective Get Options NNMQS_TIL_GET_MATCH_OPTIONS |
Options used when performing a selective get from a WebSphere MQ queue. MQMO_MATCH_MSG_ID - Retrieve message with specified message identifier. This option specifies that the message to be retrieved must have a message identifier that matches the value entered in the Message ID window of the endpoint wizard (Key: NNMQS_TIL_GET_MSG_ID). MQMO_MATCH_CORREL_ID - Retrieve message with specified correlation identifier. This option specifies that the message to be retrieved must have a correlation identifier that matches the value entered in the Correlation ID window of the endpoint wizard (Key: NNMQS_TIL_GET_CORREL_ID). MQMO_NONE - No matches. This option specifies that no match options are to be used in selecting the message to be returned; therefore, all messages on the queue are eligible for retrieval (but subject to control of MQGMO_ALL_MSGS_AVAILABLE, MQGMO_ALL_SEGMENTS_AVAILIABLE, and MQGMO_COMPLETE_MSG options). |
|
Matching Message ID NNMQS_TIL_GET_MSG_ID |
Message ID used in conjunction with the selective get options. |
|
Matching Correlation ID NNMQS_TIL_GET_CORREL_ID |
Correlation ID used in conjunction with the selective get options. |
|
Alternate Queue Manager Name NNMQS_TIL_OPEN_QMGR |
Alternate queue manager name used for specific purposes. See WebSphere MQ documentation. |
|
Queue Open Options NNMQS_TIL_OPEN_OPTIONS |
Open options to use when opening a connection (MQOPEN call) to a remote queue. MQOO_ALTERNATE_USER_AUTHORITY - Validate with specified user identifier. This indicates that the user input in the Alternate user name widow in the wizard (Key: NNMQS_TIL_OPEN_ALT_USER_ID) is to be used to validate this MQOPEN call. The call can succeed only if the alternate user is authorized to open the object with the specified options, regardless of whether the user under which the application is running is authorized to do so. This option is accepted but ignored in 16-bit and 32-bit windows environment. MQOO_FAIL_IF_QUIESCING - Fail if queue manager is quiescing. This option forces MQOPEN call to fail if the queue manager is in quiescing state. This option is accepted but ignored in 16-bit and 32-bit Windows environment. MQOO_INPUT_AS_Q_DEF - Open queue to get messages using queue-defined default. Option is valid only for local, alias, and model queues; it is not valid for remote queues, distribution lists, and objects that are not queues. Only one of the following options can be specified: MQOO_INPUT_AS_Q_DEF, MQOO_INPUT_EXCLUSIVE, MQOO_INPUT_SHARED. MQOO_INPUT_EXCLUSIVE - Open queue to get messages with exclusive access. This call will fail if the queue is currently open by this or another application for input of any type (MQOO_INPUT_SHARED or MQOO_INPUT_EXCLUSIVE) This optionis valid only for local, alias, and model queues; it is not valid for remote queues, distribution lists, and objects that are not queues. Only one of the following options can be specified: MQOO_INPUT_AS_Q_DEF, MQOO_INPUT_EXCLUSIVE, MQOO_INPUT_SHARED. MQOO_INPUT_SHARED - Open queue to get messages with shared access. This fails with queues already open with MQOO_INPUT_SHARED or MQOO_INPUT_EXCLUSIVE. This option is valid only for local, alias, and model queues; it is not valid for remote queues, distribution lists, and objects that are not queues. Only one of the following options can be specified: MQOO_INPUT_AS_Q_DEF, MQOO_INPUT_EXCLUSIVE, MQOO_INPUT_SHARED. MQOO_OUTPUT - Open queue to put messages. The queue is opened for use with subsequent MQPUT calls. This option is valid for all types of queues including distribution lists. MQOO_PASS_ALL_CONTEXT - Allow context to be passed. This allows MQPMO_PASS_ALL_CONTEXT option to be specified when a message is put on a queue; this gives the message the identity and origin context information from an input queue that was opened with the MQOO_SAVE_ALL_CONTEXT. Not supported with 16-bit or 32-bit Windows environment. MQOO_PASS_IDENTITY_CONTEXT - Allow identity context to be passed. This allows the MQPMO_PASS_IDENTITY_CONTEXT option to be specified when a message is put on a queue; this gives the message the identity context information from an input queue that was opened with the MQOO_SAVE_ALL_CONTEXT option. Not supported with 16-bit or 32-bit Windows environment. MQOO_SAVE_ALL_CONTEXT - Save context when message is received. Context information is associated with this queue handle. This information is set from the context of any message retrieved using this handle. Not supported with 16-bit or 32-bit Windows environment. MQOO_SET_ALL_CONTEXT - Allow all context to be set. This allows the MQPMO_SET_ALL_CONTEXT option to be specified when a message is put on a queue; this gives the message the identity and origin context information contained in the MQPUT. This option implies the following options , which do not need to be specified: MQOO_PASS_IDENTITY_CONTEXT, MQOO_PASS_ALL_CONTEXT, MQOO_SET_IDENTITY_CONTEXT. The MQOO_OUTPUT option must be specified. MQOO_SET_IDENTITY_CONTEXT - Allow identity context to be set. This allows the MQPMO_SET_IDENTITY_CONTEXT option to be specified when a message is put on a queue; this gives the message the context information specified on the MQPUT call. This option implies MQOO_PASS_IDENTITY_CONTEXT, which need not be identified. The MQOO_OUTPUT_OPTION must be specified. Suggested value is MQOO_OUTPUT |
|
NNMQS_TIL_OPEN_SYN_Q_NAME |
Dynamic queue name in the MQOD structure passed to MQOPEN. |
|
Alternate Username NNMQS_TIL_OPEN_ALT_USER_ID |
Alternate user id in the MQOD structure passed to MQOPEN. |
|
Audit MQGets NNOT_AUDIT_TRANSPORT_FOR_GETS |
The name of another transport to receive a copy of the message after a Get is complete. |
|
Audit MQPuts NNOT_AUDIT_TRANSPORT_FOR_PUTS |
The name of another transport to receive a copy of the message after a Put is complete. |
|
Put Options NNMQS_TIL_PUT_OPTIONS |
Options used when performing an MQPUT to a WebSphere MQ queue. MQPMO_DEFAULT_CONTEXT - Use default context. The message is to have default context information associated with it, for both identity and origin. This is the default action if no context options are specified. MQPMO_FAIL_IF_QUIESCING - Fail if the queue manager is quiescing. This option forces the MQPut call to fail if the queue manager is in the quiescing state. This option is accepted but ignored on 16-bit and 32-bit Windows environment. MQPMO_LOGICAL_ORDER - Messages in groups and segments of logical messages will be put in logical order. This option tells the queue manager how the application will put messages in groups and segments of logical messages MQPMO_NEW_CORREL_ID - Generate a new correlation identifier. This option causes the queue manager to replace the contents of the correlation id with a new correlation id. This is useful in situations where the application requires a unique correlation identifier. MQPMO_NEW_MSG_ID - Generate a new message identifier. This option causes the queue manager to replace the contents of the message id field with a new message identifier. MQPMO_NO_CONTEXT - No context is to be associated with the message. Both identity and origin context are set to indicate no context; this is blank for character fields, nulls for byte fields, and zeros for numeric fields. MQPMO_NO_SYNCPOINT - Put message without syncpoint control. The request is to operate outside the normal unit of work protocols. The message is available immediately, and cannot be deleted by backing out a unit of work. MQPMO_NO_SYNCPOINT must not be specified with MQPMO_ SYNCPOINT. MQPMO_NONE - No options specified; all options assume their default values. MQPMO_PASS_ALL_CONTEXT - Pass all context from an input queue handle. The message is to have context information associated with it. This option is not supported in 16-bit or 32-bit Windows environment. MQPMO_PASS_IDENTITY_CONTEXT - Passes identity context from an input queue handle. This option is not supported in 16-bit and 32-bit Windows environments. MQPMO_SET_ALL_CONTEXT - Set all context from the application. The message is to have context information associated with it specified by the application. MQPMO_SET_IDENTITY_CONTEXT - Set identity context from the application. The message is to have context information associated with it specified by the application. MQPMO_SYNCPOINT - Put message with syncpoint control. The request is to operate within the normal unit of work protocols. The message is not visible outside the unit if work until the unit of work is committed. If the unit of work is backed out, the message is deleted. MQPMO_SYNCPOINT must not be specified with MQPMO_NO_SYNCPOINT. |
|
MQRFH Version NNMQS_TIL_PUT_RFH_VERSION |
Specifies which version of the header format to use. Note: WebSphere MQ applications using Java messaging service (JMS) and IBM’s MQSI Version 2 broker use the MQRFH2 header format to store application properties. |
The information in the table identifies configuration parameters used in the Endpoint Wizard for each type of transport mechanism used. The specific key name is provided when it is used within the GUI to reference these parameters.
|
Transport Name |
Description |
|
Name |
Name and description of the new configuration object for use in the GUI for selecting the appropriate service. |
|
Session Name NNOT_TIL_OPEN_SESSION_ID |
Name of the session associated with the transport instance. |
|
Transport Name NNOT_TIL_OPEN_TSI |
Name of the transport specific instance name (such as the WebSphere MQ queue name or the file name). Required. |
|
Blocking Timeout NNOT_TIL_GET_BLOCKING_TIMEOUT |
Amount of time in milliseconds to wait for a message to arrive before the process performs another put or get. The default is for no blocking to occur so the return is immediate. It is recommended that you set blocking timeout to 2000 (2 seconds). |
|
Message Option Headers
|
Specifies whether a message put to the transport should contain a message option header. NNOT_HDR_INCLUDE NNOT_HDR_EXCLUDE NNOT_HDR_IF_NEEDED |