Readme-WebGate Customization Tool

This readme provides information about WebGate Customization Tool:

Processing Instructions
ALM Configuration tabs
Running Webgate Customization from the Command Line
Notes and Limitations

Processing Instructions

WebGate Customization is used when:

A web proxy is required.
A web proxy requires authentication.
A web server in front of ALM requires authentication.
External authentication is enabled in ALM.

In ALM, click Help > ALM Tools to open the ALM Tools page. On the ALM Tools page, click ALM WebGate Customization. On the ALM WebGate Customization page, click Download Tool to run ALM WebGate Customization. The ALM WebGate Customization dialog box opens.

The ALM WebGate Customization dialog box contains the settings for the WebGate Client component. The settings are maintained in the HKEY_CURRENT_USER\SOFTWARE\Mercury Interactive\TestDirector\WEB_CLNT_DEBUG and HKEY_CURRENT_USER\SOFTWARE\Mercury Interactive\TestDirector\WEB registry keys.

ALM Configuration tabs

The following sections describe the various tabs of the ALM Configuration dialog box.

Web Server Settings	The Web Server Settings tab configures the Web Server credentials, WebClient certificates, and general HTTP settings. Web Server Credentials: When the web server requires user credentials, for example with SSO, enter Web Server Username, Web Server Password, and Domain. Select Always ask for credentials to force credentials to be entered for the web server to load. Note: Selecting Always ask for credentials causes ALM Explorer to ask for Web/Proxy credentials even if they are specified by the tool. If a user is not working with ALM Explorer, do not select this setting. Headers: For SSO users, enable Add basic authentication header and select whether to add the header when a cookie is present. For SSO users, this option must be selected to allow testing tools and Microsoft add-ins to connect. For SSO users, this option must be selected in case the SSO response does not contain an HTTP authentication error code for an unauthorized request. WebClient Certificates: Select Use client certificate according to the desired mode to define a client certificate if the HTTP server requires it for authentication. After selecting the mode, click Select to select the certificate. Not specify mode: No specific execution mode is set, but the OTA script displays user dialogs. Interactive mode: The OTA script displays user dialogs. Non-interactive mode: The OTA script does not display user dialogs. Note: To run UFT tests in a smart card authentication environment, select Non-interactive mode and select a valid client certificate. Ensure that the Certificate Authority that issued your client certificate is added to the Trusted Root Configuration Authorities list for the current user. General HTTP Settings: Set the following HTTP settings: Connection Timeout: Set the timeout in seconds for the HTTP connection between the ALM client or OTA script and the ALM server. Enable HTTP Compression: The HTTP traffic from the ALM server to the ALM client is compressed with a standard HTTP-compliant gzip compression. Use Default User Agent: Regulate the user agent value in HTTP requests to the ALM server. Select this checkbox to use the TeamSoft WinInet Component; otherwise,the user agent is the same as for Internet Explorer. QCCH - SSL Type: Select the SSL type for the QCCH (QC Connectivity Helper) connection from the dropdown list.
Proxy Settings	The Proxy Settings tab configures the proxy server and proxy credentials. Proxy: Set the type of proxy server: Use a Proxy Server: Select this option if the ALM client or OTA script is using a proxy to connect to the ALM server. Enter the proxy server port in Proxy Port, and enter the proxy server I.P. or machine name in Proxy Server. Use IE Proxy Server: Select this option if the Internet Explorer proxy setting is used for the ALM client or OTA script connection to the ALM server. This option and the Use a Proxy Server option are mutually exclusive. Bypass Proxy Server: Select this option to bypass the proxy settings, when the ALM client or OTA script does not use a proxy to connect to the ALM server Proxy Credentials: Enter Proxy Username, Proxy Password, and Domain if the proxy server requires user credentials. Select Always ask for credentials to force credentials to be entered for the proxy server to load. Note: Selecting Always ask for credentials causes ALM Explorer to ask for Web/Proxy credentials even if they are specified by the tool. If a user is not working with ALM Explorer, do not select this setting.
Log Settings	The Log Settings tab configures the log file. WebClient Log: Select Write Client Side Log File and enter a path to create a log file for the WebGate component in the specified path.
Authentication Settings	The Authentication Settings tab sets the authentication mode. Enter API Key and Secret.
Shared Login Settings	Available in versions: 15.5.1 and later The Shared Login Settings tab sets the browser and timeout settings for external authentication, such as SSO authentication, ALM Client Launcher authentication, and Business Views Microsoft Excel Add-in authentication. Custom User Agent: Enter your custom user agent header in the HTTP requests. Use embedded web browser: If it's selected, you get authenticated with the embedded web browser, regardless of the setting of the `DISABLE_SLM_WITH_DEFAULT_WEBBROWSER` site parameter. If it's not selected, you get authenticated with your default web browser, regardless of the setting of the `DISABLE_SLM_WITH_DEFAULT_WEBBROWSER` site parameter. Authentication timeout: Set the amount of time in seconds after which the authentication expires. The default value is 60 seconds. This setting only works for authentication with your default web browser.

Running Webgate Customization from the Command Line

Webgate Customization can be run from the command line.

To open the Webgate Customization dialog box from the command line, enter WebGateTool.exe.

To run Webgate Customization in silent mode, enter WebGateTool.exe /silent followed by the appropriate parameters. Following is a list of the parameters:

Parameter Name	Short Name
Silent	S
UseProxy	P
UseIEProxy	IE
BypassProxy	BP
ProxyPort	PrP
ProxyUrl	PrU
ProxyUserDomain	PrUD
ProxyUserName	PrUN
ProxyPassword	PrUP
ProxyAlwaysAskCreds	PrAC
ShouldFilterCertificates	CeF
CertSNForNotspecifyMode	CeNS
CertSNForInteractiveMode	CeI
CertSNForNoninteractiveMode	CeNI
IISUserDomain	SUD
IISUserName	SUN
IISPassword	SUP
IISAlwaysAskCreds	SAC
ConnectionTimeout	CTO
AcceptCompressedResponse	ACR
UserAgent	UA
SslType	SslT
AddBasicAuthHeader	ABAH
ForceAddBasicAuthHeader	FABAH
MakeLog	ML
LogPath	LP

Value the CertSNForNotspecifyMode, CertSNForInteractiveMode , and CertSNForNoninteractiveMode parameters with the certificate serial number.
Value Boolean parameters with y or n. For example, /MakeLog=y or /ML=Y.
If a parameter value contains spaces, use quotes. For example, /LogPath=”d:\my docs”.

For example, to set the log path and make a log checkbox in silent mode, run WebGateTool.exe /Silent /LogPath="C:\logs" /MakeLog=y or WebGateTool.exe /s /lp="C:\logs" /ml=y.

Notes and Limitations

Webgate Customization cannot be run directly from Internet Explorer. To run Webgate Customization, right-click on the link and save the file to your hard drive. Then, double-click on the downloaded file.
Proxy Username must be valued with the domain and the username, as domain\username. Domain must be blank.
WebClient Certificate cannot be disabled once it is activated.
The list of WebClient Certificates to select displays all certificates, not just the certificates from the trusted Certificate Authority (CA).
If you enable Add basic authentication header and select Add when a cookie is present, and you run ALM from Internet Explorer, an unnecessary authorization window appears. Ignore this window.