Configuring Actions module settings
Who is this article for?Site Administrators who want to set up a custom configuration for Actions.
Site Admin permissions are required.
Actions module settings let you customise the workflows for Actions to make it suitable for your way of working. This guide will walk you through how to configure each of the settings.
In this article:
- Actions Settings view
- Expected Outcomes
- Action Types
- Code Formatting
- Defaults
- Tooltips
- Further reading
1. Actions Settings view
To access Action settings:
- Open the Go To... menu.
- Hover over 'Site Admin' at the bottom of the menu.
- Select 'Actions Settings' (under 'Module Setup').
Once there, you should be presented with this page:
You can make all required changes from this view!
2. Expected Outcomes
This setting allows you to create set Outcomes for Actions.
Creating Expected Outcomes
To create an Expected Outcome:
- Open the Actions Settings view.
- Click 'Expected Outcomes▼'.
- Select 'Manage'.
You will be taken to the Expected Outcomes list. - Click 'Expected Outcomes▼'.
- Select 'New Expected Outcome'.
You'll be prompted to enter the title and select an icon for your Outcome. - Click 'Save & Close'.
You will be taken back to the Expected Outcomes list:
Editing Expected Outcomes
To edit an Expected Outcome:
- Open the Actions Settings view.
- Select the hyperlinked Title of the Outcome you want to edit.
You can also access the option from the 'Manage' screen. - Enter a new name or select a new icon.
- Click 'Save & Close'.
Duplicating or deleting Expected Outcomes
To duplicate or delete an Expected Outcome:
- Open the Actions Settings view.
- Click 'Expected Outcomes▼'.
- Select 'Manage'.
You will be taken to the Expected Outcomes list. - Highlight the item row for the Expected Outcome you want to administer.
- Click 'Expected Outcomes▼'.
- Select 'Duplicate' or 'Delete'.
You'll be prompted to confirm whether you want to carry out the selected action. - Click 'Duplicate' or 'Delete' to confirm.
This will not change the Default Ownerships or Actions in this Action Type settings.
3. Action Types
This setting allows you to create Action Types that will be available to Users when creating a new Action.
Creating Action Types
To create an Action Type:
- Open the Actions Settings view.
- Click 'Action Types▼'.
- Select 'Manage'.
You will be taken to the Action Types list. - Click 'Action Types▼'.
- Select 'New Action Type'.
You'll be prompted to enter the title, description, and select an icon for your Action Type. - Click 'Save & Close'.
From this view, you can add Ownerships of the Action Type, determine which Actions that fall under it, and set up the First Tab for that specific Action Type.
-- Default Ownerships
To add Default Ownerships:
- Click 'Default Ownerships▼'
- Choose Ownership type.
- Enter the name of the User you'd like to add.
- Click 'Search'.
- Tick the box next to each User want to add.
- Click 'Add Users/Roles'
Editing Action Types
To edit an Action Type:
- Open the Actions Settings view.
- Select the hyperlinked Title of the Outcome you want to edit.
You will be taken to the Action Types list. - Click 'Action Name▼'.
- Select 'Edit'.
- Enter a new name, description, or select a new icon.
- Click 'Save & Close'.
This will not change the Default Ownerships or Actions in this Action Type settings.
-- Default Ownerships
To edit Default Ownerships:
- Click 'Ownership Type▼'.
- Select 'Remove Owners' or 'Remove All'.
You will be prompted to confirm which Owners need to be removed in the pop-up.
-- Actions in this Action Type
To add Actions:
- Click 'Actions in this Action Type▼'.
- Select 'Move Actions into this Action Type'.
- Select the Action you want to move.
Your list will refresh, and you should now see the Action (and any Sub-actions) listed.
-- First Tab
To edit the First Tab:
- Click 'First Tab▼'.
- Select 'Edit'.
- Update the layout of the First Tab for that Action Type.
- Click 'Save & Close'.
Duplicating or deleting Action Types
To duplicate or delete an Action Type:
- Open the Actions Settings view.
- Click 'Action Types▼'.
- Select 'Manage'.
You will be taken to the Action Types list. - Highlight the Action Type you want to duplicate on the left.
- Click 'Action Types▼'.
- Select 'Duplicate' or 'Delete'.
You'll be prompted to confirm whether you want to carry out the selected action. - Click 'Duplicate' or 'Delete' to confirm.
Not seeing the 'Delete' option?
Make sure that you are not looking at the default Action Type! It cannot be deleted.
4. Code Formatting
This setting allows you to have a serialised sequence of codes, all based on the same alphanumeric format. Each subsequent Action created will increment the value of the code, while retaining the prefix set here.
Creating Code Formatting
To set up Code Formatting:
- Open the Actions Settings view.
- Click 'Code Formatting▼'.
- Select 'Manage'.
You will be taken to the Code Formatting list. - Click 'Code Formatting▼'.
- Select 'New Code Format'.
You'll be prompted to enter the title and number format in the pop-up. - Click 'Save & Close'.
Below is a list of symbols you can use in the 'Number Format' field to set up your code.
| Symbol | Effect |
|---|---|
| 0 | Output data will have as many digits as number of zeroes used in the mask. For example, if you've entered 00000 in your format and have the number 123 in your data, it will display as 00123. |
| # | Output data will not show unnecessary zeroes. |
| . (dot) | Output data will show a decimal point in this space. |
| £ | Output data will show the £ sign in this space. |
| % or '%' | Output data will show the % sign in this space. |
| + or - | Output data will show the + or - symbol in this space. For example, +##.00 will make the number 123.4 show as +123.40. |
| ' (single quote) | Enables you to use # and ' within your format. For example, '#'##.00 applied to 123.4 will give you #123.40. |
Editing Code Formatting
To edit a Code Format:
- Open the Actions Settings view.
- Select the hyperlinked Title of the Code Format you want to edit.
You can also access the option from the 'Manage' screen. - Enter a new name or create a new format.
- Click 'Save & Close'.
Duplicating or deleting Code Formatting
To duplicate or delete a Code Format:
- Open the Actions Settings view.
- Click 'Code Formatting▼'.
- Select 'Manage'.
You will be taken to the Code Formatting list. - Highlight the item row for the Format you want to administer.
- Click 'Code Formatting▼'.
- Select 'Duplicate' or 'Delete'.
You'll be prompted to confirm whether you want to carry out the selected action. - Click 'Duplicate' or 'Delete' to confirm.
Example: Code Format after being duplicated.
5. Defaults
This setting allows you to configure default behaviours for Actions.
To change Defaults:
- Open the Actions Settings view.
- Click 'Defaults▼'.
- Select 'Edit'.
Update the values to match your requirements. - Click 'Save & Close'.
6. Tooltips
To add Tooltips to default Action fields, follow steps outlined in our Creating Tooltips for default fields article.
7. Further reading
We also offer guides to the other module settings: