Definition of an Action Parameter

Required Parameters

A definition of an action parameter requires at least the name of the action parameter and a parameter type.

The definition of the minimum parameters looks like this:

1
2
3
4
5
<action>
    <parameters>
        <parameter name="Active" type="Boolean"/>
    </parameters>
</action>

Optional Parameters

For the name of the action parameter, a display name and a description can be specified. This information is optional and is used for the display in user interfaces. In case of missing attributes (plain and description), the specified name is used instead of the display name or the description.

For some action parameters the view attribute can be added (depending on the type). In the corresponding section of the selected type you can look up if this option is available.

The definition specifying the display name and the description looks like this:

1
2
3
4
5
6
7
8
<action>
    <parameters>
        <parameter name="Active" type="Boolean">
            <plain>Active</plain>
            <description>Indicates if ...</description>
        </parameter>
    </parameters>
</action>

In addition to the display name and the description, a database field and a priority can be defined for the action parameter. The priority is used to hide insignificant parameters, e.g. when using the event text in a viewer.

The definition specifying the priority and a database field looks like this:

1
2
3
4
5
6
7
8
<action>
    <parameters>
        <parameter name="Active" type="Boolean" priority="4" dbfield="Int32_A">
            <plain>Active</plain>
            <description>Indicates if ...</description>
        </parameter>
    </parameters>
</action>

The priority level behaves in a way that an action parameter with a lower priority level (higher number) than the set priority level is hidden. The priority level ranges from 1 (important) to 10 (unimportant).

For example, the hash parameter is only displayed if the priority level is set to 7 or higher.

1
2
3
4
5
6
7
8
<action>
    <parameters>
        <parameter name="Hash" type="Numeric64Bit" priority="7" dbfield="Int64_A" view="ForeignKey">
            <plain>Hash value</plain>
            <description>Hash value of ...</description>
        </parameter>
    </parameters>
</action>