All Products
Search

This Product

    Data Management:Configure notification by DingTalk Standard Edition, DingTalk Exclusive Edition, and Lark

    Document Center

    Data Management:Configure notification by DingTalk Standard Edition, DingTalk Exclusive Edition, and Lark

    Last Updated:Oct 25, 2024

    Data Management (DMS) is connected to DingTalk Standard Edition, DingTalk Exclusive Edition, and Lark. You can view notifications on mobile devices and clients. This way, approvers can approve tickets on mobile devices.

    Prerequisites

    An organization of your enterprise is created in DingTalk or Lark.

    Note

    The organization is an internal organization of your enterprise instead of a public organization of Alibaba Cloud, such as an organization of Alibaba Cloud technical support or Alibaba Cloud DMS.

    Usage notes

    • You can only approve tickets on mobile devices.

    • If you are an internal user of Alibaba Group, contact technical support in the DingTalk group 67215001618 of DMS.

    Preparations

    1. Configure an application that is used to receive messages.

      DingTalk Standard Edition and Exclusive Edition

      1. Create an application.

        1. Log on to DingTalk and join a DingTalk organization.

          1. Access DingTalk Open Platform.

          2. In the upper-right corner of the page, click Log On and select the organization to which your enterprise belongs. In this example, XXX Test Organization is selected.

        2. Access the background management console of DingTalk and create a DingTalk application.

          1. In the upper-right corner of the page, click My Background.

          2. On the page that appears, click the Application Development tab. In the left-side navigation pane, choose Enterprise Internal Applications > DingTalk Applications.

          3. On the DingTalk Applications page, click Create Application.

          4. In the Create Application panel, configure the Application Name and Application Description parameters and click Save.

        3. Configure a DingTalk chatbot that is used to receive messages.

          1. On the DingTalk Applications page, find the application that is created in the previous step and click the name of the application to go to the page on which you can modify the application.

          2. In the left-side navigation pane, choose Application Capabilities > Add Application Capabilities. On the Add Application Capabilities page, click Add in the Chatbot section.

          3. On the Chatbot page, turn on Chatbot Configuration and configure the parameters of the chatbot, including Chatbot Overview, Chatbot Description, and Message Receiving Mode. Then, click Publish.

            Note

            In this example, the Message Receiving Mode parameter is set to HTTP Mode.

        4. Configure a web application.

          1. On the Add Application Capabilities page, click Add in the Web Application section.

          2. On the Web Application page, specify the URL of the homepage of the web application and click Save.

            Specify the URL of the homepage of the web application based on the region in which DMS is deployed. For example, if DMS is deployed in the Singapore region, specify https://dms-ap-southeast-1.alibabacloud.com as the URL of the homepage of the application. You can specify one of the following URLs based on the region in which DMS is deployed:

            Note

            For more information about how to view the region in which DMS is deployed, see Switch regions.

            • China (Hangzhou): https://dms-cn-hangzhou.alibabacloud.com.

            • Japan (Tokyo): https://dms-ap-northeast-1.alibabacloud.com.

            • Singapore: https://dms-ap-southeast-1.alibabacloud.com.

            • Malaysia (Kuala Lumpur): https://dms-ap-southeast-3.alibabacloud.com.

            • Indonesia (Jakarta): https://dms-ap-southeast-5.alibabacloud.com.

            • SAU (Riyadh - Partner Region): https://dms-me-central-1.alibabacloud.com.

        5. Grant permissions.

          In the left-side navigation pane, choose Development Configurations > Permission Management. On the Permission Management page, apply for the following permissions:

          • Basic permissions to call the SNS API operations

          • Permissions to read information about members

          • Permissions to query basic information about a member by the mobile number

          • Basic permissions to call API operations of the enterprise

          • Basic permissions to query the access credentials that are used to call DingTalk API operations

          • Permissions to manage the basic information about DingTalk groups

          • Permissions to send messages by using a chatbot in an enterprise

          • Permissions to write the content of interactive cards

        6. Create and publish a new version of the application.

          To allow users in an enterprise to use a self-managed application that is created in the enterprise, you must publish a version of the application.

          In the left-side navigation pane, choose Application Publishing > Version Management and Publishing. On the Version Management and Publishing page, click Create New Version. On the Version Details page, configure the parameters and click Save.

      2. Create a card.

        1. Create a card template.

          1. Log on to the Card Platform and then click Create Template.

          2. In the Create Template dialog box, configure the Template Name, Card Type, and Card Template Scenario parameters. Then, click Create.

            Set the Card Template Scenario parameter to Regular Card and select the created application in the Associated Applications section.

        2. Import the card template.

          In the upper-right corner of the page, choose More > Import Template to import and save the card template.

        3. Publish the notification card template.

      Lark

      1. Log on to the Lark Open Platform and go to the developer background management console.

        1. Access Lark Open Platform.

        2. Click Log On in the upper-right corner of the page.

          The account that you use to log on must belong to an organization of your enterprise. In this example, the organization is named XXX Test Organization.

        3. Click Developer Background Management Console.

      2. On the page that appears, click Create Self-managed Enterprise Application. In the Create Self-managed Enterprise Application dialog box, configure the Name and Application Description parameters, and click Create. For more information, see Create a self-managed enterprise application.

      3. Add a Lark chatbot.

        1. Optional. Click the name of the application that you want to manage to go to the page on which you can modify the application.

          Note

          If the application is newly created, skip this step.

        2. In the left-side navigation pane, choose Application Capabilities > Add Application Capabilities.

        3. On the Add Application Capabilities page, click the Add by Capability tab and then click Add in the Chatbot section.

        4. On the Chatbot page, click the Modify icon in the Chatbot Configuration section, enter a name for the chatbot in the field, and then click Save.

      4. Add a web application.

        1. In the left-side navigation pane, choose Application Capabilities > Add Application Capabilities.

        2. On the Add Application Capabilities page, click the Add by Capability tab and then click Add in the Web Application section.

        3. On the Web Application page, specify the URL of the homepage of the application and click Save.

          Specify the URL of the homepage of the web application based on the region in which DMS is deployed. For example, if DMS is deployed in the Singapore region, specify https://dms-ap-southeast-1.alibabacloud.com as the URL of the homepage of the application. You can specify one of the following URLs based on the region in which DMS is deployed:

          Note

          For more information about how to view the region in which DMS is deployed, see Switch regions.

          • China (Hangzhou): https://dms-cn-hangzhou.alibabacloud.com.

          • Japan (Tokyo): https://dms-ap-northeast-1.alibabacloud.com.

          • Singapore: https://dms-ap-southeast-1.alibabacloud.com.

          • Malaysia (Kuala Lumpur): https://dms-ap-southeast-3.alibabacloud.com.

          • Indonesia (Jakarta): https://dms-ap-southeast-5.alibabacloud.com.

          • SAU (Riyadh - Partner Region): https://dms-me-central-1.alibabacloud.com.

      5. Add a redirect URL and an HTML5 trusted domain.

        1. In the left-side navigation pane, choose Development Configurations > Security Settings.

        2. On the Redirect URL tab, configure the Redirect URL and H5 Trusted Domain parameters.

          Specify the redirect URL and HTML5 trusted domain based on the region in which DMS is deployed. For example, if DMS is deployed in the Singapore region, specify https://dms-ap-southeast-1.alibabacloud.com/console/mobile/index/ as the redirect URL and https://dms-ap-southeast-1.alibabacloud.com as the HTML5 trusted domain.

        3. Separately click Add next to the Redirect URL and H5 Trusted Domain fields.

      6. Configure application permissions.

        1. In the left-side navigation pane, choose Development Configurations > Permission Management.

        2. On the Permission Management page, click the API Permissions tab and apply for the following permissions. For more information about permission application and permissions, see API permissions.

          • Permissions to query user IDs

          • Permissions to query a user ID by the mobile number or email address

          • Permissions to upload images and attachments to cloud documents

            Note

            Lark does not support this permission.

          • Permissions to receive messages from and send messages to an individual user or a group chat

          • Permissions to send messages as an application

          • Permissions to send messages to multiple users at a time

          • Permissions to query and upload image or file resources

      7. Publish an application version.

        To allow users in an enterprise to use a self-managed application that is created in the enterprise, you must publish a version of the application.

        1. In the left-side navigation pane, choose Application Publishing > Version Management and Publishing.

        2. On the Version Management and Publishing page, click Create Version.

        3. On the Version Details page, configure information such as version number and the default capability of the mobile device and click Save.

          Select all members in the Available Scope section.

    2. Obtain key information about DingTalk Standard Edition, DingTalk Exclusive Edition, or Lark. The key information is used to configure notification methods in DMS.

      DingTalk Standard Edition

      • The AppId, AgentId, AppKey, and AppSecret of the application

        Log on to the DingTalk Open Platform and go to the details page of the application. In the left-side navigation pane, choose Basic Information > Credential and Basic Information. On the page that appears, obtain the AppId, AgentId, AppKey, and AppSecret of the application.

      • Chatbot code

        In the left-side navigation pane of the application details page, choose Application Capabilities > Chatbot. On the Chatbot page, obtain the chatbot code.

      • Card template ID

        Log on to the Card Platform and go to the Templates page.

      DingTalk Exclusive Edition

      • The AppKey and AppSecret of the application.

        Log on to the DingTalk Open Platform and go to the details page of the application. On the Basic Information page, obtain the AppKey and AppSecret of the application.

      • Chatbot code

        Log on to the DingTalk Open Platform and go to the details page of the application. On the Chatbot page, obtain the chatbot code.

      • Card template ID

        Log on to the Card Platform and go to the Create Card page.

      Lark

      Log on to the Lark Open Platform and go to the details page of the application. In the left-side navigation pane, choose Basic Information > Credential and Basic Information. On the page that appears, obtain the AppId and AppSecret of the application.

    Step 1: Enable and configure notification methods in DMS

    The notification method management feature of DMS is used to enable or disable tenant-level notification methods and maintain the configurations of applications such as Lark and DingTalk Exclusive Edition.

    Note

    The notification settings that you configured in DMS take effect only after you enable the notification methods. DMS sends notifications to you by using these methods.

    Only a DMS administrator or a database administrator (DBA) can configure notification methods in DMS.

    1. Log on to the DMS console V5.0.

    2. Mover the pointer over the 2023-01-28_15-57-17.png icon in the upper-left corner and choose All Features > O&M > Notification.

      Note

      If you use the DMS console in normal mode, you can choose O&M > Notification in the top navigation bar.

    3. On the Notification page, click Channel Management in the upper-left corner.

    4. In the Channel Management panel, select the notification methods that you want to use.

    5. Configure the information required for Lark, DingTalk Standard Edition, or DingTalk Exclusive Edition.

      The following example shows how to configure the information for Lark. The operations for configuring other notification methods are similar to those in this example.

      1. Click Edit in the Lark section.

      2. Configure the AppId and AppSecret parameters, and click Save.

    Step 2: Specify users to receive notifications

    The following example shows how to specify users to receive notifications related to a data export ticket to be approved.

    1. Add a user who receives notifications to DMS as a DMS administrator. For more information, see Manage users.

    2. Go to the Notification page as a DMS administrator or a DBA.

      On the Notification page, select the features or modules for which you want DMS to send messages when the features or modules are updated.

    3. From the Module / Business type drop-down list, choose Ticket > Data export.

    4. Find the ticket in the Pending approval state and click Modify in the Operation column.

    5. In the Modify global message notification dialog box, select users from the Additional notification User drop-down list and click Confirm.

    6. Enable notification.

      Subsequent notifications related to data export tickets to be approved are directly sent to the users by using DingTalk Standard Edition, DingTalk Exclusive Edition, or Lark.

    References

    DMS allows you to process tickets on mobile devices, which greatly improves the R&D efficiency.

    FAQ

    Q: I configured the information for Lark. Why am I unable to receive notifications that DMS sends by using Lark?

    A: Check whether you have enabled notification by Lark. The information that you configured takes effect only after you enable notification by Lark. Then, DMS sends notifications to you by using Lark. For more information, see the Step 1: Enable and configure notification methods in DMS section of this topic.