Dataphin:Create and manage standard templates

Permissions

• Super administrators and data standard administrators can create and manage standard templates.

• Super administrators, data standard administrators, and template owners can edit and delete standard templates.

• Super administrators, data standard administrators, roles with data standard management permissions, and the user who created the import record can view the details of standard template imports and encoding correction records.

Limits

You can create a maximum of 500 standard templates per tenant.

Create a standard template

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

2. In the left navigation pane, click Standard Template. On the custom template page, click Create Template in the upper-right corner.

3. In the Create Standard Template dialog box, configure the basic parameters.

   Parameter	Description
   Template Name	The name of the standard template. The name must be globally unique and cannot exceed 128 characters.
   Template Code	The code of the standard template. The code must be globally unique and cannot exceed 64 characters. It can contain letters, digits, and underscores (_).
   Maintainer	The owner of the standard template. The owner is responsible for regular maintenance and can edit the template.
   Description	A description of the standard template's use cases. The description cannot exceed 512 characters.
   Standard Code	Defines the code generation rule for data standards that reference this template. This improves code standardization and reduces manual configuration and management costs. The following two methods are supported: Customized and Auto-generated based on encoding rules. Customized: Manually enter the standard code when you create a data standard. Auto-generated Based On Encoding Rules: Automatically generates the code based on the rules configured in the referenced standard template. You can manually modify the code after it is generated. You can create encoding rules based on an auto-increment sequence (by standard creation order), a fixed string, or the code of the parent data standard set. You can configure a maximum of five rules. Only one auto-increment sequence rule is supported. Auto-increment Sequence (by Standard Creation Order): Increments based on the generation time of the standard ID. You must specify the number of digits, start value, and step size for the sequence. If you also configure a data standard set code, the sequence auto-increments within each data standard set. This ensures code continuity within the set for easier management. You can drag the icon next to a rule type to change its order. The code is generated based on the rule order. Digits: The number of digits for the auto-increment sequence. Enter a positive integer from 1 to 12. Example: 4. Start Value: The start value of the auto-increment sequence. The number of digits in the start value cannot exceed the value of Digits. Example: 1. Step Size: The value by which the sequence increments. Enter a positive integer from 1 to 10. Pad with leading zeros: If you select this option, leading zeros are added to the start value to match the specified number of digits. String: A fixed string. The string can be up to 20 characters long and cannot start or end with a space. Example: ads_. Parent Data Standard Set Code: The code of the selected parent data standard set when you create a data standard. If an auto-increment sequence is configured, it increments within the data standard set. Encoding preview: Shows a preview of the code based on the configured generation rules. The following figure shows a preview based on the example values. Note If you select Strictly Validate That The "Standard Code" Value Conforms To The Rule Constraints When Submitting The Standard, the system checks whether the configured code (including manual modifications) conforms to the rules when you submit a data standard created from this template. This helps ensure code standardization. Check whether the encoding rule configuration conflicts with the attribute constraints of the standard code. This prevents failures when creating data standards due to constraint violations. If you modify the encoding rule configuration, you can choose whether to regenerate existing standard codes. For more information, see Regenerate.

4. Click Next to go to the property configuration page for the standard template.

