Configuring Charting Tool¶

This page explains how application developers configure the Charting Tool page so that end users can query the measurement-point and metric data of assets as required by their business, and analyze data trends in time-series charts.

Prerequisites¶

The current account has menu access to the Charting Tool page in the target application, as well as the template-configuration permission of Charting Tool. If not assigned, contact the OU administrator.
The attributes, measurement points, and metrics of the relevant assets are registered in EnOS. If needed, you can query the registered data through the EnOS Common Data Service API.
You have read Exploring Charting Tool to understand the functions of the Charting Tool page.

Note

Unified Monitoring supports customized menu names, so the actual menu name may differ from this page. The following text uses the default name Charting Tool to refer to the Charting Tool menu configured in the application.

Entering the Charting Tool Configuration Page¶

Once the application developer’s account has the template-configuration permission of Charting Tool, follow these steps to enter the Charting Tool configuration page:

Select Charting Tool in the left navigation pane of the target application.
Select Function Configuration in the upper right corner of the page.

The Charting Tool configuration page contains four tabs, each determining a different aspect of the page:

Tab	What It Determines	Typical Adjustment Timing
Basic Settings	Whether end users can modify query conditions themselves, whether they can use templates, and the UI text of the page.	When you need to fix the page view or replace interface terms.
Asset Settings	The asset dimensions, asset types, and device types that the page supports querying, and the way assets are selected and their display names.	Must be configured before the page goes live; it determines which assets end users can query.
Time Settings	The time intervals, data comparison methods, time aggregation methods, and time zones available to end users.	When you need to narrow the range of time intervals, or open aggregation methods based on metric characteristics.
Data Settings	The data types that the page supports querying, how data fields are categorized and filtered, and the refresh and layout behavior of charts.	When you need to organize data fields by visualization group, or enable auto refresh.

If required fields are not completed, you cannot switch to other tabs or publish the page.

Configuring Page Functions¶

Basic Settings¶

On the Basic Settings tab, you can decide the scope that end users can adjust on the page themselves, and customize the interface text.

Setting	Description	Default
Modify Query Conditions	When enabled, the query-condition bar is displayed at the top of the page and end users can modify the assets, data fields, and time of the current query themselves. When disabled, the query-condition bar is hidden from end users and the page only shows the organization default view or charts fixed in a template; users with the template-configuration permission can still see the query-condition bar. Suitable for scenarios that require a unified monitoring view.	`Enable`
Template	When enabled, the template entry is displayed at the upper left corner of the page and end users can apply, save, and manage chart templates. When disabled, the template entry is hidden from end users; users with the template-configuration permission can still manage templates.	`Enable`
Template Menu Style	How the template entry expands. `Card` displays template cards tiled in a panel, making it easy to browse template descriptions; `Drop Down` shows template names in a drop-down list, taking up less space. Configurable only when Template is enabled.	`Drop Down`

UI Text Customization¶

To meet customization needs such as project terminology display and brand exposure, you can uniformly update certain specific terms in the Charting Tool interface; the change takes effect on both the configuration page and the end-user page. For example, the standard term “site” can be replaced in bulk with the business term “store”.

Follow these steps to customize the interface text:

Find UI Text Customization on the Basic Settings tab.
Select Add, and select or enter a key in the Key column. Each key can be configured only once, and up to 100 entries can be configured. To customize more text, contact the system administrator to obtain keys.
- If the key does not exist in the text resources, the page shows Invalid key.
- If the key already exists in the table, the page shows Key already added.
In the Default Text column, view the text that will be replaced.
In the Custom Text column, enter the updated text. You can enter text for each interface language separately, with up to 200 characters per language.

After configuration, the Default Text values in system text will be uniformly replaced with the Custom Text values. Text entered later by users (such as template names, custom analysis object names, and data field group display names) is not affected.

Asset Settings¶

On the Asset Settings tab, you can decide the range of assets that the page supports querying and how end users select assets.

