Managing Metric Templates¶
A metric template summarizes the basic information and the extended information (such as metric identifier, name, query interval, aggregation method, and unit) of a metric associated with a specific object type. Metric templates can be applied to typical scenarios like synchronizing and sharing metric data. You can achieve the standardized synchronization and management of metric systems in different services and platforms by exporting and importing metric templates.
Prerequisites¶
You need to be assigned the required asset permission and operation permission, and a menu group containing the Metric Templates menu. If not assigned, contact the application administrator.
If you need to enable synchronization for a metric template to synchronize all the metrics in the template to EnOS Metric Management, Metric Management needs to be obtained, authorized, and enabled in the current OU.
Importing a Metric Template¶
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Click Import and choose one of the following methods to prepare the file to be imported:
If you need to share a metric template between different OUs, export the target metric template in the source OU.
If you need to create a metric template in the current OU, click Download in the pop-up window and enter the following information in the template file.
Category
Field Name
Identifier
Required/Optional
Description
General Information
Metric Template Key
metricTemplateKey
Required
The unique identifier of the metric template.
General Information
Metric Template Chinese/English/Japanese/Spanish Name
nameZh/En/Ja/Es
English and Chinese names are required
The template name in different languages.
General Information
Metric Template Chinese/English/Japanese/Spanish Description
descriptionZh/En/Ja/Es
Optional
The template description in different languages.
Field List
Field Key
field
Required
The field that needs to be defined for the metrics in the metric template.
Field List
Field Chinese/English/Japanese/Spanish Name
nameZh/En/Ja/Es
English and Chinese names are required
The field name in different languages.
Field List
Field Chinese/English/Japanese/Spanish Description
descriptionZh/En/Ja/Es
Optional
The field description in different languages.
Field List
Data Type
dataType
Required
The data type of the field. Use these data types: Int, Double, and String.
Field List
Is Required
isRequired
Optional
Whether the field is a required field.
Field List
Is I18n
isI18n
Optional
Whether the field data is returned in the I18n structure. The default value is N.
Field List
Related Basic Information Identifier
enumSourceRelatedBasicInfoTemplate
Optional
The key of the related basic information template. The information list in the basic information template will be used as the enumeration values of the field.
Field List
Related Basic Information Name
enumSourceRelatedBasicInfoTemplateName
Optional
The name of the related basic information template. The information list in the basic information template will be used as the enumeration values of the field.
Note
The “Org ID”, “Org Name”, “Updated On”, and “Updated By” fields in the template file can be left blank and will be filled by the system after upload.
Click Upload in the pop-up window, select the filled or exported file, and click OK. When you import a private metric template, if the template key in the file is the same as a public template key, the private template will overwrite the public template.
Exporting a Metric Template¶
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Click Export
in the upper right corner of the target metric template card. The exported file displays the template information and the specific field information in the template.
Deleting a Metric Template¶
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Click Delete
in the upper right corner of the target metric template card. Deleted metric templates cannot be restored.
Synchronizing Metrics¶
Follow the steps below to synchronize the metrics in a metric template to Metric Management.
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Check Enable Synchronization in the target metric template card to synchronize all the metrics in the template to Metric Management.
Note
A metric can only be added to one metric template that has enabled synchronization.
Importing Metrics¶
Follow the steps below to import metrics to a metric template.
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Click the target metric template card to open the template details page.
Click Import in the Related Metric List section.
In the pop-up window, select a business object type, check all the metrics to be added in the template, and click Next Step.
Choose one of the following methods to prepare the file to be imported:
If you need to share a metric list between different OUs, export the target metrics.
If you need to create a metric list in the current OU, click Download in the pop-up window. The fields in the template file consist of the fields defined in the metric template and the metric meta fields. The metric meta fields include business object type, metric name, metric identifier, description, aggregation dimension, query interval, aggregation method, unit, and data type.
Click Upload in the pop-up window, select the filled or exported file, and click OK > Finish.
Exporting Metrics¶
Follow the steps below to export all the metrics in a metric template.
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Click the target metric template card to open the template details page.
Click Export in the Related Metric List section. The exported file displays the detailed fields of all metrics in the metric template, including the fields defined in the metric template and the metric meta fields. The metric meta fields include business object type, metric name, metric identifier, description, aggregation dimension, query interval, aggregation method, unit, and data type.
Deleting Metrics¶
Follow the steps below to delete metrics in a metric template.
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Click the target metric template card to open the template details page.
Click Delete
of the target metrics in the metric list under Related Metric List. Deleted metrics cannot be restored.
Viewing Template Fields¶
Select Business Templates > Metric Templates from the left navigation pane.
Select the Public Metric Templates or Private Metric Templates tab according to the effective scope of the target metric template. For more information about the difference between public and private metric template, see Public/Private Metric Template.
Click the target metric template card to open the template details page.
Click View Fields in the Related Metric List section. All the fields that need to be defined for the metrics in the template are displayed in the list in the pop-up window.
(Optional) To delete a field, click Delete
of the target field in the list. Deleted fields cannot be restored.