Create and Edit Connection Profiles

A connection profile is a way of storing the details about a connection to a database system. Datamaker and other programs in the  suite can connect to any number of databases to manipulate and generate data. A set of profiles allows you to store the details of different connections. 
tdm48
A connection profile is a way of storing the details about a connection to a database system. Datamaker and other programs in the
Test Data Management
 suite can connect to any number of databases to manipulate and generate data. A set of profiles allows you to store the details of different connections. 
Use the CA TDM Portal to create connection profiles for Microsoft SQL Server, DB2, MySQL, MariaDB, Oracle, Sybase, and Teradata databases. CA TDM Portal does not support connection profiles using DSN type that were created in CA TDM Datamaker. Profiles created in the CA TDM Portal are compatible with both TDM Portal and Datamaker.
You can also share a connection profile with a group. When a connection profile is shared with a group, all users associated to that group can then access the shared connection profile. 
Connection Profiles are shared between Test Data Reservation Service and Data Discovery using CA TDM Portal. For more information about how to use Connection Profiles with Data Discovery, see The Data Model in CA TDM Portal.
Considerations
 Review the following considerations for connection profiles:
  • Super administrators and users who have access to the "Settings" security function can create a connection profile.
  • Only two types of user can edit or delete a connection profile:
    • The owner (i.e. creator) of that connection profile. This user must have the '
      Settings
      ' privilege.
    • Super administrators who are a member of a group with which that connection profile is shared.
  • Super administrators, project administrators (users who are part of the "Admin" group for a project), and users who have access to the "Users and Groups" security function can share their connection profiles with user groups that they can manage. Also, only these users can view the
    User Groups
    section in the Portal; this section is not visible to other users.
    If you are an administrator, connection profiles that you share with a group are available to users, but these users cannot see the connection profiles in the Connection Profiles section of the UI, and are not able to edit or delete them.
  • Users can access and use those connection profiles that they have created. Additionally, they can also access those connection profiles that are shared with a group of which they are a member.
  • Super administrators and project administrators can create, update, and delete user groups for their project.
  • Connection profiles that are already available in Datamaker become accessible in the Portal. Similarly, connection profiles that you create in the Portal are accessible in Datamaker. 
  • All the group connection profiles in Datamaker become available as shared connection profiles in the Portal; however, they are not editable in the Portal.
  • Shared connection profiles in the CA TDM Portal show up as a single user connection profile in Datamaker.
  • The CA TDM Portal now enforces that the connection profile names must be unique.
    If you created connection profiles in Datamaker and in earlier versions of the CA TDM Portal, you might see two connection profiles with the same name in your list. In that case, rename your connection profile to resolve the conflict.
  • In scenarios where a connection profile that is shared with a group is used in both the interfaces—CA TDM Portal and Datamaker, we recommend that you create this connection profile in Datamaker and then use it across both the interfaces, as required.
Create a Connection Profile 
You can create a new Connection Profile from the CA TDM Portal. Follow these steps:
  1. Access the CA TDM Portal.
  2. Expand
    Configuration
    in the left panel.
  3. Click
    Connection Profiles
    .
    The
    Connection Profiles
    page opens.
  4. Click
    New Profile
    .
    The
    Add New Connection Profile
    page opens.
  5. Enter required information in the following fields:
    • Profile Name
      Specifies a unique name for the connection profile that you are creating.
    • Description
      Specifies an appropriate description for the connection profile that you are creating.
    • DBMS
      Lets you select the type of the database you want to connect to. 
      Note:
      Input fields vary depending on the type of the data source you select.
    • Server
      Specifies the host name or the address of the server where the database is available. 
    • Database
      Specifies the name of the database that you want to use as a source or target.
    • User Name
      Specifies the name of the user who can access the database.
      Note:
       For Microsoft SQL Server, you can now select the Integrated Security option instead of providing a user name and password.
    • Password
      Specifies the password for the database user.
    • Port
      Specifies the port number where the database is running on the server.
    • Oracle Service Name
      (For Oracle) Specifies the name of the Oracle service. TNS names are not supported.
    • SQL Server Instance Name
      (For Microsoft SQL Server) Specifies the name of the Microsoft SQL Server instance.
    • SQL Server Schema Name
      (For Microsoft SQL Server) Specifies the Microsoft SQL Server database schema name.
    • Additional Connection Properties
      (For DB2/OS, DB2/AS400 and Teradata) Lets you specify additional connection properties. Add key/value pairs separated by semi colons (;). An equals sign (=) separates each key from its value or values (separate values with commas).For example, 
      libraries=Schema1,Schema2,Schema3
       causes the Connection Profile only to include the schemas Schema1, Schema2 and Schema3.
      These properties are specific to your database type. See your specific database documentation for a comprehensive list of properties.
  6. (Optional) Share the connection profile that you are creating with a group as follows: 
    1. Click the
      Share to User Group
      button.
      The
      Select User Groups
       dialog opens.
    2. Select an appropriate group from the list and click
      Add
      . You can also select multiple groups.
      The selected group is added to the
      User Groups
      table.
    3. To delete a specific group from the connection profile, click the Remove icon (X icon) in the row corresponding to the identified group, and confirm the deletion. The group is removed from the list and is no longer associated with the connection profile. 
  7. Click
    Test
    to verify that the connection profile is able to establish the connection.
  8. Click
    Save
    if the test is successful.
    The
    Connection Profiles
    page opens. 
Edit Connection Profile
You can edit Connection Profiles from the CA TDM Portal. Follow these steps:
  1. Access the CA TDM Portal.
  2. Expand 
    Configuration
     in the left panel.
  3. Click 
    Connection Profiles
    .
    The 
    Connection Profiles
     page opens.
  4. Click a Connection Profile.The 
    Editing <Connection Profile name>
     page opens. You can now change the following properties:
    • Description
    • Profile properties
      You can change the properties of this Connection profile. Different database management systems have different properties. Server and Port are common to all database management systems
      In Oracle / SQL Server DBMS, you have the option to
      Use a specific DBMS Schema
      . This property is case-sensitive.
      If you click
      Test
      to test the database connection, this does not test the connection to the specified schema. The test may return the message 'The Connection works OK', but the schema may be invalid.
    • User Groups
  5. Click 
    Test
     to verify that the connection profile is able to establish the connection.
  6. Click 
    Done
     if you are happy with the changes.
    The 
    Connection Profiles
     page opens.
Select Source and Target Profiles
The 
Connection Profiles
 page displays only those connection profiles that you have created. If you are a member of a user group and a connection profile is shared with that group, then you can access that connection profile from all the appropriate places in the Portal. However, that connection profile is not listed on the 
Connection Profiles
 page for you, because you are not the owner of that connection profile.
A source is typically a database from which you want to model and interact with data. A target is typically a database to which you are publishing data.
  • You can only have one source and one target active at the same time. 
  • Source and target can refer to the same profile.
  • You can switch a profile from source to target, or from target to source any time.
The currently selected source and target profiles are displayed at the top of the page. Click the source or target name to jump down to the line in the list where this profile is defined.
To select a different source and target profile, enable the checkbox in the Source or Target column, respectively.