Parameters for the Message Correlator for WebSphere MQ: request-response with persistence pattern

Input information
Pattern parameter M C Default Description
Input queue Yes Yes IN This pattern parameter identifies the broker queue on which client requests are received.
Validation of input messages No Yes None This pattern parameter identifies the level of validation that is required for input messages. Valid values are:
  • None
  • Content
  • Content and value
If validation is set to None, the message is treated as an opaque BLOB.

If validation is specified as Content or Content and value, further input information is required, which is used to configure the MQInput node.

This property is configurable in the BAR file. You can configure this property to switch off validation.

You must not use this property to switch on validation unless the request message parameters have been defined.

Input data type No No XML This pattern parameter is required only if the value of Validation of input messages is Content or Content and value. Valid values are:
  • XML
  • Binary data (for example, C or COBOL structures)
  • Text data (for example, CSV, SWIFT, or HL7)
Input message set No No  

This pattern parameter is required only if the value of Validation of input messages is Content or Content and value.

Input message type No No  

This pattern parameter is required only if the value of Validation of input messages is Content or Content and value, and the value of Input data type is Binary data or Text data.

Input message format No No  

This pattern parameter is required only if the value of Validation of input messages is Content or Content and value, and the value of Input data type is Binary data or Text data.

Provider information
Pattern parameter M C Default Description
Provider request queue manager No Yes   This pattern parameter identifies the queue manager on which the provider application receives requests from the broker message flow. It can be left blank if the broker queue manager is used for logging.
Provider request queue Yes Yes PROVIDER This pattern parameter identifies the queue on which the provider application receives requests from the broker message flow.
Maximum response time in tenths of a second Yes Yes No timeout This pattern parameter defines the maximum time to wait for a response.

The default value is No timeout; however, you can enter a positive integer as the value for the timeout period in the same field. The timeout period is measured in tenths of a second and the messages that hold saved MQMD headers are saved with this expiry time.

If the value is No timeout, the responses that are returned to the broker are always returned to the client.

This pattern parameter provides automatic housekeeping for the messages that are left on the queue, but prevents responses from being matched to a client after the time period has elapsed.

Store Queue Yes Yes STORE This pattern parameter defines the queue that is used to store MQMD headers while waiting for a provider response.

This queue is local to the broker.

Response information
Pattern parameter M C Default Description
Response queue Yes Yes RESPONSE This pattern parameter identifies the broker queue on which client requests are received.
Validation of response messages No Yes None This pattern parameter identifies the level of validation required for response messages. Valid values are:
  • None
  • Content
  • Content and value

This property is configurable in the BAR file. You can configure this property to switch off validation.

You must not use this property to switch on validation unless the request message parameters have been defined.

Response data type No No XML This pattern parameter is required only if the value of Validation of response is Content or Content and value. Valid values are:
  • XML
  • Binary data (for example, C or COBOL structures)
  • Text data (for example, CSV, SWIFT, or HL7)
Response message set No No   This pattern parameter is required only if the value of Validation of response is Content or Content and value.
Response message type No No   This pattern parameter is required only if the value of Validation of response is Content or Content and value, and the Response data type is Binary data or Text data.
Response message format No No   This pattern parameter is required only if the value of Validation of response is Content or Content and value, and the Response data type is Binary data or Text 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 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 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 Correlator for WebSphere MQ: request-response with persistence pattern specification