Parameters for the Message Splitter for WebSphere MQ: one-way (for XML) pattern

Input information
Pattern parameter M C Default Description
Input queue Yes Yes IN This pattern parameter identifies the broker queue on which the XML messages are received.
Container name Yes No *:* The path of the container element that is in the incoming XML message that holds the elements to extract. This path is specified with syntax like ESQL, but includes only the elements from the XML; for example, SalesData.Invoices.

The namespace can be given in full but, unless you are required to distinguish between two container elements of the same name but with different namespaces, namespaces can be given as a wildcard; for example, *:SalesData.*:Invoices.

If the default value, *:*, is used, the root element of the XML message is assumed and it can have any name.

Message element name Yes No *:* The name of the elements that are extracted from the incoming message.

If the default value, *:*, is used, any children of the container are accepted.

Namespaces must not be specified because it is assumed that any element of the given name is required regardless of namespace.

Routing
Pattern parameter M C Default Description
Routing No No No Routing Valid values are:
  • No Routing
  • Specify Routes
  • Lookup Routes
No routing
Pattern parameter M C Default Description
Output queue manager No Yes   This parameter defines the queue manager to which all output messages are sent. If left blank, the default is the broker queue manager.
Output queue No Yes OUT This parameter defines the destination queue.
Specify routes

The parameters in the following optional Namespace table, define the namespace prefixes and namespace URIs that you can use to define the key locations for routes in the XPath expressions. If a row is included, both of the parameters must be included. You can add, edit, and delete values, and change the order of the values in the table.

Pattern parameter M C Default Description
Namespace prefix Yes No Not applicable The Namespace prefix parameter is included in the XPath Key location parameter in the definition of routes.
Namespace URI Yes No Not applicable The Namespace URI is the namespace associated with the specified prefix.

The parameters in the following Routing table define the output destinations and rules if the value of the Routing parameter is Specify Routes. Four parameters can be used to define a route and these can be repeated for as many routes as required. You can add, edit, and delete values, and change the order of the values in the table.

Pattern parameter M C Default Description
Key location Yes No Not applicable

A key location is an XPath expression that defines a location within the record that is being propagated. For example, $Root/XMLNSC/submitPORequest/partNo.

For more information about the type of expression to use, see "Route node" and "Using XPath" in the WebSphere Message Broker documentation.

Namespaces can be included if they are specified in the optional Namespace table.

Key value Yes No Not applicable This parameter contains the value that the Key location field in the incoming message must match to select this route.
Queue manager Yes Yes   This parameter defines the queue manager for this routing destination. If left blank, the default is the broker queue manager.
Queue Yes Yes Not applicable This parameter defines the queue for this routing destination.
Lookup routes
Pattern parameter M C Default Description
Routing data source No Yes Not applicable This parameter defines the data source from which a route can be selected. Routing information is looked up in the ROUTING_TABLE table.
Routing context No No Not applicable This parameter defines a routing context so that you can use a ROUTING_TABLE for more than one mediation flow.

Only rows in which the ROUTING_CONTEXT field matches the Routing data context value are selected for routing lookup and are added to the in-memory cache.

Key location 1 No No Not applicable This parameter defines how the first key is extracted from the propagated message element. This parameter is defined as an ESQL expression.

The first key is used to select on VARIABLE1 in a data source routing entry. The location must be in the form InputBody or InputRoot.

Key location 2 No No Not applicable This parameter defines how an optional second key is extracted from the propagated message element. This parameter is defined as an ESQL field reference expression.

The second key is used to select on VARIABLE2 in a data source routing entry. The location must be in the form InputBody or InputRoot.

Cache refresh No No Cleared If this parameter is selected, the in-memory cache of routing data is refreshed from the data source when a refresh message is received.
Refresh queue No Yes REFRESH If Cache refresh is selected, a message sent to this queue triggers a refresh of the in-memory routing data.
Logging
Pattern parameter M C Default Description
Logging required No No Cleared This pattern parameter determines whether the pattern instance includes the code for logging.

If cleared, the logging subflow is not included.

If selected, values must be set for Log queue manager and Log queue.

Log queue manager No Yes   This pattern parameter defines the queue manager for logging. It can be left blank if the broker queue manager is used for logging.

It is required only if Logging required is selected.

Log queue No Yes LOG This pattern parameter defines the queue for logging.

It is required only if Logging required is selected.

Error handling
Pattern parameter M C Default Description
Error message required No Yes Selected This pattern parameter determines whether the pattern instance includes the code for placing error messages on a queue.

If selected, values must be set for Error queue manager and Error queue.

Error queue manager No Yes   This pattern parameter defines the queue manager for error logging.

It is required only if Error message required is selected.

Error queue No Yes ERROR This pattern parameter defines the queue for error messages.

It is required only if Error message required is selected.

Bad message action No No Save This parameter defines the action that is taken when a message element cannot be routed. Valid values are:
  • Save
  • Cancel

If Save is selected, any message elements that cannot be routed are placed on the Bad message queue.

If Cancel is selected and a message element cannot be routed, the entire message flow is rolled back.

Bad message queue manager No Yes   This pattern parameter defines the queue manager for saving message elements that cannot be routed. If left blank, the default is the broker queue manager.

This parameter is required only if the value of the Bad message action parameter is Save.

Bad message queue No Yes BAD This pattern parameter defines the queue for saving message elements that cannot be routed.

This parameter is required only if the value of the Bad message action parameter is Save.

General
Pattern parameter M C Default Description
Broker schema No No mqsi If set, all message flows and ESQL files are created in the named broker schema. If not set the default schema is used.
Flow prefix No No   If set, this prefix is added to the beginning of all message flow names.
Flow suffix No No   If set, this this suffix is added to the end of all message flow names.
Queue prefix No No   If set, this prefix is added to the beginning of all queue names.

If default queue names are used, the prefix, suffix, or both, must be set to identify queue names for each pattern instance.

Queue suffix No No   If set, this suffix is added to the end of all queue names.
Short description No No   This description is added to the Short description property of all message flows that are generated.
Long description No No   This description is added to the Long description property of all message flows that are generated.

All the pattern parameters are listed with their default values.

The column headed M indicates whether the property is mandatory. The column headed C indicates whether the property is configurable, meaning that you can change the value when you add the message flow to the broker archive (BAR) file.

Where no default is indicated the default value is an empty string.

Back to the Message Splitter for WebSphere MQ: one-way (for XML) pattern specification