Dataphin:Create and manage standard templates

Permission description

• Super administrators and data standard administrators have the authority to create and manage standard templates.

• Super administrators, data standard administrators, and template maintenance personnel are permitted to edit and delete standard templates.

• Super administrators, data standard administrators, roles with data standard management permissions, and the creators of imported records can access details of standard template imports and encoding correction records.

Limits

A tenant is limited to creating a maximum of 500 standard templates.

Create a standard template

1. Navigate to the Dataphin home page, and single click the top menu bar Administration > Standard.

2. In the left-side navigation pane, select Standard Template. On the customize template page, click the upper right corner Create Template button.

3. In the Create Standard Template dialog box, fill in the basic information parameters.

   Parameter	Description
   Template Name	Enter a globally unique name for the standard template, not exceeding 128 characters.
   Template Code	Provide a globally unique code for the standard template, accepting English letters, numbers, and underscores (_), with a maximum of 64 characters.
   Owner	Designate the maintenance personnel responsible for the regular upkeep of the standard template, who will have the ability to edit template information.
   Description	Include a description of the usage scenarios for the standard template, limited to 512 characters.
   Standard Code	This is used to define the encoding generation rules for data standards that reference this template, enhancing encoding standardization and reducing manual configuration and management efforts. Two methods are supported: Customized Encoding and Automatically Generated Based on Encoding Rules. Customized: Allows for custom standard code input when creating data standards. Automatically Generated Based On Encoding Rules: Automatically generates the encoding value based on the configured rules in the referenced standard template (modifiable post-generation). Supports up to 5 encoding rules, including auto-increment sequences (based on standard creation order), fixed strings, and associated standard set encoding, with only one auto-increment sequence allowed. Auto-increment Sequence (in The Order Of Standard Creation): Increments based on the standard ID generation time, allowing specification of the number of digits, starting value, and step size. If a standard set encoding is also configured, it will increment within each standard set, ensuring continuity within the set for easier management. You can reorder the rules by dragging and dropping using the icon. Encoding will be generated based on the order of the rules. Number Of Digits: Specifies the digit count for the auto-increment sequence, accepting positive integers between 1 and 12. For example: 4. Starting Value: Sets the starting point for the auto-increment sequence. The starting value's digit count must not exceed the configured digit length. For example: 1. Step Size: Determines the increment between adjacent values in the sequence, accepting positive integers between 1 and 10. Pad starting digits with 0: If selected, leading zeros will be added to match the configured digit count. String: Accepts up to 20 characters, excluding leading or trailing spaces. For example: ads_. Associated Standard Set Encoding: Uses the encoding of the selected associated standard set when creating data standards. If an auto-increment sequence is configured, it will increment within the standard set. Encoding preview: Generates a preview of the encoding rule based on the configured automatic generation rules. The preview of the standard encoding formed by the example values of the configured rules is illustrated below: Note Selecting Strictly Validate The "standard Code" Value Against The Rule Constraints When Submitting The Standard ensures that the encoding value configured for data standards based on the current template (including manual modifications) adheres to the rule constraints upon submission, promoting encoding standardization. It is advisable to verify that the encoding rule configuration does not conflict with the attribute constraints of the standard code to prevent creation failures due to constraint violations. If encoding rule configurations are modified, you can decide whether to regenerate existing standard codes. For more information, see Regenerate.

4. Click Next to proceed to the standard template attribute configuration page.

