Setup

Setup

The containing element for Variables, InputPanels and Conditions definitions.

All expressions supplied for property values on this element, and any descendants, will be resolved in the context of the ClassLibrary node (see Context nodes and expression syntax).

Variables

The contaiing element for Variable definitions.

Whether a Variable is defined in the global Variables section, the Setup/Variables section, the Setup/InputPanels/Variables section or the Setup/Conditions/Variables section, all Variable definitions exists in the same name and address scope, i.e. they are all referenced by their name. The ability to define variables in different scopes is to allow for logical grouping and improved readiblity of a report definition.

Assuming a Variable is defined in the global section, it can very well be redefined in one of the other sections. This allows to e.g. define a Variable and assign it a default value in the global section, and then conditionally override the value in the Setup/Conditions/Variables, based on input provided by the user.

Definitions of variables follows the same rules (see ) independent of where they are defined.

Setup

The containing element for Variables, InputPanels and Conditions definitions.

All expressions supplied for property values on this element, and any descendants, will be resolved in the context of the ClassLibrary node (see Context nodes and expression syntax).

InputPanels

The containing element for InputPanel definitions.

InputPanel

geicl:id

Assigns an identifier to the InputPanel definition.

All items inside a collection element, such as InputPanels must have an identifier which is unique within the containing collection

name

This property will render as the input panel label

description

This property will render as a tooltip for the input panel

colSpan

The input panels in the export dialog are organized in virtual cells and rows, where full width represents 12 cells. This property controls how many cells the input panel should occupy, default value is 12

newRow

When the value of this property resolves to true, the input panel will render in a new row in the export dialog

disabled

When the value of this property resolves to true, all the input fields in the panel will render as disabled, and will not accept any input

suppress

When the value of this property resolves to true the input panel definition will be excluded from the report definition. The purpose of this property is to exclude or include input panels based on e.g. the value of input variables

geicl:sortOrder

An integer value that controls the order of siblings in the containing collection. To fully understand the impact of using this property.

Variables

The containing element for Variable definitions.

All expressions supplied for property values on this element, and any descendants, will be resolved in the context of the ClassLibrary node (see Context nodes and expression syntax).

Variable

geicl:id

Assigns an identifier to the variable, which can be used to reference the variable value elsewhere in the configuration.

All items inside a collection element, such as Variables must have an identifier which is unique within the containing collection

name

This property will render as the input field label

description

Applicable when the variable is used as an input field in the export dialog.
This property will render as a tooltip for the input field

dataType

This property influences how the input field renders, e.g. dataType="Boolean" will render a checkbox in the user interface. Valid values are:

String

Numeric

Boolean

List (multi select)

Color

colSpan

The input fields in the export dialog are organized in virtual cells and rows, where full width represents 12 cells. This property controls how many cells the input field should occupy, default value is 4

newRow

When the value of this property resolves to true, the input field will render in a new row in the export dialog

disabled

When the value of this property resolves to true, the input field will render as disabled, and will not accept any input

suppress

When the value of this property resolves to true the variable definition will be excluded from the report definition. The purpose of this property is to exclude or include variables based on e.g. the value of other variables

geicl:sortOrder

An integer value that controls the order of siblings in the containing collection. To fully understand the impact of using this property.

required

When the value of this property resolves to true, the input field will appear as mandatory, and the report will not render until a value has been provided

consolidate

When the value of this property resolves to true, the current state of the export dialog will be submitted to the AVEVA ISM server process for evaluation each time the value of the input field is modified. The purpose of this feature is to allow control of the export dialog rendering based on selections made by the user. E.g. if the user clicks a checkbox, other input fields should be disabled or enabled, based on the value of the underlying variable. This evaluation is done by the AVEVA ISM server process when composing the export dialog

Value

An expression that resolves to the value that the variable represents. The value represents the default value for the input field

validValues

Represents a collection of values. When provided, the input field will render as a dropdown list (single-select or multi-select, depending on @dataType).

Values for this property might be provided in different ways:

A literal array: [value1, value2, …, valueN]

Reference to a variable having valid values: $myListOfValues[]

Reference to a Class Library collection: ./Enumerations[myList]/Items

ValidValues

As an alternative to the @validValues property, a variable can have an embedded list of valid value items. When using this construct, a valid value can have both a value and a name

ValidValue

geicl:id

Assigns an identifier to the valid value item.

All items inside a collection element, such as ValidValues must have an identifier which is unique within the containing collection

value

Represents the value of the valid value item. When absent, the item will take geicl:id as value

name

This property will render as the item text in the input field dropdown list

Setup

The containing element for Variables, InputPanels and Conditions definitions.

All expressions supplied for property values on this element, and any descendants, will be resolved in the context of the ClassLibrary node (see Context nodes and expression syntax).

Conditions

The containing element for Conditional definitions.

apply

Resolves to a value that decides how the contained Condition elements should be applied:

Exclusive: The Condition@where expressions will be inspected in sequence, according to geicl:sortOrder, and the first Condition that qualifies will be applied. Remaining sibling Condition elements will be ignored.

Inclusive: All Condition elements, which where expression qualifies, will be applied

Condition

geicl:id

Assigns an identifier to the Condition definition.

All items inside a collection element, such as Conditions must have an identifier which is unique within the containing collection

where

A Boolean expression that decides whether the Condition qualifies

suppress

When the value of this property resolves to true the Condition element will be excluded from the report definition. The purpose of this property is to exclude or include Condition elements based on e.g. the value of input variables

geicl:sortOrder

An integer value that controls the order of siblings in the containing collection. To fully understand the impact of using this property.

Variables

A collection of Variable definitions that will be applied when the containing Condition qualifies

InputPanels

A collection of InputPanel definitions that will be applied when the containing Condition qualifies

Conditions

A collection of nested Condition elements that will be evaluated when the containing Condition qualifies. Conditions can be nested as deep as necessary