Windows Installation

This section describes how to install the OpenText Functional Testing Lab server on a Windows machine.

This section is not relevant for OpenText Core SDP and OpenText Core Functional Testing Lab.

Before you start

Before installing OpenText Functional Testing Lab, make sure that the following prerequisites are met.

Prerequisite Details
Server requirements Check that your server machine meets the requirements specified in the Support matrix.
Privileges Administrator privileges are required
Server accessibility The host name of the server machine must be accessible. Check this by running the following from a Windows command line:
ping -n 1 "hostname"
Drivers

Check that you have installed the USB drivers for your Android devices, or iTunes for iOS devices.

Windows 11 Build 22572 and later only

Install the WMI command-line (WMIC) utility.

  1. Open Settings by pressing the Windows + I keys together.

  2. Click Apps.

  3. Click Optional features.

  4. Click the Feature display button.

  5. Search for Wmic. Select the check box next to it and press Next.

  6. Click Install.

Back to top

Use an external database

An embedded PostgreSQL database is installed as part of the installation of the server. However, you can connect OpenText Functional Testing Lab to an existing external PostgreSQL database instead. This option lets your organization manage and utilize existing database resources.

Before installing or upgrading using an external database:

  1. Create a backup of the original database in the form of an hp4m.bin file. For details, see Export the embedded database.
  2. If you uninstalled the server without uninstalling the PostgreSQL database and are now using the database externally with a new installation of OpenText Functional Testing Lab, add the postgres user to the pg_hba.conf file. The file is located in <Postgres_installdir>/<postgres version>/data.
  3. postgres user listed in postgres configuration file
    You also need the original database encryption key. The external database needs the key to decrypt the data originally created by OpenText Functional Testing Lab.

  1. In a distributed environment where the external database is on a different machine from the OpenText Functional Testing Lab server, make sure that the database server accepts connections from the OpenText Functional Testing Lab server, and that OpenText Functional Testing Lab is configured to connect to the correct database server address:
    • In the postgresql.conf file stored under <Postgres_installdir>/<postgres version>/data, search for listen_addresses = . This specifies the addresses on which the database server listens for connections. Update the value with the OpenText Functional Testing Lab server IP or fully qualified domain name (FQDN). Setting the value as a wildcard “*” means the database server accepts connections from all addresses.
    • Locate the conf/hp4mExt-****.properties file in <OpenText Functional Testing Lab_installdir>\server\conf. Check that the IP address/ FQDN is the correct address for the database server machine. If the FQDN is not accessible to the OpenText Functional Testing Lab server machine due to DNS issues, replace the FQDN with the IP address of the database machine.
  1. Restore the database. For details, see Migrate the exported data to an external database.
  2. If your PostgreSQL database exceeds 4 GB, OpenTextrecommends that you run the VACUUM FULL command to clean the database from deleted content and reduce its size. For details, see the PostgreSQL documentation.
  3. Optional: You can configure the PostgreSQL server to enable SSL connections.

     To enable secure connections to the database server:
    1. Generate SSL certificates.

      Create a server private key, a server certificate, and a certificate authority (CA) certificate.

    2. Move the certificates and keys to the appropriate Directory, for example /var/lib/postgresql/data. Ensure the files have the correct permissions.

    3. Edit the PostgreSQL configuration by opening the Postgresql.conf file and setting the following parameters:

      • ssl = on

      • ssl_cert_file = <server.crt>

      • ssl_key_file = <server.key>

        ssl_ca_file = <root.crt>

    1. Edit the pg_hba.conf file.

      Configure client authentication to use SSL by modifying host to hostssl.

    1. Restart the PostgreSQL server.

Important note for Postgres 13

Only the md5 method is supported for password authentication. After installing Postgres 13, perform the following:

  1. In the postgres configuration file <postgresql_13_installdir>/data/postgresql.conf, change the password encryption setting to md5:
    Password_encryption = md5

  2. In the pg_hba.conf file <postgresql _13_installdir>/data/pg_hba.conf, change all occurrences of scram-sha-256 to md5.

  3. Restart the postgresql 13 service.
  4. Reset the postgresql 13 user password and restart.

