All Products
Search

This Product

    DataWorks:Modifier

    Document Center

    DataWorks:Modifier

    Last Updated:Mar 27, 2026

    Without modifiers, every variation of a metric—such as "sales by online channel" versus "sales by fresh food outlet"—requires a separate definition. A modifier is a business qualifier that lets you define the scoping condition once and reuse it across multiple derived metrics, reducing redundant definitions and keeping your metric catalog consistent.

    Combine a modifier with an atomic metric and a period to form a derived metric. For more information, see Derived metric.

    Modifier types

    DataWorks supports two modifier types. Choose based on whether the scoping values are free-form or drawn from a managed dimension table.

    Type When to use
    Common Business Modifier The scoping values are custom tags or text not tied to a dimension table. For example, a channel label like "online" or "in-store".
    Dimension Enumeration Modifier The scoping values must be enumerated values from a defined dimension table. For example, outlet types managed in a dimension table.

    Create a modifier

    Prerequisites

    Before you begin, make sure that you have:

    • Access to a DataWorks workspace with Data Modeling enabled

    • (Required for Dimension Enumeration Modifier) A submitted dimension table and a created lookup table

    • (Required for Common Layer) A created data domain

    Steps

    1. Go to the Modifiers page.

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

      2. On the Data Modeling page, click Data Metric in the top navigation bar. In the left navigation pane, click Modifiers.

    2. Click the 新建 icon.

    3. Configure the modifier.

      Parameter Description
      Modifier Type Select Common Business Modifier or Dimension Enumeration Modifier.
      Abbreviation An English abbreviation that uniquely identifies the modifier. For example, fresh_store. This value cannot be changed after creation.
      Name The English name of the modifier. For example, Fresh Food Store Type.
      Display Name The Chinese display name of the modifier. For example, fresh food outlet.
      Effective Scope The business activity scope for which data is collected. For example, outlets that sell fresh food.
      Owner The owner of the modifier. Defaults to the user who creates it.
      Description A description of the modifier.
      Data Layer Click Advanced Settings and select Common Layer or Application Layer.
      Mart/Subject Appears when Data warehouse layer is set to Application Layer. Select the data mart or subject area.
      Business Category Appears when Data warehouse layer is set to Common Layer. Associates the modifier with a data domain.
      Data Domain Appears when Data warehouse layer is set to Common Layer. Select the data domain. Create a data domain first if none exists.
      Associated Dimension Table Appears when Modifier Type is Dimension Enumeration Modifier. Select a submitted dimension table, then select a dimension field from that table as the associated dimension. For more information, see Create a logical model: Dimension table.
      Associated Lookup Table Appears when Modifier Type is Dimension Enumeration Modifier. Select a created lookup table, then select an encoded value as the enumerated value. For more information, see Data Standard: Lookup table.

    4. Click Save.

    Import modifiers from Excel

    Use batch import when you have many modifiers to create at once. DataWorks provides a downloadable template that defines the required fields.

    1. On the Modifiers page, move the pointer over the 导入 icon and click Import from Excel.

    2. Set Import Type to Modifier. Download the template, review the field preview, and fill in your modifier data.

      导入修饰词

    3. On the Data Import tab, upload your completed file and preview the data.

      • To avoid conflicts, preview fields that share names with existing fields in DataWorks, then delete or modify them as needed.

      • Import Mode: Choose whether to skip or overwrite existing objects with the same name.

      • Import Status:

        • Import and Save: Saves the imported data without creating a new version.

        • Import and Submit: Saves the data and submits a new version.

      Limits:

      Limit Value
      File format .xlsx only
      Data volume Up to 30,000 entries per import
      File size 10 MB maximum

    4. After the import completes, view the results on the OK tab. Click Details next to any modifier to open its edit page. If the import fails, resolve the errors listed in the details and re-import.

    What's next

    A modifier can be combined with an atomic metric and a period to form a derived metric.

    If a modifier is referenced by a derived metric, delete all associated derived metrics before deleting the modifier.