Integration with Lark

Version

Function Description

By installing and configuring the Lark Management plugin, you (the admin) can integrate FineReport with Lark and enable message pushing to Lark.

Notes

1. Lark member IDs cannot include special characters, as this may cause SSO to fail. Once created, the member ID cannot be modified. You can only delete and re-add the member if changes are required.

2. You cannot install and use the Feishu Management plugin and the Lark Management plugin at the same time.

You can download the Lark Management plugin at https://market.fanruan.com/plugin/362944a3-ecb5-49fe-8987-74f5cd006cc4 and the HTML5 Mobile Display plugin at https://community.finereport.com/plugin/?id=24.

For details about how to install the plugin in the designer, see Designer Plugin Management.

For details about how to install the plugin on the server, see Server Plugin Management.

Custom App Creation

1. Log in to Lark Admin as the admin, choose Workplace > App Management, and click Create App.

2. After clicking Create App, you will be redirected to Lark Developer. Choose Custom Apps > Create Custom App.

3. In the pop-up Create custom app window, enter the app information, and click Create, as shown in the following figure.

App Permission Configuration

1. After the app is created, click the created app in Custom Apps, choose Permissions & Scopes > Add permission scopes to app, and tick the required permissions, as shown in the following figure.

2. The following table lists the required permissions.

3. You can click the permission name to view the permission description, as shown in the following figure.

Note: 

Before publishing the app, you need to enter the report project to obtain the necessary information for configuring the report server and complete the server configuration.

Obtaining App Information

You need to collect three parameter values that will be used for configuring the report server.

1. Click the app created in Lark Developer, choose Credentials & Basic Info > Credentials, and copy the values of App ID and App Secret, as shown in the following figure.

2. Go to Lark Admin, choose Settings > Organization Info > More, and copy the value of Organization ID, as shown in the following figure.

Log in to the decision-making platform as the admin, and choose System Management > Lark Management > App Management.

App Management includes Server and Lark configurations.

Server

Enter the server address in Server Address, and click Save.

For example, http://Domain name:Port number/webroot/decision

Note: 

You need to enter a second-level or higher domain name that has obtained an ICP license.

Lark

Click New Lark App, name the app, and enter the information collected in the "Obtaining App Information" section in App_Id, Tenant ID (Organization ID), and App_Secret, respectively.

Log in to the decision-making platform as the admin, and choose System Management > Lark Management > App Quick Configuration.

App Quick Configuration includes Lark Proxy Jump, Lark Link Generation, and Lark Chatgroup configurations.

Lark Proxy Jump

1. If the report server is configured on an external network, you do not need to set the proxy server address.

2. If the report server is configured on an internal network:

You do not need to set the proxy server address when the report server can access the Lark server.

You need to set the proxy server address when the report sever cannot access the Lark server.

3. If a proxy server is required, enter the address in Proxy Server Address, and click Test Connection and Save, as shown in the following figure.

Lark URL Generation

The following table describes the setting items.

Note: 

If you have used the URLs generated by the Lark Management plugin of V11.0.74 and later downgrade the plugin, you need to regenerate the URLs using the plugin of the earlier version and re-copy the Lark URL and Lark redirect URL.

Generating a Lark URL for Accessing the Decision-making Platform

1. Select an app from the Lark App Name drop-down box, and select Decision-Making Platform from the Webpage drop-down box.

2. Click Generate Link. The Lark URL and Lark redirect URL are generated automatically.

3. Click Copy to copy the URLs, as shown in the following figure.

Generating a Lark URL for Accessing a Single Template

1. Select an app from the Lark App Name drop-down box, and select Single Template from the Webpage drop-down box.

2. If the parameter setting is required, click Set Default Parameter Value to perform the setting and tick Parse Parameter Value as needed.

3. Click Generate Link. The Lark URL and Lark redirect URL are generated automatically.

4. Click Copy to copy the URLs, as shown in the following figure.

Setting the default parameter value

After you click Set Default Parameter Value, the parameters of the template will be displayed below. You can set a default parameter value or click Add to add a parameter, as shown in the following figure.

Note: 

To delete a parameter, you can hover the cursor over the parameter value, and a  icon will appear.

Parsing the parameter value