Back to top

Install the server as a new installation

OpenText Functional Testing Lab can be installed as a full installation where no previous version is installed.

To install the server:

  1. Make sure that a connector is not installed on your machine. If it is, you need to remove it before installing the Windows server. For details, see Troubleshooting.
  2. Obtain the installation zip file. Use an extraction tool to extract the contents of the archive file install-server-windows-x64-x.xx-x.zip to your machine.
  3. Log in to your machine as administrator.
  4. Locate the extracted .exe file. Make sure it is on a local drive and not a network shared drive.
  5. Click the setup file and choose Run as administrator from the right-click menu. The installation wizard opens to the Introduction page.
  6. Select a folder for the installation and a local folder for temporary files.
  7. If you plan to use standalone connectors only, without connecting devices directly to the OpenText Functional Testing Lab machine, clear the Embedded connector checkbox.
  8. Configure the server according to the following guidelines.

    Server configuration Details
    FQDN or IP address Use the automatically detected values or modify them as needed. When using the Fully Qualified Domain Name (FQDN), the FQDN must begin with English alphabetical character. FQDNs beginning with numbers are not supported.
    SSL connection

    Clear the SSL only check box to work with a non-secure HTTP connection (non-SSL). The default is a secure SSL connection using port 8443.

    Consider the following guidelines:

    • The SSL setting affects all connectors and testing tools that integrate with the server. When configuring the OpenText Functional Testing Lab settings in connectors and tools, make sure that your selection matches that of the server.

    • If you intend to use single-sign on using SAML 2.0, do not clear the check box.

    Caution: When you specify an SSL connection, the setup installs a self-signed certificate. Self-signed certificates are not optimal because there is no outside authority to verify the identity of the server. OpenText highly recommends that you install an organizational CA certificate after putting the server into production. For details, see Using SSL certificates issued by a Certification Authority.


    Free port

    Accept or edit the internal port that is not included in the machine's firewall. Make sure that this port is available and that it is not externally accessible. |The default free port is 8081.

  1. Optional: Configure an external PostgreSQL database.

    An embedded PostgreSQL database that is installed as part of the installation of the server. However, you can connect to an existing external PostgreSQL database by selecting the Use external PostgreSQL database checkbox. This option lets your organization manage and utilize existing database resources. Before installing OpenText Functional Testing Lab with an external database, make sure that you have followed the steps described in Use an external database.

    When you select this option, the Next button opens the External PostgreSQL database configuration screen. Make sure that the database machine is accessible, and provide the following for the connection.

    Database configurationDetails
    External database server

    The IP address or Fully Qualified Domain Name (FQDN) of the database machine.

    Database port The port of the external database machine.
    Database

    The name of the external database. You can use a database name such as hp4m. You can use a name that already exists in the target database server. If the database does not exist, it is created as part of the OpenText Functional Testing Lab server installation provided that the user has sufficient permissions.

    Schema 

    You can use a schema name such as public. You can use a name that already exists in the specified database. If the schema does not exist, it is created as part of the server installation provided that the user has sufficient permissions.

    Note: If the database/ schema was originally created by OpenText Functional Testing Lab (for example, if you uninstalled the server but not the PostgreSQL database), you are prompted to provide the encryption key when you proceed to the next screen. If the database/ schema was not created by OpenText Functional Testing Lab, you do not need to provide an encryption key.

    User credentialsThe PostgreSQL database user name and password.
    SSL connection

    To enable the lab server to connect to the external database server using SSL, select the checkbox.

    Specify the location of the root certificate to enable an SSL connection to the external PostgreSQL database. The server must be able to access the certificate. Only files with a .crt extension are supported.

    This option requires configuring the external Postgres SQL database for SSL connections. To configure the database for SSL connections, see Use an external database.

  2. Choose a folder to which applications uploaded to OpenText Functional Testing Lab are saved.
    Read and write permissions to the folder are required both for the user running this installation and the local system account. When using a shared folder, the local system account on the OpenText Functional Testing Lab machine must have read and write permissions to the folder. Machines that are not in a domain have separate user management. Each machine keeps track of its own user accounts. To use a folder on another machine, make sure that a Windows account with the same name and password is defined on both machines. After installation, modify the OpenText Functional Testing Lab server to run under this Windows account. For details, see Run the service as a different user.
  3. Optional: Shared spaces configuration.

    If required, enable the shared spaces (multitenancy) feature.
    Important: This feature requires an Enterprise or Ultimate license. Disabling shared spaces is not supported and requires a clean installation. For details, see Shared spaces.
  4. Specify credentials for the following users.

    UserDetails
    OpenText Functional Testing Lab default administrator

    The installation creates a default admin user, admin@default.com, for accessing the lab console. Specify a password for this user.

    Postgres users- embedded database only

    Superuser
    When the PostgreSQL server is first installed, a superuser account postgres is automatically created. The superuser is needed to create the OpenText Functional Testing Lab database schema, and to add a user for administering the database. The superuser can override all access restrictions within the database, so it is best to carry out most operations using a non-superuser role.

    Database admin user

    The installation creates an additional user for administering the database. This user is not a superuser and only has permissions to perform operations on the OpenText Functional Testing Lab database. The default name is DLadmin. Do not use postgres as a user name.

    Follow the password rules displayed on the screen—at least six English characters, both lower and upper case, at least one digit, and only letters or numbers except for a space or the "@" symbol.

  5. When the installation is complete, the wizard displays a message that the server was successfully installed, and provides options to:
    • Start the service automatically when you press Next.

    • Allow data collection for the improvement of the product. You can modify your selection for this option in the Administration Settings.

  6. After the service starts, the OpenText Functional Testing Lab console opens in the default browser window. Log in with the credentials you provided earlier. Follow the instructions on the screen to connect devices and begin working.

    The installation creates a new shortcut on the desktop, OpenText Functional Testing Lab Server, to the server's installation folder.

  7. After installing OpenText Functional Testing Lab, OpenText strongly recommends that you keep your files and data safe by incorporating the following for the application file storage folder and external database (if relevant):
    • Access monitoring

    • Limited access rights (only OpenText Functional Testing Lab user)

    • Regular backup

    • Encryption

    • Storage consumption monitoring

    OpenText also recommends that you:

    • Change the account running the OpenText Functional Testing Lab service, instead of the default LocalService account. Make sure that this account has full access to the OpenText Functional Testing Lab installation folder. For details, see the Windows documentation.
    • Incorporate file system monitoring on the installation and temporary folders.
    • Back up the encrypted.properties file. The file is located in <path to your OpenText Functional Testing Lab Server installation> server >conf.

