Configuring System Environments > Client Session Configuration File
Client Session Configuration File
The client session file defines client session characteristics of the QAD .NET UI.
By default, the file is located in
The default client-session.xml file also includes parameters for QAD Enterprise Applications–Enterprise Edition’s Financials module, starting from <!-- QAD Financials Settings --> to the end of the file. Each parameter includes comment sections that describe parameter usage. These parameters only apply if you are using QAD Enterprise Applications–Enterprise Edition. They do not apply if you are using QAD Enterprise Applications–Standard Edition.
You can view the configuration settings directly from the QAD .NET UI client by choosing Help | View Configuration.
Note: The client-session.xml.sample file in the TomcatInstallDir/webapps/qadhome/configurations/
directory includes extensive comments with examples of using the parameters for each file entry. Be sure to refer to this file for more information about the client session configuration.
File Usage
You can define client session files for each system environment by placing them in appropriate sub-directories under the /configurations directory, as follows:
Where config-name is the system environment name that you select when you log in to the QAD .NET UI.
File Format
The client session configuration file’s top-level XML element is <Configuration>, which then includes the elements listed in the next section.
File Elements
This section summarizes settings available in client-session.xml. For a complete listing with comments and examples, be sure to refer to the client-session.xml.sample file in the TomcatInstallDir/webapps/qadhome/configurations/default/ directory.
Includes elements for specifying attachment properties, including <AttachmentsEnabled>, <MaxFileSize> and <ValidFileTypes>.
Specifies the administrator roles that have permission to use Attachment Maintenance. For example:
<role1, role2>
Specifies whether attachments are enabled (true or false). Included in <Attachment>...</Attachment> element.
Specifies various browse notification and performance controls (see Browse Performance Controls).
(Refer to examples in client-session.xml.)
When this number of records is reached or exceeded during printing, a warning is displayed on the client.
When this number of records is reached or exceeded during export to Excel, a warning is displayed on the client.
Rendering charts with many elements can be CPU intensive. To prevent users from attempting to render large charts that could degrade their computer’s performance, the system checks the number of elements in a chart before rendering the chart and provides a warning if the number of elements exceeds the value specified here. In a chart without grouping, the number of elements in a chart is the number of records in the browse display. In a chart with grouping, the number of elements is the number of groups of records.
Specifies the application server (AppServer) protocol. Enter one of the following:
AppServer — Unsecured connection to the name server.
AppServerS — Secure connection to the name server.
AppServerDC — Unsecure connection to the AppServer broker.
AppServerDCS — Secure connection to the AppServer broker.
Specifies the host name of the Progress Name Server if <ConnectionProtocol> is set to AppServer or AppServerS. Specifies the Progress AppServer broker host name if <ConnectionProtocol> is set to AppServerDC or AppServerDCS.
Specifies the NameServer port number if <ConnectionProtocol> is set to AppServer or AppServerS. The default NameServer port number is 5164. Specifies the AppServer broker port number if <ConnectionProtocol> is set to AppServerDC or AppServerDCS.
Specifies the name of the Progress AppServer created for this configuration.
Specifies the AppServer secure protocol used during authentication.
Specifies the protocol to use when launching Desktop maintenance programs within the QAD .NET UI. This may be changed to https for that kind of communication.
Specifies the secure AppServer host name.
Specifies the secure AppServer port number.
Specifies the dashboard configuration settings, including administration roles, padding, maximum number of panels, and border colors (see Dashboard Settings in client-session.xml File).
(Refer to examples in client-session.xml.)
Specifies the default rate in seconds at which browses are automatically refreshed. QAD .NET UI users can start the automatic refresh by choosing Refresh|Start and can stop it by choosing Refresh|Stop. They can change the refresh rate by choosing Refresh|Rate, right-clicking, and editing the value.
Specifies the protocol for connecting to the AppServer. Valid values are http or https.
Specifies the name of the machine that Tomcat is running on.
Specifies the port number that Tomcat listens on; by default this is 8080, but could be 8443 if <DesktopProtocol> is https.
Specifies the name of the UI configuration directory under Tomcat webapp directory.
Specifies the program used to run Desktop maintenance programs; it does not change.
Specifies the Desktop base URL.
Specifies the link to the program that delivers the QAD Desktop help service.
Specifies the name of the servlet used to track user log-ins; it does not change.
Set to false if Tomcat has <Connector> with URIEncoding=”UTF-8” in server.xml. Otherwise, set it to true (the default).
Specfies a performance check on the index use of a new browse definition when you save it from Browse Maintenance. The performance check, Show Index Information, will help to avoid the creation of poorly performing browses with non-indexed fields in joins, filters, and sorts.
Specifies whether a program screen (frame) will be automatically submitted when the cursor leaves the last field on the frame. Enter true or false.
When set to “true” unresolved tokens are displayed and the Browser context menu is enabled. Tokens are in the form {help:program:field} and by default unresolved tokens are not displayed.
Enables/disables the GuideMe feature.
Sets the time in milliseconds the mouse must hover over a control region before displaying the GuideMe tooltip.
Sets the time in milliseconds to display the GuideMe tooltip before hiding the tooltip. A value of zero indicates the tooltip will not be hidden until the mouse leaves the control region.
Enables/disables GuideMe animation. Animation can cause performance issues in Citrix environments and can be disabled using this setting.
Specifies whether the home page feature is enabled or disabled by default. Enter true or false.
Specifies the default home page URL. The URL can be any valid URL, including qadsh:\\ links.
Specifies the help service program. This is an administration setting; it does not change.
In operational metrics, specifies the font used in saved images. Included in <Metrics>...</Metrics> element.
Microsoft Sans Serif, 8.25pt
Specifies the maximum file size (in kilobytes) that users can attach. Zero (0) specifies no limit. Included in <Attachment>...</Attachment> element.
In opertaional metrics, specifies the maximum number of records for count metrics. Included in <Metrics>...</Metrics> element.
In operational metrics, specifies the maximum number of records returned to the client when requested. Included in <Metrics>...</Metrics> element.
Specifies the maximum number to check for (count) before a > symbol is displayed on a client.
Specifies the maximum number of records that a client can download.
Specifies a path to a custom image for a custom menu item type.
<Image name="custom">http://url_path/custom.png
Includes elements for operational metrics, including: <MaxBrowseRecordsForCount>, <MaxBrowseRecords Returned>, <ShowTextOnImage>, and <ImageFont>.
As listed
Specifies the frequency to retrieve Inbox messages from the server in milliseconds.
300000 (five minutes).
This parameter sets the number of seconds after which a web request times out. The range is 10 to 120 seconds.
30 seconds.
You can configure the workspace title to include the server time zone by setting this parameter to true.
In operational metrics, specifies whether to show the title and date on saved images. Included in <Metrics>...</Metrics> element.
Specifies the location for the DLL file (Routrek.granados.dll) to be downloaded to the clients when they use SSH for terminal connections. Note that the file is not included with QAD software because of exportation laws regarding encryption software. When installing QAD software, you must download the file from
. and place the file in the location specified by the <SshProviderUrl> so that the file is downloaded to clients. For additional information, see the comments in the client session configuration file (client-session.xml) for the <SshProviderUrl> element.
Specifies the protocol used for terminal connections. Options include telnet, ssh1, and ssh2. The telnet option is the default setting for typical non-secure Telnet implementations. The ssh1 option is for Secure Shell protocol 1 (SSH1). The ssh2 option is for Secure Shell protocol 2 (SSH2). Note that Telnet uses port 23 and SSH protocols use port 22. The port number is set in User Option Telnet Maintenance ( Also see: Configuring Georgia Softworks for both Telnet and SSH.
Specifies the encoding for terminal connections.
Specifies code pages (such as <CodePage Progress="iso8859-1">iso-8859-1</CodePage> ) for configuring terminal encoding by domain (see Configuring Terminal Encoding By Domain).
(Refer to examples in client-session.xml.)
Specifies the credentials to use for terminal connections. Valid values are ShellUser, ScriptUser, or PromptUser. (The values are case-insensitive.) ShellUser specifies to use the QAD .NET UI user ID and password when logging into the server. ScriptUser specifies to use the user ID and password defined in User Option Telnet Maintenance ( With PromptUser, when a terminal screen is launched, the user is prompted for a user ID and password to log into the server. These credentials are used throughout the current session, so the user is not prompted again until they log in again to the QAD .NET UI.
Specifies whether the QAD .NET UI uses the regional settings on a user’s computer. Enter true or false.
Specifies a comma-separated list of file types allowed for attachment. Includes a size attribute so a particular file type has a larger size than the default (as specified in <MaxFileSize>). For example, <ValidFileTypes size="3096">zip</ValidFileTypes> specifies that .zip files can be up to 3096 kilobytes. Also includes a typeid attribute to overwrite the default for a particular program. For example,<ValidFileTypes typeid="sosomt.p" size="0">zip</ValidFileTypes> specifies no limit on the size of .zip files that can be attached to Sales Order Maintenance. <ValidFileTypes> is included in the <Attachment>...</Attachment> element.
By default, attachments are stored in TomcatInstallDir/webapps/qadhome/configurations/config-name/
, where subdirectories organize the attachments based on domain, program, type, and field. Each directory includes an underscore character (_) at the end by default to account for the possibility of using a blank.
Instead of using the default attachment path, you can specify a different path (WebDAV location) using the <Attachment> <WebDAVRoot> setting. By default, the setting is commented out and the default path is used.
Note that the WebDAV location should be UTF-8 enabled to support the WebDAV standard.
Specifies the maximum number of Web connections.
Specifies the DNS refresh timeout limit in milliseconds.
7200000 (two hours)
Specifies the session “keep alive” limit in milliseconds.
10000 (10 seconds).
Set to false if Tomcat has <Connector> with URIEncoding=”UTF-8” in server.xml. Otherwise, set it to true (the default).
Specifies toolbar colors. To set the primary toolbar color, use <Workspace.DefaultToolBarColor>, specifying the color as RGB values. To set the secondary toolbar color, use <Workspace.DefaultToolBarColor2>, specifying the color as RGB values. You can specify individual workspaces to have different toolbar colors based on the workspace ID, which typically has the format domain-id.entity_id. For example:
Specifies the workspace provider as QAD.Plugin.Services.DomainWorkspaceProvider, which creates one workspace per domain, or QAD.Plugin.Services.DomainEntityWorkspaceProvider, which creates one workspace per domain plus entity.
Specifies the format of a workspace display name. You can use the following to customize the workspace name:
${db-name} (the database name)
${domain-name} (the domain name)
${domain-id} (the domain ID)
${currency} (the currency)
${entity-name} (the entity name)
${entity-id} (the entity ID)
${culture-name} (the culture name)
${domain-timezone} (server timezone name for domain)
${domain-tzoffset} (server timezone offset for domain, +HH:MM format)
${domain-codepage} (server codepage used for domain)
${domain-id} ${domain-name} [${currency}] > ${entity-id} ${entity-name}
Configuring Georgia Softworks for both Telnet and SSH
You can configure the Georgia Softworks Universal Terminal Server to run both Telnet and SSH on the same machine by configuring some registry settings:
1 Make sure that you are running Georgia Softworks Universal Terminal Server (GSW UTS) version V6.50.0038 or later.
2 Change the parameter:
to a setting of 1.
3 Change the parameter:
to a setting of 0.
4 Restart the GSW UTS service.