Administrator Command
Reference Manual
Transaction Database
: TRMESS, TRSUCC, and TRFAIL Elements
TRMESS, TRSUCC, and TRFAIL Elements
The TRMESS, TRSUCC, and TRFAIL elements are for Messages, Successes and Failures respectively.
Operations and Output Commands are able to have any number of messages attached to them. They will be generated by Local operation during their execution and be stored. Remote operations will receive messages from their output commands that will:
•
generate messages relating to transaction events (sends, acknowledgements etc.)
•
receive messages from the execution of commands at other site
•
receive transaction event messages forwarded through other site remote operations.
Operations and output commands have a TRSUCC attribute stating a success or (relative) failure. Each point of failure will generate a single TRFAIL element (e.g. failure to claim an element). Each point of success will generate a single TRSUCC element (E.g. an element claimed).
The attributes of TRSUCC and TRFAIL elements are equivalent. They include:
•
A Reference to an element involved in the operation (e.g. the ref of a claimed element)
•
A double integer code relating to an AVEVA E3D™ message or error (0,0 if not known or relevant)
•
A text string which is a representation of the said message or error.
•
An integer qualifier to be used for such things as session numbers etc.
The result of a command (TROUCO) is the sum of all TRSUCC and TRFAIL elements owned by its operations and output commands. All of these are communicated back to either the user (if it is a local command) or propagated to the originating site (if it is a foreign command). In the latter case the compounded errors will appear under the relevant originating TROUCO operation and hence onwards and upwards
Whether a TROPER itself is classed as a success is determined by its execute method. Input Commands are successes if all its operations AND output commands are successes. An output Command is a success if the input command it spawned returns a success. Results are only passed on to the generating TROUCO when the input command is totally finished.
Messages are sent immediately they are generated before waiting for operation or command conclusion. They go the same route as the result, being compounded by a TROUCO and transmitted to other site TROPER elements. They are only stored under the final TRINCO generated from a USER command.
Attributes for Elements %TRSUCC and %TRFAIL
DATEMS
date
Date success/failure raised.
MESNUM[2]
int[2]
Message/error number relating to MSTEXT or 0,0 if none available. This can be used as an indication of the severity of a failure.
MSTEXT
text
Any result text (not passed on).
MSTYPE
int
Data type indicates significance of MESQUA, MSREF, MSDTXT.
MESQUA
int
Data qualifier.
MESREF
ref
Data refno corresponding to the error.
MSDTXT
text
Data text of the result/error.
MSLOC
text
Name of location that generated the success/failure
TRCNUM
int
Source command type number (if generated by a TRINCO).
TRONUM
int
Source operation type number (if generated by a TROPER).
TRTYPE
text
Pseudo-attribute, which combines the OPTYPE (Operation Number) and COMMTYPE (Command Number) attributes.
Allows you to query the member operations of a command independently of whether the operations are TROUCO or TROPER. It combines the TRCNUM and TRONUM queries (these are attributes of TROUCO and TROPER respectively).
Attributes for Element %TRMESS
DATEMS
Date
Date success/failure raised.
MESNUM[2]
int[2]
Message/error number relating to MSTEXT or 0,0 if none available.
MSTEXT
Text
Message text.
MSLOC
text
Name of location that generated the success/failure.
MSSENT
log
Unused.
TRCNUM
int
Source command type number (if generated by a TRINCO).
TRONUM
int
Source operation type number (if generated by a TROPER).
TRTYPE
text
Pseudo-attribute, which combines the OPTYPE (Operation Number) and COMMTYPE (Command Number) attributes.
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.