Back to top

Upgrade the server

OpenText Functional Testing Lab can be installed as an upgrade from version 3.2 or later.

To ensure a smooth upgrade, see Best practices for upgrades.

Packaged apps: 
To run the app packager upgrader on iOS apps, you must have already set up your Mac machine as described in Automatic signing services.

If your apps were packaged manually from the command line and then uploaded to OpenText Functional Testing Lab, the upgrader is not able to upgrade the apps. You need to repackage your apps using the latest version of the Packager service (iOS) or the Android Enabler and tgeb upload them to OpenText Functional Testing Lab.

To upgrade:

  1. Obtain the installation zip file. Use an extraction tool to extract the contents of the archive file install-server-windows-x64-x.xx-x.zip to your computer.
  2. Run the setup file. When you begin the installation, the wizard detects that you are performing an upgrade and warns you about losing existing apps. It also prompts you for the database password. When you upgrade, all existing apps remain associated with their corresponding workspaces. For details, see Lab and workspace management.
  3. Indicate if you want to perform an automatic backup of the database during the upgrade, so that the installation can perform a rollback in case of failure. This step may increase the duration of the upgrade.
  4. In the next screen, indicate if you want to automatically run the app packager upgrader after the installation. Apps are upgraded asynchronously after upgrade of the OpenText Functional Testing Lab server, reducing downtime of the server. Users are able to access the upgraded server and continue using OpenText Functional Testing Lab while apps are being upgraded.
    If you choose not to run the automatic upgrader, you can run the upgrader manually at a later time. For details, see Upgrade packaged apps.
  5. You can also choose to delete old uploads of applications. If you select Yes, specify the number of uploads to keep (Default: 30). When you select the option to delete old uploads and specify the number of uploads to keep, these settings are copied over to the General section in Administration > Settings . For details, see file storage settings in Administration settings.
  6. Select a folder to which applications uploaded to OpenText Functional Testing Lab are saved. Read and write permissions to the folder are required both for the user running this installation and the Local System account.
  7. When the file storage and the OpenText Functional Testing Lab server machines are not in the same domain, but are part of the same Windows workgroup, the same Windows admin username and password are required on both machines. After installation, run the OpenText Functional Testing Lab server under the Windows admin user. For details, see Run the service as a different user.
  8. If you choose to upgrade apps, the next screen prompts you to select the operating systems of the apps you want to upgrade.
  9. Review the summary of the installation settings and click Next to proceed with the installation.
  10. To complete the server upgrade, click Next. Applications continue to be upgraded after the upgrade of the server.

    When the server starts, after installation, you can check the upgrade status of apps in the Apps menu in the Lab console. To see the status of an app, click the More info icon on the app card. The example below shows an app that is still in the process of being upgraded.

    App in the proces of being upgraded

  11. When the installation is complete, the wizard displays a message that the server was successfully installed, and provides options to:

    • start the service automatically when you press Done.
    • allow data collection for the improvement of the product. You can modify your selection for this option in Administration Settings.
  12. Click Done.

  13. After upgrading the server, OpenText strongly recommends that you keep your files and data safe by incorporating the following for the application file storage folder and external database (if relevant):

    • Access monitoring

    • Limited access rights (only OpenText Functional Testing Lab user)

    • Regular backup

    • Encryption

    • Storage consumption monitoring

    OpenText also recommends that you:

    • Change the account running the OpenText Functional Testing Lab service, instead of the default LocalService account. Make sure that this account has full access to the OpenText Functional Testing Lab installation folder. For details, see Configure how a service is started in the Microsoft Windows documentation.
    • Incorporate file system monitoring on the installation and temporary folders.
    • Back up the encrypted.properties file located in the OpenText Functional Testing Lab server installation folder.

