HPE ALM Client MSI Generator

Transcription

1 HPE ALM Client MSI Generator Software Version: User Guide Document Release Date: August 2017 Software Release Date: August 2017

2 HPE ALM Client MSI Generator Legal Notices Warranty The only warranties for Hewlett Packard Enterprise Development LP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HPE shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice. Restricted Rights Legend Confidential computer software. Valid license from HPE required for possession, use or copying. Consistent with FAR and , Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. Copyright Notice Copyright Hewlett Packard Enterprise Development LP Trademark Notices Adobe is a trademark of Adobe Systems Incorporated. Microsoft and Windows are U.S. registered trademarks of Microsoft Corporation. UNIX is a registered trademark of The Open Group. This product includes an interface of the 'zlib' general purpose compression library, which is Copyright Jean-loup Gailly and Mark Adler. HP ALM Client MSI Generator (12.55) Page 2 of 11

3 HPE ALM Client MSI Generator Contents HPE ALM Client MSI Generator 1 Working with ALM Client MSI Generator 5 The ALM Client MSI Generator Work Process 5 ALM Client MSI Generator Prerequisites and Considerations 5 Installing ALM Client MSI Generator 6 Generating ALM Client MSI Files 6 Running ALM Client MSI Files 9 Send Us Feedback 11 HP ALM Client MSI Generator (12.55) Page 3 of 11

4 HPE ALM Client MSI Generator HP ALM Client MSI Generator (12.55) Page 4 of 11

5 Working with ALM Client MSI Generator Welcome to HP ALM Client MSI Generator. The Client MSI Generator enables you to generate MSI files for locally deploying ALM client components on workstations. The ALM Client MSI Generator Work Process Working with ALM Client MSI Generator involves the following steps: 1. Make sure that the machine on which you want to install and run ALM Client MSI Generator meets the minimum requirements. For more information, see "ALM Client MSI Generator Prerequisites and Considerations" below. 2. Install ALM Client MSI Generator from the HPE ALM Add-ins page. For more information, see "Installing ALM Client MSI Generator" on the next page. 3. Generate an ALM Client MSI file. For more information, see "Generating ALM Client MSI Files" on the next page. 4. Deploy ALM client components on workstations. For more information, see "Running ALM Client MSI Files" on page 9. ALM Client MSI Generator Prerequisites and Considerations Microsoft.NET Framework 4 or 4.5 must be installed on the machine on which you want to run HPE ALM Client MSI Generator. To install and run ALM Client MSI Generator, and to run ALM client MSI files, you must log in with administrator privileges. HPE ALM Client MSI Generator only supports multiple independent servers with the same version installed. For example, version of HPE ALM Client MSI Generator supports all 12.5x ALM versions. ALM Client Generator supports ALM servers with the following proxy or Web server configurations: Forward proxy with no authentication or with basic authentication. Reverse proxy with no authentication or with basic authentication. Web server with basic or NTLM authentication. If a double authentication scheme is used, MSI file generation fails. To enable communication with an ALM server configured for HTTPS, the machine on which you run ALM Client MSI Generator must have a valid SSL certificate. ALM Client MSI Generator cannot run on an FDCC workstation. External Authentication. HPE ALM Client MSI Generator does not fully support external authentication, however the following workaround can be used to bypass external authentication when using MSI Generator: HP ALM Client MSI Generator (12.55) Page 5 of 11