5. Click Create Property. You can select Public Attribute or Create Custom Property to add properties to the standard template.

   Note

   • When you reference a custom property, you can modify all its configurations to quickly add reusable properties. When you reference a system property, you can modify only some of its configurations. If standard-to-asset mapping monitoring is configured for a system property, data standards created from this standard set inherit that monitoring configuration. You can view the mapping records and evaluation results in the standard-to-asset mapping evaluation details. For more information, see System property list and View standard-to-asset mapping evaluation details.

   • The system creates four built-in required properties: Standard Code, Standard Name, Standard English Name, and Standard Type.

   • Create Custom Property: A user-defined property that you can flexibly configure as needed.

   • Reference Public Attribute: Quickly reference pre-configured public attributes to improve configuration efficiency.

     • System Attribute

       1. In the Public Attribute dialog box, select an attribute. The configuration pages for system and custom attributes are mostly the same. The main difference is that custom attributes support the Clone reference method. The following figure shows an example of a system attribute.

          Note

          • After you add a custom attribute, you can modify all its configurations to quickly add reusable attributes. The clone reference method is supported, which lets you make changes that are independent of subsequent changes to the public attribute.

          • After you reference a system attribute, you can modify only some of its configurations. Other configurations are inherited from the public attribute.

          

          Area	Description
          ①Filter and search area	You can filter by Attribute Type, including Business Attribute, Technical Attribute, Management Attribute, Quality Attribute, Master Data Attribute, Lifecycle Attribute, and Security Attribute. You can also search by Attribute Name or Attribute Code.
          ②List area	If an attribute with the same name already exists in the list, you cannot add it again.
          ③Select all on this page	Performs operations on the objects on the current page. You can view the number of selected custom and system attributes here.
          ④OK	Click OK to quickly add the referenced attributes. You can click Edit to modify the attribute configurations.

       2. Click OK to finish referencing the public attributes.

     • Custom Attribute

       1. In the Create Standard Template Property dialog box, enter the parameters.

          Parameter	Description
          Property Name	The name of the public standard property. The name must be unique within the current public standard property. The name cannot start with an asterisk (*) and cannot exceed 128 characters.
          Property Code	The code of the public standard property.
          Property Type	Select the type of the public standard property. Valid values: Business Attribute, Technical Attribute, Management Attribute, Quality Attribute, Master Data Attribute, Lifecycle Attribute, and Security Attribute.
          Required	Specifies whether the property is required. The default value is No. You can switch it to Yes.
          Description	A description of the public standard property. The description cannot exceed 512 characters.
          Input Type	Affects how property values are entered and stored when you create a standard. Different input types support different field types: Text Input: String, numeric, and date/time. Dropdown Single Select: String, numeric, Boolean, and date/time. Dropdown Multi-select: String, numeric, and date/time. Range: String, numeric, and date/time. The following figure shows examples of creating a data standard with different input types: Note Field types include String: STRING. Numeric: BIGINT, DOUBLE (up to 6 decimal places). Boolean: BOOLEAN (True or False). Date/time: DATE (yyyy-mm-dd), DATETIME (s). If you set Input Type to Custom Input and the field type is String, you can configure the maximum length of the property value. The maximum length is 10,000 characters. If you set Input Type to Custom Input (Numeric, Date/time), Dropdown Single Select, or Dropdown Multi-select, you can configure the Value Range to better constrain the values. For more information, see Value Range configuration. If you set Input Type to Range, you can configure the Range Type. For more information, see Range Type configuration.
          Value Range	Constrains the input range of property values. When you create a data standard, the property values are configured based on the current specifications. Based on the selected Input Type, you can configure the following value ranges: Custom Input (Numeric/Date/time): If the field type is numeric or date/time, you can configure the constraint range for the property value. You can specify a range or have no limit. No limit: You can enter any property value when you create a standard. Specified range: You must enter a property value within the specified range when you create a standard. Dropdown Single/Multi-select: If the field type is String, you can set the constraint range to custom enumeration values, values from a specified lookup table, or system properties. If the field type is Numeric or Date/time, you can set the constraint range to custom enumeration values or values from a specified lookup table. No configuration is required if the field type is Boolean. Enum: Separate multiple enumeration values with commas (,). The total length cannot exceed 10,000 characters. You can click Batch Edit and enter the 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. The following special enumeration types are supported: If the field type is Boolean, no configuration is required. The fixed values are True and False. If the field type is Date, use the yyyy-MM-dd format. Example: 2022-09-01. If the 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 available values for this property are the code values from the specified lookup table. System Attribute: If the field type is String, you can configure system properties. System properties include data blocks, projects, users, and user groups. If you select Data Block for this property, the available values for this property are all data blocks in the current tenant when you create a data standard. Note Range values do not support value constraints. System properties do not support default values.
          Range Type	Range types include Unspecified, Interval, Specified Lookup Table (all Values), and Enum. Unspecified: Allows you to specify the type when you create a data standard. Interval: Suitable for continuous numeric or date values. Supports Numeric and Date/time field types. Example: For the range property of a Member Birthday standard, specify an interval. When you create the standard, enter: >1900-01-01, no limit. Specified Lookup Table (all Values): Suitable for property values that change dynamically or must follow a constraint. Supports Numeric, Date/time, and String field types. Example: For the range property of a Member's Frequent Delivery City standard, reference a lookup table. When you create the standard, select the "China Region Code Table" lookup table. Custom Input Enumeration Values: Suitable for a small number of values that do not change frequently. Supports Numeric, Date/time, and String field types. Example: For the range property of a Member Registration Channel standard, specify enumeration values. When you create the standard, enter: Mini Program, Official App, Offline Member Store. Note If the field type is Boolean, the value type cannot be set to a range.
          Default Value	Specifies a default value for each property. When you create a standard, this property is pre-filled with the default value. This is suitable for properties whose values do not change often. You can configure different default values based on the selected field type and value constraints. Note If you set value constraints, the default value must also comply with the constraints.

       2. Click OK to create the custom property.

          After you configure the standard template properties, you can view the configured properties on the Standard Template page. You can also search, filter, sort, edit, clone, and delete properties.

          

          Area	Description
          ①Filter and search area	You can search by property name or code. You can also click the filter icon to filter by property source, whether it is required, and standard-to-asset mapping monitoring.
          ②Sort and preview	Sort: Affects the display order of standard properties on the data standard page. Sorting is available only on the All Properties page. You can drag the icon next to a property name to change its order. You can also use the icons in the Actions column to move the property. The icons from left to right are: Move Up, Move Down, Move to Top, and Move to Bottom. Preview: Displays a preview of the property configuration form for creating a new standard. The preview is based on the latest property styles and order. Click to view the input style. No information is saved.
          ③List area	Displays the property name, code, type, whether it is required, field type, field length, value, value constraints, standard-to-asset mapping monitoring, and description.
          ④Actions area	You can edit, clone, and delete properties. Edit: Changes to property information affect associated unpublished data standards. Evaluate the impact before you make changes. For built-in system properties, you cannot modify the property name, code, type, or whether it is required (Standard English Name and Standard Type can be modified). When you reference a system public property, you can modify whether it is required and the description. For range properties, you can also modify the data type and range type. Clone: Quickly duplicates the property information of the standard. Delete: Deleting a property is irreversible. Proceed with caution. Built-in system properties cannot be deleted.

6. Click Save And Publish to save the current sort order. In the Save And Publish Standard Template dialog box, enter a description for this version.

7. Click OK to publish the standard template to the production environment.

View standard templates

On the Standard Template page, you can view default and custom standard templates. You can also edit, delete, and create data standards from the templates.

Standard template details

• Property Information: Displays the basic information and property details of the standard template. You can click Edit Basic Information or Edit Property Information to edit the basic information or properties of the template. You can also switch to view historical versions.

• Reference Information: Displays information about the data standards that reference any version of the standard template. The information includes Standard Name/Code, Description, Parent Folder & Standard Set, Owner, and Referenced Version.

  • Click the name of a data standard to view its property details.

  • Click the name of a data standard set to view its details.

  • Click the version number of the standard template to view the property information of that version.

• Version History: Displays the version history of the standard template, including Version Number, Submitter, Submission Time, and Version Description. Click the View Details icon to view the details of a specific version.

Batch operation records

What to do next

After you create a standard template, you can create data standards based on the template. For more information, see Create and manage data standards.