Actions and field values¶
Each checklist item can both guide the user and automate work on the record. This page describes those item settings, in the same order as they appear in the item settings in the Checklist Builder:
- User actions — buttons the user can choose to press.
- Set field values when the item becomes active — set values on the record when the item becomes the current step.
- Set field values when the item is checked — set values on the record when the item is checked.
- Run actions automatically when checked — run actions on their own when the item is checked.
For running custom server code when an item is interacted with, see Configure Custom Endpoint.
Info
The Action and Create Related Object user actions and Run actions automatically when checked run commands from limepkg-standard-actions. The checklist works without that package, but these features need limepkg-standard-actions 1.14.0 or later installed in the solution. See Requirements.
User actions¶
User actions are buttons shown on a checklist item. They are there to help the user — for example to open a link, create a document or create a related object — and the user decides if and when to press them. Pressing them is not required to be able to complete the item.
You can per checklist item configure a set of user actions.
To configure a user 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 |
Set field values when the item becomes active¶
When the item becomes the current step, these values are set automatically on the record. No user action is needed.
A value can also be shown to the user next to the item title inside the checklist, by turning on Show in title for that field.
How the value is set depends on the type of the field — see Properties for the different value types.
Set field values when the item is checked¶
Works the same way as above, but the values are set when the user checks the item instead of when it becomes active.
See Properties for the different value types.
Run actions automatically when checked¶
User actions are buttons the user presses when they want to. Sometimes you instead want something to happen on its own, every time an item is checked, without the user having to press anything.
For that you can configure one or more actions under Run actions automatically when checked in the item settings.
- The actions run automatically as soon as the item is checked.
- No button press is needed.
- All the actions must finish successfully before the checklist moves on to the next item. If an action fails, an option to proceed or cancel is given. If an action is cancelled, the item stays unchecked.
Use this when something must always happen when a step is completed.
You can configure both:
- Standard actions, the same ready-made actions available elsewhere in Lime (for example creating a record).
- Other custom actions built specifically for your solution.
Each action you add has a Command (which action to run) and optional Parameters for that command.
Info
Only commands that are tagged for the dynamic checklist can be selected here. If the picker is empty or you don't see the command you expect, the solution's limepkg-standard-actions is most likely missing or older than 1.14.0 (see Requirements); otherwise the command needs to be tagged/set up first (usually done together with a consultant).
