Skip to main content

Value Keywords

Value keywords are used to address additional information of each element and can be used in combination with Context switch keywords. Supported keyword are:

{Name}​

The {Name} keyword returns a string containing the name of the referenced element. While the use of this keyword in a search expression is supported, the simplest way is to use literals.

Example

{name} % 'c4' is equivalent to c4

{topelement}:{name}

The result is a string containing the name of the Main element.

{Template}​

The {Template} keyword returns a string containing the template name of the referenced element.

Examples

{template} % 'gas'

The result is true if the template name contains the string [gas].

{template} = 'SF_GasMeter'

The result is true if the template name is equal to the string [sf_gasmeter].

{inputpath}​

Supported in Studio expressions only. The {inputpath} keyword returns a string containing the full input path of the referenced element. While navigating input connections of an element, the input path contains the parent elements list separated by a slash '\'.

{outputpath}​

Supported in Studio expressions only. The {outputpath} keyword returns a string containing the full output path of the referenced element. While navigating output connections of an element, the output path contains the children elements list separated by a slash '\'.

{attachedpath}​

Supported in Studio expressions only, returns a string containing the attached path of the referenced element, it works with meters and flows only.

{casestart}​

Supported in Studio expressions only. The {casestart} keyword returns the current case start time or the previous case start time, if the {PreviousCase} context switch keywords precede it. If the case is not selected, or the previous case is not associated, then Undefined is returned.

{caseend}​

Supported in Studio expressions only. The {caseend} keyword returns the current case end time or the previous case end time, if the {PreviousCase} context switch keywords precede it. If the case is not selected, or the previous case is not associated, Undefined is returned.

Examples

{casestart}

The result is the current case start time in UTC format.

{previouscase}:{casestart}

The result is the previous case start time in UTC format.

{casesend}

The result is current case end time in UTC format.

{transferstart}​

Supported in Studio expressions only. The {transferstart} keyword returns the transfer start time, if the current element is a transfer. Otherwise, Undefined is returned.

Example:

{transferstart}

The result is the transfer start time in UTC format, if the current element is a transfer and the start time is defined. Otherwise, Undefined is returned.

{transferend}​

Supported in Studio expressions only. The {transferend} keyword returns the transfer end time, if the current element is a transfer. Otherwise, Undefined is returned.

Example:

{transferend}

The result is the transfer end time in UTC format, if the current element is a transfer and the end time is defined. Otherwise, Undefined is returned.

{transfersource}​

Supported in Studio expressions only. The {transfersource} keyword returns the transfer source element name, if the current element is a transfer. Otherwise, Undefined is returned.

{transferdestination}​

Supported in Studio expressions only. The {transfersdestination} keyword returns the transfer destination element name, if the current element is a transfer. Otherwise, Undefined is returned.

Last updated on