Parameters for the Record Distribution to WebSphere MQ: one-way pattern

Input file
Pattern parameter M C Default Description
Directory of input file Yes Yes  

The location of the input file.

File pattern Yes Yes *

A file name or string containing optional wildcard characters (asterisk (*) or question mark (?)) identifying the file or files to process from the input directory.

Use FTP Yes Yes Cleared

This parameter determines whether FTP is used to retrieve remote files.

FTP configurable service No Yes ftpservice

This configurable service defines how FTP is used to retrieve a remote file.

Input record processing
Pattern parameter M C Default Description
Record detection No No Fixed length (binary or text)

Records are read from the file according to the record detection method that is selected.

Valid values are:

  • Fixed length (binary or text)
  • Delimited (binary or text)
  • Delimited (XML)
  • Parsed (binary or text)
  • Parsed (XML)

If Parsed (binary or text) is selected, the Input message set, Input message type, and Input message format parameters must also be configured.

Record length No No 80

Records of the required length are read from the source file.

Delimiter type No No DOS or UNIX line end

If your data does not use the default, select Custom delimiter (hexadecimal).

Record delimiter No No  

Records that are read from the file are separated by the specified delimiter, which is given in hexadecimal.

This delimiter must be specified as an even number of up to 32 characters, each character must be between 0-9 or A-F (either uppercase or lowercase).

Input message set No No  

Records are read from file based on a definition in this message set.

Input message type No No  

Records are read and parsed according to this message type.

Input message format No No  

Records are read and parsed according to this message format.

CCSID of file Yes Yes Broker system default

This parameter defines the coded character set that is used to interpret bytes of the file that is being read.

Encoding of file No Yes Broker system determined

This parameter defines the encoding scheme for the numbers and large characters that are used to interpret bytes of the file that is being read. Valid values are:

  • Broker system determined
  • Little endian with IEEE floating point (546)
  • Big endian with IEEE floating point (273)
  • Big endian with S390 floating point (785)

For information about encoding, see "Converting data with message flows" in the WebSphere Message Broker documentation.

Routing
Pattern parameter M C Default Description
Routing No No No routing

This parameter defines the routing method to use. 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.

Output queue No Yes OUTPUT

This parameter defines the queue to which all output messages are sent.

Specify routes
Pattern parameter M C Default Description
Default queue manager No Yes

This parameter defines the queue manager to which messages are sent when the criteria for the Specify routes property value are not met.

Default queue No Yes DEFAULT

This parameter defines the queue to which messages are sent when the criteria for the Specify routes property value are not met.

The parameters in the following Namespace table define the namespace prefixes and the namespace URIs that you can use in the XPath expressions that define the key locations for routes. 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.

Namespace table parameter M C Default Description
Namespace prefix Yes No

This parameter defines the tag for a namespace.

Namespace URI Yes No

This parameter defines the namespace for the current tag.

The Namespace table defines the namespaces that are available for you to use in XPath expressions in the Routing table.

Routing table parameter M C Default Description
Key location Yes No

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

This parameter contains the value that the Key location field in the incoming message must match to select this route.

Queue manager No Yes

This parameter defines the queue manager for a routing destination.

Queue Yes Yes

This parameter defines the queue for a routing destination.

Lookup routes
Pattern parameter M C Default Description
Routing data source No Yes

This parameter defines the data source from which a route can be selected. Routing information is looked up in the ROUTING_TABLE table.

Routing data context No No 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

This parameter defines how the first key is extracted from the propagated message element. It 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

This parameter defines how an optional second key is extracted from the propagated message element. It is defined as an ESQL 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.

Default queue manager No Yes

This parameter defines the queue manager to which messages are sent when the criteria for the Lookup routes property value are not met.

Default queue No Yes DEFAULT

This parameter defines the queue to which messages are sent when the criteria for the Lookup routes property value are not met.

Cache refresh No No Cleared

If this parameter is selected, when a refresh message is received the in-memory cache of routing data is refreshed from the data source.

Refresh queue No Yes REFRESH

If Cache refresh is selected, a message that is 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 Logging required is cleared, a Log subflow is not included.

If Logging required is selected, a Log subflow is included in the message flow and 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.

This parameter is required only if Logging required is selected.

Log queue No Yes LOG

This pattern parameter defines the queue for logging.

This parameter is required only if Logging required is selected.

Error handling
Pattern parameter M C Default Description
Error message required No No Selected

This pattern parameter defines whether the pattern application creates the message flow elements that create the error messages.

If Error message required is 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 messages. It can be left blank if the broker queue manager is used for logging.

Error queue No Yes ERROR

This pattern parameter defines the queue for error messages.

This parameter is required only if Error message required is selected.

General
Pattern parameter M C Default Description
Broker schema No No mqsi

If a broker schema is specified, all message flows and ESQL files are created within that schema. If no schema is specified, the default broker 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 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.

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

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 of 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 Record Distribution to WebSphere MQ: one-way pattern specification