Adding a connection profile

A connection profile is a set of JDBC connection data that refers to the properties of the target database and some settings for the JDBC connection, for establishing connection to the target database.

About this task

After you complete the setup process, it is important to add connection profiles. Any user who has the authority to log in to the product web console can create a database connection.

Procedure

  1. Log in to IBM® Db2® Data Management Console.
  2. Click Administration and select Connection profile.
  3. To create a connection, click New connection.
  4. In the New connection dialog, select Add a connection and click Next.
  5. In the Create connection page, specify the connection parameters, and click Save.
    Note:
    • Operation credential is needed to perform operational tasks on connected databases, such as administration tasks, querying the database, or optimization through tuning.
    • Data collection credential is needed to collect data from a connected database for monitoring and alert generation.
    • JDBC URL attributes are only valid in the context for query execution that uses JDBC as a connection. It is not effective when SQL is run by using:
      • CLP WITH SSH in SQL editor
      • CLP or shell script in jobs
      • Shell script in custom alerts.
  6. To export connection profiles, do the following steps:
    UI: The database connection information that you can export must be in CSV (comma-separated value) text format.
    1. Go to Administration > Connection profile.
    2. Click the Export profiles icon and select the one of the following export methods:
      • Export with credentials 
      • Export without credentials.
      Result: All the profiles are exported as CSV file to your browser.
    API: The database connection information that you can export must be in CSV (comma-separated value) text format or JSON array.
    • GET /dbprofiles/export  (export without data collection credentials, CSV)
    • GET  /dbprofiles/export?json=true (export without data collection credentials, JSON)
    • GET  /dbprofiles/export?exportCred=true   (export with data collection credentials, CSV)
    • GET  /dbprofiles/export?json=true&exportCred=true  (export with data collection credentials, JSON)
    Note: Data collection credentials are converted to Base64.
  7. To import connection profiles, do the following steps:

    UI: The database connection information that you can import must be in CSV (comma-separated value) text format.

    1. Go to Administration > Connection profile and click New connection.
    2. In the New connection dialog, select Import connections from file and click Next.
    3. In the Import connections page, click the Import connections from file button and select the CSV file. If the content format is correct, the console retrieves two profile groups (New profile list and Duplicated profile list) from the CSV.
    4. Select the profile that you want to add or replace.
    Result: The profiles are imported as CSV file.
    API: The database connection information that you can import must be from JSON array.
    • POST /dbprofiles/import.     body : JSON array
    • GET.  /dbprofiles/import_status. (Get import progress)
  8. To synchronize database connections, do the following steps:
    1. Go to Administration > Connection profile.
    2. Select one or more database connection names and click Synchronize.
    3. In the Synchronize profiles dialog, click Run.

      Result: The database information such as version, edition, and other properties are synchronized for the selected connection profiles.

  9. To batch update the connection credentials, do the following steps:
    1. Go to Administration > Connection profile.
    2. Select one or more database connection names and click Update credentials.
    3. In the Update credentials dialog, do one of the following actions:
      • Select Data collection credentials, provide the security details, and click Update data collection credentials.
      • Select Shared credentials, provide the security details, and click Update shared credentials.

      Result: The collection credentials and the shared credentials for multiple connection profiles are updated.