KPI Configuration form
The KPI Configuration form helps you create a key performance indicator for the Space Planning module in Workplace Central.
| Field | Description |
|---|---|
| Name | Name of the KPI Configuration. |
| Label | Display label that appears in the Space Planning workspace. |
| Application | Application scope in which the KPI Configuration record is created. The field is automatically filled based on the current application scope and can't be edited. |
| Active | Option to activate the record. When this field is selected, the KPI is calculated and displayed in the Space Planning workspace. |
| Order | Order of the KPI in the side panel. In the details panel, lower order values appear before the higher order values. |
| Description | Description that appears on a tooltip in the Space Planning workspace. |
| Type | The operation that is applied to the selected field. The operation is applied across all applicable spaces on the Space Planning workspace. Select one of the following values:
For example, SUM of Capacity displays the total capacity of the applicable spaces. Note: For KPIs that require multiple operations, you can set the type to None and create a script include to calculate the value. To create a script include, you can create an implementation by using the sn_wsd_spcmgmt.KPICustomConfig extension point. For reference, you can view the Script Includes like KPI_profiles_assigned or KPI_assignment_ratio, which are included with Workplace Space Management. For more information about extension points, see Using extension points to extend application functionality. |
| Computation field | Field on the Space [sn_wsd_core_space] table on which the selected operation is performed. This field is displayed only after you select a value in the Type field. For example, SUM of Capacity displays the total capacity of the applicable spaces. |