Create and manage application systems

Limits

You can create up to 100 application systems.

Permission description

Super administrators and system administrators can create and manage application systems.

OpenAPI dependencies for Quick BI acquisition and consumption

Dataphin connects to Quick BI through OpenAPI for dashboard metadata consumption and asset consumption. Asset consumption requires on-premises Quick BI application systems of version V5.5.1_feature_2507, V6.0, or later. Different modules depend on different OpenAPI operations. Before you configure the system, grant the specified AccessKey the permissions to call the following OpenAPI operations:

• OpenAPI dependencies for dashboard consumption:

  • Query all works in an organization

  • Query the list of workspaces in an organization

  • Query all works in a workspace

  • Query the data lineage of a work

  • Query dataset details

• OpenAPI dependencies for asset consumption:

  • Query a user's workspaces and preset workspace roles

  • Query the list of workspaces in an organization

  • Query the configuration of a specified workspace role

  • Query data source configuration

  • Create a data source

  • Modify the basic information of a data source

  • Query dataset details

  • Query the works a user is authorized to view

  • Query all reports built on a dataset using the dataset ID

  • Query user information by third-party account

Create an application system

1. In the top navigation bar of the Dataphin homepage, choose Management Center > Data Source Management.

2. In the navigation pane on the left, choose Application System > Application System. On the Application System page, click Create Application System.

3. In the Create Application System dialog box, configure the parameters.

   Parameter		Description
   Basic Information	System Type	Select the type of application system. Currently, only Quick BI is supported.
   	System Name	The system automatically uses the selected system type as the system name. You can modify the name. The name can be up to 64 characters in length and must be globally unique.
   	Contact	Enter the contact for the application system. The contact can be up to 256 characters in length. This helps you contact the person later to obtain information such as the endpoint, AccessKey ID, and AccessKey secret.
   	System Description	Add a description for the application system, such as its scenarios. The description can be up to 1,024 characters in length.
   Connection Configuration	Endpoint	Enter the endpoint of the application system. The URL must start with http or https and can be up to 512 characters in length.
   	AccessKey ID/AccessKey Secret	Enter the AccessKey ID and AccessKey secret of the organization's access token. They can be up to 128 characters in length. Asterisks (*) are not supported in the password. You can obtain these from Quick BI by navigating to Open Platform > Console > Resource Access Management > Organization Identity, as shown in the following figure:

4. Click OK to create the application system.

Manage application systems

1. On the Application System page, the application systems that you created are displayed as cards. You can view the name, description, type, contact, endpoint, last update time, and .

2. You can search by application system name .

3. You can perform the following operations on an application system.

   • Edit: Modify the configuration. If you change the account mapping method, you can view the analysis tasks under the new account system.

   • Delete: You cannot delete an application system if it contains acquisition tasks. You must delete the acquisition tasks before you can delete the application system. If you recreate an application system with the same name, its previous analysis tasks are restored.

   • Test: Click Test to verify that the domain name is accessible and the access token is active.

What to do next

When you create a metadata acquisition task, you can select an application system as the data source. For more information, see Create and manage metadata acquisition tasks.