Use Work Mini Apps in Base

Use Work Mini Apps in Base

7 min read
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.
🔖
If your plan does not cover this feature, you can enjoy a 7-day free trial.
I. Intro
Work Mini Apps are lightweight applications powered by Base. Simply add two configuration tables to any base to convert it into a mini app. You can also directly use the mini app templates in the template gallery, and customize them according to your needs.
The configuration of mini apps is simple and flexible, meeting various business needs such as store inspections, customer relationship management (CRM), inventory checks, and strategy implementation. At the same time, frontline staff can view the data they need and carry out the necessary operations from their phone, lowering the barrier to adoption and improving efficiency.
Note: This feature is only available in English, Simplified Chinese, and Japanese.
Mobile interface
Here, we'll use a CRM mini app as an example for demonstration.
There are two types of cards on the mini app homepage on the mobile interface:
  • Table cards, such as Leads and Opportunities in the screenshots are generated from the tables in the base. You can view records in the table by clicking on a card.
  • Link cards, such as Lead Overview and Opportunity Overview in the screenshots have an image of a planet on the right side. You can configure any type of link here, such as Base dashboards, documents, and web pages.
Note: You can use multiple mini apps at the same time. When you exit and click Work Mini Apps again, the mini app you used last will open.
250px|700px|reset
image.png
Configuration overview
250px|700px|reset
image.png
Configuration
Templates
Descriptions
App settings - Card
(The bottom two tables on the left)
Add this table to an existing Base to transfer data in tables to a mini app.
App settings - Link
Add this table to an existing Base to configure any type of link to redirect users.
Common scenarios
  • Inventory management: Add purchase, sales, and inventory data into the mini app to allow team members to view the inventory status and add new records directly from their phones.
  • Customer relationship management: Throughout the whole customer management process, the sales team can view the progress of opportunities and record customer follow-up details from anywhere.
  • Store management: Frontline staff can complete daily store inspections or inventory checks on their phones, so they can get started, record results, and report problems in a timely manner.
II. Steps
  1. Enter Work Mini Apps
Open a base, click the ··· icon in the upper-right corner > Work Mini Apps.
250px|700px|reset
If the base does not contain two configuration tables (App settings - Card and App settings - Link), a template gallery for mini apps will open.
Click Use on the mini app you want and the base created will automatically include the two configuration tables above.
250px|700px|reset
If the base contains two configuration tables (App settings - Card and App settings - Link), a QR code will be displayed. Scan the QR code with the mobile app to use the mini app on your phone.
Click Explore Mini Apps in the lower-right corner to go to the template gallery for mini apps.
If your Lark plan is Enterprise, you can directly use the mini apps.
If you don't have the plan(s) mentioned above, you can try mini apps for 7 days.
After scanning the QR code, a mini app bot will send you a message card, which you can click to access the mini app. You can pin the bot to the top if you want quick access to the mini app.
250px|700px|reset
250px|700px|reset
  1. Configure Work Mini Apps
Any base can be converted into a mini app and data between them will stay in sync.
If you want to directly convert an existing base into a mini app, add these two tables (App settings - Card and App settings - Link) to the base.
Note: The names of the above two configuration tables cannot be modified, and the field names and field types within cannot be changed.
🔖
Click Work Mini Apps Configuration Template to get the template.
Configuration table descriptions
Example
App settings - Card: For configuring which tables in the base will be displayed in the mini app. There is a limit of 30,000 rows per table. If there are more than 30,000 rows in a table, the table will not be displayed on the mobile app, and you'll get an error message instead.
Note: The mini app homepage can display up to 20 table cards (the first 20 records from the "App settings - Card" table). The content that is visible to users depends on the permission settings of the base. To display more than 20 tables, you can split them into multiple mini apps.
  • Table name: Must be exactly the same as the table names in the base.
  • Card title: The card title to be displayed in the mini app. If not filled in, the table name will be used by default.
  • Card description: Displayed below the card title in the mini app, to provide a description of the card as needed. Can be left empty.
  • Allow adding records: Checkbox field. If selected, adding new records directly from the mobile app is allowed. A + icon will appear in the lower-right corner of the corresponding card's detail page.
  • Filter by "Date": Checkbox field. If selected, a date filter will be displayed at the top of the corresponding card.
