All Products
Search
Document Center

Dataphin:Create metric mapping tag

Last Updated:Jan 23, 2025

Dataphin tags enable the direct definition of offline dataset output metrics as tags. This guide will walk you through the process of creating offline tags via metric mapping.

Prerequisites

To create offline tags through metric mapping, you must first establish the corresponding offline dataset. For more information, see Offline dataset.

Procedure

  1. Navigate to the Dataphin home page, and from the top menu bar, select Tag > Workbench.

  2. From the top menu bar, choose Project.

  3. In the left-side navigation pane, select Tag Processing > Offline Tag. On the Offline Tag page, click Add Tag.

  4. In the Add Offline Tag dialog box, click Registered Tag to access the Create Metric Mapping page.

  5. On the Add Metric Mapping page, set the offline tag's Business Attribute, Technical Attribute, and Processing Logic.

    • Business Attribute

      Parameter

      Description

      Entity-entity ID

      Select the entity and corresponding entity ID based on business needs.

      Tag Type

      Tag types are categorized based on processing methods.

      • Attribute Tag: Describes objective facts and serves as a fundamental tag for entity profiles, such as gender and name tags.

      • Statistical Tag: Created by calculating entity behavior or basic attributes to meet business requirements, such as the purchase amount tag for the last 7 days.

      • Predictive Tag: Forecasts entity characteristics or behavior using algorithm models, such as predicting the user's frequently visited province tag.

      • Composite Tag: Formed by applying specific rules to combine and process tags, such as consumer segmentation tags.

      Timeliness

      Timeliness indicates the update frequency of tags as they evolve over time, categorized into dynamic and static tags.

      • Static Tag: Typically reflects an entity's inherent characteristics that do not change, such as gender and name tags.

      • Dynamic Tag: Requires regular updates to maintain accuracy, like the order amount tag for the last 7 days.

      Owner

      Designate the developer responsible for this offline tag.

    • Technical Attribute

      Tag Update Method: Offers Periodic Update and Manual Update options.

      • Periodic Update: Automatically refreshes tags at set intervals.

      • Manual Update: Tags are updated through manual intervention.

    • Processing Logic

      Parameter

      Description

      Dataset

      Choose the offline dataset required for processing.

      Entity ID Field

      Defaults to the primary key of the offline dataset and is not subject to modification.

      Tag Definition

      Identify the metric for which you need to define a tag and provide the corresponding tag name and tag code. Supports both individual and batch additions.

      • Single Addition: Click Add and enter the relevant details.

        • Metric Name: Choose the data column you wish to define.

        • Tag Name: Accepts Chinese, English letters (both uppercase and lowercase), numbers, and underscores (_), up to 64 characters.

        • Tag Code: A unique identifier for the tag. When a tag with the same name exists in the created service, it aids in locating the specific tag. Accepts lowercase English letters, numbers, and underscores (_), must begin with a lowercase letter, and be no longer than 64 characters.

        • Lookup Table: If the source field column selected has an associated lookup table, the lookup table from the source dataset will be utilized.

          Note

          Click image.png to view details of the lookup table, including its name, code values, and code names. Only the first 50 code values are displayed.

        • Value Type: No input required. The system will automatically determine the value type based on the column name.

        • Version Number: Accepts English letters (both uppercase and lowercase), numbers, underscores (_), hyphens (-), and periods (.), up to 64 characters.

        • Tag Description: Provide a concise description of the tag, within 1000 characters.

      • Batch Addition:

        1. Click Processing Logic area's Batch Add, and in the Select Dataset Metric dialog box, select one or more metrics from the list. Use the search box to find metrics that have not yet been tagged by name or description.

          Note
          • The metric list displays only dataset metrics not yet added to the tag definition list and indicates whether a tag has been generated for each metric. You can filter to View Only Metrics Without Generated Tags and click Selected to select all.

          • Metrics that have already been used to generate tags indicate that a submitted version of a tag references that metric.

        2. Click Confirm, and the selected metrics will be automatically populated in the tag definition list.

          You can click the Actions column's image icon next to a metric to remove it individually, or select multiple metrics or all metrics and then click Batch Delete to remove them. If all metrics are removed, a default row with version number V1 and empty parameters will remain.

          Note
          • Metric duplication is not permitted within the tag definition list. Once a metric from the dataset is included in the current list, it cannot be selected a second time.

          • When Auto Fill is applied, the metric name populates the tag code column, even if it already contains a value. Should the metric include a tag description, it will populate both the tag name and tag description columns; however, existing values in these columns will remain unchanged.

  6. Click Submit to finalize the creation of the offline tag.

    Once the offline tag is created, to use it effectively, you must also publish it. After publication, project members can utilize the tag for further processing or audience group selection.

    1. In the offline tag list, click the Actions column image icon next to the desired tag to initiate publishing.

    2. In the Publish Tag dialog box, select the version of the tag you wish to publish.

      Note

      Before publishing, consider reviewing the version details and differences by clicking View Version Comparison. This can help ensure accuracy and confirm the correct version is being published.

    3. Click Confirm to complete the publishing process for the offline tag.

What to do next

After the offline tag is created and published, you can list it in the corresponding marketplace for management and incorporate it into subsequent tag development activities. For more information, see Manage tags.