MSMQ Adapter 6.0 | webMethods MSMQ Adapter Documentation | webMethods MSMQ Adapter Installation and User’s Guide Documentation | Adapter Services | Configuring Get Services
 
Configuring Get Services
A Get service retrieves and removes a message from a specified queue. You configure MSMQ Adapter services using Designer. The input and output signatures for a Get service are located on the Input/Output tab of Designer.
When you configure a Get service, the Input document is generated automatically in the input signature of the Get service on the Input/Output tab. MSMQ Adapter passes the input fields from theFilter tab in Designer to the input signature.
The Output document also is generated automatically in the output signature of the Get service on the Input/Output tab. The document contains the Body and the output fields from the Output Message Properties tab in Designer to the output signature.
For more information about Get services, see Get Service.
*To configure a Get service
1. Review the steps in Before Configuring or Managing Adapter Services.
2. Start Designer.
3. Using Designer, perform the following:
a. Right-click the package in which the service should be contained and select New > Adapter Service.
b. Select the parent namespace and type a name for the adapter service.
c. Click Next.
4. Select MSMQ Adapter as the adapter type and click Next.
5. For Adapter Connection Name, select a connection with an inbound queue access mode, and then click Next.
Important:
If you are using the adapter with Integration Server 8.0 SP1 or earlier, adapter services cannot use connections that are also used for adapter listeners.
6. From the list of available templates, select the Get template and using Designer, click Finish.
The adapter service editor for the Get service appears. You can select the Adapter Settings tab at any time to confirm adapter service properties such as Adapter Name, Adapter Connection Name, and Adapter Service Template, as necessary.
7. Select the Get Service tab to identify optional message processing features to use with this adapter service. Set the fields as follows:
Field
Description/Action
Timeout
Time period that the message queuing waits for a message to arrive. Enter this value in milliseconds.
Reset
Check to move the cursor to the front of the queue.
8. Select the Filter tab to specify how messages will be identified. The selected fields refer to the specific properties that must be present in the message for the adapter to retrieve it from the MSMQ queue.
a. From the drop-down menu, select one of the following Message Filtering Modes:
*MATCH_ONE - Any one of the selected properties can be used to identify the message.
*MATCH_ALL - All selected properties will be used to identify the message.
Note:
If none of the properties are selected, all messages will pass the filter criteria.
b. Use the following icons to manage the rows in the Property column:
*To define new property fields, select the icon (or the icon).
*To ensure that the parameters are parsed in the correct order, use the or icons to change the order of the property fields or the output field names.
*To delete any property fields or output field names, click the icon.
You can add the following property fields:
Property
Property Type
Description
MessageId
java.lang.String
Identifies the message using hex string.
MessageIdByteArray
byte array
Identifies the message using an MSMQ-generated 20-byte message identifier.
CorrelationId
java.lang.String
Identifies the message using a hex string correlation identifier. For example, {F944A0B1-1DA0-4A93-A266-E54ACDD55342}\30775.
CorrelationIdByteArray
byte array
Identifies the message using a 20-bytes correlation identifier.
Delivery
java.lang.Integer
Specifies how Message Queuing delivers the message. Valid values are:
*1 - indicates that along its route, the message is stored locally on disk until it is forwarded to the next computer.
*0 - indicates that along its route, the message stays in volatile memory until it is received.
Priority
java.lang.Integer
Specifies the message priority. The value is between 0 - 7. The lower number indicates lower priority. Default: 3.
Note:
Message Queuing automatically sets the priority level of the transactional messages to 0, which indicates that the priority is ignored by the transaction.
AppSpecific
java.lang.Integer
Specifies application-generated single integer values.
9. From the Output Message Property tab, select which property fields the service will return after the service is executed.
You can add the following fields to the Property column:
Property
Property Type
Description
Ack
java.lang.Integer
Specifies the type of acknowledgment messages that Message Queuing will post in the administration queue when acknowledgments are requested.
AdminQueuePathName
java.lang.String
Specifies the queue path name used for Message Queuing-generated acknowledgment messages.
AdminQueueFormatName
java.lang.String
Specifies the queue format name used for Message Queuing-generated acknowledgment messages.
AppSpecific
java.lang.Integer
Specifies application-generated single integer values.
ArrivedTime
java.lang.String
Specifies the time when the message arrives in the queue.
CorrelationId
java.lang.String
Identifies the message using a hex string correlation identifier. For example, {F944A0B1-1DA0-4A93-A266-E54ACDD55342}\30775.
CorrelationIdByteArray
byte array
Identifies the message using a 20-byte correlation identifier.
Delivery
java.lang.Integer
Specifies how Message Queuing delivers the message. Valid values are:
*1 - indicates that along its route, the message is stored locally on disk until it is forwarded to the next computer.
*0 - indicates that along its route, the message stays in volatile memory until it is received.
DestinationQueuePathName
java.lang.String
Specifies the destination queue path name of the message
DestinationQueueFormatName
java.lang.String
Specifies the destination queue format name of the message.
MessageId
java.lang.String
Identifies the message using a hex string.
MessageIdByteArray
byte array
Identifies the message using an MSMQ-generated 20-byte message identifier.
IsAuthenticated
java.lang.Integer
Indicates whether the message was authenticated at the request of the sending application. Valid values are:
*1 - the message is authenticated
*0 - the message is not authenticated
IsFirstInTransaction
java.lang.Integer
Indicates whether the message was the first message sent in its transaction. Valid values are:
*1 - the message is first
*0 - the message is not first
IsLastInTransaction
java.lang.Integer
Indicates whether the message was the last message sent in its transaction. Valid values are:
*1 - the message is last
*0 - the message is not last
Label
java.lang.String
Provides a description of the message.
Journal
java.lang.Integer
Specifies whether Message Queuing stores copies of the message as it is routed to the destination queue. Valid values are:
*0 - the journal is disabled
*1 - the message is stored in the applicable dead-letter queue on failure
*2 - a copy of the message is stored in the computer journal if the message was successfully delivered to the next computer
MaxTimeToReachQueue
java.lang.Integer
Specifies the time limit (in seconds) for a message to reach the queue.
MaxTimeToReceive
java.lang.Integer
Specifies the time limit (in seconds) for a message to be retrieved from the target queue.
MsgClass
java.lang.Integer
Indicates the message type.
Priority
java.lang.Integer
Specifies the message priority. The value is between 0 - 7. The lower number indicates lower priority. Default: 3.
Note:
Message Queuing automatically sets the priority level of the transactional messages to 0, which indicates that the priority is ignored by the transaction.
SendTime
java.lang.String
Indicates when the message is sent.
SourceMachineGuid
java.lang.String
Indicates the GUID of the computer that sent the message.
10. When using Designer, Designer contains only the Adapter Settings and Input/Output tabs. The information from the Audit and Permissions tabs appears in the Properties panel, and the information from the Results tab appears in the Service Results panel (in Designer). For more information, see the webMethods Service Development Help for your release.
11. From the Filemenu, select Save.