You need to enable JavaScript to run this app.
Intelligent Data Insight

Intelligent Data Insight

  • Documentation
    • Intelligent Data InsightDataWind User GuideOpen and IntegrationOffice Software IntegrationLark linkage integrationBasic Configuration for Lark Integration
Copy page
Download PDF
Lark linkage integration
Basic Configuration for Lark Integration
Copy page
Download PDF
Basic Configuration for Lark Integration

Intelligent Data Insight (hereinafter referred to as DataWind) supports functional integration with Lark. Through these capabilities, users can directly access DataWind's mobile application from the Lark Workbench, connect to Lark data sources, or receive daily, weekly, or monthly reports pushed by DataWind to their Lark personal account or group, thereby achieving integration with Lark and collaborative work. This article introduces the basic configuration operations for Lark integration.

Feature Overview

The basic configuration for Lark integration requires users to perform custom application creation and permission configuration on the Lark side, and to perform office platform integration on the DataWind side. After completing the configuration, integration with Lark and collaborative work can be achieved.

warning

This article uses the Lark SaaS standard product as an example to introduce the configuration operation process on the Lark side. It should be noted that the configuration interface of the Lark Open Platform may differ depending on the user's deployment environment and version. For details, refer to Enterprise self-built application development process.

Glossary

Related terms

Explanation

Usage scenarios

Lark Open Platform

The backend for adding new applications, which all developers can operate

In the integration scenario with DataWind, this is the backend for adding applications

Lark management console

The Lark organization management console, which only Lark organization administrators can operate

Approve application launch and grant relevant permissions to the application

Application administrator

The corresponding user role in Intelligent Data Insight is system administrator

Complete the integration of Lark with the Intelligent Data Insight platform

Enterprise organization administrator

The corresponding user role in Lark is Lark organization administrator

Responsible for granting permissions and approving application launch in the Lark admin console

Process overview

The overall steps are as follows:

  1. Lark side: Create application -> Configure permissions -> Publish application
    Image
    1. Create Lark application: The system administrator of DataWind, who is usually also the application creator and administrator on the Lark Open Platform, creates a DataWind application on the Lark Open Platform.
    2. Configure permission management: The system administrator of DataWind enables the relevant application permissions on the Lark Open Platform.
    3. Publish Lark application: The system administrator of DataWind creates and submits a new version of the application for publication on the Lark Open Platform, and after approval by the organization administrator of Lark, completes the overall application configuration and launch.
  2. DataWind side: Office platform integration.

The specific configuration methods will be introduced in detail in subsequent sections. For more questions related to Lark applications, you can also refer to the Help Center documentation on the Lark Developer Platform.

Cautions
  • If you are using Lark, you may encounter some functional differences between the Lark Open Platform and the Lark Open Platform. To configure integration with Lark, please contact after-sales support via the bottom right corner of the official website.

Lark Configuration

Create a Lark application

  1. Open the enterprise Lark Open Platform, click the avatar in the upper right corner, and select the enterprise for application delivery.
    Image
  2. Click "Create Application" to enter the developer console of the Lark Open Platform.
    Image
  3. Click "Create Enterprise Custom Application" and fill in the required "Application Name", "Application Description", and "Application Icon" as prompted.
    Image

Configure permission management

Before calling the Lark Open API, you need to enable the permissions required by DataWind for the application. In the developer console of the Lark Open Platform, click "Permission Management" to start configuring permissions for the application.
Image
According to the integration scenarios between DataWind and Lark, this document divides permissions into the following five modules. Users can select permission modules based on the integration effects they want to achieve in DataWind, and follow the steps to enable the Lark permissions required by DataWind for the application. Among them, "Basic Permissions" are fundamental for DataWind and Larkntegration and are mandatory:

Usage scenarios for DataWind integration with Lark

Permission module

Required or optional

  • Basic DataWind and Lark integration

Basic permissions

Required

  • In the data preparation module, use table or multidimensional table data from the Lark "Knowledge Base" as DataWind data sources. For details, see Lark Sheets and Lark Base Ta
  • In the visual query module, enable downloading data in the "Lark Table" file format. For details, see Data Download

Table/multidimensional table related permissions

Optional

  • In the permission module, add Lark departments to DataWind as department-level user groups. For details, see User Group Management

Lark department related permissions

Optional

  • Approval workflows can be integrated with Lark approval workflows. For details, see Permission Approval Integration with Lark

    warning

    Currently, this feature is only supported in the private deployment version of DataWind.

Permission approval and Lark integration

Optional

  • Send direct messages to Lark users within the application's available scope
  • Send group messages to groups where the Lark bot is present
  • Receive all direct messages sent by users to the Lark bot

Lark message sending related permissions

Optional

Permission type introduction:

Permission type

Description

Application identity permissions

  • Application runs automatically when the user is not logged in
  • Resources that can be accessed by the application identity

User identity permissions

  • Application must perform operations as the logged-in user
  • Resources that can be accessed by the logged-in user

Basic permissions

Permission type

Configuration instructions

Application identity permissions

  • Update address book
  • Obtain basic address book information
  • Obtain basic department information
  • Obtain department organizational structure information from the address book
  • Obtain basic user information
  • Obtain user organizational structure information
  • Obtain user ID
  • Obtain user phone number
  • Obtain user ID by phone number or email
  • Obtain company information
  • Send messages as the application identity (only required for the private deployment version; not required for SaaS)
  • Send batch messages to multiple users (only required for the private deployment version; not required for SaaS)

User identity permissions

  • View, edit, and manage the knowledge base
  • View the knowledge base
  • View, comment on, edit, and manage spreadsheets
  • View, comment on, edit, and manage multidimensional tables
  • View, comment on, and export multidimensional tables

