Salesforce

WMQ.Quick Send (Magic xpa 3.x)

Printable View
« Go Back

Information

 
Created ByKnowledge Migration User
Approval Process StatusPublished
Objective
Description

WMQ.Quick Send (Magic xpa 3.x)

The WMQ.Quick Send program opens a message queue, sends a message, and then closes the message queue. This program provides the programmer with simplicity and saves overhead, but is not efficient when you want to send a large amount of messages. See also WMQ Send Message.

This program calls the Open Queue, Message Setup, Send Message, or Close Queue programs accordingly.

The WMQ.Quick Send program does not change the code page. Therefore, the code page will not be changed when a message is sent using the WMQ.Quick Send program while the code page is set by the WMQ_CodePageSet messaging subroutine.

Note: The WMQ.Quick Send method is not yet implemented with dynamic connections, but uses the MQSERVER environment for the channel definitions.

The parameters and return value for the WMQ.Quick Send program are:

Parameter

Description

Queue Manager

Alpha (48). The name of the MQ queue manager, which is part of the MQ installation.

Queue Name

Alpha (48). The name of the queue.

Message Data

BLOB input, containing the message data.

Buffer Identifier index

Numeric (4). Input. When this parameter evaluates to zero, the message must be in the BLOB. If it evaluates to greater than zero, the message structure and values are in the memory table, the Buffer Table, and this is the index. For more information, see Buffer Table.

Note: If the buffer identifier index is zero, the component sends the BLOB as-is. If it is greater than zero, the component will create the message buffer according to the structure, and values, in the memory table.

Msg Persistence

Alpha (1). Indicates whether the message survives system failures. The valid values are:

  • P: Persistent

  • N: Not persistent

  • D: As defined by the queue

Message ID

BLOB. Optional, input and output. This parameter returns the Message ID. A message ID can be sent, and then the calling application must control the ID.
Note: The maximum size is 24 bytes.

Correlation ID

BLOB. Optional input. Identifies correlation for Message Type Request messages. Identifies subscriptions for a specific subscriber in a shared queue.
Note: The maximum size is 24 bytes.

Group ID

BLOB. Optional input. Identifies a group of messages to be processed together.
Note: The maximum size is 24 bytes.

For specifying a NULL Group ID, use the following keyword: MG_NULL_ID.

Sequence Number

Numeric (N10). Specifies the sequence number of the message in the group. If this is zero and the Group ID has a value, the component will return an error.

Priority

Numeric (2). The message priority. Default = 0

Msg Life span

Numeric (N10). The message life span. The valid values are:

  • Unlimited = 1

  • Numeric (tenths of seconds)

Transacted Msg

Logical (5). Input. When True, this will be part of a transaction. If there is no open transaction, WebSphere MQ automatically begins one.

Message Format

Numeric (2). Optional input. This defines the message format as described below:

  • 0: No format (default)

  • 1: MQ Series performs the conversion (MQSTR)

  • 2: Admin (MQADMIN)

  • 3: CHANNEL_COMPLETED (MQCHCOM)

  • 4: Dead letter header (MQDEAD)

  • 5: Trigger (MQTRIG)

  • 6: XMIT_Q_Header (MQXMIT)

WMQ Error Code

Number (N17). Attempts to return the MQ internal error code (reason code) when the Quick Send fails. There are cases when this parameter returns 0 even if an error occurs.


Return value

Numeric. 0 for success and a non-zero value for failure

Reference
Attachment 
Attachment