Setting	Description	Default
Asset Dimension	The analysis object levels that the page supports; multiple selections allowed. `Site Group` performs aggregate analysis on asset levels above sites (such as group and region); `Site` analyzes a single site or multiple sites; `Device` analyzes specific devices within a site. The dimensions selected here become the options that end users can switch among in Chart Scope, so it is recommended to keep only the dimensions required by the business to avoid mis-selection by end users.	`Site Group`, `Site`, `Device`
Asset Type	The asset types that the page supports; select at least one. Asset types are determined by the business object types in EnOS Common Data Service, such as wind power and solar power. Once selected, end users can only view assets of the specified types on the page.	None
Device Type	The device types that the page supports; select at least one. The selectable range is determined by the business domain of the selected Asset Type, so device types are added or removed accordingly when asset types change. When values are set, a device type list is displayed below, and you can drag the ordering icons to adjust the order of device types seen by end users. Configurable only when Asset Dimension includes `Device`.	Automatically selected with Asset Type
Multi-Site Device Query	When enabled, end users can select multiple sites in the site tree and query devices under multiple sites at a time; when disabled, only one site can be selected each time. Suitable for comparing devices of the same type across multiple sites horizontally. The maximum number of sites that can be selected at the same time is determined by the deployment environment configuration.	`Enable`
Asset Tree Style	The display style of the device filter and the asset list in Select Assets; multiple selections allowed. `By Hierarchy` inherits the hierarchy of the organization structure in the Application Portal; `By List` displays the devices in a site tiled by device type. When both are selected, end users can switch the asset tree style on the page. Configurable only when Asset Dimension includes `Device`.	`By List`
Asset Filter	When enabled, the asset filter is displayed in the query-condition bar and end users can switch assets directly without opening the Modify Query Conditions pop-up. When disabled, end users can only select assets in the Modify Query Conditions pop-up.	`Enable`
Filter nodes without permission	Whether to hide parent nodes for which the current account has no direct asset permission in the asset tree. This item only echoes the value of the menu URL parameter `filterParentNodes` and cannot be edited on this page; it is enabled when set to `true` in the menu URL, and remains disabled when not set. This function is different from node permission validation, which may make nodes visible but not selectable.	`Disable` (read-only)
Display Name Config	The source of device names in charts, legends, and the data table. `Asset Name` uses the registered name of the asset; `Display by attribute` uses the value of a specified attribute as the name, suitable for scenarios where device names carry no business meaning and need to be displayed as numbers or tag names instead. When `Display by attribute` is selected, an attribute must be specified in Select Attribute before publishing.	`Asset Name`

Time Settings¶

On the Time Settings tab, you can decide the time intervals, data comparison methods, and time zones available to end users.

Setting	Description	Default
Time Aggregation Filter	When enabled, end users can specify a time aggregation method for measurement-point data: `First`, `Last`, `Avg`, `Sum`, `Max`, or `Min`. When this is not enabled or end users do not specify one, the system aggregates measurement-point data with `First` by default, that is, taking the first value of each time interval. Time aggregation only takes effect on measurement-point data and has no impact on metric data.	`Disable`
Time Interval	The range of time intervals that end users can select. `Default` opens all time intervals; `Specified` opens only the intervals you check in Select Time Interval. When the business only focuses on specific granularities (such as daily or monthly statistics only), it is recommended to select `Specified` to prevent end users from running queries with excessively large amounts of data.	`Default`
Select Time Interval	The time intervals opened to end users; select at least one. Options are `1min`, `5mins`, `10mins`, `15mins`, `30mins`, `1hour`, `Day`, `Month`, and `Year`. Configurable only when Time Interval is `Specified`.	All
MoM	When enabled, end users can select `Day-over-Day`, `Month-over-Month`, or `Year-over-Year` in Comparison to overlay in the chart the data of a data field for the previous period.	`Enable`
YoY	When enabled, end users can select `Last Year` in Comparison to overlay in the chart the data of a data field for the same period of the previous year.	`Enable`
Timezone	When enabled, the timestamps on the chart x-axis, in the tooltip, and in the data table will carry timezone identifiers, making it easier for cross-timezone teams to verify the time period that data belongs to.	`Disable`

Note

The finer the time interval, the shorter the time span a single query can cover. When end users select dates beyond the span, the dates in the date picker are unavailable and a prompt is shown. The specific threshold is determined by the deployment environment configuration. See Limitations.

Data Settings¶

On the Data Settings tab, you can decide the data types that the page supports querying, how data fields are categorized and filtered, and the refresh and layout behavior of charts.

First configure the data types, which determine whether the remaining settings on this tab appear:

Setting	Description	Default
Data Type	The data types that the page supports; select at least one. `Measurement Point` is the raw physical reading uploaded by devices, and `Metric` is the business volume statistically computed by Common Data Service at time granularities. For example, if only `Measurement Point` is selected here, end users can only add measurement-point data fields in Select Data.	`Measurement Point`, `Metric`
Multi-Type Data Query	When enabled, end users can query measurement points and metrics in the same chart; when disabled, the two can only be queried separately. Configurable only when Data Type includes both `Measurement Point` and `Metric`.	`Disable`

The following settings appear only when Data Type includes Measurement Point. If only Metric is selected, these settings and their existing values take no effect.

