Eval Element (Data)

Context: HL Kit … Kit Reference  … Multiple Sources

The "eval" Element

A major facet of data file authoring it defining scripts on components and things for execution during the evaluation cycle. These scripts are referred to as Eval scripts and are invoked on each individual pick within the actor. Each separate script is specified through the use of an "eval" element. The complete list of attributes for this element is below.

NOTE! For more information on limits and sorting, please see Advanced Script Handling.

phase	Id – Specifies the unique id of the evaluation phase during which the script is invoked.
priority	Integer – Specifies the evaluation priority during which the script is invoked.
index	(Optional) Integer – Assigns an arbitrary, but unique, value to this script. This index is used within error messages to identify the script where the problem occurs. If the script is assigned a name (below), no index is necessary. Default: "1".
runlimit	(Optional) Integer – Specifies the maximum number of times this script will be invoked during the evaluation cycle for each container. A value of zero indicates no limit. Default: "0". NOTE! The limit is imposed separately within each container, so the script will always be invoked for picks within different containers.
iseach	(Optional) Boolean – Indicates whether the "runlimit" applies individually to each thing or collectively to all things derived from the component. This attribute is only applicable component scripts. Default: "yes".
sortas	(Optional) Id – Specifies the unique id of a different component for which the script will be sorted when establishing the task evaluation sequence. This attribute is only applicable to component scripts. If empty, the script uses the sequencing for the component it is defined within. Default: Empty.
name	(Optional) Text – Specifies the name assigned to this script for the purpose of establishing timing dependencies. If empty, no timing dependencies may be defined elsewhere that depend upon this script. Default: Empty.
isprimary	(Optional) Boolean – Indicates whether this task should be considered the "primary" task when multiple tasks are assigned the same name. Default: "no".
PCDATA	Script – Specifies the code comprising the Eval script.

The "eval" element also possesses child elements that pertain to the handling of the script. The list of these child elements is below and must appear in the order shown. Click on the link to access the details for each element.

match	An optional "match" element may appear as defined by the given link. This element defines a Match Tag Expression that must be satisfied in order for the script to be assigned to each thing. If omitted, the script is applied to all derived things. IMPORTANT! This element is only applicable when the condition test is defined within a component. In all other cases, this element may not be specified.
before	Zero or more "before" elements may appear as defined by the given link. This element specifies appropriate timing dependencies possessed by the script.
after	Zero or more "after" elements may appear as defined by the given link. This element specifies appropriate timing dependencies possessed by the script.

The "match" Element

The "match" element defines the Match tag expression that determines whether a particular thing is assigned the eval script. The tag expression is applied against each thing derived from the component, and the script is only assigned to things that satisfy the tag expression. The complete list of attributes for this element is below.

PCDATA

TagExpr – Specifies the code comprising the Match tag expression.

Example

The following example demonstrates what an "eval" element might look like. All default values are assumed for optional attributes.

<eval index="1" phase="Setup" priority="500">
  <before name="BeforeTest"/>
  <after name="AfterTest"/>
  debug "Script Executing"
  </eval>