Create and manage application systems

Limits

You can create a maximum of 100 application systems.

Permissions

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 the Quick BI OpenAPI to support dashboard metadata consumption and asset consumption (available for on-premises Quick BI application systems of V5.5.1_feature_2507 or later, and V6.0 or later). Different modules depend on different OpenAPI operations. Before you proceed, ensure that the specified AccessKey has permissions to call the following OpenAPI operations:

• OpenAPI dependencies for dashboard consumption:

  • Query all works in an organization

  • Retrieve the list of workspaces in an organization

  • Query all works in a workspace

  • Query the data lineage of a data work

  • Query dataset details

• OpenAPI dependencies for asset consumption:

  • Retrieve the user's workspaces and the list of preset workspace roles

  • Retrieve the list of workspaces in an organization

  • Retrieve the configuration information of a specified workspace role

  • Retrieve data source configuration information

  • Create a data source

  • Modify basic data source information

  • Query dataset details

  • Query the list of works that a user has permission to view

  • Query all reports built on a dataset by dataset ID

  • Query user information by third-party account

Create an application system

1. On the Dataphin homepage, choose Management Center > Data Source Management from the top menu bar.

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 application system type. Currently, only Quick BI is supported.
   	System Name	Auto-filled with the selected system type. You can modify it. The name must be globally unique and up to 64 characters long.
   	Contact	The contact person for the application system. Up to 256 characters. Useful for obtaining the endpoint, AccessKey ID, and AccessKey secret.
   	System Description	A description of the application system, such as its use case. Up to 1024 characters.
   Connection Configuration	Endpoint	The endpoint of the application system. Must start with http or https and be no more than 512 characters.
   	AccessKey ID/AccessKey Secret	Enter the AccessKey ID and AccessKey secret of the organization's access token. Up to 128 characters. Asterisks (*) are not allowed in the password. You can obtain it in Quick BI by navigating to Open Platform > Console > Resource Access Management > Organization Access Token, as shown in the figure below:

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 system's name, description, type, contact, endpoint, update time.

2. You can search by application system name.

3. You can perform the following operations on a specific application system:

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

   • Delete: You cannot delete an application system if a collection task has been created for it. You must delete the collection task before you can delete the application system. If you recreate the application system, the analysis tasks that were previously created for it are displayed again.

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

What to do next

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