DocsICP FilingConsole
官方文档
首页

Lab: List open platform capabilities

更新时间：
复制 MD 格式
产品详情
我的收藏

After a central application is successfully deployed in an environment, BizWorks automatically syncs its version information to the Capability Open Platform. This topic shows you how to list capabilities on the platform.

Release APIs

  1. Log on to BizWorks. Select Capability Platform from the Select Platform drop-down list. Click the Operations tab. image.png

  2. In the Capability Management navigation pane, choose Capability Management > Interface Management.

  3. Optional: On the API Management page, you can select the Business View or Application View tab, and then click a target catalog node to view the APIs in that catalog.

    Note

    By default, the API Management page displays all APIs.

    The left side of the page provides the Business View and Application View tabs to switch between views, with a business category tree below. The upper-right area contains search and filter options. You can search by API Name/Path, Release Status, or Environment Type. You can perform Batch Operations from the upper-right corner. The API list below displays information such as API name, method, path, release status, environment type, project, application, and last update time. The Actions column contains the Edit and Unrelease options.

  4. Find the target API and click Edit in the Actions column.

  5. On the Edit API Details page, complete the configuration information.

    1. Enter the Basic Information, including a description, the API owners, and the catalog. You can select multiple API owners. The selected owners will receive application requests for this API and can review and approve them.

    2. Optional: Configure the Applicable Scenarios, including a title, description, and an icon.

    3. Optional: Configure the Business Value, including a title, description, and an icon.

    4. Optional: Add Integration Steps to help consumers integrate the capability. This includes a step title, role name, step description, and tag color.

    5. Optional: View the Version History. This section is automatically generated by the system and cannot be modified.

    6. Optional: Add an FAQ section to help consumers troubleshoot common issues.

  6. In the upper-right corner of the Edit API Details page, click Save as Draft, Preview, or Submit.

    Note

    If you click Preview, you can see how the API will appear on the open portal. If you click Submit, the system saves your changes.

  7. On the API Management page, you can release APIs in one of three ways.

    • Method 1: Release a single API. In the Actions column for the target API, click Release.

      If the API does not have an assigned owner, the Release API dialog box appears. Select an API Owner and click Submit.

    • Method 2 (batch release): Release APIs in a batch based on the selected capabilities.

      1. Select the checkboxes for the APIs you want to release, click Batch Operations in the upper-right corner, and select Batch Release by Selected Capability.

      2. In the Batch Release by Selected Capability dialog box, specify an API Owner and click Submit.

    • Method 3 (batch release): Release APIs in a batch based on the selected applications.

      1. From the Batch Operations drop-down list, select Batch Release by Selected Application.

      2. In the Select Applications for Batch Release dialog box, select the applications, specify an API Owner, and click Submit.

Create a capability product

  1. Log on to BizWorks. Select Capability Platform from the Select Platform drop-down list. Click the Operations tab. image.png

  2. In the Capabilities navigation pane, choose Capabilities > Capabilities.

  3. On the Capability Product Management page, click New Capability Product.

  4. In the Capability Product panel, configure the parameters and click Create. The panel is divided into two sections: Basic Information and Initial Version Information. Fields marked with an asterisk (*) are required.

    Parameter

    Description

    Capability product name

    Enter a custom name for the capability product. The name can be up to 100 characters long.

    Code

    The code must be a combination of English letters and numbers, start with an uppercase letter, be unique within the project, and cannot be modified after creation. The length of the code cannot exceed 80 characters.

    Description

    An optional description of the capability product. The description can be up to 255 characters long.

    Capability product owner

    From the Capability product owner drop-down list, select one or more owners for the capability product.

    Capability product directory

    Select a directory for the new capability product.

    Initial version number

    After you create the capability product, the system automatically creates a draft version of it. You can continue to edit the capability product in this version.

    Default value: v1.

    Initial version description

    An optional description for the initial version.

    After the capability product is created, you can view it in the product list. The list displays information such as the code, latest version, listing status, last updated, and description for each product. The Actions column provides options to Edit properties and Delete.

List a capability product

  1. On the Capability product management page, click the name of the target capability product.

  2. In the version list for the capability product, click List in the Actions column for the target version.

  3. In the confirmation dialog box, click OK.

Configure capability directory and capability map

Configure the capability directory

A capability directory categorizes capability products and basic capabilities to help business participants find them quickly. The sample project includes three preset directory nodes: User, Product, and Transaction. You can also add new directory nodes manually.

For more information, see Build a Capability Directory.

Configure the capability map

The sample project includes three preset business participants: merchants, the platform, and consumers. A business participant is a party involved in the front-end business that the platform supports. By associating business participants with the required capability directories, you can build a capability map. This map helps business participants quickly find the capability products they need from their own perspective.

For more information, see the following topics:

Customize portal content

On the Portal customization page, the sample project provides preset content for publishing the portal. You can modify this content as needed and then click Save. For more information, see Customize Portal Content.

Access the capability open portal

Publish the portal

  1. On the Open settings page, enable the Open portal page toggle.

  2. On the Portal customization page, click Publish in the upper-right corner to publish the sample project's portal.

Access the portal

After the portal is published, click Go to the Capability Open Portal to access it.