All Products
Search
Document Center

Dataphin:Approval settings

Last Updated:Jan 21, 2025

Dataphin integrates seamlessly with internal enterprise systems and DingTalk OA to manage approval flows, offering a unified IT management solution with enterprise-level internal process systems. Users enjoy an approval experience consistent with their original system, complemented by the ability to define custom approval rules. For instance, requests for low-sensitivity assets can be set for automatic approval, while those for high-sensitivity assets require specific approvers. This topic outlines the integration process with external approval systems.

References

Select Approval System When opting for Third-party Approval, you can utilize third-party approval flows. For more information, see the referenced document.

Background information

Integrating Dataphin with external approval systems requires addressing user matching and mapping discrepancies, as well as interface conversion. Often, a Proxy application is developed to bridge Dataphin's interface with that of the external approval system. Utilizing the approval system SDK simplifies the development of the Proxy application, enabling the quick establishment of basic workflows.

image

Limits

Configuration of approval settings is restricted to accounts with superuser or system administrator roles.

Precautions

Be aware of the following when modifying approval flow settings, especially if there are ongoing approval requests:

  • Transitioning from Dataphin's internal approval flow to an external one allows in-progress requests (initiated but not completed) to continue within Dataphin.

  • Switching between external approval flows or altering their settings will cause in-progress requests to follow the new flow. Changes to the callback URL, including authentication details, may lead to callback failures, preventing the approval status from syncing with Dataphin. In such instances, reinitiate the approval process and close the original request by revoking it.

  • If you switch from an external to Dataphin's internal approval flow, the external system's in-progress request outcomes won't sync with Dataphin. You can close the original request by revoking it.

Approval settings entry

  1. Log on to the metadata warehouse tenant with a superuser or system administrator account.

  2. Navigate to the Dataphin home page and single click the Management Center on the top menu bar.

  3. To access the Approval Settings page, follow these steps:

    Single click System settings -> Approval settings.

    image

Configure approval settings

Dataphin's approval system accommodates both built-in and external systems, offering the flexibility to enable or disable external systems. Once configured, these settings can be selected within Approval templates - Approval system.

Note
  • Enabling the external approval system allows for either the built-in or an external system to be set as the default.

  • Disabling the external system sets the built-in system as the default.

Built-in approval system

On the Approval Settings page, designate the Built-in Approval System as the default and click Save to finalize the configuration.

image

External approval system

  1. To enable the External Approval System, set Third-party Approval as the default and configure the necessary parameters.

    image

  2. In the Select Approval System dropdown, choose Dingtalk OA and enter the required parameters.

    DingTalk OA

    Parameter

    Description

    External approval system configuration

    Approval System Name

    Name your approval system, ensuring it does not exceed 128 characters.

    Select Approval System

    Choose Dingtalk OA from the dropdown.

    Approval service configuration

    API Address

    Input the API address for DingTalk OA.

    AppKey

    Enter the AppKey for DingTalk OA.

    Appsecret

    Provide the Appsecret for DingTalk OA.

    Click Test Connection to verify connectivity between Dataphin and the external approval system. If the test fails, follow the prompts to resolve any issues.

    Callback URL

    This is the URL where Dataphin receives callback results from DingTalk OA. The system generates the Callback URL automatically, but customization is possible. The format is https://<Dataphin deployment domain name>/task/callback.

    Encoding AES Key

    Enter the encryption and decryption key.

    Click the icon to generate the Encoding AES Key automatically.

    Token

    Input the token used for DingTalk OA client authentication.

    Click the icon to generate it automatically.

    AgentId

    Enter the AgentId for DingTalk OA.

    Others

    Parameter

    Description

    External approval system configuration

    Approval System Name

    Name your approval system, ensuring it does not exceed 128 characters.

    Select Approval System

    Choose Other as the approval system and download the SDK file.

    Approval service configuration

    Submit Approval Request URL

    Specify the URL for submitting approval requests to the external system. Dataphin will send user approval requests to this URL.

    Access Token

    The Access Token serves as the authentication credential for accessing the external approval system. It is necessary when Dataphin submits requests to the system.

    Click Test Connection to verify connectivity between Dataphin and the external approval system. If the test fails, follow the prompts to resolve any issues.

    Callback URL

    This URL is where Dataphin receives callback results from the external approval system. The system generates the Callback URL by default, but it can be customized. The format is https://<Dataphin deployment domain name>/api/oa/bpms/integration/thirdparty/callback.

    Encoding AES Key

    Enter the encryption and decryption key.

    Click the icon to generate the Encoding AES Key automatically.

  3. Once the parameters are set, click Save to apply the changes.