Configuring the Anyware Software Client for Windows

The Software Client for Windows provides a number of configurable settings and behaviors, which allow the setting of user options, performance modes, and triggering actions like automated connections. These settings are not persistent and cannot be set via the user interface; they are set by launching the application using one of the methods described next.

To configure a client instance, you must launch it using one of these methods:

• On the command line, with configuration values passed inline as flags
• Via a URI, providing your configuration values in an encoded JWT string
• via Config files, where advanced configuration values are set via configuration files

Setting Configuration Values on the Command Line

To set configuration values this way, launch the Software Client for Windows from a command prompt, and include the required options as flags. Multiple flags can be included in the same line. Use the following conventions when setting these parameters:

The following example launches the client in full-screen mode, sets log level 3, and points to a connection broker at broker.domain.com (if your application is installed somewhere else, use your own path instead):

"c:\Program Files (x86)\Teradici\PCoIP Client\bin\pcoip_client_cli.exe"  --connection-broker  broker.domain.com  --log-level 3 --full-screen

The available settings are shown below.

Setting Configuration Values via a URI

Using this method, the Software Client for Windows is launched using a URI with configuration options (and, optionally, connection credentials) encoded in a JWT token string.

To use this method, create a URI with the following structure:

pcoip://[broker]/connect[?data={jwt}]

Where each segment shown above is:

The JWT payload can contain both credential information and client configuration. To create the JWT payload:

1. Create your configuration and credentials as a JSON object, using available configuration parameters and authentication credentials.
2. Encode the object as a JWT token.
3. Pass the token through the URI as the data parameter.

For example, the following JSON object would launch the client in full-screen mode, with log level 3:

{
    "fullscreen":true,
    "log-level":3
}

Encoded, and pointing to a connection broker at broker.domain.com, this would result in a URI similar to the following:

pcoip://broker.domain.com/connect?data=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmdWxsc2NyZWVuIjp0cnVlLCJsb2ctbGV2ZWwiOjN9.3MRUQ4VeKHbCnkG4OIXsUYp2N1IGf6AzTIo8tnFoXoA

The available settings are shown below.

Setting Configuration Values via Config files

Certain advanced configuration values are set via configuration files, rather than via the user interface, command line, or URI methods. These files are read and implemented by the Software Client for Windows when it launches.

Configuration files can be saved in a system-scoped location, for settings that should apply to any Anyware client launched on a device, or a user-scoped location, for settings that should apply to specific users. If a setting is found at both levels, the system scope takes precedence.

Configuration files do not exist until a user changes a persistent setting via the user interface. If that has not ocurred, you must create the file, either manually or using a deployment script.

Config File Syntax

The .ini file starts with a [General] group followed by a series of <key>=<value> pairs, each on its own line. For example, the following file would add the USB device identified by the VID/PID pair 18a5,0302 to the local termination blacklist, causing it to revert to bridged connections:

[General]
localtermination_black_list="18a5,0302"

Config File Locations

Depending on the desired scope, save the .ini file in one (or both) of these locations. Remember that the system-scoped file takes precedence over the user-scoped file:

Configurable Settings

The following settings can be configured on the Software Client for Windows.

General Settings

These settings affect the client's behavior both in and out of PCoIP sessions.

Language

Sets the user interface language.

Supported language options:

Usage

If the locale parameter is present but the argument is invalid or missing, the Software Client for Windows displays a Parameter parsing error and lists the valid settings, then exits (the client will not start).

Connection Settings

These settings control how the Software Client for Windows connects to PCoIP sessions.

Connection Broker

The connection broker's URL.

Note that this parameter is used by the command line only; when using the URI method, the connection broker URL is part of the URI (not part of the configuration JWT payload).

Usage

Desktop

The name of the desktop to connect to.

Usage

Domain

The domain to send to the connection broker.

Usage

Hard Host

If connecting to a Remote Workstation Card (also known as a hard host), provide its URL using this parameter.

