Install TDM Portal for Windows

As a systems administrator, you can review this article to understand how to install the CA TDM Portal. The CA TDM Portal is an intuitive browser-based user interface that lets you configure and execute test data management tasks. The CA TDM Portal installer installs and configures the Portal to connect to and use an existing CA TDM repository. After you complete the installation, you can log into the CA TDM Portal and start using the CA TDM functionality.
tdm48
As a systems administrator, you can review this article to understand how to install the CA TDM Portal. The CA TDM Portal is an intuitive browser-based user interface that lets you configure and execute test data management tasks. The CA TDM Portal installer installs and configures the Portal to connect to and use an existing CA TDM repository. After you complete the installation, you can log into the CA TDM Portal and start using the CA TDM functionality.
 
2
 
 
Installation Prerequisites
Review the following prerequisites:
  • Verify that the CA TDM repository is already available, and that you have appropriate credentials to access it. For more information, see Install the Repository.
    Warning:
     Create a GTREP database for each CA TDM Portal Installation. Do not use the same repository for multiple CA TDM Portal installations.
  • Verify that your system meets all requirements. See System Requirements.
Install the CA TDM Portal
Follow these steps:
 
  1. Ensure that the TDM Repository installation is complete. For more information, see Install the Repository.
  2. Double-click the CA TDM Portal installer executable file.
    The CA Test Data Manager Portal welcome dialog opens.
  3. Click 
    Next
    .
  4. Accept the end-user license agreement and click 
    Next
    .
  5. Specify whether to use HTTPS protocol for the CA TDM Portal:
    Default: https://localhost:8443/
    • Secure with HTTPS
      Specifies that the CA TDM Portal can be accessed using HTTPS. This uses a self-signed certificate by default. You can replace the certificate with your own certificate. For more information, see Manage Certificates.
      Default: Enabled
      You should send encrypted web tokens over HTTPS connections, rather than over HTTP. The HTTPS protocol helps prevent interception of data by unauthorized users.
    • Port
      Specifies the port where you want to run the CA Test Data Manager Portal service. The default ports are 8080 for HTTP and 8443 for HTTPS.
    Specify whether to automatically generate the keystore password:
    • Autogenerate keystore password
      Specifies whether you want to automatically generate the keystore password. Select this option to do so.
      If you do not want to automatically generate the keystore password, provide the required information in the 
      Keystore Password
       and 
      Confirm Keystore Password
       fields.
    • Keystore Password
      Specifies the password you want to use to generate the keystore.
    • Confirm Keystore Password
      Verifies that the keystore password is entered correctly. Keystore password and confirm keystore password values must be the same.
  6. Click 
    Next
    .
    The 
    Configure Installation Details
     dialog opens.
  7. Perform the following actions:
    1. Browse to the folder location where you want to install the CA TDM Portal.
      Note: 
      The default install path is C:\Program Files\CA\CA Test Data Manager Portal.
    2. Select the type of the CA TDM repository database from the
       Repository database type
       drop-down list. The supported database types are Microsoft SQL Server and Oracle. 
  8. Click 
    Next
    .
  9. Enter the connection information for your CA TDM repository as follows:
    • Server
      Specifies the name of the server where the database is located. Specify the server name in the following format:
      • SQL Server
        <Server Name> or <Server Name\Instance Name>
      • Oracle
        <Server Name/Fully Qualified Service Name>
    • Port
      Specifies the port where the database is available.
      Default: 1433 for MS SQL Server and 1521 for Oracle
    • Database
      (Microsoft SQL Server only) Specifies the repository database name. For example, gtrep.
    • Integrated Security
      (Microsoft SQL Server only) Lets you use the Windows integrated security authentication to access the database. For more information, see Enable Integrated Security for CA TDM Portal.
    • Username
      Specifies the user allowed to access the database.
      Default: sa for SQL Server and gtrep for Oracle
    • Password
      Specifies the password associated with the database user.
  10. Click 
    Next
    .
    The 
    Orient DB
     dialog opens.
  11. Enter information for creating the OrientDB database as follows:
    Note:
     OrientDB is a distributed graph database that the CA TDM Portal uses to model projects.
    • Username
      Specifies the name of the user having access to the Orient database.
      Default: root 
    • Password
      Specifies the password for the user name provided in the 
      Username
       field. Also, confirm the password.
    • Binary Port
      Specifies the binary port number where you want to run the Orient database.
      Default: 2424
    • HTTP Port
      Specifies the HTTP port number where you want to run the Orient database.
      Default: 2480
  12. Click 
    Next
    .
    The 
    ALM Service
     dialog opens. 
  13. Specify the following information to connect to an installed ALM service:
    • Server
      Specifies where the ALM service is installed.
    • Port
      Specifies the ALM service port number.
      Default: 8095
  14. Click 
    Next
    .
    The 
    Send Usage Data
     dialog opens.
  15. Select 
    Share usage data with CA Technologies
     if you want to send usage information to CA Technologies.
    For more information, refer to Configure Telemetry.
  16. Enter your support credentials.
    • Username
      Specifies the user allowed to access CA Support.
    • Password
      Specifies the password associated with the support user.
  17. Click 
    Next
    .
    The 
    Ready to Install
     dialog opens.
  18. Click 
    Install
     to start the CA TDM Portal installation.
    The 
    Installing CA Test Data Manager Portal
     dialog opens and displays the installation status.
  19. Click 
    Finish
     when the installation completes.
  20. Open the Windows 
    Services
     dialog (Start, services) and verify that services named 
    CA Test Data Manager Portal
     and 
    OrientDB
     are available and are running.
    You have successfully installed the CA TDM Portal.
    After the installation, the CA TDM Portal generates logs for each task that you perform. The log files are available at 
    %ProgramData%\CA\CA Test Data Manager Portal\logs\
    . The full default path is
    C:\ProgramData\CA\CA Test Data Manager Portal\logs
    .
  21. (Optional) Specify Find & Reserve Prefetch Databases
    The TDM Portal Find and Reserve feature lets you cache data to improve performance (see Specify where prefetched databases are stored).
    If you want to manually specify a location for this data, we recommend that you specify this location before your first use of CA TDM Portal. If you specify a location after the first prefetch (to the default gtrep database), follow the Remove prefetched data from gtrep database instructions to remove cached databases from the gtrep schema/database.
