General

Properties

Property is used as an object in different places and for different purposes:

• Definition of property attributes
• Transmission of a concrete property value
• Both together (for dynamic PropertySets)

Accordingly, the actually existing attributes also differ. Only the “Id” is always present.

Type

Kind

Different kinds are possible for the different types. Several kinds can be specified separated by commas. If the specifications are contradictory, only the first specification will be used in this case.

Option

Option.Kind

Flag

Param

Defines additional parameter of the Property.

General param values

Kind parameters

There are special parameters for several kinds of properties. The corresponding kind is used as context and therefor the prefix of parameter name.

In the following, all special parameters are listed corresponding to the property kind.

Property kind “file”

Property kind “folder”

EnumFileDialogType

Property kind “uri” ≥ext.common 0.2.2

Property kind “regexvalidation”

Property kind “timespan” ≥ext.common 0.1.0

Property kind “keyvalue”

Property kind “radio button” ≥ext.common 0.2.3

Validation severities

Variables

In Module XML and App XML it is partially possible to reference variables.

This can be, for example, to define that an Operation is only available depending on a certain State:

<Object id="Barrier">
	<State id="Opened" type="bool" />
	<Operation id="OpenBarrier" available="state.Opened == false" />
</Object>

Or for example to write contents of an Event into the text of the message to be created:

<!-- Objektdefinition -->
<Object id="Door">
	<Property id="Number" type="int" />
	<Event id="UnauthorizedAccess" notify="1">
		<Property id="Name" type="string" />
		<Property id="Number" type="int" />
	</Event>
</Object>

<!-- Mapping des Objekts -->
<Mapping>
	<Event id="UnauthorizedAccess" appevent="Alarm" appevent_text="${Name} tried to access door ${obj.Number}" />
</Mapping>

In both examples the respective variable (“state.Opened”, “${Name}”, “${obj.Number}”) is replaced by the actual value that is valid at the time of the selection. In this resolution, the particular context plays a crucial role. For example, in the second example it is different whether “${Number}” is called in the context of the “Door” object or in the context of the “UnauthorizedAccess” Event. In the first case the property of the object is meant, in the second case the property of the Event with the same name.

There are four such contexts in total. The following table illustrates the possible variables/placeholders for the respective contexts.

ℹ️ Note that the term “event” in this context always stands for the object event, not a resulting App Event. App Event properties such as CallSourceNum are not accessible in this way.

The only difference in the notation of the variable is whether it is a condition or text.

In Expressions (e.g., conditions) the variables can be used exactly as described in the table.

In texts (e.g., “appevent_text” attributes for mappings or “text” attribute for AppLog entries) they need to be embedded in curly braces preceded by a dollar sign: ${value}