Product Documentation

Customize Receiver using configuration files

Aug 16, 2013

About the configuration files

To change advanced or less common settings, you can modify Receiver's configuration files. These configuration files are read each time wfica starts. You can update various different files depending on the effect you want the changes to have.

Be aware that, if session sharing is enabled, an existing session might be used instead of a newly reconfigured one. This might cause the session to ignore changes you made in a configuration file.

Apply changes to all Receiver users

If you want the changes to apply to all Receiver users, modify the module.ini configuration file in the $ICAROOT/config directory.
Note: You do not need to add an entry to All_Regions.ini for a configuration value to be read from module.ini, unless you want to allow other configuration files to override the value in module.ini. If an entry in All_Regions.ini sets a default value, the value in module.ini is not used.

Apply changes to new Receiver users

If you want the changes to apply to all future new Receiver users, modify the configuration files in the $ICAROOT/config directory. For changes to apply to all connections, update wfclient.ini in this directory.

Apply changes to all connections for particular users

If you want the changes to apply to all connections for a particular user, modify the wfclient.ini file in that user’s $HOME/.ICAClient directory. The settings in this file apply to future connections for that user.

Validate configuration file entries

If you want to limit the values for entries in wfclient.ini, you can specify allowed options or ranges of options in All_Regions.ini. See the All_Regions.ini file in the $ICAROOT/config directory for more information.

Note: If an entry appears in more than one configuration file, a value in wfclient.ini takes precedence over a value in module.ini.

About the parameters in the files

The parameters listed in each file are grouped into sections. Each section begins with a name in square brackets indicating parameters that belong together; for example, [ClientDrive] for parameters related to client drive mapping (CDM).

Defaults are automatically supplied for any missing parameters except where indicated. If a parameter is present but is not assigned a value, the default is automatically applied; for example, if InitialProgram is followed by an equal sign (=) but no value, the default (not to run a program after logging in) is applied.

Precedence

All_Regions.ini specifies which parameters can be set by other files. It can restrict values of parameters or set them exactly. If you want changes to apply to all Receiver users, modify module.ini.

For any given connection, the files are generally checked in the following order:

  1. All_Regions.ini. Values in this file override those in:
    • The connection's .ica file
    • wfclient.ini
  2. module.ini. Values in this file are used if they have not been set in All_Regions.ini, the connection's .ica file, or wfclient.ini but they are not restricted by entries in All_Regions.ini.

If no value is found in any of these files, the default in the Receiver code is used.

Note: There are exceptions to this order of precedence. For example, the code reads some values specifically from wfclient.ini for security reasons, to ensure they are not set by a server.