(Note: This field filters for a date field titled Date. If such a field does not exist, the first date field in the first view will be used instead)
  • Button text: Single option field. Users can customize the button text at the bottom of the record detail page.
In this CRM base, Leads, Opportunities, Clients, Follow-up Records, Orders, and Contracts tables are added to the mini app, allowing frontline staff to easily view and make changes on their phones.
250px|700px|reset
250px|700px|reset
App settings - Link: To configure the link cards on the mini app homepage (cards with a planet image).
  • Card title: The card title to be displayed in the mini app.
  • Card description: Displayed below the card title in the mini app, to provide a description of the card as needed. Can be left empty.
  • Link URL: Hyperlink field. Any link (including external links) can be added to redirect users. For example, you can share a dashboard link (Learn more in Share dashboards) or a document link for easy access from the phone.
Here, the links of four dashboards are configured in the App settings - Link table. Users can click the corresponding card to go to the dashboard.
250px|700px|reset
250px|700px|reset
After completing the configuration of the two tables above, click the ··· icon in the upper-right corner of the base > Work Mini Apps and scan the QR code to access the mini app on your phone.
III. Tips and tricks
  1. Allow creating new records in mini apps
  • In the App settings - Card table, select the checkbox under Allow adding records.
  • In the mini app, a + button will appear in the lower-right corner of the corresponding detail page. Users can tap to add new records from their phone.
250px|700px|reset
250px|700px|reset
  1. Configure date filtering
In the App settings - Card table, select Filter by "Date" to add the date filter at the top of the mini app to allow users to filter data by date.
Filtering by date may be especially useful for scenarios that rely on daily data, such as store inspections and other tasks that need to be performed daily.
Filter condition: If there is a date field titled Date, it will be used as the filter condition, otherwise the first date field in the first view will be used instead, even if the field is hidden.
250px|700px|reset
250px|700px|reset
  1. Customize the button text
In the App settings - Card table, you can select or create an option in the single-option field Button text to customize the button text that'll appear at the bottom of each record page.
250px|700px|reset
250px|700px|reset
  1. Add "Status" labels to the card
Add a single-option field called Status in the base to display status labels of records in the mini app. For example, if a Status field is added to the Clients table:
  • The number of records for each status in the Clients table is displayed on the mini app homepage.
  • Tap the Clients card on mobile, and a filter can be found on top of the details page, which groups records by status. You can also see the status of each individual record on the page.
Grouping condition: If there is a single option field titled Status, it will be used as the grouping condition, otherwise the last single option field in the first view will be used instead, even if the field is hidden.
250px|700px|reset
250px|700px|reset
250px|700px|reset
IV. FAQs
How do I open mini apps?
When you tap Work Mini Program on the Lark mobile app, the mini app you last used will open. To open a specific mini app, go to the mini bot app that sent you a message when you first scanned the QR code.
Which date field is used for date filtering?
If there is a date field titled Date, it will be used as the filter condition, otherwise the first date field in the first view will be used instead, even if the field is hidden.
How many tables can the homepage of the mini app show?
20. The homepage of the mini app will only display the first 20 records from the "App settings - Card" table. If you have more than 20 tables, you can create new mini apps for them instead.
How do I set permissions for mini apps?
You can set basic and advanced permissions in the corresponding base itself. The Base administrator can control the visibility of the cards by setting advanced permissions of each table separately. For example, if the administrator sets a member's permission for a table to "no permission", the member will not see the card corresponding to this table in their mobile app.
250px|700px|reset
Written by: Lark Help Center
Updated on 2025-01-08
How satisfied are you with this content?
Thank you for your feedback!
Need more help? Please contact Support.
0
rangeDom
rangeDom
rangeDom
rangeDom
rangeDom