Modify your CA TDM Portal installation
If you run the CA TDM Portal installer executable on a machine with an installation of CA TDM Portal, the installer displays the 
Modify, Repair or Remove installation
 dialog (after the welcome dialog). Select the appropriate option (
Modify, Repair, 
or
 Remove
) and proceed with the associated steps.
Uninstallation of CA TDM Portal
You can uninstall CA TDM Portal from the Control Panel or from the Start menu (Start, All Programs, CA, CA Test Data Manager Portal, Uninstall CA Test Data Manager Portal).
For reinstallation of CA TDM Portal, we recommend you first back up your OrientDB database. Failure to do so may result in loss of data from OrientDB database - see possible outcome at CA TDM Portal Troubleshooting.
For more information, see OrientDB Backup and Restore.
Install the CA TDM Portal using Command Line Interface
Follow these steps:
 
  1. Ensure that the CA TDM Repository installation is complete. 
  2. Copy the CA TDM Portal installer executable file to the server where you want to install the CA TDM Portal. For example, 
    C:\Users\Administrator\Downloads
     
  3. Open Command Line Interface and change the drive to the folder where you copied the CA TDM Portal installer. For example, to change the directory to the 
    C:\Users\Administrator\Downloads,
     run the following command:
    cd C:\Users\Administrator\Downloads
     
  4. Run the following command:
    C:\Users\Administrator\Downloads>"setup_CA Test Data Manager Portal<version>.exe" /quiet SERVER_PROP=<database server name> PORT_PROP=<Port> DATABASE_PROP=<Repository Database Name> USERNAME_PROP=<Database User Name> PASSWORD_PROP=<Database User Password> TDMWEB_SERVICE_PORT=<Port> HTTPS_ENABLED=<true/false> ODBC_RES_PROP="<SQL Server/ORACLE>" ORIENTDB_PASSWORD=<Password> ORIENTDB_BINARYPORT=<Port> ORIENTDB_HTTPPORT=<Port> ALM_PORT_PROP=<Port> ALM_SERVER_PROP=<ALM Server Name> AUTO_GENERATE_KEYSTORE_PASSWORD=<true/false> TDMWEB_KEYSTORE_USER_PASSWORD=<password> /L*V "<Log File Name.log>"
    • You must separate each parameter with a space. If any parameter value has spaces, then use " " (double quotes).
    • Ensure that you specify the parameter values correctly. If there are any syntax errors or invalid parameter values, the installation will fail. In such case the roll back of the installation is not supported.
    • SERVER_PROP
      Specifies the name of the server where the database is located. Specify the server name in the following format:
      • SQL Server
        <Server Name> or <Server Name\Instance Name>
      • Oracle
        <Server Name/Fully Qualified Service Name>
    • PORT_PROP
      Specifies the port where the database is available.
      Default: 1433 for MS SQL Server and 1521 for Oracle
    • DATABASE_PROP
      (SQL Server only) Specifies the repository database name. For example, gtrep.
    • USERNAME_PROP
      Specifies the user allowed to access the database.
      Default: sa for SQL Server and gtrep for Oracle
    • PASSWORD_PROP
      Specifies the password to authenticate the database user.
    • ORIENTDB USER
      Specifies the name of the user having access to the Orient database.
      Default: root
    • ORIENTDB_PASSWORD
      Specifies the password for the Orient database user.
    • ORIENTDB_BINARYPORT
      Specifies the binary port number where you want to run the Orient database.
      Default: 2424
    • ORIENTDB_HTTPPORT
      Specifies the HTTP port number where you want to run the Orient database.
      Default: 2480
    • TELEMETRY_ENABLED
      Specifies whether you want to send your CA TDM usage information to CA Support. The default value is false. This is an optional parameter.
    • TELEMETRY_EMAIL
      Specifies the email of your CA Support account.
      Note: 
      This parameter is mandatory if TELEMETRY_ENABLED is set to true. 
    • TELEMETRY_PASSWORD
      Specifies the password of your CA Support account.
      Note: 
      This parameter is mandatory if TELEMETRY_ENABLED is set to true. 
    • ODBC_RES_PROP
      Specifies whether the ODBC is SQL Server or ORACLE.
    • ALM_SERVER_PROP
      Specifies where the ALM service is installed.
    • ALM_PORT_PROP
      Specifies the ALM service port number.
      Default: 8095
    • TDMWEB_SERVICE_PORT
      Specifies the TDM web service port number.
      Default: 8443
    • HTTPS_ENABLED
      Specifies whether to enable the "https" protocol or not. The value "true" indicates to enable, and "false" indicates to disable the "https" protocol.
    • AUTO_GENERATE_KEYSTORE_PASSWORD
      Specifies whether to automatically generate the keystore password. The default value is true. This is an optional parameter.
    • TDMWEB_KEYSTORE_USER_PASSWORD
      Specifies the password you want to use to generate the keystore. This parameter is applicable only when AUTO_GENERATE_KEYSTORE_PASSWORD is set to false. This parameter then becomes a mandatory parameter.
    • <Log File Name.log>
      Specifies the name of the log file that you want to create. After installing CA TDM Portal, you can access the log file under the path: 
      <install-dir>
      \logs\
      .
       
    Below is the command with parameter values for example:
    C:\Users\Administrator\Downloads>"setup_CA Test Data Manager Portal4.4.0.0.exe" /quiet SERVER_PROP=localhost\TDM PORT_PROP=1433 [email protected] DATABASE_PROP=gtrep USERNAME_PROP=sa TDMWEB_SERVICE_PORT=8081 HTTPS_ENABLED=false ODBC_RES_PROP="SQL Server" ORIENTDB_PASSWORD=root ORIENTDB_BINARYPORT=2425 ORIENTDB_HTTPPORT=2481 ALM_PORT_PROP=8092 ALM_SERVER_PROP=mat01-05 AUTO_GENERATE_KEYSTORE_PASSWORD=false [email protected] /L*V "CATDMPortalInstallation.log"
    The CA TDM Portal is successfully installed. 
  5. View the log file for detailed information. After successful installation, the log file shows the following message at the end of the file:
    "CA Test Data Manager Portal -- Installation completed successfully."
     
