Dataphin:Create and manage application systems

Prerequisites

• Only Quick BI application systems of V5.5.1 or later in an on-premises deployment environment are supported.

• You must purchase the Asset Consumption feature to configure settings related to data consumption.

Limits

Permissions

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

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.
   	Deployment Environment	Available when System Type is set to Quick BI. Currently, only on-premises deployment 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. Note The system name and channel type are combined to form the consumption channel name, such as `Quick BI Dashboard`, to distinguish between channels of the same type from different systems.
   	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. The AccessKey ID/AccessKey secret configured here are used only for the automatic creation of data sources and datasets during asset consumption. Data queries require verification of individual consumption permissions. 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:
   Consumption Configuration	For Asset Consumption	Disabled by default. After you enable it, you can configure consumption channels for asset consumption in Asset > Asset Consumption.
   	Consumer Channel	Select the consumption channels supported by the application system. Options include Dashboard, Data Download, and Workbook. When you select a channel, it is enabled by default in Asset > Asset Consumption > Channel Management. If you do not select a channel, it remains disabled, but you can enable it manually. You must select at least one consumption channel.
   	Account Integration Methods	Select the account mapping method between Dataphin and the application system of the consumption channel. Options are Third-party System Account ID or Name and Account Name. Third-party System Account ID or Name: This option is available only when Dataphin and the selected application system are connected to the same account system. A query error occurs if one account's ID is the same as another account's name. Account Name: Uses the account name as the unique identifier. This is suitable for scenarios where the two systems have different account systems (for example, if both use their own built-in accounts). You need to select the specific account type used in the Quick BI system. Quick BI Account is selected by default. Other options include Alibaba Cloud RAM user, Quick BI Account, WeCom, DingTalk Account, Lark, Lark Third-party, and Third-party System Account.
   	Operation Agent User	Enter the name or ID of the agent user based on the selected account mapping method. Up to 256 characters. Note When creating a dataset, Quick BI checks if the operation agent user has read permissions on the specified table in Dataphin. We recommend you configure an account with broad database permissions. This operation agent user needs to create corresponding data sources and datasets for consumption assets in the specified Quick BI workspace. Grant permissions as needed.
   	Default Workspace	Select the default workspace for creating analysis tasks in the current channel. Note The system queries for available workspaces in the corresponding Quick BI system based on the specified AccessKey. Select a workspace that the operation agent user has joined and has permissions to create data sources and datasets in.

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, and whether it is enabled for data consumption.

2. You can search by application system name or use the Available for Consumption filter to quickly filter the systems.

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

   • Edit: Modify the configured information. If an application system already has an enabled consumption channel, the consumption configuration cannot be edited. 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.

If you enable an application system for asset consumption, you can enable consumption channels and create analysis tasks. For more information, see Channel Management and My BI Analysis.