Parameters for the Service Access from WebSphere MQ: one-way pattern

Input information
Pattern parameter M C Default Description
Input queue Yes Yes IN This pattern parameter identifies the broker queue on which client input messages are received.
Validation of input messages No Yes None This pattern parameter identifies the level of validation required for requests. Valid values are:
  • None
  • Content
  • Content and Value
Input message set No No This pattern parameter is used to configure the message set for the Input node in the main message flow.
Service information
Pattern parameter M C Default Description
WSDL for the service provider Yes No This parameter defines the deployable WSDL file that defines the interface of the service for which WebSphere MQ access is being provided.

This value must include the path name starting at the workspace message set project.

URL of the service provider No Yes This parameter defines the endpoint of the service for which WebSphere MQ access is being provided.

If not specified, the endpoint is determined from the binding information in the WSDL file.

Maximum response time in seconds Yes Yes 120 This parameter defines the maximum time that the broker service request waits for a response.
Logging
Pattern parameter M C Default Description
Request logging required No No Cleared This pattern parameter determines whether the pattern instance includes the code for logging.

If Request logging required and Response logging required are both cleared, the logging subflow is not included.

If Request logging required is selected, a logging subflow is included in the message flow and values must be set for Log queue manager and Log queue.

If this parameter is set, all messages that are successfully submitted to the target service are logged.

Response logging required No No Cleared This pattern parameter determines whether the pattern instance includes the code for logging.

If Request logging required and Response logging required are both cleared, the logging subflow is not included.

If Response logging required is selected, a logging subflow is included in the message flow and values must be set for Log queue manager and Log queue.

If this parameter is set, all replies from the target service are logged.

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 Request logging required or Response logging required is selected.

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

This parameter is required only if Request logging required or Response logging required is selected.

Error handling
Pattern parameter M C Default Description
Error action No No Error queue This pattern parameter defines the action to take when errors are detected.

If Error action is set to Error queue, the code to write error messages is included in the pattern instances and, by default, data in the incoming message is saved and written to the nominated error queue. Events are not written to the event log; if you want diagnostic information, select Error notification.

If Error action is set to Roll back, errors cause the input messages to roll back. If this action is selected, the input queue must be configured with a backout queue, and the events leading to the rollback are recorded in the event log. Rollback also occurs if the called service returns a fault.

If this option is selected, no error queue is configured.

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 to persist messages that have caused an error.
Error notification No No Cleared This pattern parameter defines whether error notifications are generated when errors are detected.

If Error notification is selected, a notification message containing a summary of the error is written to the error notification queue. If the error is caused by a fault response from the service, a summary of the fault is included in the summary of events.

Error notification queue manager No Yes This pattern parameter defines the queue manager for error notification messages. It can be left blank if the broker queue manager is used for notifications.
Error notification queue No Yes NOTIFYERROR This pattern parameter defines the queue for error notification messages.
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 Service Access from WebSphere MQ: one-way pattern specification