The Smart Client Common Configuration can be used to configure the Smart Client for all users on a computer (contrary to the Smart Client Settings that are stored for each user separately and may be distributed over several computers using Window's roaming user profiles).
The Smart Client Common Configuration can only be modified by editing an XML file and are intended to be used in IT-environments with central deployment strategy. Listing 1 shows an example of an Smart Client Common Configuration XML file; table 1 explains the elements supported in this XML file.
When starting up the Smart Client will search the directories listed in Table 2 for a file named SmartClientCommonConfiguration.xml. Directories are searched in the same order as shown in the table. The first found file found will then be used by the Smart Client. If no file is found or the file found cannot be parsed (XML invalid, file not readable etc) the Smart Client will continue without loading the file.
Details about loading the Smart Client Common Settings are logged.
<?xml version="1.0" encoding="utf-8" ?> |
Listing 1: Example SmartClientCommonSettings.xml file
<?xml version="1.0" encoding="utf-8"?> |
Listing 2: Schema for the SmartClientCommonSettings.xml file
Setting |
Description |
EnableDownloadingNewVersions |
Default: true When a Smart Client cannot connect to an Application Server because of a version mismatch it will by default offer the user the possibility to download a suitable version of this Smart Client. Setting this Element to false will disable this behavior. |
HttpProxyOverride |
Default: false If set the Smart Client will try to use the HTTP proxy configuration as defined in this file. See chapter Smart Client HTTP Proxy configuration for more details |
HttpProxyServer |
Address of the proxy server (DNS name or IP address) |
HttpProxyPort |
Port on which the proxy server listens to connection requests. |
HttpProxyUserName |
Username used to connect with the proxy server. Leave this empty if your proxy server does not need authentication. |
HttpProxyPassword |
Password used to connect with the proxy server. Leave this empty if your proxy server does not need authentication. |
HttpProxyBypassLocal |
If set, requests to local Internet resources do not use the proxy server. Local requests are identified by the lack of a period (.) in the URI, as in http://webserver/, or access the local server, including http://localhost, http://loopback, or http://127.0.0.1. If not set, all Internet requests are made through the proxy server. |
HttpProxyBypassAddresses |
A semicolon separated list of regular expressions that describe URIs that do not use the proxy server when accessed. |
FileDepotUploadInitialDirectory |
Defines the directory that will be the initial directory when selecting files to be uploaded to the File Depot. Will only be used if the given value is referring to an existing directory. |
FileDepotUploadCustomPlaces |
A list of directories that will be shown as custom places in the open file dialogue when selecting files to be uploaded to the Filedepot. Only those elements in the list will be used that are referring to existing directories. |
Table 1: Supported settings in SmartClientCommonConfiguration.xml
Location |
Description. |
Directory where the executable of the Redbex Smart Client is located. Note that different editions of the Smart Client (Full, Light and Portable) are usually installed in different directories. Therefore it is possible to have different Smart Client Common settings for different editions. Typical installation directories for the Smart Client (can be different for your installation) Full: C:\Program Files\Redbex\Smart Client\ Light: C:\Users\<username>\AppData\Local\Redbex\Smart Client\Light\ Portable: C:\Users\<username>\AppData\Local\Redbex\Smart Client\Portable\<Smart Client Light Version>\ |
|
Common Application Data directory |
The common application data directory for the Redbex Smart Client is a sub directory of Window's Common Application Data folder (typically C:\ProgramData\, but might be different depending on the configuration of the operating system, and the operating system language) Example c:\ProgramData\Redbex\Smart Client\ |
Table 2: Locations in which the Smart Client searches for SmartClientCommonSettings.xml file
