Generate ALM client MSI file

Use ALM Client MSI Generator to generate an ALM client MSI file.

When to generate a new MSI file

You generate a new MSI version each time the ALM server or database schemas are updated. This includes the following cases:

  • A patch is installed.

  • An extension is installed.

  • A new test type is created.

  • ALM server configurations are changed.

Back to top

Generate an ALM client MSI file

Follow the instructions below to generate an ALM client MSI file using ALM Client MSI Generator.

  1. Log on to the client machine with administrator privileges.

    2. Note: You must run ALM Client MSI Generator locally, and not over a network.

  2. Close any open instances of ALM Client MSI Generator.

  3. Run ALM Client MSI Generator.

    Alternatively, you can run ALM Client MSI Generator from the command line using command line arguments. For more information, run "ClientMSIGenerator.exe/?" from the command line. 

  4. In the Server Address field, fill in the URL of the ALM server machine for which you want to create a client MSI. Use the following format:

    http://<ALM server name>:<port number>/qcbin

    Note: Only HTTP and HTTPS protocols are supported.

    If you are generating an updated MSI file, from the dropdown list, select a server address that you previously entered.

    External Authentication users. Use http://localhost:<port>/qcbin in the Server Address field.

  5. To change the proxy settings, click Proxy Settings.

  6. Fill in the following fields:

    Field Description
    MSI Language Select a language for the MSI user interface.
    MSI Name

    The MSI file name. The MSI file name includes the following elements:

    ALM server address. As entered in the Server Address box.

    MSI version number. The version number increases automatically each time you create an MSI file for the same server address.
    Save MSI in

    The output folder in which the MSI file is saved. It is recommended to save the MSI file outside the ALM Client MSI Generator program directory.

  7. Select one of the following options:

    Field Description
    Include Component Registration

    Select this option if you want to register ALM client components on the workstations.

    ALM clients must be registered to enable users to work with other OpenText testing tools as well as third-party and custom tools.

    Register for 64-bit

    Enabled when the Include Component Registration option is selected.

    • If you select this option, ALM client components registration for both 32-bit and 64-bit applications is completed when you run the generated MSI file.

    • If you do not select this option, the Include Component Registration option only registers ALM client components for 32-bit applications when you run the generated MSI file.
    Use Shared Deployment Mode Select this option if you want to deploy ALM client components on a shared location of a client machine. This is useful for users on virtual environments such as Citrix and VMware accessing the same location.
    Skip Prerequisites Check

    Select this option to instruct the MSI to bypass checks for system prerequisites on client machines. This is useful on mass distribution systems, which will deploy client components even if prerequisites are missing.

    To enable this feature, you must define the SKIP_CLIENT_PREREQUISITES_CHECK site parameter, and set its value to “Y”. For more information, see Set configuration parameters. This feature is not supported on workstations using ALM Explorer.

  8. To generate the MSI, click Generate MSI.

    For Single-Sign-On users:

    1. If the user discovery page is displayed, add your user name or email address as specified in ALM. Click Submit.
    2. In the IDP page, add your IDP credentials. Click the log in button.

    The Progress dialog box opens, displaying the progress of the MSI generation. This may take several minutes. Click Show Details to display log details of the MSI generation.

    Note: You can also view the log file of the MSI generation in the <ALM Client MSI Generator installation directory>/log directory.

  9. After the MSI is generated, in the Progress dialog box, click Go to MSI to open the folder in which the MSI file is saved.

Back to top

Next steps: