Skip to main content
Note A custom workbench card can only be used by your current organization. It cannot be shared with other organizations.

​
Prerequisites

  • To use custom workbenches, your organization must apply for and enable DingTalk Pro or DingTalk Dedicated edition features. For details, go to the DingTalk Admin Console > Custom Workbench.

​
What Is a Workbench Card

Within the DingTalk Workbench, workbench cards are a key capability for integrating app features with scenarios. Through a workbench card, your app can present part of its data and features to users on a single card and interact with them directly.

​
Features of Workbench Cards

​
Feature 1: Richer Workbench Component Materials

Workbench cards integrate capabilities such as the low-code builder, the data asset platform, and connectors. This lets you rapidly build visualized solutions for business scenarios. Backed by DingTalk’s powerful underlying PaaS, configuration, and integration capabilities, workbench cards greatly expand the range of workbench component materials. Example 1: By integrating with the data asset platform, you can directly surface business information, organizational performance, abnormal metrics, and more, and display the core data users care about on the workbench in a custom format. Example 2: By integrating with connectors, you can display certain data from within your organization on the organization’s workbench through a workbench card. The display format is fully customizable, meeting a wide range of workbench component customization needs.

​
Feature 2: Lower Barrier to Entry and Shorter Development Time

In earlier versions, users had to use full-code development to publish custom organizational components to the workbench. Compared with full-code development, cards use low-code development. With simple drag-and-drop operations in the card designer, you can create a component ready to use on the workbench, with a lower barrier to entry and shorter development time.

​
Feature 3: No Additional Adaptation Required

There is no difference in how workbench cards are used compared with cards in other scenarios. Users who have previously created cards can quickly publish existing cards to the workbench without any additional adaptation.

​
Step 1: Create a Workbench Card Template

  1. Sign in to the DingTalk Developer Console, click Open Capabilities, and select Card Platform.
  2. On the template list page, click Create Template.
  3. On the Create Template page, fill in the template information as described below, and then click Create.
    • Template Name: The name of the custom workbench card that is ultimately displayed on the workbench.
    • Card Type: Select workbench card.
    • Associated App: Select the app you want to associate. This document covers custom workbench cards for your organization, so select the internal app created by your organization.
  4. Enter the template editing page. This document uses creating a video card with a static Data Source as an example.
    • In the component library on the left, drag the video component onto the designer.
    • Click the video component in the designer. When setting the video address on the right, select Quickly Create New Variable.
    • Fill in the variable field name for the video address.
    • Set the cover image for the video.
    • After completing the steps above, click Save and then Publish in the upper-right corner.

​
Step 2: Create a Workbench Card Instance

  1. After saving and publishing the workbench card template, click Card Instance Management in the upper-right corner.
  2. On the instance list page, click Create Card Instance.
  3. On the instance creation page, complete the card instance configuration as described below, and then click Create Instance in the lower-right corner.
    • Data Configuration: Select the static Data type and fill in the video link to display.
    • Add Scenario: Select Workbench.

​
Step 3: Deploy the Card Instance

  1. On the instance list page of the workbench template, select the instance you want to deploy, and click Deploy.
  2. On the deployment page, fill in the deployment configuration information as described below, and then click Deploy.
    • Plugin Name: Automatically generated, consistent with the card template name.
    • Component Name: Automatically generated.
    • Component Icon: Upload the icon shown in the upper-left corner of the card when displayed on the workbench.
    • Preview Image: Upload a preview image showing the card’s appearance.

​
Step 4: Edit and Publish the Workbench Card

After deploying the card instance, click Click here in the reminder to enter the workbench card management and editing page.
  1. On the plugin management page, view the card instance you created, and click Version Management for the card instance.
  2. On the card instance details page, you can set the grayscale organizations for the plugin. After completing the grayscale settings, you can publish the card instance to all users.
  3. After the card instance is fully published, create a custom workbench in Workbench Management.
  4. Edit the custom workbench and use the workbench card instance you created.
    • Click View details to view the custom workbench details.
    • Click Configure Workbench to enter the workbench designer.
    • On the workbench designer page, click Create Page in the upper-left corner.
    • In the custom component library on the left, drag the card instance to the target location.
    • Click Save and then Update in the upper-right corner of the designer.
    • On the custom workbench page, click Publish Workbench.
    • On the Select Publishing Scope page, set the visibility scope of the workbench, and then click Publish.

​
Step 5: View the Result

Employees within the visibility scope of the published custom workbench can switch to the current organization’s workbench on the DingTalk client to see the result shown below.

​
Technical Support

If you encounter any issues while creating a workbench card, scan the QR Code below to join the support group for assistance.