Dataphin:Create and manage public standard properties

You can directly reference public properties when creating standard templates. This allows for one-time configuration and repeated reuse. If a property is used across multiple standard templates with the same settings, configure it as a public property. This topic describes how to create and manage public standard properties.

Permission description

Only super administrators and data standard administrators can create and manage public standard properties.

Overview of public properties

Public properties are categorized as Custom Attribute and System Attribute:

• A Custom Attribute is a user-defined property that can be flexibly configured based on business requirements.

  When you reference a custom attribute in a standard template, you can modify all its configurations. This allows for the quick addition of reusable properties.

• A System Attribute is divided into Information Configuration and Compliance Monitoring. These are built-in system properties that you can quickly reference to improve configuration efficiency.

  When you reference a system attribute in a standard template, you can modify only some of its configurations. If compliance monitoring is configured for the system attribute, any data standards created from that template inherit the monitoring configurations. You can view mapping records and evaluation results in the compliance evaluation details. For more information, see System attribute list and View compliance evaluation details.

System attributes

1. On the Dataphin home page, choose Administration > Standard in the top menu bar.

2. In the navigation pane on the left, click Public Standard Properties. On the Public Standard Properties page, click System Attribute, select the target attribute, and click the icon in the Actions column.

System attribute details

System attributes have built-in compliance monitoring configurations. Data standards that reference these attributes inherit their monitoring configurations. Compliance monitoring includes metadata monitoring and content quality monitoring. Different system attributes support different monitoring types. Click Learn About Metadata Monitoring and Learn About Content Quality Monitoring for detailed descriptions. For more information, see Metadata monitoring and Content quality monitoring.

Metadata monitoring

Attributes that support metadata monitoring include Data Type, Data Class, and Data Sensitivity Level.

• When you select the Data Type attribute, you can monitor the dataType metadata field. For example, for a data standard for member registration channels, the corresponding field is the member registration channel field. In the standard, the data type for this field is specified as string. If the data type of this field is configured as int, it does not meet the standard's constraint.

• When you select the Data Class or Data Sensitivity Level attribute, the system compares the data class and data sensitivity level values specified in the data standard with the values configured for the mapped field in the security module to check for consistency. You must enable the asset security module to monitor the data class and data sensitivity level attributes.

Content quality monitoring (requires the asset quality module)

Attributes that support content quality monitoring include Is Nullable, Is Empty String Allowed, Is Unique, and Value Domain.

• When you select the Value Domain attribute, the content of the monitoring rule depends on the value domain attribute specified in the standard. If the range type for the value domain is Enum or Specified Interval, a Field Value Domain Monitoring rule is automatically created. The value domain constraint for the rule is based on the attribute value entered in the data standard. If the range type is Specified Lookup Table (range is all code values), a Data Standard Lookup Table Reference Comparison rule is automatically created. The lookup table configuration for the rule is based on the lookup table selected in the data standard. If the range type is Text Input, no quality check is performed. If the range type is Unspecified, you can select the range type when you create the data standard.

• When you select the Is Unique attribute, data standards for primary key fields often use this attribute to constrain field values, such as the member ID field in a member dimension table. If this attribute is set to Yes, a Field Unique Value Validation quality monitoring rule is automatically created, and the validation rule is automatically set to Abnormal Row Count <= 0. If this attribute is set to No, you must configure the validation rule.

• The Is Nullable attribute is used to check whether a single field is null. If this attribute is set to Yes, a Field Null Value Validation quality monitoring rule is automatically created. You must then manually configure the validation rule. If the attribute is set to No, the validation rule is automatically set to Abnormal Row Count <= 0.

• The Is Empty String Allowed attribute checks whether a single field is an empty string. If you set this attribute to Yes, a Field Empty String Validation quality monitoring rule is automatically created, which you must then configure manually. If you set this attribute to No, the validation rule is automatically set to Abnormal Row Count <= 0.

  Note

  • If Is Nullable is set to Yes, the rule counts null rows using the following logic:

    select count(1) from ${table_name} where ${field_name} is null.

  • If Is Empty String Allowed is set to Yes, the rule counts rows with empty strings using the following logic:

    select count(1) from ${table_name} where ${field_name} is null or ${field_name} = ''.

System attribute configuration details

System attributes are divided into Information Configuration and Compliance Monitoring. When you reference a system attribute in a standard template, you can modify only some of its configurations.

• Information Configuration includes Attribute Name, Attribute Code, Attribute Type, Is Required, Attribute Field Type, Attribute Value Length, Description, Attribute Field Value, Value Constraint, and Range Value Type.

  • Attribute Value Length: This parameter is not displayed for the value domain attribute type.

  • Value Constraint: This parameter is not displayed for value domain and data type attribute types.

  • Range Value Type: This parameter is displayed only for the value domain attribute type. If the attribute field type is a date-time type, value domain monitoring is not supported for the input enumeration values range type.

• Compliance Monitoring includes Monitoring Metadata, Quality Monitoring Rules, Case Sensitivity, and Validation Rule.

  • Quality Monitoring Rules: If the range value type is Enumeration - Input Enumeration Values or Range Interval, the quality rule is the validity/field value domain validation template. If the range value type is Enumeration - Reference Lookup Table, the quality rule is the validity/data standard lookup table reference comparison validation.

  • Case Sensitivity: If the attribute field type is a string, case sensitivity affects the comparison logic for attribute and field values.

  • Validation Rule: The validation passes if the values are equal.

System attribute list