6 Working with ALM Client MSI Generator When external authentication is enabled, ALM Client MSI Generator must be installed on the ALM server. The Server Address field must contain the URL of the ALM server on which ALM Client MSI Generator is installed. Example: ALM server is installed on a machine that will be accessed using Let s assume that there is some external authentication on this machine. Generate the MSI file as follows: 1. Install MSI Generator on the alm.com machine. 2. Set the main URL for MSI generator to When MSI Generator is deployed, it accesses any server with the same ALM version installed, including alm.com. Installing ALM Client MSI Generator This section describes how to install ALM Client MSI Generator. To install ALM Client MSI Generator: 1. On the Client MSI Generator add-in page, click Download HPE ALM Client MSI Generator. The Client MSI Generator Installer launches. 2. On the Select Installation Folder page, select a folder in which to install ALM Client MSI Generator, or accept the default folder. 3. After files are installed on your machine, click Finish to close the installer. 4. To copy settings of ALM Client MSI Generator from one machine to another, copy the dat folder and files from the installation directory on the first machine to the installation directory on the second machine. Generating ALM Client MSI Files Use the ALM Client MSI Generator to generate an ALM Client MSI file. 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 HP ALM Client MSI Generator (12.55) Page 6 of 11

7 Working with ALM Client MSI Generator To generate an ALM Client MSI file: 1. Log on with administrator privileges. Note: You must run the ALM Client MSI Generator locally, and not over a network. 2. Close any open instances of the ALM Client MSI Generator, and of Internet Explorer. 3. Run the HPE ALM Client MSI Generator. The Generate Client MSI for HPE ALM Server page opens. Alternatively, you can execute the ALM Client MSI Generator from the command line using command line arguments. For more information, execute 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 a create a client MSI. Use the following format: 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 in the Server Address field. 5. To change the proxy settings, click Proxy Settings. 6. Fill in the following fields: Field MSI Language MSI Name Description Select a language for the MSI user interface. 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. HP ALM Client MSI Generator (12.55) Page 7 of 11

8 Working with ALM Client MSI Generator Field Save MSI in Description 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. Tip: Click the Browse button to select a different folder. 7. Select one of the following options: Field Include Component Registration Use Shared Deployment Mode Skip Prerequisites Check Description 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 HPE testing tools as well as third-party and custom tools. For more information, refer to the HPE Application Lifecycle Management Installation and Upgrade Guide. 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. 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. Note: To enable this feature, you must define the SKIP_ CLIENT_PREREQUISITES_CHECK site parameter, and set its value to Y. For more information, refer to the HPE Application Lifecycle Management Administrator Guide. This feature is not supported on workstations using HPE ALM Explorer. 8. To generate the MSI, click Generate MSI. 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. HP ALM Client MSI Generator (12.55) Page 8 of 11

9 Working with ALM Client MSI Generator 9. After the MSI is generated, in the Progress dialog box, click Goto MSI to open the folder in which the MSI file is saved. Running ALM Client MSI Files The ALM Client MSI file enables you to locally deploy ALM client components on a workstation. To run the ALM Client MSI file: 1. Log on to the client machine with administrator privileges. Note: If you work on multiple ALM versions side-by-side and include client registration in the ALM Client MSI file, close all open instances of previous versions of ALM/Quality Center. 2. Run the MSI file. The ALM Client Setup Wizard opens. Click Next. 3. The End-User License Agreement page opens. Accept the terms of the license agreement, and click Next. 4. The Destination Folder page opens. Accept the default path for installing the ALM Client files, or click Change to select a different folder. Note: If you are installing an updated version of ALM Client, you can select the same folder as the previous version. Click Next. 5. The Ready to install page opens. Click Install to install the ALM Client on the workstation, or Back to change the installation settings. A status bar displays the progress of the ALM Client installation. When the installation is complete, click Finish to close the ALM Client Setup Wizard. Note: If you include client registration in the ALM Client MSI and the installation fails during client registration, the installation does not roll back automatically. Run the MSI using the msiexec command, and enable logging. This may assist in determining the reason for the installation failure. HP ALM Client MSI Generator (12.55) Page 9 of 11

10 Working with ALM Client MSI Generator HP ALM Client MSI Generator (12.55) Page 10 of 11

11 Send Us Feedback Let us know how we can improve your experience with the User Guide. Send your to: HP ALM Client MSI Generator (12.55) Page 11 of 11