Actions Reference for Expression Rules

(See the function reference for supported functions.)

This page lists all actions supported for use in Expression Rules. Actions create a change in the Platform or at the asset and can be defined in Then or Else expressions only. If you attempt to configure an action in the If expression, then the rule cannot be saved or run.

To learn which actions are supported for each of the namespaces and triggers, refer to Using Appropriate Actions and Namespaces with Triggers for Expression Rules.

Tip

In general, use asset-related actions for Expression Rules generated by asset-related triggers. Do not use them with system-related triggers, such as SystemTimer, UserLogin, and UserLogout. Similarly, do not use the asset-related actions with the User namespace.

Alarm actions

Use Alarm actions to create an alarm with specified parameters, to reevaluate the alarm that generated the rule, or set the following attributes of an alarm: state, extended data, and severity. Use these actions in expression rules generated by asset-related triggers only (for example, a MobileLocation trigger). For more information about Alarm actions, refer to the following topics:

CreateAlarm()

Reevaluate()

SetAlarmState()

SetAlarmExtendedData()

SetAlarmSeverity()

Asset Configuration (ConnectedConfiguration) actions

Note: Axeda ConnectedConfiguration is a separately licensed feature. If the Axeda Platform is not licensed for ConnectedConfiguration, you will not have access to Asset Configuration actions.

Use asset configuration action, SetCfgValue, to create or modify asset configuration with specified parameters. This action can be defined to run from many types of expression rules (not only those related to asset configuration-related triggers) For more information about the action, refer to the following topic:

SetCfgValue

Rule actions

Use Rule actions to enable or disable Expression Rules, State Machines, and Threshold Rules. A rule must be enabled before it can be evaluated or run. You can use Rule actions in expression rules generated by asset-related triggers (Alarm, for example) and by system-related triggers (UserLogin, for example). For details about these actions, refer to the following topics:

DisableRule()

EnableRule()

Data Item actions

For the most part, Data Item actions send a message to an asset with a request to perform an action involving data. The message may request the value of a data item or write a value to a data item on an asset. Use these actions in expression rules generated by asset-related triggers only (for example, Alarm or MobileLocation). For details about these actions, refer to the following topics:

State Machine action

Only one action is available for State Machines. You can use this action to change the state of a State Machine in expression rules that are generated by asset-related triggers only (for example, Alarm or MobileLocation). For more information, refer to

SetState()

Audit action

Only one action is available in this category. You can use this action to create an entry in the audit log. Use this action in expression rules generated by asset-related triggers only (for example, MobileLocation or Registration). For more information, refer to

Audit()

Note: Although it works with AssetTimer and other asset-related triggers, the Audit action does not work when the Trigger type is a SystemTimer, UserLogin, or UserLogout trigger.

System-related actions

You can use the system-related actions to publish a Platform object to the ActiveMQ, to execute a legacy action (an action that has been defined through the Action wizard), or to execute a custom object action. Use these actions with system-related triggers. For example, if the expression rule is generated by a UserLogin trigger, you can use either of these actions to send a notification. For more information, refer to

PublishObject()

ExecuteAction()

ExecuteCustomObject()