warning

By default, the visible range of the address book in data permissions follows the application's available range. If the address book range is not large enough, user IDs outside the address book range cannot be bound. It is recommended to refer to the diagram below and set the available range to "All employees" in "Version management and release".
Image

Permission type

Configuration instructions

User identity permissions

  • View, edit, and manage the knowledge base
  • View the knowledge base
  • View, comment on, edit, and manage all files in the cloud space
  • View, comment on, edit, and manage multidimensional tables
  • View, comment on, and export multidimensional tables
  • View, comment on, edit, and manage spreadsheets
  • View, comment on, and export spreadsheets

Permission type

Configuration instructions

App identity permissions

  • Read the address book as the app identity
  • Obtain department organizational structure information
  • Obtain user email information
  • Obtain user mobile number
  • Obtain user ID
  • Obtain basic department information
  • Obtain basic user information
  • Obtain enterprise information
  • Obtain and update group information
  • View group information

    tip

    In DataWind, in the dashboard module, click the send button next to the "dashboard owners" icon to create a group chat in Lark with one click and contact all dashboard owners.
    Image

Permission approval and Lark integration

Permission type

Configuration instructions

App identity permissions

  • View, create, update, and delete approval app-related information
  • Query approval list
  • Access approval app
  • Obtain user ID

  1. Search and enable the following permissions.

Permission type

Configuration instructions

App identity permissions

  • Obtain and send single chat and group messages
  • View group information

  1. Contact the Lark organization administrator and log in to the Lark Management Console to perform the following operations:

    warning

    The prerequisite for this step is that the app has already been published. If the app has not been published, refer to Publish Lark app to complete the publishing operation before proceeding with this step.

    1. Enter the Lark Management Console, click "Workbench" - "Application Management", and find the published application.
      Image
    2. Select available members and set available members to all members.
      Image

  2. After the Lark organization administrator completes the configuration, the DataWind system administrator returns to the Lark Open Platform and clicks "Security Settings".
    Image
    Add the following URL information in the "Redirect URL" input box, then click "Add" to save.

    Product version

    URL information to be added

    SaaS

    https://console.volcengine.com/bi/datawind/#
    https://console.volcengine.com/bi/datawind#/dataManage
    https://console.volcengine.com/bi/datawind/auth#/dataManage
    https://console.volcengine.com/bi/datawind#/dataPrep
    https://console.volcengine.com/bi/datawind/auth#/dataPrep
    https://console.volcengine.com/bi/datawind/#/prep/dataLink/authCallback/lark_sheet https://console.volcengine.com/bi/datawind/#/prep/dataLink/authCallback/lark_bitable

    On-premises deployment

    As follows, replace $HOST with the product's deployment domain name, without any path:
    $HOST/bi
    $HOST/bi#
    $HOST/bi#/dataManage
    $HOST/bi/auth#/dataManage
    $HOST/bi#/dataPrep
    $HOST/bi/auth#/dataPrep
    $HOST/bi/#/prep/dataLink/authCallback/lark_sheet
    $HOST/bi/#/prep/dataLink/authCallback/lark_bitable

Publish the Lark application

  1. Create a new version. In the developer console of the Lark Open Platform, click "Version management and release", then click "Create version". Fill in the "App version number", "Update notes", and other information, and click "Save" to complete version creation.
    Image
  2. Release a new version. After creating a new version, click "Confirm release".
    Image

    warning

    • Only users within the available range can successfully search for, open, and use the web app.
    • After the app administrator applies for release, the enterprise organization administrator will receive a notification message for the Open Platform app review. The review must be completed before proceeding with subsequent configuration actions.
  3. After completing the steps for creating and releasing a new version, click "Credentials and basic information", and copy the APP ID and APP Secret.
    Image

DataWind-Side Configuration

Log in to DataWind as a system administrator, click "System configuration" - "Office platform" - "Lark", enter the APP ID and APP Secret obtained from the Lark-side configuration, select "Enable", and click "Submit" to complete the basic configuration for Lark integration.
Image

Configuration Required for Usage Scenarios

Common scenarios

Use cases

Scenario introduction

Specific configuration operations

Account binding

Supports binding users in Intelligent Data Insights (hereinafter referred to as DataWind) with Lark accounts, including both single and batch binding.

How to Bind Lark Accounts and Create Users in Bulk

Send Lark messages

After the administrator completes the basic Lark integration setup (including permission configuration), subscription and alert rules can be set in DataWind to send charts, dashboards, and data anomaly notifications to Lark and Lark groups.

How to Push Lark Messages

Connect to Lark data sources

DataWind supports uploading Lark spreadsheets and Lark multi-dimensional spreadsheets to create datasets, and supports scheduled offline data updates.

How to Integrate a Lark Data Source

Mobile integration

A key part of the Lark integration is deploying the DataWind mobile application on the Lark mobile client, allowing users to access and open DataWind directly from the Lark Workbench.

How to Integrate the Lark Mobile App

More scenarios

Lark group authorization

To authorize a dashboard or dataset for a Lark group, complete the above Lark-side configuration and DataWind-side configuration, then authorize the resources you have permission for in the dashboard or dataset. Follow the steps below to complete Lark group authorization for the account.

warning

The basic permission configuration and message sending permission configuration must be completed in the Lark-side settings.
The scope of this authorization is limited to the user who configures it; that is, the Lark group authorization set by a specific user is only valid for that user. Other users who require this functionality must complete the configuration using their own accounts.

Last updated: 2026.07.06 16:36:12