The ALM WebGate Customization tool helps you to customize the WebGate client components.
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.
Download WebGate Customization
You download the WebGate Customization tool from the ALM Tools page.
To download the tool:
From the ALM qcbin page (http://<ALM_server>:<port_number>/qcbin/), click the Tools link.
On the ALM Tools page, click ALM WebGate Customization.
On the ALM WebGate Customization page, click Download Tool.
Run WebGate Customization
Run the downloaded WebGateTool.exe file to configure the WebGate Customization settings.
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.
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.
To force credentials to be entered for the web server to load, select Always ask for credentials.
For SSO users, enable Add basic authentication header and select whether to add the header when a cookie is present.
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.
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:
|QCCH - SSL Type
|Select the SSL type for the QCCH (QC Connectivity Helper) connection from the dropdown list.
The Proxy Settings tab configures the proxy server and proxy credentials.
Select the type of proxy server:
Enter Proxy Username, Proxy Password, and Domain if the proxy server requires user credentials.
To force credentials to be entered for the web server to load, select Always ask for credentials
Note: If you select Always ask for credentials, ALM Explorer asks 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 option.
The Log Settings tab configures the log file.
|Write Client Side Log File
|To create a log file, select Write Client Side Log File and specify the path where the log file is created.
The Authentication Settings tab sets the authentication mode.
|Enter API Key and Secret for API Key authentication mode.
Shared Login Settings
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
|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.
The Launcher Settings tab enables log and high-resolution displays for ALM Client Launcher.
|Enable Launcher Log File
|Toggles on or off log for ALM Client Launcher.
|If ALM Client Launcher log is enabled, specify where the log file is stored.
If ALM Client Launcher log is enabled, select the type of log file you want ALM Client Launcher to create.
|Support High-DPI Mode
|Select this option if you want to use ALM Client Launcher against high-resolution displays.
|Enable Large UI
|Whether or not to display ALM Client Launcher in bigger fonts.
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. The 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
Set Boolean parameters to y or n. For example, /MakeLog=y or /ML=Y.
If a parameter value contains spaces, use quotes. For example, /LogPath="d:\my docs".
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.
WebGate Customization includes the following 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.