Running eLink Adapter for MQSeries # Running eLink Adapter for MQSeries Running the eLink Adapter for MQSeries consists of the following basic tasks: Booting the Servers Initiating a TUXEDO-to-MQSeries Request Initiating an MQSeries-to-TUXEDO Request Sending and Receiving Messages to and from MQSeries ## Booting the Servers The eLink Adapter for MQSeries servers boot as part of the TUXEDO application using standard TUXEDO utilities, such as `tmboot`. The eLink Adapter reads the server configuration files and attempts to connect to the specified queue manager. Once the eLink Adapter establishes a connection with the queue manager, the eLink to MQSeries server (ELINKMQO) advertises the services associated with that queue manager. ## Initiating a TUXEDO-to-MQSeries Request TUXEDO clients can call services advertised by the eLink Adapter for MQSeries eLink to MQSeries server (ELINKMQO). A TUXEDO-to-MQSeries request consists of the following actions. The TUXEDO client initiates a request for a service advertised by ELINKMQO. The eLink Adapter uses the MQSeries Message Queue Interface (MQI) to forward these requests to the appropriate MQSeries queue. The eLink Adapter retrieves response data (if any) from the designated reply queue and returns this data to the TUXEDO client. ## Initiating an MQSeries-to-TUXEDO Request MQSeries applications can request TUXEDO services via the MQSeries to eLink server ELINKMQI. An MQSeries-to-TUXEDO request consists of the following actions. The MQSeries application queues a message requesting the service to a designated queue. The eLink Adapter retrieves the message from the incoming queue. The eLink Adapter forwards the message data to the appropriate service. The eLink Adapter places response data (if any) on the specified reply queue. ## Sending and Receiving Messages to and from MQSeries The TMQUEUE_MQM server processes `tpenqueue` and `tpdequeue` requests, as well as `tpcall` requests, from a TUXEDO server. ### Processing a tpenqueue Request The syntax for a `tpenqueue` request is as follows: Listing 4-1 Syntax for `tpenqueue` requests `tpenqueue (``qspace, qname, qctl, data, len, flags``)` A `tpenqueue` request requires all parameters shown previously. Following are brief descriptions of these parameters. For more information, refer to the BEA TUXEDO Programmer's Guide. QSPACE The name of the service advertised by TMQUEUE_MQM. This value can be overwritten in the TUXEDO UBBCONFIG file using the `-s` option. For example: `-s myname:MQMQUEUE` Default is MQMQUEUE. QNAME The name of the queue where you want the adapter to place or retrieve messages. Can contain up to 15 characters. Corresponds to an MQSeries queue defined in the TMQUEUE_MQM.CFG file (MQNAME). QCTL Provides additional information about the message. The supported options you can define for `tpenqueue` requests are as follows: TPNOFLAGS No options apply to this message TPQPRIORITY Message priority. TUXEDO values for this field can be from 1-100. The eLink Adapter values can be 0-9 and are mapped to TUXEDO values as follows: 0=TUXEDO 1-10, 1=TUXEDO 11-20, etc. TPQCORRID Correlation ID. Identifies the response to a request. TUXEDO supports up to 32 bytes. The eLink Adapter supports up to 24 bytes and truncates TUXEDO values on `tpenqueue` requests. TPQREPLYQ Name of the queue where you want to place reply messages. Can contain up to 15 characters. TPQMSGID Return the message ID generated when the message is placed on the queue. TUXEDO supports up to 32 bytes. The eLink Adapter supports up to 24 bytes and pads the ID with nulls. DATA Data to be placed on the queue LEN Length of the data to be placed on the queue FLAGS Defines the flag settings for the message. The supported flags for `tpenqueue` requests are as follows: TPNOTRAN Messages from callers that are in transaction mode are not queued within the same transaction as the caller. ### Processing a tpdequeue Request The syntax for a `tpdequeue` request is as follows: Listing 4-2 Syntax for `tpdequeue` requests `tpdequeue (``qspace, qname, qctl, data, len, flags``)` A `tpdequeue` request requires all parameters shown previously. Following are brief descriptions of these parameters. For more information, refer to the BEA TUXEDO Programmer's Guide. QSPACE The name of the service advertised by TMQUEUE_MQM. This value can be overwritten in the TUXEDO UBBCONFIG file using the `-s` option. For example: `-s myname:MQMQUEUE` Default is MQMQUEUE QNAME The name of the queue where you want the adapter to place or retrieve messages. Can contain up to 15 characters. Corresponds to an MQSeries queue defined in the TMQUEUE_MQM.CFG file (MQNAME). QCTL Provides additional information about the message. The supported options you can define for `tpdequeue` requests are as follows: TPNOFLAGS No options apply to this message TPQGETBYMSGID Dequeues the specified message ID. TPQGETBYCORRID Dequeues the message with the specified correlation ID. TPQPRIORITY Message priority. TUXEDO values for this field can be from 1-100. The eLink Adapter values can be 0-9 and are mapped to TUXEDO values as follows: 0=TUXEDO 1-10, 1=TUXEDO 11-20, etc. TPQCORRID Correlation ID. Identifies the response to a request. TUXEDO supports up to 32 bytes. The eLink Adapter supports up to 24 bytes and truncates TUXEDO values on `tpenqueue` requests. TPQREPLYQ Name of the queue where you want to place reply messages. Can contain up to 15 characters. TPQMSGID Return the message ID generated when the message is placed on the queue. TUXEDO supports up to 32 bytes. The eLink Adapter supports up to 24 bytes and pads the ID with nulls. DATA Data to be placed on the queue LEN Length of the data to be placed on the queue FLAGS Defines the flag settings for the message. The supported flags for `tpdequeue` requests are as follows: TPNOTRAN Messages from callers that are in transaction mode are not queued within the same transaction as the caller. ### Processing a tpcall Request Processing a `tpcall` request with the eLink Adapter for MQSeries requires no special parameters. The only requirement is that, if you request a response, the REPLYTOQ must be specified in the server configuration file. Refer to Configuring eLink Adapter for MQSeries for more information on the server configuration files. Refer to the BEA TUXEDO Programmer's Guide for more information on `tpcall`. [Table of Contents] [Prev] [Next]