Checklist item Actions¶
You can per checklist item configure a set of actions that the user can choose to use.
To configure an action you need to set some or all of these properties
| Name | Type | Description |
|---|---|---|
| Title | string |
The name/text that the user see when using the action |
| Type | option |
What type of action that you want. You can see them here |
| Icon | string |
What icon to use for the action |
| Action | - |
This is based on the selected Type i.e. External Link => Link to open Document Template => Document template Action => Command Create Related Object => Object to create |
Description of Action types¶
| Action Type | What does Action contain |
Description |
|---|---|---|
| External Link | Link/path to file to open | Executes the given link |
| Document Template | Name of template (limepkg-document-templates) | Renders a document template and saves a document record opens the document card |
| Action | Command and properties to run |
Executes the given command with pre-defined props together with the ones user have given |
| Create Related Object | Relation to create object in | Opens a "Create new dialog" of the given relation |
Pre-defined properties to the configured command¶
The configured action will get some built-in properties from the checklist, and then the user can provide their own as well in the checklist builder.
| Name | Type | Description |
|---|---|---|
| item | ChecklistItemTemplate |
Containing all information about the item the actions was on |
| userAction | ChecklistUserAction |
Containing all information about the userAction the user used |
| context | LimeWebComponentContext |
The context the user was on while using the action limetype and id of the limeobject |