Install on Windows

Before installing, consider the following:

  • Verify that you meet the various installation prerequisites. For prerequisite information, see the relevant chapters in Installation prerequisites.

  • If you are planning to upgrade a copy of the existing Site Administration schema, the database server of the existing Site Administration schema and the database server of the existing Lab Project must be supported. If these database servers are not supported, you can disable the validation check. For details, refer to Disabling validation checks for the installation wizard.

    Note: For the most up-to-date supported environments, see the Support Matrix.

  • If you encounter problems during the installation process, see Troubleshooting the installation for troubleshooting suggestions.

  • If you want to reconfigure OpenText Application Quality Management after the installation and configuration is complete, you must run the installation procedure again.
  • If an error occurs during the installation procedure, you must uninstall and restart the installation procedure.

  • If an error occurs during the installation procedure and the installation log file is not found, ensure that enough disk space is available for installation and deployment to the selected locations, and that system settings such as the open file resources limit are set to the maximum allowable value.

To install on Windows:

  1. Log in to the server machine with the appropriate permissions. For a list of required permissions, see Required Permissions: Windows.

  2. If OpenText Application Quality Management is installed on the machine, uninstall it. For information on uninstalling, see Uninstall.

    Cluster environment: Uninstall ALM from all nodes.

  3. Make sure the following services are started on the machine:

    1. Secondary Logon

    2. Windows Management Instrumentation

  4. Run thesetup.exe, and click ALM Platform (Windows OS).

    Note:  

    • The configuration settings are saved in the qcConfigFile.properties file. The file is created in the C:\ProgramData\Micro Focus\ALM\conf directory.

    • Also, the repid.txt file is created in the <ALM Repository path>\qc folder. The file should not be moved from this location.
    • If you are installing OpenText Application Quality Management on a secondary node of a cluster, some of the dialog boxes that are needed only for the primary node are not displayed.

  5. The Installation wizard starts, displaying the Welcome page. Click Next.

  6. The License Agreement page opens.

    Read the license agreement. To accept the terms of the license agreement, select I accept the license terms. Click Next.

  7. In the JDK/JRE Path step, browse to or enter the JDK or JRE folder path. Click Next.

    The JDK or JRE folder path you specified in this step is written to the qcConfigFile.properties file and MICRO_FOCUS_JAVA_PATH. It can be different from the value of the JAVA environment variable JAVA_HOME. For details about MICRO_FOCUS_JAVA_PATH and JAVA_HOME, see Installation Considerations: Windows.

    Required only if you use the Microsoft SQL Server (Windows Auth.) authentication type:

    1. In your JRE/JDK's bin folder, which is specified in JAVA_HOME, back up and remove the old mssql-jdbc_auth*.dll file if any.

    2. Copy the mssql-jdbc_auth-8.2.2.x64.dll file from the installer folder (where you extracted the install.zip file) to your JRE/JDK's bin folder. If there is a jre folder under the JDK folder, copy the file to both the JDK/bin and JDK/jre/bin folders.

    If the values of MICRO_FOCUS_JAVA_PATH and JAVE_HOME are different, also copy the mssql-jdbc_auth-8.2.2.x64.dll file to the bin folder of the JDK or JRE folder specified by MICRO_FOCUS_JAVA_PATH.

  8. In the Folder Selection step, browse to or enter the installation path, or accept the default. Click Next.

  9. If the wizard detects settings from a previous installation, the Current Settings page opens.

    Select Use default values of existing configuration to use the current settings as default settings for the current installation. You can make changes to any of the default settings during the wizard. Select No to clear all settings in the Configuration wizard.

    Click Next

  10. The Database Server page opens.

    1. Under Database Type, select the database type to be used in your OpenText Application Quality Management system.

      Oracle Uses Oracle authentication
      MS-SQL (SQL Auth.) Authenticates the user to the database using a database user name and password.
      MS-SQL (Windows Auth.) Windows authentication relies on the user being authenticated by the operating system.
      MS-SQL (AAD Auth.) Authenticates the user to the database using an Azure AD account.

      Note: When upgrading projects to 25.1, you must use the same type of SQL authentication that you used when that project was originally created.

      For details on database requirements, see Prerequisites: Oracle Database Servers or Prerequisites: Microsoft SQL Database Servers.

    2. Select one of the following options:

      • Database Parameters. Select this option to enter database server information using the following fields:

        DB host name Type the database server host name or IP address. For example, dbsrv01.domain.com.
        DB port number Type the database server port number, or accept the default port number.
        Oracle service name If you selected Oracle as the database type, type the Oracle service name.

      • Connection String. Select this option to type a formulated database server connection string.

        Oracle RAC database

        Select Connection String, and enter a connection string, specifying the folder that contains the tnsnames.ora file, and the TNS server to which ALM should refer. Use the following example:

        jdbc:oracle:thin:@OrgRAC;oracle.net.tns_admin=c:\oracle\NETWORK\ADMIN;

        For details on prerequisites for Oracle RAC support, seeOracle RAC Support

        Microsoft SQL Server database

        		 If your database requires SSL/TLS access, see Configure a secure database connection for a new installation.

    3. DB admin user name. Type the name of the user with the administrative permissions required to install on the database server.

    4. DB admin password. Type the database administrator password.

    Note: DB admin user name and DB admin password are not applicable for Microsoft SQL Server Windows Authentication.

    Click Next.

  11. The Site Administration Database Schema page opens.

    1. In Select Action, choose one of the following:

      Create a New Schema

      Creates a new Site Administration database schema and a new Lab_Project.

      Note: The installation log and the enable_extensions.txt file contain error messages stating "Schema differences were found". These errors can be ignored, they are generated as part of the schema enable extension mechanism and the upgrade mechanism.
      Upgrade a copy of the existing schema

      Creates a copy of the existing Site Administration database schema, and upgrades the copy. For details, see Schema Upgrade Guidelines.

      If you select this option, the Schema Exception File option appears. If you have defined an exception file for the upgrade process, click Browse and navigate to the location where it was saved before the installation. For details about exception files, see Manage schema changes.

      When working in a cluster environment, select this option if you have an existing primary node and you want to install OpenText Application Quality Management.

      Note: When you upgrade a copy of the existing Site Administration schema, OpenText Application Quality Management tries to copy LAB_PROJECT to the database server where the original LAB_PROJECT exists. If LAB_PROJECT is successfully copied, the new upgraded Site Administration schema points to the new copy of LAB_PROJECT. If LAB_PROJECT is not copied, a new empty LAB_PROJECT is created in the database server where the new Site Administration database schema is created. For details, see LAB_PROJECT installation considerations
      Connect to existing schema / second node

      This option can be used in two scenarios:

      • If you are reinstalling and would like to reconnect to the same Site Administration database schema.

      • If you have an existing node and you want to install on another node to create a cluster. For details on cluster configuration, see Clustering: Windows.

        Note: This option enables you to connect to a 25.1 Site Administration database schema only. To connect to an earlier version, you must first upgrade the schema. For details, seeUpgrade the Site Administration database schema.

    2. When creating a new schema, in Database Name, enter the name of the database.

    3. When connecting to OpenText Application Quality Management on an Oracle database server:

      If you are installing on a secondary node or if the Site Administration database already exists, the new Site Administration database schema is created in the same tablespace as the existing schema. Continue with the Security step below.

      Type the following information:

      • Default Tablespace. Select a default storage location from the list.

      • Temporary Tablespace. Select a temporary storage location from the list.

    4. Under SA Schema Details, type the following information:

      • Schema name. Type a Site Administration database schema name, or accept the default schema name. The Site Administration database schema name can contain English characters or numbers only.

      • Schema password. Enter the following information, depending on your database type:

        Oracle: The default tdtdtd password is created, which you can accept or change.
        Microsoft SQL Server (SQL Auth.):

        OpenText Application Quality Management uses the td user to create the Site Administration database schema. For more details on the td user, see User Permissions for Connecting to a Microsoft SQL Database Server.

        Type a password for the td user that complies with your organization’s password policy, or keep the default tdtdtd password.
        Microsoft SQL Server (Windows Auth.): Not applicable.
        Microsoft SQL Server (AAD Auth.) Enter the name and password of the Site Administration database schema name, or keep the default tdtdtd password.

      • New Schema name. If you selected Upgrade a copy of the existing schema, type a name for the upgraded copy of the database schema. The Site Administration database schema name can only contain English characters or numbers.

        Note: When upgrading an existing Site Administration database schema to work in 25.1, you must use the same name that you used before the upgrade.

    Click Next.

  12. The License Key page opens.

    Note: If you selected Connect to existing schema / second node in the previous step, the License Key step is skipped. Continue with the Security step below.

    Select one of the following options:

    ALM server license key Browse to or enter the OpenText Application Quality Management license file path.
    Use Evaluation Key

    If you do not have a license file, select this option for a 30-day trial version. From the drop-down list, select the edition to install for the trial period.

    Note: If you install Quality Center Community Edition, you must assign named licenses to your users. Only then can the users successfully log in to ALM and see the appropriate modules.

    License URL Parameters

    This option configures the AutoPass License Server (APLS).

    1. Enter the license server host and port.

    2. To secure the communication, select HTTPS.

    Alternatively, you can also configure APLS after the ALM installation. Perform the following steps:

    1. From the ALM server machine, navigate to C:\ProgramData\Micro Focus\ALM\repository\sa\Admin\MaintenanceData\conf
    2. Edit clusterSettings.properties
    3. Define values for the following fields: AUTOPASS_SERVER_PROTOCOL, AUTOPASS_SERVER_PORT, AUTOPASS_SERVER_NAME.
    4. Save and restart the ALM server.

    Click Next.

  13. The Security page opens.

    1. Confidential Data Encryption

      Passwords for accessing external systems (databases and LDAP) are stored by OpenText Application Quality Management after encryption. Enter a Confidential Data Passphrase that is used to encrypt the information.

      Make a note of the passphrase for future support calls. You need the passphrase if you choose to redeploy OpenText Application Quality Management and choose to upgrade a copy of the existing Site Administration Database Schema. The passphrase is also required for the next installation.

      Select Use default value for Passphrase to use the default Confidential Data Encryption passphrase. By selecting this option, the encrypted information is more vulnerable to unauthorized access.

      Note:  

      • After completing the server configuration wizard, you cannot change the confidential data encryption passphrase.

      • The passphrase is case-sensitive. Also check that there are no empty spaces before or after the passphrase. The passphrase must contain only alphanumeric characters.

      • If you do not have a note of the confidential data passphrase, there is a workaround to recover it. However, you will have to abort the configuration process and then begin again once the workaround is complete. For details, seeRecover a lost confidential data passphrase.

    2. Communication Security

      Communication between OpenText Application Quality Management and other applications is enabled after authentication by a Single Sign-On (SSO) token. Enter a communication security passphrase that OpenText Application Quality Management uses to encrypt the SSO token.

      Note:  

      • The communication security passphrase is stored as the value of the COMMUNICATION_SECURITY_PASSPHRASE site configuration parameter.

      • The passphrase must contain only alphanumeric characters, and must contain at least 12 characters .

    Passphrases considerations

    • You must use the same passphrases (both confidential data passphrase and communication security passphrase) that were used for the previous installation.

    • If you are planning to migrate, restore, or import extension-enabled projects (such as LoadRunner Enterprise and/or Lab Management enabled projects)onto the server on which the project was originally created, you must use the same passphrases that were defined on the server on the original server.

    • If you are installing on a cluster, you must use the same passphrases for all nodes.

    Caution: If you use different passphrases than those for the previous version, stored information such as API key secrets, SMTP passwords, and database server passwords become invalid and cannot be restored. This results in connection failures to all ALM projects and the corresponding systems.

  14. The Site Administrator User page opens.

    You use the site administrator name and password that you define here to log in to Site Administration for the first time. After installation, you can change the site administrator or add other site administrators. Enter a site administrator user name (maximum length 60 characters) and password, and retype the password to confirm.

    If you are upgrading a copy of the existing Site Administration database schema, by default the same user and credentials are applied to the upgraded schema. To create an additional user, select Create additional Site Administrator user (this field appears only when you are upgrading a copy of the existing schema).

    Note:  

    • The user name cannot include the following characters: \ / : * ? " < > |

    • The password cannot be longer than 20 characters.

    • It is important that you remember the site administrator user name and password so you can log in to Site Administration.

    Click Next.

  15. The ALM Service page opens.

    Type the User Name, Password, and Domain to be used to run the application server as a service. This enables the service to access your local network.

    If the repository is on a remote machine, or if you are using a Microsoft SQL server with Windows authentication, enter the details of a domain user who has administrative permissions for the SQL server and who is a local administrator.

    Click Next.

  16. The Repository page opens.

    In the File repository path box, click the browse button to choose a repository path, or accept the default path. Make sure to enter a unique, case-sensitive name for the repository folder.

    Note:  

    • Make sure you select a path where you have full read and write permissions.

    • To work with cluster nodes, make sure that all nodes have access to the file repository path and that the path is UNC. All nodes in the cluster must have the same string for the repository path.

    • The length of the file repository path cannot exceed 200 characters.
    • The file repository path cannot reside on the root folder.
    • Due to a Windows limitation, the file repository path cannot be on a mapped drive.

    Using the BASE_REPOSITORY_PATH site configuration parameter, you can create a location for a repository path where new projects will be located. Performing this action, therefore, means there will be two repository paths: the previous path containing older projects, and a second path containing projects created subsequently.

    Click Next.

  17. The Application Settings page opens.

    1. In the Deployment Path box:

      Specify the location in which you want to deploy application files. Click the browse button to choose a location, or accept the default location. We recommend that you keep the default.

      Note:  

      • The length of the deployment path cannot exceed 200 characters.

      • Due to a Windows limitation, the deployment path cannot be on a mapped drive.

    2. In the Web Server box:

      Change or keep the default HTTP port number. The default port is 8080.

      Note: If an error message is displayed that the default port is unavailable, the port may be in use by another application running on the server machine. Either locate the application and stop it, or enter a different port number. To enter a different port number, you must first change the port number on the application server. For details, see  . Then proceed with the configuration as normal.

    3. Select Start ALM server once installation completed to automatically start the server when the installation is successfully completed.

    Click Next.

  18. The Mail Service page opens.

    To enable OpenText Application Quality Management to send emails to users in a project, select a mail protocol. For SMTP Service, type the server name and port.

    If you selected Microsoft IIS SMTP Service, you must configure the Microsoft IIS SMTP service. For details, see Configure the IIS Mail Service.

    Click Next.

    Note: The Mail Server can be configured after installation in Site Administration. For details, refer to the online help.

  19. The ALM Client Launcher page opens.

    ALM Client Launcher is a tool that allows you to run an ALM client on any Windows machine without the need of deploying it from an ALM server and without Windows administrator permissions.

    From this page, you can:

    • Click the marketplace link to download ALM Client Launcher and learn more about the tool.

      You can also download ALM Client Launcher after the ALM installation.

    • Check the Package client files in the server for ALM Client Launcher option to have client files automatically packaged in the server.

      We recommend you check this option if you want to use ALM Client Launcher. It saves you from manually uploading client files to the server. Users that have downloaded ALM Client Launcher can seamlessly run an ALM client upon the successful ALM installation.

    Note: Skip this page if you do not plan to use ALM Client Launcher.

  20. The Installation Summary page opens. To change any settings, click Previous.

    Understand the breaking changes in this version by clicking the help link and select the Acknowledge all the breaking changes checkbox. Click Next to continue.

  21. The Install Complete page opens.

    If the installation process ends with warnings, check the installation logs for details, and start the server manually. For details see Checking the installation and configuration log files.

  22. If you are prompted to restart the machine, you can choose to restart at a later time, but you must restart before you use OpenText Application Quality Management. You must also restart before you install any related files, such as integration add-ins.

  23. If you are using an Oracle RAC database, verify that the ORACLE_RAC_SUPPORT site configuration parameter is set to Y. For details, refer to the online help.

  24. The installation is now complete. Proceed to Starting the system.