DataWorks：Derived metric

Go to the Derived Metric page

1. Log on to the DataWorks console. In the left-side navigation pane, choose Data Modeling and Development > Data Modeling. On the page that appears, select the desired workspace from the drop-down list and click Go to Data Modeling.

2. In the top navigation bar of the Data Modeling page, click Data Metric. The Derived Metric page appears.

   You can create a derived metric at a common layer or an application layer based on your business requirements. In addition, you can choose to create a single derived metric or create multiple derived metrics at a time.

   In most cases, the business activities of an enterprise are complex and diverse, and the status of multiple business activities within different periods and scopes needs to be analyzed at the same time. We recommend that you create multiple derived metrics for one type of business activity at a time. For information about how to create multiple derived metrics at a time, see the Create multiple derived metrics at a time section in this topic. For information about how to create a single derived metric, see the Create a single derived metric section in this topic.

Create multiple derived metrics at a time

1. Select an operation type.

   In the Derived Metric pane, move the pointer over the icon and click Multiple Derived Metrics.

2. Create a metric model that is used to create multiple derived metrics at a time.

   1. Select atomic metrics, modifiers, and periods.

      

      Area	Description
      1	In this area, you can select atomic metrics, modifiers, and periods that are used to create multiple derived metrics at a time. Note If the atomic metrics, modifiers, or periods that are displayed do not meet your business requirements, you can click Create to create the desired objects. A derived metric is composed of an atomic metric, a period, and one or more modifiers.
      2	In this area, a render tree is displayed to show all derived metrics that will be created at a time. The following icons can be displayed for a derived metric: : indicates that the derived metric does not exist. : indicates that the derived metric already exists. When you create derived metrics, the system does not create an existing derived metric again. : allows you to copy the derived metric.
      3	In this area, you can change the display mode of the render tree. For example, you can zoom in, zoom out, or center the render tree, or present the render tree in full screen.

   2. Click Generate Derived Metrics.

3. Create multiple derived metrics at a time.

   1. Select a data layer and a checker.

      In the Generate Derived Metrics dialog box, select a data layer and a checker based on your business requirements. The checker is used to standardize the naming formats of the derived metrics.

      Note

      If no checkers are available, you can create one in Data Warehouse Planning. For more information about how to create a checker, see Configure and use a checker at a data layer.

   2. Click Next.

   3. Select the derived metrics that you want to create.

      1. In the Select Derived Metrics step, select the derived metrics that you want to create based on the created metric model. By default, all derived metrics in the metric model are selected.

      2. Click Create or Create and Submit. The derived metrics are created at a time.

         • If you click Create, the selected derived metrics are created. You must go to the configuration tabs of the derived metrics to submit the derived metrics.

         • If you click Create and Submit, the selected derived metrics are created and submitted. Only submitted derived metrics can be referenced when you create tables.

         After a derived metric is created, the state of the metric in the render tree changes from to .

   4. In the Create Derived Metric step, view the created derived metrics.

      You can view information about the created derived metrics in the derived metric list.

Create a single derived metric

1. Select an operation type.

   In the Derived Metric pane, move the pointer over the icon and click Derived Metric.