Install Additional Database Drivers
When you try to connect to a database without having required drivers installed, an error message will tell you that the respective JDBC driver class was not found. After you install CA TDM Portal, add JDBC drivers for additional databases that you are using. 
To add JDBC Drivers to a CA TDM Portal installation:
 
  1. Download the JDBC driver from the respective company's support portal.
    • MySQL JDBC driver - mysql-connector-java-5.1.38-bin.jar
    • MariaDB JDBC driver - mariadb-java-client-2.0.3.jar
    • Sybase JDBC driver - jconn4.jar
    • DB2 JDBC driver - db2jcc4.jar
    • Teradata JDBC drivers - tdgssconfig.jar and terajdbc4.jar
    • DB2 AS/400 JDBC driver - jt400.jar
  2. Copy the jar files into the following CA TDM folder:
    C:\Program Files\CA\CA Test Data Manager Portal\tomcat\jdbc-drivers
     
  3. Restart the CA Test Data Manager Portal service.
If you want to connect to the CA TDM Repository or source and target data sources with Integrated Security, Enable Integrated Security for CA TDM Portal.
How to Install the CA TDM Portal and Datamaker on Separate Servers
When Datamaker and CA TDM Portal are installed on the same machine with default settings, no additional configuration is required. 
If you have customized the URL parameters of CA TDM Portal during installation (for example, you changed the protocol or port to be different from the default, https://localhost:8443), or, if you have installed the Portal on a different machine than Datamaker, tell Datamaker where you have installed CA TDM Portal. 
  1. Browse to the Datamaker installation directory:
    C:\Program Files (x86)\Grid-Tools\GTDatamaker 
     
  2. Open the file 
    RESTutil.properties
     in a text editor.
  3. Configure the 
    server.url
     property to point to your custom CA TDM Portal server and port.
Authentication and Security
Datamaker's RESTutil uses the default CA TDM login endpoint (/TestDataManager/user/login) to authenticate users. Proper security for the REST client can only be ensured when the CA TDM Portal uses the HTTPS protocol. When the Portal uses HTTP, all the requests, including login and password, are sent unencrypted in open text. 
The RESTutil supports two levels of TLS certificate trust. Choose 
one
 of the following options:
Trust Server Certificate
 
Enable the SSL Trust property in your RESTutil.properties file:
security.ssl.trust-server-certificate=true
 
Trusting the server certificate is generally an unsafe option when the RESTutil and Portal are installed on separate machines, as it does not prevent man-in-the-middle attacks.
Trusting the server certificate is acceptable in case of single-machine installations, which is the default installation option for Portal and Datamaker.
Verify Server Certificate
 
Disable SSL Trust and configure the server certificate in the RESTutil.properties file. 
If you use the default self-signed certificate in CA TDM Portal:
  1. Open the Portal login page in a browser.
  2. Save the SSL certificate as a file to the following path:
    C:\Program Files (x86)\Grid-Tools\GTDatamaker\server.cer
     
  3. Configure your certificate file 
    server.cer
     in the RESTutil.properties file:
security.ssl.trust-server-certificate=false
security.ssl.certificate-file=server.cer
security.ssl.trust-store=.truststore
security.ssl.trust-store.password=
Alternatively, you can configure it to use your Java Trust Store.