run-result indication

From The x3270 Wiki

A b3270 protocol message that indicates completion of a run operation.

Attribute/Member Always present? Type Purpose
r-tag no string Tag supplied to the run operation, if any
success yes Boolean true or false
text no XML: string
JSON: array(string)
result text or error message
text-err yes XML: string
JSON: array(Boolean)
New in 4.4 error text mapping
abort no Boolean true or false
time yes number execution time in seconds (with a decimal fraction)

text may span multiple lines. In XML, they are separated by &#10 (newline) characters. In JSON, each line is an element of an array.

New in 4.4 text-err indicates which lines of the output are errors. In XML it is a string consisting of comma-separated values of either true or false. In JSON, it is an array of Boolean values. There is one element per line of output. If a text-err element value is true, then the corresponding text line is an error message.

If abort is true, the operation was aborted, and all associated resources should be cleaned up.

Example (XML)

<run-result r-tag="ui-432" success="true" text="well done&#10;really" time="0.001"/>

New in 4.4 Example of distinguishing errors from ordinary output. The actions run were Set(tls992) Foo().

<run-result success="false" text="true&#10;Unknown action: Foo" text-err="false,true" time="0"/>

Example (JSON)

New in 4.2

{"run-result':{"r-tag":"ui-432","success":true,"text":["well done","really" ],"time":0.001}}

New in 4.4 Example of distinguishing errors from ordinary output. The actions run were Set(tls992) Foo().

{"run-result":{"success":false,"text":["true","Unknown action: Foo"],"text-err":[false,true],"time":0}}