Service MQ form
|
|
Use the Response tab to define data sent as part of the outgoing response message. The system maps data from the clipboard to fields of the message header or data values in the message buffer. By specifying various response conditions on this tab, the MQ service can return response messages of different types and formats.
At runtime, the system evaluates the array of response conditions in order, and returns response data to the client from the first condition that evaluates to True
.
Two arrays of fields are associated with each condition. Click the Expand icon to access these fields, which are initially hidden. Click the Collapse icon to hide them.
Field |
Description |
Response Condition | |
Condition |
Specify a condition that determines the format and content of the response message:
If a runtime mapping error, security error or service error exception occurs but this array does not include an entry for that exception condition, the system returns a standard error report message to the client application. Tip: It is a best practice to configure the error conditions to ensure that the system notifies an administrator about the error. |
When Name |
If the Condition value is |
Requestor Options |
Indicate whether the system is to keep this requestor session open or close it after the response message is sent for this condition. |
Header fields |
Click the Expand icon to access these fields. |
Field Name |
Select a message header field from the selection list. |
Description |
Enter a text description. |
Map From |
Select how the system creates response header values:
If more choices appear, they identify a custom function rule in a |
Map From Key |
If the Map From value is If the Map From value is |
Message Data | |
Data Type |
Enter the external data type of the response parameter: To write the entire message buffer as one variable-length text or binary data, specify |
Offset |
Optional. Enter a number of bytes. At runtime, the system positions the internal cursor within the buffer to this position before it writes the data. |
Length |
Optional. Complete this field only for
At runtime, the system examines the length of the data value. If the data value is longer than the specified length, the data value is truncated. If it is shorter, the value is padded with white space (for If you don't specify a data length, the system writes an integer representing the actual string length into the data buffer immediately before it writes the data value. |
Description |
Enter a text description. |
Map From |
Select how the system creates request parameter values. The choice you make for this field depends on what you select for Data Type:
If more choices appear, they identify a custom function rule in a |
Map From Key |
Enter additional details that complete the Map From mapping:
|
The Pega Platform examines information in the arriving message, as well as the results of evaluating this Response tab, to determine whether to send a reply MQ message. The table below shows this computation.
Request type
|
Reply to Q and
|
Evaluation of
|
Result |
N | N | N | No reply. |
N | N | Y | No reply, warning message added to the Pega Platform log. |
N | Y | N | No reply. |
N | Y | Y | Normal reply, information message added to log. |
Y | N | N | No reply, warning message added to log. |
Y | N | Y | No reply, warning message added to log. |
Y | Y | N | Reply with empty message, information message added to the Pega Platform log. |
Y | Y | Y | Reply. |