Available with these plans:
Starter
Basic
Pro
Enterprise
To upgrade your Lark Plan or for more information, contact Support or your Customer Success Manager. The Lark Basic plan supports only specific countries and regions.
I. Intro
Who can perform these steps: Primary administrators or administrators with Approval management permissions.
Lark Approval can host your organization's approval documents, allowing members to access the documents on their desktop, mobile, or tablet device and updating the documents' interface. It can also allow them to use Lark Approval features such as Group, Review, and Share, as well as other tools to improve efficiency. Moreover, Lark Approval can help organizations analyze the efficiency of approvals and provide suggestions for optimization.
Organizations can use the General form module provided by Lark Approval to quickly create an Approval document details page based on business data.
Hosting highlights:
- Computers, smartphones, and tablets will all be able to process approval documents, and each platform will benefit from an upgraded experience.
- Members will get access to numerous efficiency-boosting features. For more information, see Lark Approval feature overview.
- Lark Approval can help organizations analyze the efficiency of approvals and provide suggestions for optimization.
Example scenarios:
- Scenario 1: An organization's approval system does not support mobile platforms. Approval hosting would facilitate this at a low cost.
- Scenario 2: An organization wants approvals to be better connected to the Lark suite. Here, through approval hosting, you can use features such as one-click grouping, sharing to chats, copying links to chat/documents and one-click reminders for greater productivity.
- Scenario 3: An organization wants to systematically analyze and improve the approval process. Here, approval hosting can help the organization discover and understand approval inefficiencies, as well as offering suggestions for optimization.
II. Steps
- Confirm whether the documents contain sensitive information
Related business role: @product manager
Currently, Lark Approval will store the UIData data of documents that are already hosted, to create an inverted index and allow users to use the search function normally.
But for documents that are not yet hosted, organizations should first confirm whether the document contains sensitive data. If so, they can choose not to store data to disk in Lark Approval. If there are sensitive document details which have been stored on disk, you can contact Support or your Customer Success Manager. They can then provide the Lark Approval product manager with your custom approval_code and Lark will no longer index the relevant records.
- Confirm document style once hosted
Related business roles: @frontend @backend
Organizations can design the documents' style once they're hosted. Options include:
- Specify the hosting scope:
- Process scope: Which processes need to be hosted, and whether form mapping will be enabled.
- Node scope: Whether all nodes in a specific process will need to be hosted, and whether node editing will be allowed.
- Confirm whether the hosting modules meet the requirements:
- Confirm whether existing general modules meet the requirements.
- Confirm whether the approval history and approval actions meet the requirements.
Note: For details on the form designer/debugger tools that are currently available, see "4. Design UISchema/UIData" below.
- Access Lark Approval task integration
Related business role: @backend
Before approval documents can be hosted, organizations must integrate the corresponding approval tasks for approval documents. (For more information about integrating approval tasks refer to Lark Open Platform documentation).
Once approval tasks have been integrated, by adjusting some of the parameters of the Third-party approval instance synchronization API (including task/cc_relation object and instance object), the approval documents can be hosted.
- Design UISchema/UIData
Related business role: @frontend
Organizations can assemble and adapt the hosted forms on the basis of their original forms.
The UISchema/UIData tools that are currently available include:
After using the tools to complete adjustments to the schema, you can use the following 2 methods to provide it to the backend:
- Directly provide the UISchema to the backend;
- Provide the UIData sample to the backend. They will need to return the real data to hosting in accordance with this format (Note: The backend will generally transmit data using the Open API, and there will be a conversion process from one end to the other).
- Business backend assembles UIData
Related business role: @backend
Through the steps described above, the backend will receive the UISchema and UIData samples provided by the frontend. The backend will now need to provide the assembly logic for the actual UIData data, as well as the callback URL API.
- Implement the relevant APIs for hosting processes
Related business role: @backend
Once the backend has completed integration of the UISchema and UIData, follow the hosting process to complete the necessary development for the following APIs:
- Access the callback API for Page and form details;
- Access the API for the Approval button;
- Access the callback API for Approval history;
- Callback API for Submit button action;
- Callback API for Dynamically obtain data (if there isn't a strong dependency, this configuration can be left blank).
- Integrate APIs with Lark Approval
Related business role: @backend
API integration refers to providing the first 4 APIs implemented in Step 6 with access to hosting through task integration in Step 3. For details, see Third-party approval instance synchronization.
- Launch after completing document debugging
Related business roles: @backend @frontend
After completing all the steps described above, you can start joint frontend and backend debugging. Go to the corresponding environment or Lark > Workplace > Approval and open the document to carry out debugging.
III. FAQs