This topic describes how to add an ApsaraDB RDS for SQL Server data source in DataWorks.

Procedure

  1. Go to the Data Source page.
    1. Log on to the DataWorks console.
    2. In the left-side navigation pane, click Workspaces.
    3. After you select the region where the required workspace resides, find the workspace and click Data Integration in the Actions column.
    4. In the left-side navigation pane of the Data Integration page, choose Data Source > Data Sources to go to the Data Source page.
  2. On the Data Source page, click Add data source in the upper-right corner.
  3. In the Add data source dialog box, click SQLServer in the Relational Database section.
  4. In the Add SQLServer data source dialog box, set the parameters as required.
    1. Configure basic information for the SQL Server data source.
      You can use one of the following modes to add an SQL Server data source: Alibaba Cloud instance mode and Connection string mode.
      • The following table describes the parameters you can set if you add an SQL Server data source by using the Alibaba Cloud instance mode. Add an SQL Server data source by using the Alibaba Cloud instance mode
        Parameter Description
        Data source type The mode in which the data source is added. Set this parameter to Alibaba Cloud instance mode.
        Data Source Name The name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
        Data source description The description of the data source. The description can be up to 80 characters in length.
        Environment The environment in which the data source is used. Valid values: Development and Production.
        Note This parameter is displayed only when the workspace is in standard mode.
        Region The region in which the data source resides.
        RDS instance ID The ID of the ApsaraDB RDS for SQL Server instance. You can log on to the ApsaraDB RDS console to view the ID of the instance.
        RDS instance account ID The ID of the Alibaba Cloud account that is used to purchase the ApsaraDB RDS for SQL Server instance. You can use the Alibaba Cloud account to log on to the DataWorks console, move the pointer over the profile picture in the upper-right corner, and then view the ID of the account.
        Database name
        The name of the default ApsaraDB RDS for MySQL database. The following descriptions provide instructions for you to configure a data synchronization node or solution that uses a MySQL data source:
        • When you configure a database-level real-time or batch data synchronization node or solution that uses a MySQL data source, you can select one or more databases on which you have access permissions in the ApsaraDB for MySQL instance.
        • If you select multiple databases when you configure a batch synchronization node, you must add a data source for each database.
        User name The username that you use to connect to the database.
        Password The password that you use to connect to the database. Do not use at signs (@) in your password.
        Note You must add the IP addresses or CIDR blocks that you use to connect to the ApsaraDB RDS for SQL Server instance to a whitelist of the instance. For more information, see Configure an IP address whitelist.
      • The following table describes the parameters you can set if you add an SQL Server data source by using the Connection string mode. Add an SQLServer data source by using Connection string mode
        Parameter Description
        Data source type The mode in which the data source is added. Set this parameter to Connection string mode.
        Data Source Name The name of the data source. The name can contain letters, digits, and underscores (_) and must start with a letter.
        Data source description The description of the data source. The description can be up to 80 characters in length.
        Environment The environment in which the data source is used. Valid values: Development and Production.
        Note This parameter is displayed only when the workspace is in standard mode.
        JDBC URL The Java Database Connectivity (JDBC) URL of the database, in the format of jdbc:sqlserver://ServerIP:Port;DatabaseName=Database. You must replace Database with the name of the default database. However, when you configure a sync node, you can use all the databases in the ApsaraDB RDS instance.
        User name The username that you use to connect to the database.
        Password The password that you use to connect to the database.
    2. Configure authentication information for the SQL Server data source.
      Third-party authentication mechanisms are used to perform strict identity authentication on users and services. These mechanisms prevent untrusted applications or services from accessing data and improve data security during data synchronization. DataWorks allows you to use a third-party authentication mechanism when you add a data source. If you enable identity authentication, only the trusted applications and services can access data sources. To enable SSL-based authentication, set the Special Authentication Method parameter to SSL Auth.
      Note If you enable SSL-based authentication, you must upload the required authentication files on the Authentication File Management page of the DataWorks console. For more information about how to upload and reference authentication files, see Configure third-party identity authentication. If you do not need to perform identity authentication on applications or services, you can set the Special Authentication Method parameter to None Auth when you add the SQL Server data source.
      The following figure shows the parameters you must set if you enable SSL-based authentication. Add SQLServer data source dialog box
      Parameter Description
      Truststore file The truststore that is used to store specific trusted certificates. This certificate is authenticated when DataWorks accesses the SSL server. This ensures that only trusted applications and services can access data sources.

      You can lick Add Authentication File to upload a new truststore.

      Truststore password
      • If your data source is an ApsaraDB RDS for MySQL, ApsaraDB RDS for SQL Server, or ApsaraDB RDS for PostgreSQL database, the password in the truststore is apsaradb.
      • If your data source is a self-managed RDS database, the value of the Truststore password parameter is a password that you specify.
  5. Set Resource Group connectivity to Data Integration.
  6. Find the desired resource group in the resource group list in the lower part of the dialog box and click Test connectivity in the Actions column.
    A synchronization node can use only one type of resource group. To ensure that your synchronization nodes can be normally run, you must test the connectivity of all the resource groups for Data Integration on which your synchronization nodes will be run. If you want to test the connectivity of multiple resource groups for Data Integration at a time, select the resource groups and click Batch test connectivity. For more information, see Establish a network connection between a resource group and a data source.
    Note
    • By default, the resource group list displays only exclusive resource groups for Data Integration. To ensure the stability and performance of data synchronization, we recommend that you use exclusive resource groups for Data Integration.
    • If you want to test the network connectivity between the shared resource group or a custom resource group and the data source, click Advanced below the resource group list. In the Warning message, click Confirm. Then, all available shared and custom resource groups appear in the resource group list.
  7. After the data source passes the connectivity test, click Complete.