On the System Attribute page, you can view information about built-in standard template attributes. However, you cannot perform operations such as creating, cloning, or deleting attributes. For more information, see Custom attribute list.

Custom attributes

Custom attribute configuration

1. On the Dataphin home page, choose Administration > Standard in the top menu bar.

2. In the navigation pane on the left, click Public Standard Properties. On the Public Standard Properties page, click Custom Attribute, and then click + New Attribute.

3. In the New Attribute dialog box, configure the parameters.

   Parameter	Description
   Attribute Name	The name of the public standard attribute. The name must be unique among all public standard attributes. The name cannot start with an asterisk (*) and can be up to 128 characters in length.
   Attribute Code	The code of the public standard attribute.
   Attribute Type	Select the type of the public standard attribute. Options include Business Attribute, Technical Attribute, Management Attribute, Quality Attribute, Master Data Attribute, Lifecycle Attribute, and Security Attribute.
   Is Required	The default value is No. You can switch it to Yes.
   Description	Add a description for the public standard attribute. The description can be up to 512 characters in length.
   Input Type	Affects how attribute values are entered and stored when you create a standard. You can select different attribute field types for different input types: Text Input: String, Numeric, Date-time. Dropdown Single Select: String, Numeric, Boolean, Date-time. Dropdown Multi Select: String, Numeric, Date-time. Range: String, Numeric, Date-time. The following figure shows an example of creating a data standard for different input types: Note Field types include String: STRING; Numeric: BIGINT, DOUBLE (up to 6 decimal places); Boolean: BOOLEAN (values are True or False); Date-time: DATE (yyyy-mm-dd), DATETIME (s). If you select Text Input for the input type and String for the field type, you can configure the attribute value length. This constrains the maximum length of the attribute value that can be entered when you create a standard. The maximum length is 10,000 characters. If you select Text Input (Numeric, Date-time), Dropdown Single Select, or Dropdown Multi Select for the input type, you can configure the Value Range to better constrain the input specifications for the data standard. For more information, see the Value Range configuration. If you select Range for the input type, you can configure the Range Type. For more information, see the Range Type configuration.
   Value Range	Constrains the input range of attribute values. When you create a data standard, the attribute value is configured based on the current input specifications. You can configure different value ranges based on the selected Input Type: Text Input (Numeric/Date-time): If the field type is numeric or date-time, you can configure the constraint range for the attribute value. Options are No Limit and Specified Range. No Limit: You can enter a custom attribute value when you create the standard, without any range constraints. Specified Range: Enter an attribute value based on the specified range when you create the standard. Dropdown Single/Multi Select: If the field type is String, the configurable value range includes custom enumeration values, values from a specified lookup table, and system attributes. If the field type is Numeric or Date-time, the configurable value range includes custom enumeration values and values from a specified lookup table. If the field type is Boolean, no configuration is required. Enum: Separate multiple enumeration values with commas (,). The total length cannot exceed 10,000 characters. You can click Batch Edit and enter enumeration values in the Batch Edit Enumeration Options dialog box. Separate multiple values with commas or line breaks. The total length cannot exceed 10,000 characters. Special enumeration types are as follows: If the attribute field type is Boolean, no configuration is required. The fixed values are True and False. If the attribute field type is Date, use the yyyy-MM-dd format. Example: 2022-09-01. If the attribute field type is Date-time, use the yyyy-MM-dd hh:mm:ss format. Example: 2022-09-01 12:00:00. Specified Code: You can select only lookup tables that are in the Published state. When you create a data standard, the selectable values for this attribute are the code values from the configured lookup table. System Attribute: If the field type is String, you can reference Dataphin system attributes, including data domains, projects, users, and user groups. This enhances the global adaptability of the standard module and simplifies unified management. For example, if you select data domain as the system attribute, the selectable values for this attribute are all data domains within the current tenant when you create a data standard. Note Range attributes do not support value constraints. If you select a system attribute for the value range, you cannot configure a default value.
   Range	Indicates that the attribute value is a set of values. It can be used to configure attributes such as value domains. Four range input methods are supported: Unspecified, Interval, Specified Lookup Table (range Is All Values), and Enum. Unspecified: You can specify the type when you create the data standard. Data standards created from the same template can have different range types, which provides greater flexibility. Interval: Used when the value range consists of continuous numbers or dates. Supports Numeric and Date-time field types. Example: For the value domain attribute of a Member Birthday standard, specify an interval. When you create the standard, enter: >1900-01-01, no limit. Specified Lookup Table (range Is All Values): Used when the attribute value range is dynamic or must follow a specific constraint. Supports Numeric, Date-time, and String field types. Example: For the value domain attribute of a Member Common Delivery City standard, reference a lookup table. When you create the standard, select the "China Region Code Table" lookup table. Custom Enumeration Values: Suitable for scenarios where there are few values and they do not change frequently. Supports Numeric, Date-time, and String field types. Example: For the value domain attribute of a Member Registration Channel standard, specify enumeration values. When you create the standard, enter: Miniapp, Official APP, Offline Member Store.
   Default Value	You can specify a default value for each attribute. When you create a standard, this attribute is automatically filled with the specified default value. This is suitable for standard attributes whose values do not change often. You can configure different default values based on the selected field type and value constraint. Note If you set a value constraint, the default value must also meet the constraint.

4. Click OK.

Custom attribute list

On the Custom Attribute page, you can view information about configured standard template attributes and perform operations such as creating, cloning, and deleting attributes.

What to do next

After you create a public standard attribute, you can reference it when you create a new standard template. For more information, see Create and manage standard templates.