Welcome to our Support Portal. Search for answers using the search box below, or create a support ticket if you cannot find your answer.
KPI Widget
KPI Widget explained
The KPI widget allows for the viewing of a grouping of records and allows tracking of their status for compliance reasons. The widget itself can display records that are about to expire as well as records that have expired.
See below a brief description for the status of records.
Driver License:
This record is current as you can see the expiry date is set to 2024-04-02 meaning this is still within date.
CPR:
This particular record is highlighted Orange indicating it will be expiring shortly.
Staff Development Review:
The Staff Development Review has expired as is indicated by the Red text.
KPI Widget Rights
The ability to view the KPI widget is provided as a right labelled “widget_kpis_v2” and the ability to control what is displayed and edit the existing widget is given via “kpi_v2_admin”.
Once assigned you will see the KPI widget displayed on your dashboard as shown below.
The widget itself can also display certain information to specific groups and this feature will be further explained in the “Creating a KPI Widget” section below.
Creating a KPI Widget
In order to create a tab of information select the green cog button 
and a new window will be shown.
Below is a list of the above fields as well as a description of their purpose.
| Field Name | Description |
| Name of Displayed Tab | Assigns the name for the specific tab. This will be shown on the dashboard at the top of the screen when viewing the information. |
| Groups that can view | This will assign the ability for a group to see the information within the tab. Please note that the unless the group has the above-mentioned viewing right they will be unable to see the widget at all. |
| Groups displayed within the Tab | This controls which users will be displayed within the tab. As an example, if you’d like to see only support coordinators KPI’s you would assign the Support coordinator group if applicable. |
| Order documents are rendered | Ordered Alphabetically: Will order the documents from A – Z Ordered by Percentage: Documents with higher percentage values will be at the top of the dataset. Ordered by Missing Data: Will prioritise the documents / primary records that have the least data and will push them to the top of the list. |
| Section Alignment | This points the KPI widget towards either the staff or client section. |
| Grid Size | Alters the size of the boxes displayed in the actual KPI widget itself. Can select from small, medium and large. |
| Staff with no client’s own manager | This option will create an individual box for each primary record that is lacking a “Case worker / Staff library” field. If you make no use of the above-mentioned field enable this to see all staff members in a list. |
| First Name library | Is used to identify the first name of the primary record. |
| Last Name library | Is used to identify the last name of the primary record. |
| Case worker/Staff library | This option allows you to nominate if the staff member has a line manager / team leader that is responsible for their KPIs as this will group all staff under the one “Manager”. *Note* This can also be used for clients to identify a case worker or someone that manages their plan / information. *Note* This field needs to point towards a record field. |
After creating a tab, you need to identify which documents will be displayed within the KPI widget.
Select “add document type” and the below options will be presented.
Below is a list of all fields and a brief description.
| Name | Description |
| Name of Displayed Document | Will populate the name of the form and how it’s displayed within the tab. |
| Document Form | Identifies which form you’re seeking the information from. |
| Document Field Reference | This identifies which field within the form actually holds the “Document” can be placed on a upload field as this will always be required for qualification submissions. |
| Referenced Document Date | Used to identify the key date in the form whether it be an expiry date or a date the document is valid from. |
| Date Modes |
Past Date is expired If the date goes past the specified date within the document the widget will present it as Red and state it is an expired record. Past Date is Current If the date goes past the specified date, it will view this record as current and apply it to the overall total of the widget. Date not required This will simply make the document valid if there is a document present. |
| Document Selection Condition | This allows the KPI widget to identify which record it should use as a single form can have multiple records. For an example I have an expired blue card and am uploading a new blue card as a new submission. In the widget I will select “Latest Record” as I want the widget to target the new blue card being submitted. |
| Include only if results | This field is used to identify if the document is mandatory or not. If this is ticked as a yes the document itself will only display in the widget if there is a document present meaning it will not count towards the 100% KPI rating. |
You can then repeat the process to build as many documents as you see fit into the widget. See below an example of a KPI widget set to display a staff members Driver License.
