Skip to main content

Manage SQL approval processes

NineData provides default approval processes for development and production environments. Use approval processes to control when SQL tasks, permission requests, exports, imports, and SQL reviews require manual approval.

Important notes

  • The creation of a new process must be based on an existing process.
  • The default process cannot be deleted, but it can be edited.
  • In the DevOps Pro edition, creating processes is not supported, while the DevOps Enterprise edition has no such limitation.

Before you begin

  • You have created or joined an organization, and this organization has subscribed to either DevOps Pro or DevOps Enterprise. Please ensure that your annual or monthly subscription is still active. For more information, please refer to Manage Organizations.
  • Your current account has switched to the target organization. For more information, please refer to Switching to an Organization.
  • Your role in the organization is a Administrator.

No specified approver

Turn on Not Specifying Approvers when submitters should not choose a specific approver. All users with approval permission receive the approval notification. This helps prevent important tasks from waiting for one unavailable approver.

Create a process

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.

  3. On the Policy & Process page, click the Approval Process tab, and click Create Process.

    tip

    Alternatively, click Duplicate in the Actions column to create a new process based on an existing process.

  4. In the Create Process dialog, configure the parameters and click OK.

    • Duplicate Process: Select which process to use as the basis for the new process.

      tip

      If you arrived at this dialog by clicking Duplicate, this is already pre-selected.

    • Name: Enter a meaningful name for the new process. The name must be 1 to 32 characters.

      tip

      If you arrived at this dialog by clicking Duplicate, this is already filled in.

    • Description (optional): Enter a description for the new process. The description must be 1 to 64 characters.

  5. The console opens the Details page. Edit approval processes for various tasks on this page. The Not Specifying Approvers feature at the top of the page lets users submit approval requests without manually selecting an approver. Instead, all users with approval permission receive approval notifications.

    Approval processes are grouped into categories such as SQL Task, Apply Permission, Data Export, Data Import, and SQL Code Review. Use the tabs to switch categories. Click Edit next to a target process to configure it. The main parameters are described in this table.

    ParameterDescription
    Approve ManagerChoose whether users can submit the approval process.
    • Allow to Submit: Lets users advance the approval process to the next level.
    • NOT Allow to Submit: Blocks the user's approval process, preventing further advancement.
    Enable ProcessWhen Approve Manager is set to Allow to Submit, choose whether to enable the approval process.
    • Turned on: Approval processes submitted by users must undergo manual approval.
    • Turned off: Users do not require manual approval; the approval process proceeds directly.
    Approval ProcessWhen the Enable Process switch is on, click the Add button to add an approval node. Clicking the Add button multiple times adds multiple approval nodes. Enter the name of the approval node in the left text box and select the approver for that node on the right. Click the delete icon next to the approval node to delete it.

Edit a process

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.
  3. On the Policy & Process page, click the Approval Process tab, and then click the target Name.
  4. The console opens the Details page. Edit the approval process for each triggered rule level on this page.

Delete a process

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.

  3. On the Policy & Process page, click the Approval Process tab.

  4. Click the process you want to delete. On the Details page, click Delete.

    tip

    Alternatively, click Delete in the Actions column for the target process.

  5. In the confirmation window, click Delete.

    tip

    If the current process is already associated with an environment or data source, select a replacement process for these resources in the Associated envir. and datasources existed, Please modify first. window, and then click Modify and Delete.

Associate a process with an environment

When you associate an approval process with an environment, the new process replaces the previous environment process. All data sources in that environment use the new process.

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.
  3. On the Envir. Config tab, find the target environment name and click Edit in the Actions column.
  4. In the Edit Envir. Config window, select the required Approval Process and click OK.

Associate a process with a data source

When you associate an approval process with a data source, that data source uses the selected process instead of the process inherited from its environment. Other data sources in the same environment are not affected.

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.

  3. Click the Datasource Config tab, find the target data source name, and click Edit in the Actions column.

    tip

    In the Approval Process associated with the data source, the bind icon on the left indicates that Approval Process has inherited the configuration in the environment.

  4. In the Edit Datasource Config window, clear the checkbox to the left of Inheriting Envir. Config under Approval Process, select the required Approval Process, and click OK.

    tip

    To restore the Approval Process configured in the environment, select Inheriting Envir. Config again.

Link a process to a database group

Database groups are used for unified table changes across distributed databases. When an approval process is linked to a database group, the group uses that process instead of the process set for the environment. Other data sources in the environment are not affected.

  1. Sign in to the NineData Console.

  2. Go to DevOps > Policy & Process.

  3. Click the DB Group Config tab, find the target database group name, and click Edit in the Actions column.

    In the Approval Process linked to the database group, icons like bind on the left indicate inherited Approval Process from the environment configuration.

  4. In the Edit Group Config window, clear the checkbox to the left of Inheriting Envir. Config under Approval Process. Then select the desired Approval Process and click OK.

    Select Inheriting Envir. Config again to restore the Approval Process configuration inherited from the environment.

Result

The selected approval process takes effect at the configured scope. Environment-level processes apply to all data sources in the environment, while data source and database group processes override the inherited process only for that target.

Next steps

  • Confirm that each approval node has the correct approvers.
  • Pair the approval process with the relevant SQL development policy in Manage SQL development policies.