If the template a.cpt is configured with the parameter date and the parameter value is set to the formula ${today}, after you select Parse Parameter Value and click Generate Link, the generated link will contain the parsed parameter value (that is, today's date), for example, a.cpt&date=2025-11-03.

If you want to keep the formula in the generated link rather than the parsed value, you can deselect Parse Parameter Value. In this case, the generated link will include the formula, for example, a.cpt&date=${today}.

Note: 

For URLs of templates configured with the template message event, you can deselect Parse Parameter Value, so that parameters can be calculated via formulas. For other templates, you must select Parse Parameter Value; otherwise, the parameter values may be lost.

Generating a Lark URL for Accessing a Custom Webpage

1. Select an App from the Lark App Name drop-down box, select Custom Link from the Webpage drop-down box, and enter the URL copied from App Encapsulation.

2. Click Generate Link. The Lark URL and Lark redirect URL are generated automatically.

3. Click Copy to copy the URLs, as shown in the following figure.

Lark Chat Group

You can create a Lark chat group only after publishing the app, following the steps in the "App Publication in Lark Developer" section. Click New Lark Chatgroup to create a chat group for message pushing. In addition to the group owner, the chat group must include at least two members, as shown in the following figure.

Go back to Lark Developer, enter the Lark app created in the "Custom App Creation" section, and complete the necessary configurations before publishing the app.

Security Setting

1. Choose Securities Settings > Redirect URLs, enter the Lark redirect URL generated in the "Lark Link Generation" section, and click Add, as shown in the following figure.

2. Configure the IP allowlist, as shown in the following figure.

Note: 

IP allowlist configuration is required for app integration.

3. If you preview templates containing code scanning and file widgets in Lark, SSO with H5 trusted domain authentication is required, as shown in the following figure.

App Homepage Configuration

1. Click Add Features in Features, and select Web app.

2. Enter the Lark URL generated in the "Lark Link Generation" section in Web app configurations, and click Save.

Note: 

To open the homepage in the Lark Desktop App Center, you need to enter the Lark URL in Desktop homepage.

Bot Configuration

To ensure notifications can be successfully pushed to Lark, you need to add a bot in Add Features. Otherwise, the notification push will fail.

For details about pushing notifications to Lark, see Scheduled Notification to Lark.

App Publication

Note: 

All configurations will take effect only after the app is published.

1. Choose Version Management & Release > Create a Version, as shown in the following figure.

2. Fill in App version and Update Notes as needed, and select Web App from the Default feature on mobile and Default feature on desktop drop-down boxes.

3. Click Edit in Availability, select All members or Some members in the pop-up Availability Settings window, and click Save.

Note: 

1. For the Lark Management plugin of V11.0.65.1 and earlier versions, select All members in the Availability Settings window.

2. To be redirected to the decision-making platform, you need to set Default feature on mobile and Default feature on desktop to Web App.

4. Click Save, and click Submit for release.

5. The app will be published after being approved by the admin.

Effect Display

Log in to Lark as a user, and you can find the published custom app in Workplace.

Starting from FineReport of V11.0.10 and the Lark Management plugin of V11.0.75, you can synchronize the user information of Lark contacts to User Management on the decision-making platform.

Note: 

You need to distinguish user synchronization from user matching in the document. User synchronization refers to synchronizing the user information of Lark contacts to User Management on the decision-making platform, so that the user information on the platform remains consistent with that in Lark. User matching refers to the process of matching Lark contacts with FineReport users on the decision-making platform via various matching rules to ensure correct matching results.

For details about user synchronization configuration, see User Synchronization.

1. Synchronization configuration

Log in to the decision-making platform, choose System Management > User Management, click Synchronize User, set User Source to Sync from Lark, select the desired Lark app in App, and click OK. In this way, the Lark contacts will be synchronized successfully.

Note: 

You can update user information on the platform via manual or automatic updates of Lark contacts under either Lark Management> Member Management or System Management > User Management.

2. After successful synchronization, the user information will be updated on the platform.

Note: 

Due to restrictions of Lark APIs, user passwords cannot be synchronized. Platform passwords for the synchronized users are generated randomly. If you (a synchronized user) want to log in to the decision-making platform or the DataAnalyst app using your username and password, you need to click Forgot Password to reset it.

For details about synchronization issues, see Common Issues with User Synchronization/Import

3. Synchronization triggering method

Note: 

1. To ensure successful synchronization, you need to ensure that Name, User ID, Department, and Phone number of new Lark contacts are not empty; otherwise, the synchronization will fail.

2. The prerequisites for user synchronization are that the synchronization function is enabled and that the synchronized information should not have been cleared beforehand; otherwise, the synchronization will fail.

4. Field mapping between users of Lark and the platform

The following table lists the field mapping relationship of Lark contacts and users in User Management on the platform.

User Match Way

After the custom Lark app is published, you can synchronize user information of Lark contacts under System Management > Lark Management > Member Management on the decision-making platform.

You can select an option from the User Match Way drop-down list as needed.

User Match Way includes four options: Lark Account Match, Mobile Number Match, Manual Match, and Custom Match. The following figure shows the Member Management page.

Note: 

1. Lark member IDs cannot include special characters, as this may cause SSO to fail. Once created, the member ID cannot be modified. You can only delete and re-add the member if changes are required.

Note: You need to distinguish user synchronization from user matching in the document. User synchronization refers to synchronizing the user information of Lark contacts to User Management on the decision-making platform, so that the user information on the platform remains consistent with that in Lark. User matching refers to the process of matching Lark contacts with FineReport users on the decision-making platform via various matching rules to ensure correct matching results.

Note: 

You can manage all users in Member Management regardless of the number of integrated Lark apps.

1. Lark Account Match/Mobile Number Match

The displayed columns are the same for Lark Account Match and Mobile Number Match.

Lark Account Match: The Lark member ID is matched with the report username. If a member ID corresponds to multiple report usernames, the first one in the user list in User Management will be matched.

Mobile Number Match: The Lark member’s phone number is matched with the report user’s phone number. If a member’s phone number corresponds to multiple report users’ phone numbers, the first one in the user list in User Management will be matched.

When either of these two options is selected, the displayed Lark contact information includes Name, Lark Member ID, Department, and Mobile Number, as shown in the following figure.

2. Manual Match

You can manually match report users with Lark members. When User Match Way is set to Manual Match, an additional Username column will appear in Lark Contacts. You can manually select the user to be matched in the Username drop-down list.

Note: 

1. You can select Select None in the Username drop-down list when Manual Match is selected.

2. Manual Match allows you to freely choose the report user to match Lark members, and it allows matching a single report user with multiple Lark members, as shown in the following figure.

3. Custom Match

You can set User Match Way to Custom Match when the values of the Lark Member ID field and the report user's Username field are inconsistent.

Select the corresponding server dataset, and select the data columns containing the Lark member IDs and report users' usernames to match Lark Member ID with Username.

If a Lark member corresponds to multiple report users, the first one in the user list in User Management will be matched by default. When User Match Way is set to Custom Match, Match Setting appears below. You need to select a dataset, a Lark member ID, and a username for matching, as shown in the following figure.

Lark Contacts

Click Update Now to update Lark contacts immediately.

Click Set Auto Update. You can enable the automatic update and configure the update frequency, as shown in the following figure.

Note: 

1. When User Match Way is set to Lark Account Match or Mobile Number Match, if you (the admin) add, modify, or delete users on the decision-making platform or in Lark Admin, you will need to manually synchronize the Lark contacts in Member Management.

2. When User Match Way is set to Manual Match or Custom Match, if you (the admin) add, modify, or delete users on the decision-making platform or in Lark Admin, manual synchronization of Lark contacts in Member Management is not required.

Published Lark App Modification

To modify the configurations of a published Lark App, you can enter the app in Lark Developer and make the changes as needed.

Department-Based User Selection Available in Lark Availability Settings

Starting from the Lark Management plugin of V11.0.65.1, you can select users grouped by department in the Availability Settings, as shown in the following figure.

Note: 

The Lark Management plugin of all versions does not allow you to select individual users in Availability Settings.

Error Code 10010002

When you configure the Lark app, a prompt pops up, displaying the error message "An error occurred. The error code is: 10010002."

The error is caused by the unauthorized Lark Management plugin. To resolve the issue, you can purchase the plugin to obtain the authorization.