~.UcClient.~ Settings #

Local ~.UcClient.~ settings allow the user to customize key features as well as accessing diagnostic information.

tip
To change the avatar image for the signed in user, use the User Settings option from the user menu.

General #

Region

The region selector is only available when there is no user logged into ~.UcClient.~. The region should default automatically based on location but can be changed if required.

Language

Select one of the supported languages to be used in the ~.UcClient.~ UI.

Startup/Shutdown #

Launch on startup

This setting controls whether ~.UcClient.~ will be automatically started when the logging into Windows. When enabling this setting, a Windows prompt will ask for confirmation from the user.

Softphone prompt¹

The softphone prompt allows the user to select which mode ~.UcClient.~ should run in on startup. If disabled, ~.UcClient.~ will automatically run in which ever mode was enabled when it was shutdown.

~.UcClient.~ can be configured to automatically change presence when it is closed or when the computer is locked.

Set presence on exit

Automatically change presence when the application is closing. When enabled, the user can choose a specific presence on select 'Prompt' to ask the user during the shutdown process.

tip
This feature relies on a graceful application shutdown with a still live network connection.

Set presence on lock

Automatically apply a specific presence when the computer is locked. ~.UcClient.~ will automatically revert the presence when the computer is unlocked.

info
The original presence will be restored when the computer is unlocked.

Display Control #

To avoid issues with Windows power modes and screen savers, ~.UcClient.~ can request that the computer does not go to sleep or turn off the display.

Whilst on a call

When this is enabled, ~.UcClient.~ will request that the operating system does not turn the display off whenever a call is in progress. By default, this is enabled.

When softphone is enabled

When this setting is enabled, ~.UcClient.~ will request that the operating system does not turn the display off whenever the softphone is enabled.

Softphone #

NAT¹ #

When registering as a softphone, the ~.UcClient.~ client may need to provide the server with additional network information in order for the server to be able to communicate back to ~.UcClient.~ successfully.

warning
Where possible, please disable any SIP ALG implementation on routers between the user and the communications server to prevent SIP requests being modified.

Auto-detect NAT using ICE

This is the default setting for NAT on ~.UcClient.~ and will work in most implementations. When enabled, ICE will be used to automatically discover the most optimized path to route media traffic.

Discover public IP address using STUN²

If available, a STUN server can be used to help discover the public IP address for the softphone which will then be used in softphone registration requests.

Use media relay using TURN²

If available, a TURN server can be used to relay media between the server and the softphone.

None

Selecting 'None' will disable any NAT configuration, registrations will be made with the server with no additional public IP information.

info
The NAT settings required will different depending on the Network, Router, Internet Connection and Firewall involved in the user's setup.

Audio¹ #

Speaker & Microphone

These settings control the audio input and output devices for softphone calls. The speaker and microphone settings can be updated manually as required.

If a previously selected audio device is not currently available, ~.UcClient.~ will automatically select the most appropriate device to use for softphone calls, automatically defaulting to a device labeled as a 'Headset' where possible.

tip
If a previously selected audio source is not connected, the drop-down will show empty.

Ringing Speaker

The ringing speaker setting controls where the ringing audio for incoming calls will be played. Once the call has been answered, the audio will switch to the configured 'Speaker' device as normal.

This feature is ideal for users with headsets, helping to ensure they are alerted to incoming calls if they are not wearing their headset or are away from their desk.

Presence #

This section provides access to override the default configuration of each presence profile if required.

For exact details on the configuration, please refer to the Presence section.

tip
A specific presence can automatically be applied when ~.UcClient.~ is shutdown or the computer is locked .

Integration #

This section provides access to control features where ~.UcClient.~ is integrating with 3rd party applications.

Outside Number to Clipboard #

This feature provides users with a simple way to search for contacts in a CRM or contact directory. When enabled, ~.UcClient.~ will populate the local clipboard with the current call's Outside Number. The user can then paste the number into whichever application they require in order to perform a contact search.

Copy Outside Number to Clipboard

This setting toggles the feature on or off (default - off).

Call State Trigger

When the feature is enabled, select whether the Caller ID is copied to the Clipboard on ringing or on answered events (default - ringing).

Call Direction

This setting controls whether the Caller ID should be copied to the Clipboard on incoming calls, outgoing calls or both (default incoming).

note
Existing clipboard data will be lost when this feature is used.

Custom Screen Pop #

To help with integration with third-party applications, ~.UcClient.~ provides a method to screen pop a URL using details of your current call. The screen pop can be configured to occur automatically based on a call ringing or answered event, or manually using a Keyboard Shortcut.

Please refer to the Screen Pop feature for details on configuration.

Busylight #

~.UcClient.~ provides support for the Kuando Busylight. Busylight devices provide a visual indication of availability to other users you work with. This can be very handy for when using a headset where it may not be obvious whether you are on a call or not.

~.UcClient.~ will update the color of any connected Busylight to match the availability of the logged in user.

For more information, please refer to the Kuando website.

tip
This section is only available if the Do Not Disturb, Call Forwarding and Personal Routing features of presence profiles is available on you system.

Keyboard Shortcuts #

~.UcClient.~ provides keyboard shortcuts for commonly used actions. This allows quick and easy access, without having to use the mouse or navigate the user interface.

To enable a specific shortcut, toggle the switch next to it and then select a key and modifier combination, e.g. Ctrl-D.

Modifiers

A key on its own cannot be used without at least 1 modifier (Alt, Control, Shift or Windows). To enforce this, ~.UcClient.~ will gray out the current modifier if there is only 1, so that it cannot be unselected. To switch modifiers, select the new modifier before unselecting the previous one.

Available Actions

tip
Some actions only work when running ~.UcClient.~ in softphone mode. Check the table above for more details.

About #

The following details provide information which may be used when diagnosing problems.

Diagnostics #

The following settings control aspects of ~.UcClient.~ diagnostics. Users may be asked to modify these as part of a support investigation.

Maximum log size

The maximum individual log file size allowed before a new file is created. Default - 10MB.

Time to live

The amount of time diagnostics logs are kept, before they are automatically deleted. Default - 14 Days.

Diagnostics

View -> Open File Explorer to the location of the ~.UcClient.~ diagnostics logs.

Upload -> Zip and upload logs to the server for analysis.

tip
Viewing logs will open the root ~.UcClient.~ 'LocalState' folder. The current day's logs are the 'logs' sub-folder, previous days' logs can be found in the 'logsarchive' folder.