This option is ignored if the connection-broker url is provided.

Usage

Password

The password sent to the Connection Broker, for logging into a desktop. Transmitting passwords this way is not recommended.

Usage

Session ID

This setting launches the JSESSIONID. This parameter is only available via JWT; it cannot be used on the command line.

Usage

Username

The username sent to the Connection Broker.

Usage

USB Settings

These settings control how USB devices connect to PCoIP sessions, including rules for which devices are allowed to be forwarded.

Disable USB

USB devices are available by default. Use this flag to disable USB connections. This will not prevent simple human input devices like mice or keyboards from connecting.

Usage

USB Auto-Forward

This setting auto-forwards all non-HID devices to the host.

Usage

Vidpid Auto-Forward

To auto-forward specific devices, provide their VID and PID values separated by a comma (,). Multiple values can be provided, separated by spaces. Enclose the list in quotation marks.

Usage

If you are not sure of the device's ID values, see Identifying Vendor and Product IDs for instructions.

Improve graphics tablet responsiveness on high latency network

When this setting is enabled and connected with a compatible client, performance and responsiveness on the locally terminated Wacom/Xencelabs graphics tablet will be improved on networks with high latency or occasional packet drops, though there may be a slight reduction in accuracy.

This setting is not applicable to USB bridged graphics tablets.

This setting takes effect when you start the next session. By default, this setting is disabled.

Vidpid Black List

To block specific devices from auto-forwarding at all, provide their VID,PID values as a space-separated list using this parameter.

This setting overrides usb-auto-forward and the USB dialog in the client interface.

Usage

If you are not sure of the device's ID values, see Identifying Vendor and Product IDs for instructions.

Session Behavior Settings

These settings control the client's behavior once a session is connected.

Fullscreen Mode

Fullscreen mode enables the display topology to support multiple monitors as an extended desktop.

If both fullscreen and windowed parameters are sent, the client will launch in Windowed mode.

Usage

Windowed Mode

Launches the client in windowed mode.

If both fullscreen and windowed parameters are sent, the client will launch in Windowed mode.

Usage

Log Settings

These settings control logging functionality, including verbosity and file location.

Log Folder

A custom location for client log files.

Usage

Log ID

A unique ID that will identify sessions in all PCoIP log files (including those created by other components like agents and a connection manager).

Usage

Log Level

Sets the log level. This parameter will override any existing configuration values.

Usage

Log Prefix

A user-defined prefix for log files. This value will be prepended to the timestamp in the log file name, like this:

<log-prefix value><timestamp>

Log files are saved in the location provided by log-folder.

Usage

Advanced Settings

Disable Hotkeys

Session convenience hot keys, such as Ctrl+Delete+F12 (which disconnects a PCoIP session) are available to users by default. Use this flag to disable all hotkeys.

Usage

Disable Menu Bar

The Anyware client menu bar is available to users by default. Use this flag to disable the menu bar, preventing users from accessing it or executing any of its functionality.

Usage

Enable Scaling

This setting enables scaling on the Anyware Client without having to specify the desktop resolution. This can only be configured on a single display. This is off by default.

Usage

Force Native Resolution

This setting sets the resolution of the Client monitor to the native resolution when the session client is launched. This can only be configured on a single display.

Usage

Maintain Aspect Ratio

This setting maintains the display aspect ratio between the host and the Client. Maintaining the aspect ratio in this way can result in letterboxing if the two devices are naturally different.

This can only be configured on a single display.

Usage

Quit After Disconnect

If this is enabled, disconnecting from the PCoIP session will immediately quit the Software Client for Windows.The pre-session interface will not be available after disconnecting.

Usage

Set Host Resolution

This setting locks the resolution of your host application display.

Provide the value as a string, made up of the horizontal resolution, the letter "x", and the vertical resolution. For example, "1024x768".

This can only be configured on a single display.

Usage