Create and manage business processes

更新时间:
复制 MD 格式

In DataService Studio, APIs are developed within a business process. A business process helps you organize and manage related APIs, functions, and workflows. Therefore, you must create a business process before you can generate an API.

Prerequisites

You must activate the API Gateway service and create an API group in the API Gateway console.

Background information

A business process helps you organize development by grouping related resources. Each business process contains your APIs, functions, and workflows.

Create a business process

  1. Go to the Data Services page.

    Log on to the DataWorks console. In the target region, click Data Analysis and Service > DataService Studio in the left-side navigation pane. Select a workspace from the drop-down list and click Go to DataService Studio.

  2. In the Service Development pane, click the image.png icon and select Create Workflow.

    Parameter

    Description

    Workflow Name

    The name must meet the following requirements:

    • The name must be unique within the workspace.

    • The name can contain Chinese characters, letters, digits, and underscores (_).

    • The name must start with a letter or a Chinese character.

    • The name must be 4 to 50 characters long.

    API grouping

    An API group is a collection of APIs for a specific feature or scenario. It is also the smallest management unit for APIs in API Gateway. In Alibaba Cloud API Marketplace, an API group corresponds to an API product.

    To create a new group, go to the API Gateway console.

    Business Description

    Enter a description for the business process. The description can be up to 180 characters long.

  3. Click Determine.

    The new business process appears in the Workflow list.

Modify a business process

  1. In the Service Development pane, right-click the business process and select Change.

  2. In the Edit business process dialog box, enter the new Workflow Name and Business Description.

    Note

    You cannot modify the Creator or API grouping of a business process.

  3. Click Confirm to save the changes.

Delete a business process

  1. In the Service Development pane, right-click the business process and select Delete.

  2. In the Prompt dialog box, click Confirm.

    Note
    • You can delete a business process only after removing all its assets, such as folders, APIs, functions, and workflows.

    • The delete operation fails if the business process is not empty.