Adapter for JMS 6.1 SP1 | webMethods Adapter for JMS Documentation | webMethods Adapter for JMS Installation and User’s Documentation | Adapter Services | Configuring Message-to-Document Conversion Services
 
Configuring Message-to-Document Conversion Services
 
Using Message-to-Document Conversion Services
The Adapter for JMS provides services that enable you to convert JMS messages into Integration Server documents. You use these services in combination with the MessageConsumer and MessageRequestor adapter services.
*To configure a message-to-document conversion service
1. Review the steps in Before Configuring or Managing Adapter Services.
2. Start Designer.
Note:
Make sure the server with which you want to use Designer is running.
3. Right-click the package in which the service should be contained and select New > Adapter Service.
4. Select the parent namespace and type a name for the adapter service. Click Next.
5. Select Adapter for JMS as the adapter type and click Next.
6. Select the appropriate Adapter Connection Name and click Next.
7. Select one of the following templates, depending on the type of message to which you want to convert:
*TextMessageToDocument
*ObjectMessageToDocument
*MapMessageToDocument
*BytesMessageToDocument
*StreamMessageToDocument
8. Click Finish.
The service is created and its parameters and controls are displayed in the adapter service editor. You can select the Adapter Settings tab at any time to confirm adapter service properties such as the adapter name, adapter connection name, and adapter service template, as necessary.
9. Select the service's message tab to confirm or define the message body field name, as follows:
*For the TextMessageToDocument service template, select the Text Message tab to confirm that the Body Field Name is called TextMessageBody. Do not change the name of this field. This field contains the message data. It appears in the service's output signature.
*For the ObjectMessageToDocument service template, select the Object Message tab to confirm that the Body Field Name is called ObjectMessageBody. Do not change the name of this field. This field contains the message object. It appears in the service's output signature.
*For the MapMessageToDocument service template, select the Map Message tab to define the message body.
*To define new field names, select the icon.
*To change the order of the fields, use the or icons.
*To delete any field names, use the icon.
Provide values for the rows as follows:
Parameter
Description/Action
Body Field Name
The name of the JMS message body field.
Body Field Type
The data type of the JMS message body field. Select the data type from the list of available data types.
Output Field Type
The Java data type of Output Field Name. Select the data type from the list of available data types.
Output Field Name
The name of the output field.
*For the DocumentToBytesMessage service template, select the Bytes Message tab to define the message body.
*To define new field names, select the icon.
*To change the order of the fields, use the or icons.
*To delete any field names, use the icon.
Provide values for the rows as follows:
Parameter
Description/Action
Body Field Name
The name of the JMS message body field.
Body Field Type
The data type of the JMS message body field. Select the data type from the list of available data types.
Output Field Type
The Java data type of Output Field Name. Select the data type from the list of available data types.
Output Field Name
The name of the input field.
*For the DocumentToStreamMessage service template, select the Stream Message tab to define the message body.
*To define new field names, select the icon.
*To change the order of the fields, use the or icons.
*To delete any field names, use the icon.
Provide values for the rows as follows:
Parameter
Description/Action
Body Field Name
The name of the JMS message body field.
Body Field Type
The data type of the JMS message body field. Select the data type from the list of available data types.
Output Field Type
The Java data type of Body Field Name. Select the data type from the list of available data types.
Output Field Name
The name of the output field.
10. Select the JMS Header tab to configure the JMS Message Header fields that you want the service to expose. If you are not using JMS Header fields, skip this step.
*To define new Message Header parameters, select the icon.
*To change the order of the fields, use the or icons.
*To delete any field names, use the icon.
Provide values for the rows as follows:
Parameter
Description/Action
Header Field Name
The name of the JMS Message header field.
Header Field Type
The data type of the JMS Message header field. Select the data type from the list of available data types.
Output Field Type
The Java type of the Output Field Name. Select the data type from the list of available data types.
Output Field Name
The name of the output field.
11. Select the JMS Properties tab to configure the JMS message property fields that you want the service to expose. If you are not using JMS property fields, skip this step.
*To define new JMS message property fields, select the icon.
*To change the order of the fields, use the or icons.
*To delete any field names, use the icon.
Provide values for the rows as follows:
Parameter
Description/Action
Property Field Name
The name of the JMS message property field.
Property Field Type
The data type of the JMS message property field. Select the data type from the list of available data types.
Output Field Type
The Java data type of the Output Field Name. Select the data type from the list of available data types.
Output Field Name
The name of the output property field.
12. For information about configuring the Input/Output, Settings, Audit, Permissions, and Results tabs, see the webMethods Service Development Help for your release. These tabs apply to all services that you configure using Designer.
13. Select File > Save.