WebGate Customization

The ALM WebGate Customization tool helps you to customize the WebGate client components.

Overview

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.

Back to top

Download WebGate Customization

You download the WebGate Customization tool from the ALM Tools page.

To download the tool:

  1. From the ALM qcbin page (http://<ALM_server>:<port_number>/qcbin/), click the Tools link.

  2. On the ALM Tools page, click ALM WebGate Customization.

  3. On the ALM WebGate Customization page, click Download Tool.

Back to top

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.

Option Description
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.
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.

Option Description
Proxy

Select 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 System Proxy Server. Select this option if the system 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.

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.

Log Settings

The Log Settings tab configures the log file.

Option Description
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.

Authentication Settings

The Authentication Settings tab sets the authentication mode.

Option Description
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.

Option Description
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 browser, regardless of the setting of the DISABLE_SLM_WITH_DEFAULT_WEBBROWSER site parameter.

    IE Mode: This option forces authentication using the embedded browser with IE mode. This is typically used in scenarios where specific authentication mechanism or configurations are required. For example, you can select this option if the embedded browser loading in Edge mode has compatibility issues, or ALM interacts with legacy systems that are dependent on IE core functionalities, or your application uses custom authentication mechanisms that are optimized for IE core.

  • 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

Available for authentication with your default web browser.

Set the amount of time in seconds after which the authentication expires.

You can set the timeout to a maximum of 120 seconds. By default, it is 60.

Launcher Settings

The Launcher Settings tab enables log and high-resolution displays for ALM Client Launcher.

Option Description
Enable Launcher Log File Toggles on or off log for ALM Client Launcher.
Log Path If ALM Client Launcher log is enabled, specify where the log file is stored.
Log Level

If ALM Client Launcher log is enabled, select the type of log file you want ALM Client Launcher to create.

  • All. Records all events.

  • Information. Records informational messages.

  • Warning. Records potentially harmful situations.

  • Error. Records error events.

  • Debug. Records events that are most useful for debugging.
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.

Back to top

Run 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. 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

    Note:  

    • 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.

Back to top

Notes and Limitations

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.

Back to top