Configuring Performance Indicators module settings
Who is this article for?Site Administrators who want to set up a custom Performance Indicator Types.
Site Admin permissions are required.
Performance Indicators (PIs) module settings let you create custom PI Types to fit your data gathering and analysis needs. This guide will show you how to set them up.
In this article:
1. PIs Settings view
To access PIs settings:
- Open the Go To... menu.
- Hover over 'Site Admin' at the bottom of the menu.
- Select 'PIs Settings' (under 'Module Setup').
Once there, you should be presented with this page:
2. Creating PI Types
To create a PI Type:
- Open the PIs Settings view.
- Click 'PI Types▼'.
- Select 'Manage'.
You will be taken to the PIs list. - Click 'PI Types▼'.
- Select 'New PI Type'.
You'll be prompted to enter the title, description, and select an icon for your PI Type. - Click 'Save & Close'.
You will be taken back to the overview of all PI Types, with the newly created PI Type highlighted:
From this view, you can add Ownerships of the PI Type and any PIs that fall under it.
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'
PIs in this PI Type
To add PIs:
- Click 'PIs in this PI Type▼'.
- Select 'Add PIs'.
- Select the PI you want to move.
Your list will refresh, and you should now see the PIs listed.
3. Editing PI Types
To edit a PI Type:
- Open the PI Settings view.
- Select the PI Type you'd like to amend on the left.
- Click 'PI Type Name▼'.
- Select 'Edit'.
- Change the name, icon, or description.
- Click 'Save & Close'.
This will not change the Default Ownerships or PIs in this PI Type settings.
Default Ownerships
To edit Default Ownerships:
- Open the PIs Settings view.
- Click 'Ownership Type▼'.
- Select 'Remove Owners' or 'Remove All'.
You'll be prompted to confirm which Owners need to be removed in the pop-up.
PIs in this PI Type
To edit PIs in this PI Type:
- Open the PIs Settings view.
- Click 'PIs in this PI Type▼'.
- Select 'Remove PIs' or 'Remove All'.
You'll be prompted to confirm which PIs need to be removed in the pop-up.
First Tab
To edit the First Tab:
- Click 'First Tab▼'.
- Select 'Edit'.
- Update the layout of the First Tab for that PI Type.
- Click 'Save & Close'.
4. Duplicating PI Types
To duplicate a PI Type:
- Open the PIs Settings view.
- Select the hyperlinked Title of the PI you want to delete.
You can also access the option from the 'Manage' screen. - Click 'PI▼'.
- Select 'Duplicate'.
You'll be prompted to confirm whether you want to carry out the selected action. - Click 'Duplicate'.
You will be taken back to the overview of all PI Types, with the duplicated PI Type highlighted:
Description and Default Ownerships will match the ones assigned to the original PI Type, but no PIs will be present, as they'll still be assigned to the original PI Type.
For clarity, we also recommend you change the name of the PI Type from 'Copy of PI Type Name'.
5. Deleting PI Types
To delete a PI Type:
- Open the PIs Settings view.
- Select the hyperlinked Title of the PI you want to delete.
You can also access the option from the 'Manage' screen. - Click 'PI▼'.
- Select 'Delete'.
You'll be prompted to confirm whether you want to carry out the selected action. - Click 'Delete'.
Not seeing the 'Delete' option?
Make sure that you are not looking at the default PI Type! It cannot be deleted.
6. Further reading
We also offer guides to the other module settings: