KMSYS Worldwide
All documentation
HGS Web Client for UTS/Installation

HGS Web Client — File Distribution and Start-up

Install and configure the HGS UTS or T27 Web Client on a web server, alongside the Application Deployment System, and define the launch parameters.

Last updated March 19, 2008

Overview

This guide covers installing either the HGS UTS Web Client or the HGS T27 Web Client. Where you see XYZ in file or product names, substitute either UTS or T27 to match the variant you are deploying. Two installations are required on the web server users will browse to: the Application Deployment System (AppDep) and the HGSXYZClient package.

Note: The two installs can run in any order, but installing AppDep first keeps the configuration simpler.

Install the Application Deployment System (AppDep)

  1. AppDep is a generic launcher used by many KMSYS Worldwide products. Whenever possible, install it into the default location.
  2. Run AppDep.exe on the web server. By default it installs into the IIS root at <drive>:\inetpub\wwwroot\AppDep.
  3. If you choose a different location, plan to update Configuration.xml so its <RelativeURL> points at the HGSXYZClient directory.

Install HGSXYZClient

  1. On the web server, run HGSXYZClient.exe. The installer creates an HGSXYZClient directory with HGSXYZClient and CGIEXE subdirectories and copies the required files.
  2. The default install location is <drive>:\inetpub\wwwroot\HGSXYZClient\.
  3. If you install outside the default path, edit Configuration.xml in the AppDep directory so the <RelativeURL> tag points at your HGSXYZClient subdirectory.
  4. Generate the contents of Parameters.htm using QPlexXYZAdmin.exe (installed alongside the client) on the administrator's workstation, then paste the generated parameters into Parameters.htm on the web server.

Launching the client

Users open the AppDep launch.asp page in their browser. By default launch.asp is wired to handle every web-launchable KMSYS Worldwide product, so target a specific install with a query parameter:

http://<YourServer>/AppDep/launch.asp?HGSXYZClient

launch.asp can be customised for site branding, but the .NET Framework detection script and product list machinery must remain. See the Application Deployment System Installation and Deployment Guide for details on what is safe to edit.

Web Client configuration parameters

Aside from the Open ID settings (OpenIdCount and OpenIdsn), every parameter is optional. In the tables that follow, T is the parameter type — (B)oolean, (I)nteger, or (S)tring — and E indicates emulation-specific parameters: (U)TS for OS 2200 hosts and (T)27 for MCP hosts.

Global parameters (each occurs once)

  • HostGatewayType (I, default 1) — always 1 unless directed otherwise by KMSYS.
  • ApplicationTitle (S) — main window title; defaults to "QPlex UTS Client".
  • AllowUserConfig / AllowMacroRecord / AllowMacroRun (B, default True) — enable end-user configuration, macro recording and macro execution.
  • TraceOption (I, 0) — 0 None, 1 Window, 2 File, 3 Both. TransportTrace (B, False) toggles the transport trace.
  • LanguageType (I, 0) — 0 = Latin (US, UK, Europe). Other character sets are reserved for future use.
  • Pages (I, UTS only, default 1) — number of UTS screen pages, 1–9. T27 always defaults to 9.
  • ScreenRows (I, 24) and ScreenColumns (I, 80) — must be set before the session is opened.
  • AutoScaleMode (I, 2) — 0 None, 1 size screen to font, 2 size font to screen.
  • AutoReopen (B, False) — automatically reopen sessions when the host disconnects.
  • Color, ScreenFont, UTS, VOpts, DCOpts, KBOpts (S) — generated by the Configuration Administrator and pasted in.
  • PrintTimeOut (I, UTS only, 15) — seconds before printer timeout; -1 disables, 0 times out immediately.
  • ShowMaximized (B, False) — start the screen frame maximized.

Open ID parameters (one set per OpenIdCount)

  • OpenFlagsn (B, True) — open the screen/environment automatically. False shows the tab without connecting.
  • NoSceensn (B, UTS only, False) — when True, reserves OpenIdsn for $$OPEN without creating a screen frame.
  • OpenIdsn (S, required) — Open ID configured on the HGS server. At least one is required, and at least one matching NoScreensn must be False so a screen frame exists.
  • SITAOpenIdsn (B, UTS only, False) — flag Open IDs that require Special SITA Gabriel Handling.
  • StationNamesn (S) — unique station name. If omitted, HGS assigns one. Duplicate names against the same host fail with a socket error.
  • TerminalTypesn (S, default UTS60) — UTS20/40/60 (UTS only) or TERMINAL/PRINTER (T27 only).
  • IPAddressesn (S, required) — IP or DNS name of the HGS server.
  • IPPortsn (I, default 102) — TCP port on HGS. Typical: T27 23 (or 992 SSL); UTS 102 (or 3782 SSL).
  • HGSSecurityFlagsn (I, 0) — 0 None, 1 Authenticate, 3 Authenticate + Encrypted.
  • InitialMacrosn / SignOffMacrosn (S) — macro names to run on open and on close. Each must also appear in the matching Macrosn entry.

Custom keys, macros, and printers

  • KeyCount (I, 0) plus Keysn (S) — preset custom key mappings; n is 1–99.
  • MacroCount (I, 0) plus Macrosn (S) — preset macros downloadable from the parameters page.
  • Printer1 / Printer2 / Printer3 (S, UTS only) — printer parameters per DID.
  • PXLate1Cnt / PXLate2Cnt / PXLate3Cnt (I, 0) plus PXLate{1,2,3}n (S) — character translation tables per printer.
Note: Repeating tags start n at 0. Printer settings, assigned macros and keyboards are global to the install — you cannot scope them per screen.