Skip to main content

๐Ÿ“ Indicator Registration

The Indicator Registration page is a functional page used to register individual new indicators or to bulk upload indicator definitions. Below are the main contents and functions of this page:

  1. Basic Information: Basic information about the indicator, such as indicator name, description, unit, etc. These information are the basic attributes of the indicator, used to help users better understand and use the indicator.
  2. Model Information: Model information related to the indicator, such as model name, model entity, dimensions, and measures, etc.

Creating Business Domainsโ€‹

In the management of indicators, whether through business domains, product lines, or departments for classification and management of indicators, an organizational structure is needed to manage indicators of different attribute categories. We manage indicators by grouping them under business domains.

Refer to Business Domain Management

  1. First, open the Business Domain page, click on "Create Business Domain," and enter a name such as Finance.
  2. Click the add button on the Finance row to continue adding child business domains, such as Management Reports.
  3. Continue adding sub-sections of Management Reports: Core Indicators, Revenue Indicators, Profit and Loss Indicators, etc.

Registering Indicatorsโ€‹

Next, create specific indicators.

Unique Code

Indicator codes are only limited to uniqueness within the semantic model's multidimensional dataset; there are no restrictions at the business domain or global level, and users regulate them themselves.

  1. Open the indicator registration page and enter the following indicator information:
  • Basic Information
NameDescription
Indicator NameLanguage description of the indicator. From a management perspective, indicator names are unique, but the system itself does not enforce this uniqueness.
Indicator CodeUnified indicator code, facilitating user memory and query of indicators.
Business DomainThe business sector to which the indicator belongs (i.e., business domain). For example, we can put Total Company Revenue into the core indicator business domain.
Authentication ProcessThe authentication process of the indicator in the indicator system.
CreatorThe creator of the indicator.
Responsible PersonThe person responsible for the indicator in the business.
Unit of MeasureThe unit of measure for the indicator, such as RMB.
Validity PeriodThe validity period of the indicator.
Activation StatusWhether the indicator is in an active state.
Indicator Application AvailabilityWhether the indicator is available for use in indicator applications.
Business CaliberA language description of the indicator from a caliber perspective. The definition of indicator business caliber needs to be determined according to specific business scenarios and requirements, generally formulated jointly by business experts, data analysts, data managers, etc. At the same time, the indicator business caliber also needs to match the design of the data source to ensure the correctness, reliability, and repeatability of the indicator calculation results.
  • Model Information
NameDescription
Semantic ModelThe semantic model to which the indicator belongs.
Model EntityA specific multidimensional model in the semantic model where the indicator data comes from.
Indicator TypeBasic Indicator: Select a measure from the existing measure fields in the semantic model for the indicator to use as the quantity value.
Derived Indicator: Data values obtained by combining existing measures and dimensions through calculation formulas.
VisibilityWhether the indicator is visible to users when used in the frontend.
MeasureWhen the indicator type is Basic Indicator, select a measure as the quantity value of the indicator.
Calculation FormulaWhen the indicator type is Derived Indicator, enter the calculation formula for the indicator measure value.
Aggregation TypeWhen the indicator type is Derived Indicator, specify an aggregation type for the calculation formula; defaults to using the aggregation type of the measure for Basic Indicator.
Free DimensionsDimensions on the multidimensional model unrestricted for this indicator. Will be selected or restricted when displayed.
Restrictive ConditionsRestrictions on other dimensions besides free dimensions on the multidimensional model for this indicator. See Indicator Restrictive Conditions for details.
  1. Submit to save.
  2. Download Template: You can download a template file for bulk upload, fill in indicator information in bulk, and then upload the file for bulk entry of indicators.
  3. Bulk Upload: Upload a template file format of the indicator file for bulk entry of indicators.

After registration, you can view the indicators on the My Indicators page.

Previewโ€‹

On the indicator registration page, you can preview the data trends of indicators in real-time, so that users can better understand the source and trends of indicator data when entering indicators. After completing the indicator registration, click the Data Preview button to view the data trends of the indicator.

Preview of indicator
Indicator Data Preview

Bulk Uploadโ€‹

For initial indicator entry or bulk indicator creation, you can use the bulk upload feature.

First, download the model file for bulk uploading indicator data. To facilitate manual organization of indicator data, you can download data similar to a particular indicator, then modify it by copying, open an existing indicator, or enter a new one, then click the Download Template button to download the current indicator data as a template. After organizing the indicator data, click the Bulk Upload button to upload.

As shown in the figure below, during bulk import, users can modify the attribute configuration of indicators one by one, and then click the "Import" button to complete the bulk import of indicators.

Indicator Batch Import
Indicator Batch Import

Below is a YAML format template for an indicator:

- name: ADJ Rosy Sunglasses Profit
code: 'Demo: ADJ-R-Sun Profit'
isActive: true
isApplication: true
visible: true
businessAreaId: 13ce2de2-a53f-4ad8-9c9d-8806291c77ec
authentication: ERP
business: |-
Profit of the product "ADJ Rosy Sunglasses" is the profit obtained by deducting the main business income from the main business cost and the main business taxes and surcharges.
Since the profit from the main business has not yet deducted period expenses such as sales expenses, management expenses, financial expenses, etc., it cannot fully reflect the profit status of the company's main business.
principal: Wang Tiwen
validity: '2023-04-29T16:00:00.000Z'
type: BASIC
modelId: a379cb26-19bd-4f82-84d7-db8a7c782385
entity: Sales
filters:
- members:
- value: '[ADJ].[ADJ Rosy Sunglasses]'
label: ADJ Rosy Sunglasses
dimension:
dimension: '[Product]'
dimensions:
- '[Time]'
- '[Store]'
- '[Promotions]'
- '[Customers]'
measure: Profit
formula: null
unit: RMB
tags:
- name: Sales
category: indicator
color: blue
-

name: Finance
category: indicator
color: blue