2. Create a derived metric.

   1. Configure business logic.

      Configure the parameters listed in the following table based on your business requirements.

      Parameter	Description
      Period	The period of time for which you want to perform statistical analysis for a business activity. Examples: last day and last week.
      Modifier	The scope for the statistical analysis of a business activity. Examples: online and offline.
      Atomic Metric	The atomic metric that is used to define a criterion and computing logic for the statistical analysis of a business activity. Example: order amount.

   2. Configure basic information.

      You can create a derived metric at the DWS layer or ADS layer based on your business requirements. The following table describes the basic information that you can configure.

      Parameter	Description
      Data Layer	The data layer at which the derived metric is created.
      Business Category	The business category to which the derived metric belongs. A business category can be associated with a data domain or data mart. This parameter is displayed and required only if you set the Data Layer parameter to Common Layer.
      Business Process	The category of the business activity. This parameter is displayed and required only if you set the Data Layer parameter to Common Layer.
      Mart/Subject	The category of the business activity for a specific scenario or product. This parameter is displayed and required only if you set the Data Layer parameter to Application Layer.
      Display Name	The display name of the derived metric. You can click Intelligent Recommendation on the right side to generate a display name in the Period name_Modifier names_Atomic metric name format. The generated display name can help you identify the meaning of statistical data collected by the derived metric in an efficient manner. Note Intelligent Recommendation is displayed only after you specify an atomic metric and a period when you configure business logic for the derived metric. You can click the icon and select a checker to check whether the display name of the derived metric complies with the specified naming convention. If the checkers that are displayed do not meet your business requirements, you can create one at the related data layer. For more information about how to create a checker, see Configure and use a checker at a data layer.
      Abbreviation	The abbreviation for the name of the derived metric. You can click Intelligent Recommendation on the right side to generate an abbreviation in the Period name_Modifier names_Atomic metric name format. The generated abbreviation can help you identify the meaning of statistical data collected by the derived metric in an efficient manner. Note Intelligent Recommendation is displayed only after you specify an atomic metric and a period when you configure business logic for the derived metric. You can click the icon and select a checker to check whether the display name of the derived metric complies with the specified naming convention. If the checkers that are displayed do not meet your business requirements, you can create one at the related data layer. For more information about how to create a checker, see Configure and use a checker at a data layer.
      Name	The name of the derived metric.
      Owner	The owner of the derived metric. The default owner is the creator of the derived metric.
      Description	The description of the derived metric.

3. Click Save in the upper part of the configuration tab. The derived metric is created.

4. Click Submit in the upper part of the configuration tab. The derived metric is submitted. Only derived metrics that are submitted can be referenced when you create tables.

   Note

   • Only derived metrics that are saved can be submitted.

   • Each time you submit the same derived metric, a new version is generated for the derived metric. You can submit a derived metric of a specific version only once.

Manage the versions of a derived metric and view the fields associated with a derived metric

Export derived metrics

1. Go to the tab that displays the derived metric list.

   In the Derived Metric pane, click the icon to go to the tab that displays the derived metric list. On this tab, you can view information about all derived metrics that are created.

2. Select the derived metrics that you want to export.

   Note

   If you want to export all existing derived metrics, you can skip this step.

   You can use one of the following methods to select the derived metrics that you want to export:

   • Search for the desired derived metrics by keyword: You can enter a keyword in the search box to search for the desired derived metrics and select the derived metrics.

     Note

     Fuzzy match is supported. After you enter a keyword in the search box, all derived metrics whose names contain the keyword are displayed.

   • Select the desired derived metrics from the derived metric list: You can directly select the desired derived metrics from the derived metric list.

3. Export the derived metrics at a time.

   You can use one of the following methods to export the derived metrics at a time:

   • Export All: You can click Export All in the upper part of the tab to export all derived metrics that are created in the current workspace.

   • Export Searched Objects: You can enter a keyword in the search box to search for the derived metrics that you want to export, click the Batch Export drop-down list in the lower part of the tab, and then select Export Searched Objects. Then, all atomic metrics that are displayed in the search result are exported.

   • Export Selected Objects: You can select the derived metrics that you want to export, click the Batch Export drop-down list in the lower part of the tab, and then select Export Selected Objects. Then, all derived metrics that you selected are exported.

4. View and download the export result.

   After you initiate an export task, you are navigated to the Details of Export Status of Derived Metrics page. On this page, you can view the status of the export task. After the derived metrics are exported, you can click Download File to download the derived metrics that are exported.

Delete or submit multiple derived metrics at a time

1. Go to the tab that displays the derived metric list.

   In the Derived Metric pane, click the icon to go to the tab that displays the derived metric list. On this tab, you can view information about all derived metrics that are created.

2. Select the derived metrics that you want to delete or submit.

   Note

   Only derived metrics that are saved but not submitted can be submitted at a time.

3. Click Batch Delete or Batch Submit based on your business requirements.

   • Batch Delete: After you click this button, the selected derived metrics are deleted at a time. The deleted derived metrics cannot be referenced when you create tables.

     Note

     If a derived metric is referenced by a table, you must remove the reference relationship before you delete the derived metric.

   • Batch Submit: After you click this button, the selected derived metrics are submitted at a time. Then, they can be referenced when you create tables, and the latest versions are generated for the derived metrics. For more information about the versions of a derived metric, see the Manage the versions of a derived metric and view the fields associated with a derived metric section in this topic.