Setting	Description	Default
Filter Measurement Points With No Data	When enabled, the measurement point list in Select Data only shows measurement points that have data uploaded. When the current OU has too many measurement points, enabling this function improves the efficiency for end users to select data fields.	`Disable`
Show DI Raw Value	When enabled, both the raw value and the mapped value of a DI point are displayed when querying and exporting DI point data, in the format `raw value (mapped value)`. Suitable for troubleshooting scenarios that require verifying enum mapping relationships.	`Disable`
Raw Interval Query	When enabled, the `Raw` option appears in Time Interval, and end users can view data at the original upload interval of measurement points.	`Disable`
Show Data Quality	When enabled, the Data Quality switch appears at the upper right of the data table, and end users can view the validity and quality details of data. Raw Interval Query must be enabled first; otherwise the switch is unavailable.	`Disable`
Auto Refresh	When enabled, the page automatically re-queries and updates charts according to the Refresh Interval. When end users use a quick time range, the start and end times are recalculated on each refresh; while end users have the time picker open, auto refresh is paused to prevent the time being selected from being overwritten.	`Disable`
Refresh Interval	The period of auto refresh, ranging from 10 to 3600 seconds. Configurable only when Auto Refresh is enabled.	60 seconds
Data Layout Style	The arrangement of the data field list in Select Data: `One Column` or `Two Columns`. When there are many data fields, selecting `Two Columns` reduces scrolling.	`Two Columns`
Y-Axis Scaling	When enabled, a zoom slider appears vertically on the chart and end users can zoom the chart vertically to view areas with dense values; in addition, box zoom in the chart toolbox supports vertical box selection. When data fields differ greatly in magnitude, enabling this helps observe details of curves with small magnitudes.	`Disable`

Data Filter Configuration¶

Charting Tool can use the configuration in Common Data Service > Visualization Groups and asset attributes to control how data fields in Select Data are organized and their selectable range. The following settings determine the source and display of data filtering:

Setting	Description	Default
Data Filter Mode	How data fields in Select Data are organized. `By Measurement Point Type` groups data by the type of the measurement points themselves; `By Visualization Group` groups data by the visualization groups configured in Common Data Service, which is closer to business semantics. When `By Visualization Group` is selected, if an asset type has no corresponding visualization group configured, the data of that asset type is displayed by measurement point type.	`By Measurement Point Type`
Data Field Group	The business object field group key used by the page to read visualization groups. Keep the default value unless otherwise agreed.	`CT_Metric`
Filter By Attribute	When enabled, the page filters field categories in the field group according to the attribute values of assets, and uses this field category to display data. Suitable for scenarios where different device models under the same asset type need to display different data fields. When enabled, an attribute must be specified in Select Attribute before publishing.	`Disable`
Data Field Group	When enabled, data groups and their display names can be predefined on top of visualization groups. In Select Data, end users can check multiple data fields by group at a time without searching item by item.	`Disable`
Group Identifier	The visualization group identifiers that participate in grouping, separated by commas, with the wildcard `` supported. For example, `Wind_` refers to all visualization groups starting with `Wind_`. Configurable only when Data Field Group is enabled, and cannot be empty; otherwise the page cannot be published.	Empty
Group Display Name	The name displayed for the group entry on the end-user page; can be entered separately for each interface language. If not configured, the end-user page displays Select by Group. Configurable only when Data Field Group is enabled.	Empty

Column Selector¶

When Column Selector is enabled, the data filter is displayed in the query-condition bar and end users can add or remove the data fields in charts directly without opening the Modify Query Conditions pop-up. When disabled, end users can only select data fields in the Modify Query Conditions pop-up. Enabled by default.

Publishing the Page¶

After completing the configuration, follow these steps to publish the page so that the configuration takes effect for end users:

Select Publish in the upper right corner of the Charting Tool configuration page.
In the pop-up window, enter content such as the modification notes of this publication as the Remarks. The remark will be displayed in the history version list, making it easier to locate and roll back later.
Select OK. After publishing, the page will reload the runtime configuration, and end users will see the new configuration the next time they enter the page.

Configuring Charts¶

In addition to page functions, you can also build a specific asset data chart on the Charting Tool page and save it as a template or the organization default view, which serves as the initial view that end users see when entering the page.

The entry for building a chart is the same as for end users: select More on the Charting Tool page to open the Modify Query Conditions pop-up, complete selecting assets, selecting data, selecting the display style, and selecting time in order, and then select Apply. For the fields and limitations that can be configured in each step, see Modifying Query Conditions.

After the chart is built, you can persist it by saving the current chart as a template. If you select Yes for Save as OU default view when saving, all end users in the OU will see this chart by default when entering the Charting Tool page.

Managing Chart Templates¶

A chart template is used to persist a complete set of query conditions and display styles, avoiding repeated configuration by end users each time. A template mainly contains the following information:

Asset dimensions and asset types
Analysis objects and data fields
Chart style and Y-axis settings
Time interval and time range
Custom analysis objects

Templates are divided into two types:

My Templates: visible only to the creator, used to accumulate personal analysis habits.
Organization Templates: visible to all end users in the OU; the template-configuration permission is required to create and edit them. Used to distribute a unified analysis view to everyone. The maximum number of templates for a single OU is 50.

