Data Management:Schema design

Basic configuration items

Checkpoints

DMS provides various built-in templates of security rules to validate these two processes. You can use the templates or modify the templates as needed. For more information, see Procedure of creating a security rule.

Factors and actions

• Factor: A factor is a built-in variable that is used to obtain the context to be validated by security rules, such as the categories of SQL statements and the number of rows in which data is affected. A factor name consists of the prefix @fac. and the display name of the factor. Each module of the Security Rules page offers different factors for different checkpoints. The following table describes the factors that are provided for the checkpoints in the Schema Change module.

  Factor	Description
  @fac.table_kind	The type of the table whose schema is to be changed. Valid values: new: a newly created table old: an existing table
  @fac.column_kind	The type of the field to be changed. Valid values: new: a newly created field old: an existing field
  @fac.xxxx_old	The value of an existing field or index that is used for comparison.
  @fac.column_is_primary	Indicates whether the field serves as a primary key column. Valid values: true: The field serves as a primary key column. false: The field does not serve as a primary key column.
  @fac.column_type_support_default	Indicates whether a default value can be set for the field of a data type. Valid values: true: A default value can be set. false: A default value cannot be set. For example, a default value can be set for a field of the CHAR type, but cannot for a field of the TEXT type.
  @fac.index_kind	The type of the index to be changed. Valid values: new: a newly created index old: an existing index
  @fac.index_column_count	The number of fields in the index.
  @fac.change_type	The type of the schema change performed by using DDL statements. Valid values: new: Adds one or more fields or indexes. modify: Modifies one or more fields or indexes. delete: Deletes one or more fields or indexes.
  @fac.altered_table_size	The size of the table whose schema is to be changed. Unit: MB
  @fac.online_execute	Indicates whether the schema change can be performed in an online environment. Valid values: true: The schema change can be performed in an online environment. false: The schema change cannot be performed in an online environment.
  @fac.change_risk_level	The risk level of the schema change. Valid values: high middle low
  @fac.env_type	The type of the environment. The value is the display name of the environment type, such as DEV and PRODUCT. For more information, see Change the environment type of an instance.

• Action: An action is the operation that DMS performs after the conditions specified in the if statement are met. For example, DMS can perform actions to prohibit submitting a ticket, select an approval process, approve a ticket, or reject a ticket. Actions show the purpose of security rules. An action name consists of the prefix @act. and the display name of the action. Each module of the Security Rules page offers different actions for different checkpoints. The following table describes the actions that are provided for the checkpoints in the Schema Design module.

  Action	Description
  @act.block_submit	Blocks submitting the schema change and displays the error message. This action can be used in the process of saving changes. The format of the statement: @act.block_submit 'Reason for blocking'.
  @act.show_warning	Displays the error message without blocking submitting the schema change. This action can be used in the process of saving changes. The format of the statement: @act.show_warning 'Error message'.
  @act.mark_middle_risk	Specifies that the schema change is at medium risk. This action can be used in the process of identifying the risk level. The format of the statement: @act.mark_middle_risk 'Reason for the identification'.
  @act.mark_high_risk	Specifies that the schema change is at high risk. This action can be used in the process of identifying the risk level. The format of the statement: @act.mark_high_risk 'Reason for the identification'.
  @act.forbid_submit_publish	Rejects the ticket. This action can be used in the process of setting the approval process. The format of the statement: @act.forbid_submit_publish 'Reason for the rejection'.
  @act.do_not_approve	Specifies the ID of an approval template. For more information, see Configure approval processes.
  @act.choose_approve_template
  @act.choose_approve_template_with_reason

Templates of security rules

Procedure of changing the default approval template

1. Log on to the DMS console V5.0.
2. In the top navigation bar, choose Security and Specifications > Security Rules.
3. On the Security Rules page that appears, find the security rule set that you want to modify and click Edit in the Actions column.
4. In the left-side navigation pane of the Details page, click the Schema Design tab.
5. On the Schema Design tab, click Basic Configuration Items.
6. Find the Default approval template for schema design configuration item and click Edit in the Actions column.
7. In the Change Configuration Item dialog box that appears, click Switch Approval Template.
8. Find the template that you want to apply and click Select in the Actions column.
   Note You can also click Reset to Free of Approval to skip the approval for tickets.
9. Click Submit.

Procedure of creating a security rule

1. Log on to the DMS console V5.0.
2. In the top navigation bar, choose Security and Specifications > Security Rules.
3. On the Security Rules page that appears, find the security rule set that you want to modify and click Edit in the Actions column.
4. In the left-side navigation pane of the Details page, click the Schema Design tab.
5. On the Schema Design tab, click Create Rule next to Actions.
6. In the Create Rule - Schema Design dialog box that appears, set the parameters as required. The following table describes the parameters.

   Parameter	Description
   Checkpoints(Required)	The checkpoint for which you want to create the security rule. DMS provides various checkpoints in the Schema Design module. For more information, see Checkpoints.
   Template Database (Optional)	The template based on which you want to create the security rule. DMS provides various built-in templates of security rules. After you select a checkpoint from the Checkpoints drop-down list, you can click Load from Template Database to select a template. For more information about the available templates, see Templates of security rules.
   Rule Name(Required)	The custom name of the security rule. If you load a security rule from a template in the Template Database, the rule name is automatically filled in.
   Rule DSL(Required)	The domain-specific language (DSL) statement used to set the security rule. For more information, see . If you load a security rule from a template in the Template Database, the statement is automatically filled in.

7. Click Submit.
8. By default, the security rule that you create is in the Disabled state. Find the created security rule and click Enable in the Actions column.
9. In the message that appears, click OK.