Dataphin:Create and manage application systems

Prerequisites

• Only on-premises Quick BI application systems of version 5.5.1 or later are supported.

• You must purchase the asset consumption feature to configure consumption-related settings.

Limits

Permission description

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

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.
   	Deployment Environment	This parameter is available when you set System Type to Quick BI. Currently, only on-premises deployment 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. Note The system name and channel type are combined to form the name of the consumption channel. This helps distinguish channels of different systems of the same type. Example: Quick BI Dashboard.
   	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. The AccessKey ID and 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 these from Quick BI by navigating to Open Platform > Console > Resource Access Management > Organization Identity, as shown in the following figure:
   Consumption Configuration	Used For Asset Consumption	This feature is disabled by default. If you enable it, you can configure consumption channels for asset consumption in Asset > Asset Consumption.
   	Consumption Tool	Select the consumption channels that the selected application system supports. Options include Dashboard, Data Download, and Workbook. If you select a consumption channel, it is enabled by default in Asset > Asset Consumption > Channel Management. If you do not select a channel, it is not enabled, but you can enable it manually. You must select at least one consumption channel.
   	Account Mapping By	Select the account mapping method between Dataphin and the application system of the consumption channel. Options are Third-party System Account ID Or Account Name and Account Name. Third-party System Account ID Or Account Name: This option is available only when Dataphin and the selected application system are connected to the same account system. If the ID of one account is the same as the name of another account, a query error occurs. Account Name: Uses the account name as a unique identifier. This is suitable for scenarios where the account systems of the two systems are inconsistent, for example, when both use their own built-in accounts. You must select the specific account type to use in the Quick BI system. Quick BI Account is selected by default. Options include Alibaba Cloud RAM User, Quick BI Account, WeCom, DingTalk Account, Lark, Third-party Lark, and Third-party System Account.
   	Operation Proxy User	Enter the name or ID of the proxy user based on the selected account mapping method. The name or ID can be up to 256 characters in length. Note When creating a dataset, Quick BI checks whether the operation proxy user has read permission for the specified table in Dataphin. We recommend that you configure an account with extensive database permissions. This operation proxy user must create corresponding data sources and datasets for consumption assets in the specified workspace of the Quick BI system. Grant permissions as needed.
   	Default Workspace	Select the default workspace to use when you create analysis tasks for 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 proxy user has joined and has permission 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 name, description, type, contact, endpoint, last update time, and whether the system is enabled for consumption.

2. You can search by application system name or filter by Available For Consumption.

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

   • Edit: Modify the configuration. If a consumption channel is already enabled for an application system, you cannot edit the consumption 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.

If you enable an application system for asset consumption, you can enable consumption channels and create analysis tasks in the corresponding channel. For more information about how to enable consumption channels, see Channel Management. For more information about how to create analysis tasks, see My BI Analysis.