IBM MQ service definition properties
You can set properties and attributes for service definitions while creating a new service definition, or when editing an existing service definition.
Some attributes will only be available when the service definition is of a specific binding type or message exchange pattern. Follow these links to view the properties for the individual property pages of a service definition:
- General
- Operation
- Input destination
- Input message schema
- Input message header
- Output destination
- Output message schema
- Output message header
For each attribute, there is a brief description of when you might need to configure the attribute.
General page
The following table lists the attributes you can set on the General page of the Service definition properties dialog.
Attribute | Description |
---|---|
Namespace | Specifies the namespace for the service. There is already a temporary default value assigned. |
Name | A unique name for the new Service Definition. The service definition name is not case sensitive, but a mixed-case service definition name is retained. |
Message exchange pattern | The Message Exchange Pattern describes the direction
of messages sent and received during the invocation of a service.
There are two possible selections:
|
Binding type | Specifies the version of the IBM® MQ service definition specification. |
Comment | Specify a comment to annotate the service in the WSDL file. |
Operation page
The following table lists the attributes you can set on the Operation page of the Service definition properties dialog. Each service definition has only 1 operation.
Attribute | Description |
---|---|
Operation name | Specifies the name of the operation. This property must have a value to create a service definition. |
Action | Used by the service provider to dispatch service requests. For example:
Allowing multiple services to be deployed using a single destination, enabling a service provider to
dispatch the requests arriving on the destination appropriately. When the binding type is MQ, Action specifies targetAction. |
Comment | Specify a comment to annotate the operation in the WSDL file. |
Input destination page
The following table lists the attributes you can set on the Input Destination page of the Service definition properties dialog. The input pages define the details of the message that the service expects, and the destination where it will be retrieved from.
Attribute | Description |
---|---|
Input destination name | Specifies the name of the destination queue or the destination topic to which the request is
sent, for example: The queue-dest or topic-dest particle of an IBM MQ IRI, such
as:
|
Destination queue manager name | Specifies the name of the destination queue manager. |
Connection queue manager | Specifies the name of the queue manager to which the requesting service connects to. This corresponds to the QmgrName parameter used on the MQCONN() and MQCONNX() calls. |
Client connection properties | The client connection properties specify detailed bindings which can include information about how a service requester binds to a specific machine or channel. Being able to specify client-bindings and channel names is useful in some circumstances, but over-specifying the service might be restrictive however. A solution to this problem is to minimize the amount of binding information incorporated into a service definition and allow underlying infrastructure or IBM MQ to route messages where possible. |
Channel table name | Specifies the name of the client channel table
file which is used to identify the channel connection.
|
Channel table library | Specifies the path to the client channel table.
|
Client channel connection name | Specifies the connection string used when a service requester makes an IBM MQ MQI client-binding connection. For TCP/IP, the connection
is in the form of a host name followed by a port number, for
example:
If the port number is not specified, a default value of
1414 is used.
|
Client channel name | Specifies the channel used when an IBM MQ service requester make an IBM MQ MQI client-binding connection.
|
Client channel transport type | Specifies the transport type to be used when an IBM MQ service requester makes an IBM MQ MQI client-binding connection.
|
Input message schema page
The following table lists the attributes you can set on the Input message schema page of the Service definition properties dialog. They allow the schema for the message payload to be defined.
Attribute | Description |
---|---|
Inbound data type | Specifies the expected inbound data type. For simple types,
this can be modelled using the built-in XML xsd types such as xsd:string or xsd:int .
For more complex types, a data type can be imported from an external
file by specifying the Import schema file and Import
namespace for the data type. |
Import schema file | Specifies the schema file to be imported. |
Import namespace | Specifies the namespace to be imported. |
Input message header page
The following table lists the attributes you can set on the Input message header page of the Service definition properties dialog. The input pages define the details of the message that the service expects, and the destination where it will be retrieved from. Some of the properties only apply to service definitions of an MQ binding type.
Attribute | Description |
---|---|
CCSID | Specifies the Coded Character Set ID which corresponds to the CodedCharSetId field in the MQMD structure. If this value is not specified, then the service requester and service provider uses the value which corresponds to the character set of the message data. |
Format | Specifies the format name of the message data. This property corresponds to
the MQRFH2 format field, or the MQMD format field if there is
no MQRFH2 is present. The value must be a character string between 0 and 8
characters long consisting of the A-Z and 0-9 characters. The Format can be set to any value according to the guidelines in the Format field. |
User properties | Specifies the user defined data carried in IBM MQ service messages. Values must be specified in the format
allowed for RFH2 folder elements; in a series of triplets encoded using an XML-like syntax such as:
The
dt="datatype " element is optional, and if it is omitted, it is treated as a string,
allowing elements to be specified as:
For
example:
For further information on the allowed data types and formatting, see NameValueData ( MQCHARn ) in IBM Knowledge Center.
It is not recommended to include security sensitive
properties such as UserId or passwords. |
Message type | Specifies the type of message that is sent.
This property corresponds to the MsgType in the MQMD structure.
The five possible values are:
|
Persistence | Specifies whether the message is persistent
or not, and it corresponds to the Persistence field
in the MQMD structure. The three possible values
are:
|
Message ID | Specifies the Message identifier which corresponds to the
MsgId field in the MQMD structure. The Message ID allows certain specialized IBM MQ applications to be described as services (for example: applications that share an input queue and select the messages intended for them based on a pre-defined msgId value). Predefined msgIds in service definitions might lead to problems such as when a request-response Message Exchange Pattern return the request's msgId. The Message Id can be either a character string or a binary value. Binary values must be a string of up to 24 pairs of two-character hexadecimal values.Click Edit to open a dialog and enter a value as text or bytes |
Correlation ID | Specifies the Correlation ID corresponds to
the CorrelId field in the MQMD structure. The Correlation ID can be
either a character string or a binary value. Binary values must be
a string of up to 24 pairs of two-character hexadecimal values. Click Edit to open a dialog and enter a value as text or bytes |
Expiry | Specifies the message lifetime. It must be a
signed integer, and it is measured in tenths of a second. The Expiry range
is from 1 to 2 147 483 647. A special value of Unlimited is used to indicate that the message does not expire. The value of -1 is written to the WSDL file. A value of Unspecified means that no value is written to the WSDL file. This is the default value. |
Priority | Specifies the priority associated with the message
and corresponds to the priority field in the MQMD structure.
It must be specified as an integer between 0 and 9, with 0 as the
lowest priority and 9 as the highest priority. A special value of Unlimited is used to indicate that the message priority is taken from the definition of the first queue that the message is put to. The value of -1 is written to the WSDL file. A value of Unspecified means that no value is written to the WSDL file. This is the default value. |
Encoding | Specifies the numeric encoding of message data,
which corresponds to the Encoding field in the
MQMD structure:
|
Report options | Specifies how the message and correlation identifiers
in the reply message or fault message are set by the service provider.
This property corresponds to the Report field in the MQMD structure.
There are four possible values:
|
Output destination page
The following table lists the attributes you can set on the Output destination page of the Service definition properties dialog. The output pages define the details of the message that the service will send in response to the input message, and the destination where it will be put. The output destination name must be prefixed with 'msg/queue/' for queues, or 'msg/topic/' for topics.
Attribute | Description |
---|---|
Output destination name | Specifies the name of the destination queue or the destination topic to which the response
message is sent, and corresponds to the ReplyToQ and ReplyToQMgr fields of the MQMD structure. The
Destination Name must take the form of either the queue-dest or topic-dest particle of an IBM MQ URI, such
as:
|
Destination queue manager name | Specifies the name of the destination queue manager. |
Connection queue manager | Specifies the name of the queue manager to which the requesting service connects to. This corresponds to the QmgrName parameter used on the MQCONN() and MQCONNX() calls. |
Client connection properties | The client connection properties specify detailed bindings which can include information about how a service requester binds to a specific machine or channel. Being able to specify client-bindings and channel names is useful in some circumstances, but over-specifying the service might be restrictive however. A solution to this problem is to minimize the amount of binding information incorporated into a service definition and allow underlying infrastructure or IBM MQ to route messages where possible. |
Channel table name | Specifies the name of the client channel table
file which is used to identify the channel connection.
|
Channel table library | Specifies the path to the client channel table.
|
Client channel name | Specifies the connection string used when a service requester makes an IBM MQ MQI client-binding connection. For TCP/IP, the connection
is in the form of a host name followed by a port number, for
example:
If the port number is not specified, a default value of
1414 is used.
|
Client channel connection name | Specifies the channel used when an IBM MQ service requester make an IBM MQ MQI client-binding connection.
|
Client channel transport type | Specifies the transport type to be used when an IBM MQ service requester makes an IBM MQ MQI client-binding connection.
|
Output message schema page
The following table lists the attributes you can set on the Output message schema page of the Service definition properties dialog. They allow the schema for the message payload to be defined.
Attribute | Description |
---|---|
Outbound data type | Specifies the expected outbound data type |
Import Schema File | Specifies the schema file to be imported |
Import Namespace | Specifies the namespace to be imported |
Output message header page
The following table lists the attributes you can set on the Output message header page of the Service definition properties dialog. The output pages define the details of the message that the service will send in response to the input message, and the destination where it will be put. Some of the properties only apply to service definitions of an MQ binding type.
Attribute | Description |
---|---|
CCSID | Specifies the Coded Character Set ID which corresponds to the CodedCharSetId field in the MQMD structure. If this value is not specified, then the service requester and service provider uses the value which corresponds to the character set of the message data. |
Format | Specifies the format name of the message data. This property corresponds to
the MQRFH2 format field, or the MQMD format field if there is
no MQRFH2 is present. The value must be a character string between 0 and 8
characters long consisting of the A-Z and 0-9 characters. The Format can be set to any value according to the guidelines in the Format field. |
User properties | Specifies the user defined data carried in IBM MQ service messages. Values must be specified in the format
allowed for RFH2 folder elements; in a series of triplets encoded using an XML-like syntax such as:
The
dt="datatype " element is optional, and if it is omitted, it is treated as a string,
allowing elements to be specified as:
For
example:
For further information on the allowed data types and formatting, see NameValueData ( MQCHARn ) in IBM Knowledge Center.
It is not recommended to include security sensitive
properties such as UserId or passwords. |
Message type | Specifies the type of message that is sent.
This property corresponds to the MsgType in the MQMD structure.
The five possible values are:
|
Persistence | Specifies whether the message is persistent
or not, and it corresponds to the Persistence field
in the MQMD structure. The three possible values
are:
|
Message ID | Specifies the Message identifier which corresponds to the
MsgId field in the MQMD structure. The Message ID allows certain specialized IBM MQ applications to be described as services (for example: applications that share an input queue and select the messages intended for them based on a pre-defined msgId value). Predefined msgIds in service definitions might lead to problems such as when a request-response Message Exchange Pattern return the request's msgId. The Message Id can be either a character string or a binary value. Binary values must be a string of up to 24 pairs of two-character hexadecimal values.Click Edit to open a dialog and enter a value as text or bytes |
Correlation ID | Specifies the Correlation ID corresponds to
the CorrelId field in the MQMD structure. The Correlation ID can be
either a character string or a binary value. Binary values must be
a string of up to 24 pairs of two-character hexadecimal values. Click Edit to open a dialog and enter a value as text or bytes |
Expiry | Specifies the message lifetime. It must be a
signed integer, and it is measured in tenths of a second. The Expiry range
is from 1 to 2 147 483 647. A special value of Unlimited is used to indicate that the message does not expire. The value of -1 is written to the WSDL file. A value of Unspecified means that no value is written to the WSDL file. This is the default value. |
Priority | Specifies the priority associated with the message
and corresponds to the priority field in the MQMD structure.
It must be specified as an integer between 0 and 9, with 0 as the
lowest priority and 9 as the highest priority. A special value of Unlimited is used to indicate that the message priority is taken from the definition of the first queue that the message is put to. The value of -1 is written to the WSDL file. A value of Unspecified means that no value is written to the WSDL file. This is the default value. |
Encoding | Specifies the numeric encoding of message data,
which corresponds to the Encoding field in the
MQMD structure:
|
Report options | Specifies how the message and correlation identifiers
in the reply message or fault message are set by the service provider.
This property corresponds to the Report field in the MQMD structure.
There are four possible values:
|