Approval settings

Related documentation

When you select Third-party Approval for the Select Approval System option, you can use a third-party approval flow. For more information, see Integrate with a custom approval system.

Background information

When you integrate Dataphin with an external approval system, you typically need to develop a proxy application. This application maps user accounts between Dataphin and the approval system and handles differences in their respective APIs and data formats. The provided approval system SDK helps you develop this proxy application and quickly establish the basic approval flow.

Limitations

Only users with the super administrator or system administrator role can configure approval settings.

Usage notes

When you change the approval flow settings, note the following effects on in-progress approval requests:

• If you switch from the Dataphin built-in approval flow to an external one, in-progress approval requests (requests that have been submitted but not yet completed) are still processed within Dataphin.

• If you switch from one external approval flow to another, or change the flow's configuration parameters, in-progress approval requests are processed according to the new flow. If you change the callback URL, including its authentication information, the callback might fail, which prevents the approval status from being synchronized to Dataphin. You must withdraw (or force-withdraw) the original approval request and submit a new one.

• If you switch from an external approval flow back to the built-in one, the results of in-progress approvals from the external system cannot be synchronized to Dataphin. Withdraw (or force-withdraw) the original approval request to close it.

Configure approval settings

1. Log on to the metastore tenant as a super administrator or system administrator.

2. In the top navigation bar of the Dataphin homepage, choose Admin Center > System Settings.

3. In the left navigation bar, select System Settings > Approval Settings to open the Approval Settings page.

4. Configure the Default Approval System.

   When External Approval System is disabled, the default is the Built-in Approval System. When External Approval System is enabled, you can set either the Built-in Approval System or a Third-party Approval System as the default. If you use an external approval system, you must also configure its system and service settings.

   Note

   This selection sets the default Approval System for an approval template.

5. Configure External Approval System Configurations and Approval Service Configurations.

   • Approval System Name: Enter a custom name for the approval system. The name can be up to 128 characters long and can include any character type.

   • Select Approval System: You can select DingTalk OA or Other. The required service configurations vary depending on your selection.

     DingTalk OA

     Parameter	Description
     API address	Enter the API address for DingTalk OA.
     AppKey	Enter the AppKey for DingTalk OA.
     AppSecret	Enter the AppSecret for DingTalk OA. Click Test Connection to verify connectivity between Dataphin and the external approval system. If the test fails, troubleshoot the issue based on the error message that appears on the page.
     DingTalk account mapping	For users without a configured DingTalk UID, the system automatically attempts to match their Source_UID from SSO. If the match fails, an error occurs. In addition to using the Batch Update feature, you can also manage DingTalk UIDs for individual members in Admin Center > Member Management. Click Batch Update and follow the steps in the Batch Update dialog box to import the data. Download Data: Exports the first 10,000 Dataphin users. The exported data includes username, Dataphin_UID, Source_UID, phone number, email address, and DingTalk UserID. Upload Excel File: Supports only .xlsx files with no more than 10,000 rows. Import Configurations: If a user in the uploaded file does not exist, the user is ignored. If a DingTalk UID is provided, it is updated. Email addresses and phone numbers are not updated.
     Callback URL	The URL where Dataphin receives callback results from DingTalk OA. The system automatically generates this URL. You can customize it in the format: https://{Dataphin-deployment-domain}/task/callback.
     Encoding AES key	The key used for encryption and decryption. Click the icon to automatically generate an Encoding AES Key.
     Token	The token used for authentication with the DingTalk OA client. Click the icon to automatically generate a token.
     AgentId	Enter the AgentId for DingTalk OA.

     Other

     For information about how Dataphin interprets different parameter values passed from an external approval system, see Parameter value mapping.

     Parameter	Description
     Integration mode	Select either Display only the final approval result or Display all nodes of the third-party approval. The default is to display only the final result. Display only the final approval result: Only the final result from the approval system is returned. Dataphin displays only the start and end nodes. Display all nodes of the third-party approval: The approval system must return details for each node. Dataphin synchronizes and displays all approval nodes.
     Submit approval request URL	The URL of the external approval system. Dataphin sends user-submitted approval requests to this URL.
     Access token	This token authenticates Dataphin to the external approval system and must be included in each approval request. Click Test Connection to verify connectivity between Dataphin and the external approval system. If the test fails, troubleshoot the issue based on the error message that appears on the page.
     Callback URL	The URL where Dataphin receives callback results from the external approval system. The system automatically generates this URL. You can customize it in the format: https://<Dataphin-deployment-domain>/api/oa/bpms/integration/thirdparty/callback.
     Encoding AES key	The key used for encryption and decryption. Click the icon to automatically generate an Encoding AES Key.

     Parameter value mapping

     Field name	Condition	Displayed value
     Operation	No specific condition	The value of node_name.
     Result	"node_status": "PENDING"	Pending Approval
     	"node_status": "APPROVED"	Approved
     	"node_status": "REJECTED"	Rejected
     	"node_status": DELEGATED	Add Approver ${User Name}
     	"node_status": TRANSFERRED	Transfer ${User Name}
     Operator	"node_status": PENDING "approverRelation":or	All pending approvers. The value is taken from the user_name in the pending_approvers field.
     	"node_status": PENDING "approverRelation":and	Pending approval: ${Pending Approver 01}, ${Pending Approver 02}, ${Pending Approver 03} Already approved: ${Approver 01}, ${Approver 02}, ${Approver 03}
     	All other cases	Operator
     Operation description	"node_status": PENDING "approverRelation":or	Approved if any one approver agrees.
     	"node_status": PENDING "approverRelation":and "operator" is empty	Approved only if all approvers agree.
     	"node_status": PENDING "approverRelation":and "operator" is not empty	Some approvers have approved: ${Approver Name}(${Reason for approval}), ${Approver Name}(${Reason for approval})... Example: Some approvers have approved: John Doe (Agreed), Jane Smith (Request is reasonable, approved for go-live).
     	All other cases	The reason from the operator.

6. After you configure the parameters, click Save.

Appendix: Integrate with the new DingTalk OA