Creating an Action Definition
To add a new Action Definition to a Thing Definition, you should:
- Enter the Involvement / Actions page.
- Select the Thing Definition to edit.
- Press the Add Action button.
- Provide the required information.
- Press the Save button and edit the additional information, if needed.
Editing an Action Definition
An Action Definition is described by the following sections:
- Name: the name of the action visible to users.
- Description: the text describing the action.
- Topic: the topic to which this action belongs
- Priority: the priority used to order actions
- Icon: the icon to be displayed within the pages for this type of action.
- Due Period: the time period from the date of activation within which the action is recommended.
- Limit this action visibility depending on the user type: you can select the user-types that have visibility on the action of this type.
The condition verified by Servitly to activate an action of this type.
The activation condition can be:
- Event Based: an event is activated (e.g. a failure occurs).
- Period Based: the action is periodically activated (e.g. every X months).
You can specify metric based conditions to automatically mark an action as done or discarded according to the value of a specific metric. For instance, the action informing the user that a cartridge must be replaced, can be automatically mark as done, when the user replaces the cartridge and the machine publishes the new consumable level.
In case the activation condition is period based, you can also define whether the action is Reschedule. If selected, end-users will be able to change the periodicity of an action. For instance, the OEM proposes to check filters every month, but due to the utilization of the machine, the end-user may decide to check filters every 3 months.
Here, you can provide the text/html that describes in a more technical way what the user must perform to complete the action instance.
Once define, actions are automatically computes and activated by the Servitly backend, and by using specific widgets, you can display actions in the page in the most helpful way for the end-users.
These are the widget displaying actions:
- Action Group List: displays actions in a list grouped by type.
- Action List: displays actions in a list ordered by priority.
In addition, badges can be displayed within the navigation menus that alert the user to the presence of actions to be completed.
Refer to the Menu Informational Badge section in the Dashboard Definition article.