Available Tool Variables |
DEVELOPER |
|
|
Master Object Name |
This is the name of the list object currently being processed. It is Read-Only. |
Master Object Type |
This is the type of the list object currently being processed. It is read-only, and the values currently supported are: (FN) Function |
Master Object Fail Error Message & Status |
These two variables can either be set automatically by the tool when an error occurs, or set by the developer in an action. When either error variable is set, the list object is rejected and all further processing ceases. The error message will be printed in the audit, and if an automatic backup of the list object was made, then the object will be restored from it. |
Alpha & Numeric Scratch Variables 1-10 |
A set of ten Alpha and Numeric variables which can be read or updated by the tool at any time. They can be used to store information from one processed component item to the next, or as flags to trigger subsequent conditional actions. These scratch variables are also exposed to the external update for querying/updating. The scratch variables are automatically reset for each list object processed, but an action also exists to reset them at any time. |
Current Object Nest Level |
This variable is populated when processing an object which forms part of the function structure – i.e. Cycles, Dynamics, Files and Control Breaks. The value of this variable describes the ‘depth’ of the object within the function structure. Primary cycles and their immediate child objects have a nest level of 1. A cycle within the primary cycle and its immediate children will have a nest level of 2, and so on. |
Master Object Number in Process List |
This is the sequence number of the list object currently being processed. |
Total of Master Objects to be Processed |
This is the total number of list objects. The value is not adjusted to take account of any list objects which will be rejected during processing. |
Persistent Alpha & Persistent Numeric Scratch Variables 1-10 |
A set of ten persistent Alpha and Numeric variables which can be read or updated by the tool at any time. They can be used to store information from one processed component item to the next, or as flags to trigger subsequent conditional actions. These scratch variables are also exposed to the external update for querying/updating. These scratch variables are NOT automatically reset for each list object processed, but retain their values for the duration of the tool. Actions exist to reset their values at any time. |
Topic ID: 500024