Saving the Current Chart as a Template¶

Follow these steps to save the configured asset data chart as a new template or update the current template:

Select Charting Tool in the left navigation pane.
Hover the cursor over the settings button and select Save Template. Before saving the template, make sure at least one data field is selected in the current chart.
Enter the following information in the Save Template pop-up window.
- - Field
  - Description
- - Template Name
  - Enter the name of the template. When exporting chart data, if a template is currently applied, the exported file will be named after the template name.
- - Template Description
  - Enter the description of the template. The description is displayed in the Card template menu, helping end users judge the purpose of the template.
- - Template Category
  - Select the category the template belongs to. If not selected, the template is placed in the default category.
- - Save Time Interval and Time Range
  - Select Yes, and the template will save the time interval and time range configuration of the current chart. Select No, and the system default time interval and time range are used when the template is applied. Select Yes for fixed-period review scenarios, and No for daily monitoring scenarios.
- - Save as OU default view
  - Select Yes, and the current chart is displayed by default when end users in the OU enter the Charting Tool page. Only users with the template-configuration permission can configure this item.
Select OK.

Saving the Modified Template as a New Template¶

If a template is currently applied on the page and the original template has been modified, follow these steps to save the modified template as a new template while the original template remains unchanged:

Select Charting Tool in the left navigation pane.
Hover the cursor over the settings button and select Save as Template. Before saving as a template, make sure a template is currently applied to the chart.
Enter the template name, template description, template category, and other information in the Save Template pop-up window. The descriptions of the fields are the same as in Saving the Current Chart as a Template.
Select OK.

Editing a Template¶

Follow these steps to modify the name, description, category, and other information of a template. The query conditions and display styles in the template are not modified; to adjust those, apply the template and save it again.

Select Charting Tool in the left navigation pane.
Select Template.
Select Edit at the upper right corner of the target template card.
In the pop-up window, edit the name, description, and category of the template, and whether to save the time interval and time range, and select OK.

Deleting a Template¶

Select Charting Tool in the left navigation pane.
Select Template.
Select Delete at the upper right corner of the target template card.
Select OK in the pop-up window.

Note

A deleted template cannot be recovered. If the deleted template is being applied, the page exits the template; the template is also removed from the recently used template records.

Managing Template Categories¶

Template categories can be used to manage templates by category according to information such as the applicable scenario, analysis object, and time range of templates. When there are many templates, categories can significantly shorten the time for end users to find templates.

Creating a Category¶

Select Charting Tool in the left navigation pane.
Select Template.
Select the edit icon to open the category configuration pop-up window.
Select Categories and enter a category name. After a category is created, you can add templates to the category when saving a template, saving a template as a new template, or editing a template.

Editing a Category¶

Select Charting Tool in the left navigation pane.
Select Template.
Select the edit icon to open the category configuration pop-up window.
Select the template category tab and edit the category name.

Sorting Categories¶

Select Charting Tool in the left navigation pane.
Select Template.
Select the edit icon to open the category configuration pop-up window.
Drag the ordering icon next to the category tab to edit the display order of the categories in the template panel.

Deleting a Category¶

Select Charting Tool in the left navigation pane.
Select Template.
Select the edit icon to open the category configuration pop-up window.
Select the delete icon to the right of the category tab.

Restoring History Versions¶

The history version list contains information such as the version number, modifier, modification time, and remark of published pages. To use a previous Charting Tool page configuration, follow these steps to restore the current page to a history version:

Select Charting Tool in the left navigation pane.
Select Function Configuration on the Charting Tool page.
Select History Version to open the history version list.
In the history version list, select Restore for the corresponding version.
Select OK in the pop-up window.

Importing or Exporting Page Configuration¶

Charting Tool supports importing or exporting the following content as JSON files, enabling migration and reuse of the same page across different applications or environments:

Page function configuration
Asset and data field configuration
Templates and template categories

Exporting Page Configuration¶

Select Charting Tool in the left navigation pane.
Select Function Configuration on the Charting Tool page.
Select Import/Export > Export, and the browser will automatically download the configuration file.

Importing Page Configuration¶

Select Charting Tool in the left navigation pane.
Select Function Configuration on the Charting Tool page.
Select Import/Export > Import.
Upload the configuration file in the pop-up window and select OK.

After importing, the content in the configuration file is populated into each tab, and you can continue to adjust it before publishing. If an imported asset type or device type does not exist in the current OU, the system automatically changes the selection to an available type under the current OU, so it is recommended to review each tab after importing.

Note

Importing only overwrites the settings contained in the configuration file. If the configuration file comes from an earlier version, newly added settings retain the values of the current page.

Configuring URL Parameters¶

In addition to the configurations above, application developers can enable or disable page functions, or specify the default query conditions when the page opens, by configuring parameters in the menu URL. For more information, see URL Parameters.