Sending WebSphere Java MQ endpoint requests
You can send requests to services that use a WebSphere Java MQ endpoint.
Before you begin
If the service uses Secure Sockets Layer (SSL) authentication, create an SSL configuration before sending the request. For more information, see Creating SSL configurations.
Procedure
- Click Open the Generic Service Client () and select the Requests page.
- Click Add () or in Request Library, right-click EndPoints and select a type of request to send.
- In the Configure Protocol window, select WebSphere Java MQ and specify the transport configuration. If necessary, create the transport configuration for the call by clicking New (see Creating a WebSphere Java MQ transport configuration).
-
Complete the following information in the General tab:
Learn more about the UI elements in the General tab:
- Queue
- Name of the queue as defined on the WebSphere MQ server.
- Message type
-
The types of messages are these:
- Datagram means that the message does not require a reply.
- Request means that the message requires a reply.
- Reply means that the message is a reply to an earlier request message.
- Report means that the message is reporting on some expected or unexpected occurrence, usually related to some other message. An example is a request message that contained data that was not valid.
- Message Persistence
-
This value indicates whether the message is persistent or not. If the message is persistent, it survives the system failures and restarts of the queue manager. If the message is not persistent, it survives a restart if it is present on a queue having the NPMCLASS(HIGH) attribute. However, even with the NPMCLASS(HIGH) attribute a message does not survive a QMGR class. Nonpersistent messages on queues having the NPMCLASS(NORMAL) attribute are discarded at queue manager restart, even if the message is found on the auxiliary storage during the restart procedure.
- Dynamic Reply
- Select this check box for the WebSphere MQ server to dynamically create a temporary queue as a reply. If this check box is not selected, the message in Reply Queue is used.
- Reply Queue
-
This is the name of the message queue to which the application that issued the get request for the message should send the reply and report messages.
- Reply Manager
-
This is the name of the queue manager on which the reply-to queue is defined.
- Additional properties
- Specify the additional properties for the queues.
- Optional:
If necessary, complete the following information on the Config
tab:
Learn more about the UI elements in the Config tab:
- Message Priority
-
This is the priority of the message. The lowest priority is 0.
- Encoding
-
This is the numeric encoding of numeric data in the message. This value does not apply to numeric data in the MQMD structure itself.
- Expiry Interval
-
This is the period of time, in tenths of a second, after which the message becomes eligible to be discarded if it has not already been removed from the target queue. The expiry interval is set by the application that put the message.
- Character set
-
This is the character set identifier of the character data in the application message data.
- Optional: In the Report tab, select the report messages to receive.
- Optional:
If necessary, complete the following information in the Context
tab:
Learn more about the UI elements in the Context tab:
- Application Identity Data
-
This information is defined by the application suite. Use it to provide information about the message or its originator.
- Application Origin Data
-
This information is defined by the application suite. Use it to provide additional information about the origin of the message.
- Accounting Token
-
This information is needed by the application to appropriately charge for the work that is done as a result of the message.
- User ID
-
This is the user identifier of the application that originated the message.
- Optional: In the Identifiers tab, for the messages that require binary input, specify the ID in the string format in the second column. The first column is filled automatically in the hexadecimal format.
- Optional: In the Segmentation tab, select the segment of the message and click Next.
- This step is not applicable for a Text request. On the Select Root Element page, if the service uses a specific XML Schema Definition (XSD), select one from the list. If the XSD element is not listed, click Browse to import the XSD file, and select the root element for the request. If no XSD is available for the service, select No Schema.
- Click Finish. The request is added to the Endpoints section of the Request Library.
-
In the Request Library, select the request element.
The generic service client shows three steps: Edit Request, Invoke, and View Response. The details for the request are displayed under the Edit Request step.
-
Based on the request selected in Step 2, on the Message page, use the
Form, Tree, or Source views to edit
the contents of the request.
Each view shows a different format of the same data. To add or remove XML elements in the Form or Tree view, click to comply with an XSD specified in the schema catalog.
-
On the Transport page, if necessary, change the transport configuration to
be used by the request.
To create and edit transport and security configurations, use the Transport tab.
-
If you selected SOAP XML request in step 2, on the Request Stack page,
specify whether you want to override the security or processing algorithms that are applied to the
outgoing request for the WSDL file.
To add a Response Stack page to edit the security or processing algorithms for incoming responses, click Show Response Stack.Note: These settings apply only to the current request. To edit the request or response stack for all requests that use the current WSDL file, click Edit WSDL Security to open the WSDL Security Editor.
-
When you are ready, click Invoke to send the service request.
The generic service client sends the request and displays the message return under the View Response step.