DataWorks:Configure and use a checker at a data layer

Configure a checker at a data layer

1. Log on to the DataWorks console. In the left-side navigation pane, click Workspaces. On the Workspaces page, find the workspace in which you want to configure a checker and click DataStudio in the Actions column. On the DataStudio page, click the More icon in the upper-left corner and choose Data Modeling > Data Warehouse Planning. The Data Layer page appears. On the Data Layer page, click the created data layer to go to the details page of the data layer.
2. Configure a checker at the data layer.
   1. In the Checker Management section of the details page of the data layer, configure a checker at the data layer.
      You can move the pointer over Create Rule and select Create Rule for Model or Create Rule for Metric to configure a checker to standardize the naming formats of tables or derived metrics at the data layer.

      Note You can create multiple checkers for tables or derived metrics at a data layer.

      The following table describes the parameters that you can configure when you configure a checker.

      Parameter	Description
      Rule Name	The name of the rule based on which the checker generates a name for a table or a derived metric or checks the name of a table or a derived metric.
      Rule Type	Rule for tables: If you select Create Rule for Model, the value of this parameter is fixed as Name. When you create a table at the data layer, you can select the checker to generate a name for the table based on the naming convention defined in the checker. Rule for metrics: If you select Create Rule for Metric, you can set this parameter to Display Name or Abbreviation. When you create a derived metric at the data layer, you can select the checker to generate a display name or an abbreviation of the display name for the derived metric based on the naming convention defined in the checker.
      Rule Definition	The naming convention for tables or derived metrics. The checker checks the names of tables or derived metrics at the data layer based on the naming convention when you create tables or derived metrics. Rule for tables: You can specify a prefix for table names. For example, if you want the names of tables at a data layer to start with dim, you can enter dim. You can also click the icon and select options such as Business Category Abbreviation, Data Mart Abbreviation, and Subject Area Abbreviation to define a naming convention for tables. You can determine the order and number of the options based on your business requirements. Note The options that you can select vary based on the table type, such as application tables or dimension tables. You can view the supported options in the DataWorks console. Rule for metrics: You can select Modifier, Atomic Metric, and Statistical Period to define a naming convention for derived metrics. You can determine the order and number of the options based on your business requirements.
      Description	The description of the checker.

   2. Configure a default checker.
      You can configure a default checker for tables or derived metrics. When you create a table or a derived metric at the data layer at which the default checker is configured, this checker is selected by default to generate a name for the table or the derived metric. The following figure shows how to configure a checker created for tables as a default checker.
   3. Specify a strength type for the rule defined in a checker.
      You can specify a strength type for the rule defined in a checker. The following figure shows how to specify a strength type for the rule defined in a checker created for tables.

      The rules defined in all checkers that are created for tables or derived metrics at the same data layer have the same strength type. Rules of different strength types have the following impacts on the operation of creating a table in Dimensional Modeling or creating a derived metric in Data Metric:

      • If you set the Strength Type parameter to Weak Rule for the rules defined in checkers at a data layer, you can select a checker to generate a name for a table or a derived metric when you create the table or the derived metric at the data layer. You can also specify a name for the table or the derived metric without using a checker.
      • If you set the Strength Type parameter to Strong Rule for the rules defined in checkers at a data layer, you can select a checker to generate a name for a table or a derived metric when you create the table or the derived metric at the data layer. If you specify a name for the table or the derived metric without using a checker, you must make sure that the name complies with the naming convention defined in one of the checkers. Otherwise, the configurations of the table or the derived metric cannot be saved.
3. Run the configured checker and view check results.
   1. After the checker is configured, click Start Check. The checker checks the names of tables or derived metrics at the data layer. The system displays the tables or derived metrics whose names do not comply with the naming convention defined in the checker. You can make modifications based on the check result.
      Note

      • Only checkers in the enabled state can be triggered after you click Start Check.
      • By default, newly created checkers are in the enabled state. If you do not need to use a checker, you can disable it. After the checker is disabled, it does not perform check.
   2. After the check is complete, click View Results. Then, you can view the check results.

Use a checker

• Example 1
  An enterprise wants the names of tables at the desired data layer to start with dim_. If the data layer contains tables named dim_sku, dim_store, dimension_warehouse, and fact_order, the checker used by the enterprise starts the check after the checker is triggered. The following table shows the check results.

  Table name	Naming convention observed
  dim_sku	Yes.
  dim_store	Yes.
  ension_warehouse	No. The name of the table does not start with dim_.
  fact_order	No. The name of the table does not start with dim_.

• Example 2

  An enterprise wants tables at the DWD layer to be named in the format of dwd_sale_order_df/di. dwd represents the prefix for the names of tables. sale represents the name of the data domain to which tables belong. order represents the abbreviation of the name of a custom tag for tables. df/di represents a storage policy.

  If the data layer contains tables named dwd_sale_order_df, dwd_sale_order_di, dwd_sale_order, and dws_sale_order_df, the checker used by the enterprise starts the check after the checker is triggered. The following table describes the check results.

  Table name	Naming convention observed
  dwd_sale_order_df	Yes.
  dwd_sale_order_di	Yes.
  dwd_sale_order	No. The name of the table does not contain df or di.
  dws_sale_order_df	No. The name of the table does not contain dws.

• Example 3
  The model committee of an enterprise wants to unify and standardize the display names of derived metrics at the DWS layer in the Period_Modifier_Atomic metric format. The model committee creates a checker that meets the following conditions: The Rule Type parameter is set to Display Name, the Rule Definition parameter is set to Period_Modifier_Atomic metric, and the Strength Type parameter is set to Strong Rule for the rule defined in the checker. When developers create derived metrics named Last one day_Shop A_Users, Last 30 days_Beijing_Commodity B_Sales volume, Shop A_Users_Last seven days, and Shop A_Users at the DWS layer and save the configurations of the derived metrics, the checker is triggered and starts the check. The following table describes the check results.

  Derived metric name	Naming convention observed
  Last one day_Shop A_Users	Yes
  Last 30 days_Beijing_Commodity B_Sales volume	Yes
  Shop A_Users_Last seven days	No
  Shop A_Users	No