5. Click Create Attribute to add attribute information to the standard template. You can choose either Public Attribute or Create Custom Attribute.

   Note

   • Referencing custom attributes allows for full configuration modification to quickly add reusable attributes; referencing system attributes permits partial configuration changes. If system attributes are set with standard monitoring, data standards created from the standard set will inherit the monitoring setup and can access mapping records and evaluation results in the standard evaluation details. For more information, see System Attribute List, View Standard Evaluation Details.

   • By default, the system generates four mandatory attributes: Standard Code, Standard Name, Standard English Name, and Standard Type.

   • Create Custom Attribute: User-defined attributes that can be tailored to specific business requirements.

   • Reference Public Attribute: Quickly incorporate pre-configured public attributes to enhance efficiency.

     • System Attribute

       1. In the Public Attribute dialog box, select an attribute. The pages for system attributes and custom attributes are similar, with the distinction that custom attributes support the Clone reference method. The following image exemplifies the System Attribute selection.

          Note

          • After adding custom attributes, you can modify all configurations for quickly addingreusable attributes; supports the clone reference method, which can be modified independently and is not affected by subsequent changes to public attributes.

          • After referencing system attributes, only part of the configurations can be modified, and other configurations reference public attributes.

          

          Area	Description
          ①Filter and Search Area	Filter by Attribute Type, such as Business Attribute, Technical Attribute, Management Attribute, Quality Attribute, Master Data Attribute, Lifecycle Attribute, or Security Attribute. Alternatively, search by Attribute Name or Attribute Code.
          ②List Area	Attributes with the same name already configured in the list cannot be added again.
          ③ Select All on This Page	Operate on the objects on the current page. The number of selected custom attributes and system attributes is displayed here.
          ④Confirm	Click confirm to finalize the quick addition of attributes. Attribute configurations can be modified via Edit.

       2. Click Confirm to complete the reference of public attributes.

     • Custom Attribute

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

          Parameter	Description
          Attribute Name	The name of the public standard attribute, unique within the current public standard attribute set. Names starting with an asterisk (*) are not supported, and the length should not exceed 128 characters.
          Attribute Code	The unique code of the public standard attribute.
          Attribute Type	Choose the desired type of public standard attribute, such as Business Attribute, Technical Attribute, Management Attribute, Quality Attribute, Master Data Attribute, Lifecycle Attribute, or Security Attribute.
          Is It Required	The default is set to No, but can be toggled to Yes.
          Description	Provide a description for the public standard attribute, limited to 512 characters.
          Input Type	The input type affects how attribute values are entered and stored when creating standards. Various attribute field types are available based on the input method: Text Input: character, numeric, datetime. Dropdown Single Select: character, numeric, Boolean, datetime. Dropdown Multi-select: character, numeric, datetime. Range: character, numeric, datetime. Example graphs for creating a new data standard based on different input methods are provided below: Note Field types are categorized as character type: STRING; numeric type: BIGINT, DOUBLE (up to 6 decimal places); Boolean type: BOOLEAN (values are True or False); date and time type: DATE (yyyy-mm-dd), DATETIME (s). When the field value is set to custom input and the field type is character type, you can configure the length of the property value. This length is constrained by the maximum value entered during the creation of the standard, up to a limit of 10000 characters. When the field value selection is custom input (numeric type, date and time type), Drop-down Single Selection Box, or Drop-down Multi-selection Box, you can configure the Value Range to enhance the data standard specification. For more information, see the Value Range configuration. When the field value selection is set to Range, configuration of the Range Type is supported. For additional information, refer to the Range Type configuration details.
          Value Range	Limits the range of permissible attribute values by defining a value range. During the creation of data standards, attribute values are set in accordance with the specified filling requirements. Depending on the chosen Input Type, various value ranges can be established: Custom Input (Numeric Type/Date-Time Type): If the field type is numeric or date-time, you can configure the attribute value constraint range, supporting either no limit or a specified range. No Limit: Allows custom input of attribute values when creating standards, without constraints on the value range. Specified Range: Requires input of attribute values according to the specified range when creating standards. Dropdown Single/multi Select: For Character Type fields, you can configure the constraint range with custom enumeration values, specific code table values, or system attributes. For Numeric Type or Date-Time Type fields, the constraint range can be set using custom enumeration values or specific code table values. Boolean Type fields require no configuration. Enum: Separate multiple enumeration values with English half-width commas, ensuring the total character count does not exceed 10,000. To add values in bulk, single click Batch Edit and input the values into the Batch Edit Enumeration Options dialog box, using either English half-width commas or carriage returns to separate them, without surpassing the 10,000 character limit. Note the following special enumeration types: If the attribute field type is Boolean Type, it is preset with fixed values: True or False, and requires no further configuration. If the attribute field type is Date Type, use the format yyyy-MM-dd, such as 2022-09-01. When the attribute field type is Date-time Type, use the format yyyy-MM-dd hh:mm:ss, such as 2022-09-01 12:00:00. Specified Code: You can only select code tables that have a Published status. The code values from the configured code table here become the selectable options for this attribute when establishing data standards. System Attribute: For fields of the Character Type, system attributes such as data blocks, projects, users, and user groups can be set. When data blocks are selected for this attribute, the available options during the creation of data standards include all data blocks associated with the current tenant. Note Range values do not support configuring value constraints. System attributes do not support configuring default values.
          Range Type	Select from range value types such as Unspecified, Interval, Specified Code Table (range For All Values), and Enum. Unspecified: Allows for specifying the type when creating data standards. Interval: Ideal for continuous numbers or dates, supporting Numeric Type and Date-time Type field types. For instance, if the Member Birthday standard's value range attribute specifies an interval, then when creating the standard, you would enter: >1900-01-01, no limit. Specified Code Table (range For All Values): Suitable for attributes with dynamically changing values or specific constraints, supporting Numeric Type, Date-time Type, and Character Type field types. For example, if the Member's Common Delivery Location City standard's value range attribute references a code table, then when creating the standard, you would select the "China Region Code Table." Custom Input Enumeration Values: Appropriate for scenarios with a limited number of infrequently changing values, supporting Numeric Type, Date-time Type, and Character Type field types. For instance, if the Member Registration Channel standard's value range attribute specifies enumeration values, then when creating the standard, you would enter: miniapp, official APP, offline member store. Note If the field type is Boolean Type, the field value type does not support being configured as a range value.
          Default Value	Specify default values for each attribute. When creating a standard, this attribute will be pre-filled with the set default value, which is useful for attributes with infrequent value changes. Depending on the field type and value constraints, various default values can be set. Note The default value must comply with any set value constraints.

       2. Click Confirm to finalize the creation of custom attributes.

          Upon configuring the standard template attributes, you can review the information on the Standard Template list page and perform operations such as search, filter, sort, edit, clone, and delete.

          

          Area	Description
          ① Filter and Search Area	Search by attribute name or code, or use the filter button to narrow results by attribute source, requirement status, and standard monitoring.
          ② Sort and Preview	Sort: Influences the display order of standard attributes on the data standard page. Sorting is available on the All Attributes page. Drag to sort using the icon or use the operation column icons to move attributes up or down. The icons, from left to right, are: move up, move down, move to top, move to bottom. Preview: Showcases the attribute configuration section of the form generated when creating a new standard based on the latest attribute configurations and their sequence. Click to view the fill style, though no information will be saved.
          ③ List Area	Displays detailed information for attributes, including name, code, type, requirement status, field type, length, value, constraints, standard monitoring, and description.
          ④ Operation Area	Perform edit, clone, and delete operations on attributes. Edit: Modifying attribute information will affect associated unpublished data standards. Evaluate and complete the changes accordingly. System-built data attributes cannot be modified in terms of name, code, type, and requirement status (standard English name and standard type are exceptions). Referencing system public attributes allows for modification of requirement status and description. Value range attributes also permit changes to the data type of the fill method and range type information. Clone: Quickly duplicate the attribute information of the standard, effectively creating a copy. Delete: Deletion is irreversible. Exercise caution when deleting attributes. System-built attributes cannot be deleted.

6. To save the current sort order and prepare it for online publication, single click Save And Publish. Then, in the Save And Publish Standard Template dialog box, enter a version description to serve as a reference.

7. Click Confirm once to publish the standard template to the production environment.

View standard template

Once the standard template is created, you can edit, delete, and create standards using the template.

Standard template details

• Attribute information: This section presents both the essential details and the comprehensive attributes of the standard template. To modify the template's basic or attribute information, simply Edit Basic Information or Edit Attribute Information. Additionally, it facilitates the review of historical version records.

• Reference information: Shows details for all versions of the standard template used by data standards, covering Standard Name/Code, Description, Directory & Standard Set Association, Owner, and Referenced Version.

  • Click on the data standard's name to view its detailed attribute information.

  • Click on the standard set's name to access its detailed information.

  • Click on the version number of the standard template to view its attribute information.

• Historical versions: Lists the historical versions of the standard template, including Version Number, Submitter, Submission Time, and Version Description. Click the view details icon to explore the specifics of a particular version.

Batch operation records

What to do next

After creating the standard template, proceed to configure data standards based on the template. For guidance, refer to Create and manage data standards.