Report Builder β Create custom KPIs
The Report Builder lets you define your own metrics by combining existing predefined KPIs and previously created custom KPIs into formulas. A custom KPI appears in the Custom category of the KPI Library for every user in your organization and can be used in any report at the same level it was created at.
On this page
- How it works
- Entry button
- Step 1 β Build the formula
- Step 2 β Define KPI details
- Availability and visibility
- Deleting a custom KPI
Before you begin
Your organization must have Report Builder enabled.
You need the following permission:
Permission: Create Custom KPIs β Required to see the entry button and open the custom KPI builder. Without this permission, the button does not appear.
How it works
Custom KPIs are level-specific. When you open the KPI Library inside a Report Builder report, the bottom of the library shows a button whose label matches the report's level β Create Organization Level Custom KPI, Create Employee Level Custom KPI, Create Category Level Custom KPI, Create Guest Level Custom KPI, or Create Campaign Level Custom KPI. Selecting it opens the Create custom KPI panel, which walks you through two steps: building the formula and defining the KPI's name and display settings.
Once saved, the custom KPI:
- Appears in the Custom category of the KPI Library for everyone in the organization.
- Is available only at the level it was created at β an organization-level custom KPI does not appear in an employee-level report.
- Can be used in any report at that level, including the report you are currently building.
Custom KPIs cannot be edited after they are saved. Only the user who created a custom KPI can delete it, and only while no active report β including a draft β references it.
Formula evaluation
Zenoti validates the formula as you build it and again when you advance to the details step. The builder checks that the formula is well-formed β for example, that parentheses are closed and that operators are not consecutive. It does not check whether the resulting calculation is meaningful for your business.
When the formula is saved, Zenoti applies the standard order of operations: multiplication and division before addition and subtraction, left to right, while honoring any parentheses you added. The formula displayed on screen remains exactly as you typed it.
Entry button
The entry button appears at the bottom of the KPI Library panel inside any Report Builder report. Its label reflects the current report's level:
| Report level | Button label |
|---|---|
| Organization Level | Create Organization Level Custom KPI |
| Employee Level | Create Employee Level Custom KPI |
| Category Level | Create Category Level Custom KPI |
| Guest Level | Create Guest Level Custom KPI |
| Campaign Level | Create Campaign Level Custom KPI |
Below each button, the description reads: "Build new metrics from existing predefined or custom KPIs".
Note: The button appears only for users with the Create Custom KPIs permission. If your organization has reached its custom KPI limit, a message appears in place of the button indicating that the limit has been reached.
Step 1 β Build the formula
Selecting the entry button opens the Create custom KPI panel. The first step presents two areas side by side.
Available metrics (left panel)
The left side lists the metrics available for your formula. Use the Search metrics... box to filter by metric name or category. Categories expand to show individual metrics. Both predefined KPIs and any custom KPIs you or your colleagues have already created are available as metrics.
Metric restrictions:
Some metrics cannot be used in a formula:
- Date metrics β selecting one shows the message "Date metrics can't be used in a custom KPI formula".
- Categorical metrics β selecting one shows the message "Categorical metrics can't be used in a custom KPI formula".
- After you add at least one metric, metrics that are calculated differently across the date range become unavailable and show the message "This metric can't be combined with the ones already in your formula β they're calculated differently across the date range."
Metrics from any KPI Library category can be combined freely β there is no restriction to a single category.
There is a limit on the number of metrics you can include in a single formula. If you reach it, the builder shows a message indicating that the maximum has been reached and prompts you to remove a metric before adding another.
Formula area (right panel)
The right side shows the formula area with the placeholder text "Start building your formula using metrics and operators". Select a metric in the left panel to add it to the formula. Use the keypad to insert operators and grouping:
| Keypad controls |
|---|
| Backspace |
| Clear |
| Γ· |
| 7, 8, 9, Γ |
| 4, 5, 6, β |
| 1, 2, 3, + |
| (, 0, ), and a decimal point |
Formula validation
The builder checks the formula continuously as you type and when you select Next: Define KPI details. If a problem is found, an explanation appears. Examples include:
- "Cannot have consecutive operators"
- "Formula has unclosed parenthesis"
- "Formula cannot end with an operator"
- "At least one KPI metric is required in the formula"
Resolve all issues before proceeding to step 2.
Step 2 β Define KPI details
After a valid formula is built, select Next: Define KPI details to open the details step. Complete the following fields:
KPI name β Required. Up to 50 characters. Accepts letters, numbers, spaces, and hyphens. The name must be unique within the level. If a KPI with the same name already exists at the same level, an error appears β for example, "A KPI with this name already exists in Organization level".
Description β Required. Up to 250 characters.
Metric type β Choose a type to classify the KPI. Report values are shown as rounded numbers regardless of which type you select:
Option Description Currency Classifies the KPI as a currency metric. This is the default. Quantity Classifies the KPI as a quantity metric. Percentage Classifies the KPI as a percentage metric.
Actions
| Button | Behavior |
|---|---|
| Back | Returns to the formula step without losing your formula. |
| Save | Saves the custom KPI to the Custom category of the KPI Library. The panel closes. |
| Save & add | Saves the custom KPI and immediately adds it to the report you are currently building. The confirmation "<KPI name> added" appears. |
Availability and visibility
A saved custom KPI is available immediately to everyone in your organization at the level it was created at. It appears under the Custom category at the top of the KPI Library. Users with the appropriate report access can select it when building any report at that level β they do not need the Create Custom KPIs permission to use an existing custom KPI, only to create one.
Deleting a custom KPI
Only the user who created a custom KPI can delete it. A trash icon appears on the custom KPI's row in the KPI Library only for the creator.
Selecting the trash icon opens the Delete KPI confirmation dialog, which reads: "Are you sure you want to delete '<KPI name>'?"
- Select Yes, Delete to permanently remove the KPI.
- Select Go Back to cancel without deleting.
Deletion restrictions: If the custom KPI is referenced by an active report β including a draft β the trash icon is dimmed and a tooltip explains: "This KPI cannot be deleted as it is being used in active reports". Remove the KPI from all reports before attempting to delete it.
Important: Custom KPIs cannot be edited after they are saved. If you need to change the formula or details, delete the existing KPI (if no reports reference it) and create a new one.