Metrics
Define a reusable aggregation once, reference it by code everywhere
On this page
#About Metrics
Define a reusable aggregation once, reference it by code everywhere. This is a report page for reading, filtering and exporting results in BSuit ERP (Reports & Analytics). It is used by staff (internal users). What you can see and do depends on your role and permissions.
#How to open it
In BSuit ERP, open Reports & Analytics and choose “Metrics”, or go directly to the address /mis/metrics.
#What you can do here
These controls are present in the page’s implementation. Whether you see a given one also depends on your permissions and on the data shown.
- Add new records — a form opens for the details.
- Change existing records.
- Delete records (you are asked to confirm).
- Bring records in from a file.
- Export what you see to a file.
- Print or save as PDF.
- Attach or upload files.
- Search within the page.
- Filter the data shown.
- Sort by a column.
- Page through long lists.
- Open dialogs or drawers for detail and confirmation.
#Fields
When you enter or change a metric, these fields are on the form. Required fields must be completed before you can save. 1 of them are reference fields: you pick an existing record from another master rather than typing a value.
| Field | Type | Required | Details | Refers to |
|---|---|---|---|---|
| Code | text | Yes | — | — |
| Name | text | Yes | — | — |
| Description | textarea | No | — | — |
| Active | checkbox | No | Default: true. | — |
| Data Source | select | No | Which report data source to aggregate. Leave blank if this metric is a Formula (below) composed from other metrics instead. | List loaded from /api/mis/report-sources |
| Field | text | No | The field key on the selected source to aggregate (see that source\'s fields under Reports → Builder). Unused for a Formula metric. Example: e.g. net_amount. | — |
| Aggregate | select | No | One of: Sum, Average, Count, Minimum, Maximum. Default: sum. | — |
| Formula (optional) | text | No | Compose this metric from OTHER metrics\' Code values instead of a data source — arithmetic only (+ - * / parentheses). When set, Data Source/Field/Aggregate above are ignored. Example: e.g. (revenue - cogs) / revenue * 100. | — |
| Display Format | select | Yes | One of: Number, Currency, Percent. Default: number. | — |
| Filter (JSON, optional) | textarea | No | Optional ReportFilter[] JSON applied before aggregation — leave blank to aggregate the whole source. Example: [{. | — |
#What the list shows
The list displays these columns; use search and filters to narrow it.
- Code
- Name
- Definition
- Format
- Active
- Value
#How to run a metrics report
Reports are read-only: running one never changes data.
- Open Reports & Analytics › Metrics from the menu.
- Set any date range or filters shown at the top of the page.
- Run or refresh the report so the figures reflect your filters.
- Read the result columns: Code, Name, Definition, Format, Active, Value.
- Use Export to download what you see.
- Use Print to print or save it as a PDF.
- If the numbers look wrong, check the filters, the selected company and the accounting period before contacting support.
#How to add a metric
Steps follow this page’s form. You need permission to create records here.
- Open Reports & Analytics › Metrics from the menu.
- Choose the Add button (a plus icon) above the list.
- Complete the required fields: Code, Name, Display Format.
- Some fields offer a fixed list: Aggregate: Sum, Average, Count, Minimum, Maximum; Display Format: Number, Currency, Percent.
- Save. The new record appears in the list; use search or the filters to find it again.
- To change it later, open the record from the list and edit it.
- Deleting asks you to confirm. Records that other records refer to may be refused or may affect them (see “Where … is used as a reference”).
#Observed on a running system
On 2026-09-21 this page was opened in a browser as a test administrator. This is what was visible on screen. Your own view can differ with your role, data and settings.
| Button |
|---|
| Filter |
| History |
| Add (plus icon) |
| Settings (cog icon) |
| Code |
| Name |
| Definition |
| Format |
| Active |
| Value |
| Compute |
| Edit (pencil icon) |
#If something is missing or fails
- No data: confirm the company or context selected in the top bar, and any filters or date range in use.
- An action is hidden or disabled: it usually needs a permission your role does not have. Ask an administrator to check your effective access.
- An error message appears: note the message, the page address and what you were doing, and contact support with those details (never include passwords).
#About this guide
This guide was generated from the page’s implementation. It has not yet been reviewed by a person against a running system, so treat it as a reference for what the page contains rather than a complete procedure.
About this guide
- Status
- Partially reviewed
- Application
- BSuit ERP
- Audience
- Staff (internal users)
- Owner
- BSuit documentation team
- Reviewer
- Not yet reviewed
- Last verified
- Never
- Checked against
- Generated from source revision a36c7a086 on 2026-10-02
- Seen on a running system
- 2026-09-21
- Help version
- 2026.0.0-preview
- Guide ID
erp:/mis/metrics
