Skip to main content

Integrate WeCom Approval Workflows

Connect WeCom approval templates and callback events to NineData so that database DevOps tasks can use WeCom for approval.

Before you begin​

  • You have already created or joined an organization, and the organization has subscribed to 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 been switched to the target organization. For more information, please refer to Switching to an Organization.
  • Sign in to WeCom as an enterprise administrator.
  • The NineData deployment is a Dedicated Cluster.
  • You have system administrator permissions in NineData.
  • The WeCom organization has been configured with its departments and employee phone numbers or account names.

Step 1: Create a WeCom self-built application​

  1. Sign in to WeCom.
  2. Open Applications > Applications, find Self-built, and click Create Application.
  3. Enter the application logo, name, description, and visibility scope. Save the application and record corpId, appSecret, token, and encodingAesKey from the application details.
  4. In the developer interface settings, configure the trusted domain and add the public IP address of the NineData server to Enterprise Trusted IP.

Step 2: Create a WeCom approval template​

  1. Open the WeCom approval management page.
  2. Under Template Management, click Add Template > Custom Template.
  3. Design the form and workflow as required, and publish the template.
  4. Do not use Applicant selects approver when configuring approvers, because the WeCom API call will fail. Set a visibility scope that includes all users who need to submit approvals.
  5. Record the ID at the end of the template URL.

Step 3: Authorize the template and application​

  1. In WeCom, open Applications > Applications and select the Approval application.
  2. Click API.
  3. Add the template from Step 2 to Templates for Callback Notifications.
  4. Under Applications Allowed to Call APIs, select the self-built application from Step 1 and confirm.

Step 4: Bind the WeCom application in NineData​

  1. Sign in to the NineData Console.

  2. In the left navigation bar, click DevOps > Policy & Process.
  3. Open Approval Process and click External approve channel.
  4. Click Add External Approval Channel and enter the WeCom application information, then click OK.
  5. Click the new application ID and record Callback url. This URL must be publicly reachable from WeCom.
  6. Open Approval Process Mapping Definitions, create a mapping definition, and map the NineData fields to the fields in the WeCom template from Step 2.

Step 5 (Optional): Configure the callback URL​

  1. In WeCom, open the target application.
  2. Under Receive Messages, click Set API Receive.
  3. Enter the callback URL, token, and encoding AES key required by the application, then save.

Step 6: Bind the approval workflow​

  1. Sign in to the NineData Console.

  2. In the left navigation bar, click DevOps > Policy & Process.
  3. Open Approval Process, select the target process, and open Details.
  4. Select the task type, click Edit, enable Launch External Approval Workflow, select the WeCom application, select the corresponding WeCom workflow ID, and click OK.