Back to top

Stop, start, or restart the server

From the Windows Start menu, go to OpenText Functional Testing Lab Server and choose the required action.

Back to top

Run the service as a different user

For certain integrations, you may need to run the OpenText Functional Testing Lab service as another user. You can do this through the Services manager.

  1. Click Win +R to open the Run dialog box, and enter services.msc
  2. Locate the OpenText Functional Testing Lab Server and OpenText Functional Testing Lab Nginx services.
  3. Right-click the OpenText Functional Testing Lab Server service and select Properties.
  4. In the Log On tab, select This account, enter the credentials, and click Apply.

  5. Repeat the above steps for the OpenText Functional Testing Lab Ngnix service.

Back to top

Modify the server

If needed, you can modify the server configuration by running the update tool. For details, see Reconfigure the server.

Back to top

Patch installation

To benefit from the latest enhancements and fixes, install the latest patch for your current version. Server and connector patches can be downloaded from Software Licenses and Downloads. The latest patch includes the content of any previous patches. There is no need to install previous patches.

Important: If you use the remote iOS signing service, this should be upgraded before you upgrade the server.

When upgrading the server to the latest patch, the following should also be upgraded:

  • All connectors.

  • Manual signing tools (if applicable).

    • iOS Enabler for manual signing of iOS apps. After installing the server patch, the iOS  enabler is available in the Agent folder. Patches are available on the ADM Marketplace.

    • Android Enabler for manual signing of Android apps. After installing the server patch, the updated Android enabler is available in the server folder.

Follow the patch installation instructions included in the patch release notes.

Back to top

Troubleshooting

For information on troubleshooting the Windows server, see Windows server.

Back to top

See also: