Basics

To install the CTI Client for multiple users on a terminal server, a few steps in a particular sequence must be executed.

  1. Install CTI Client
     
  2. Configuring CTI Client
     
  3. "provide/release" CTI Client configuration for all users

Installation

Run setup.exe and follow the dialogs.

If the setup does not automatically recognize the Terminal Server environment, you can set the entry [TerminalServer > Force=1] in the "SETUP.INI".
In the dialog "Terminal Server Mode", the installation mode "Terminal Server" is to select. The following criteria are applied:

  • The Terminal Server is automatically placed in the "Installation" mode (change user /install).
     
  • The installation is done automatically for all users.
     
  • As of version 3.0.037, the "CTI Client TAPI Connector (MultiUser)" also works in a Terminal Server environment.More infos...
     
  • The startup of the CTI Client is initially locked for all other users, that is, after the installation initially only the user (administrator) who performed the installation, may start the CTI Client to configure it if necessary. The release for all users is done only after completing configuration via "Setup Generator".

In the dialog "Select Working Directory" you can set the path to the user working directory. Each user needs his own work directory.
Example: "C:\Users\%USERNAME%\Documents and Settings\My Documents\xtelsio_CTI_Client_data"

In the dialog "Optional Components" you can install the Outlook Add-In, when required. The activation of the Add-In is user-related. In the CTI Client the Add-In can be activated/deactivated via [Options > Outlook].

In the dialog "Program Shortcuts" you can set the program shortcuts to be created.

By pressing the "Finish" button the installation is executed.  

After successfully completing the installation and before you start the CTI Client for the first time, you should put the terminal server back in "execution mode" (change user /execute).

Install "CTI Client TAPI-Connector (MultiUser)" manually
This step is only relevant if the installation of the "CTI Client TAPI-Connector (MultiUser)" via the setup did not work.
  1. Copy the "cctcmu.tsp" file from the CTI Client setup directory "bin\x64" to "C:\Windows\System32".
  2. If possible, you should be logged on to the system as a local administrator.
  3. Open "Phone and Modem" in the Windows Control Panel.
    • Go to the "Advanced" tab.
    • If an entry "CTI Client TAPI-Connector" already exists, then remove it.
    • Click on "Add..." and select "CTI Client TAPI Connector (MultiUser)".
    • Now the TAPI driver should be available in the Windows system.
    • You can configure the TAPI driver via "Configure...".
      • In the basic setting, the user-related TAPI lines should be created automatically as soon as a user starts the CTI Client for the first time.
  4. Open the "Telephony" Management Console by: [Start > Settings > Control Panel > Administrative Tools > Computer Management > Services and Applications > Telephony];
    or <Execute> "tapimgmt.msc".
    • Right click on your server-item and select "Properties".
    • In the "Properties" dialog, uncheck "Enable telephony server". This is necessary so that the CTI Clients can communicate with the TAPI driver.
  5. In the CTI Client instances, the two checkmarks must be set under [Options > Telephony > Activate CTI Client TAPI-Connector for].
    • If necessary, run [File > Restart Application].
  6. Further information on the "CTI Client TAPI Connector"...

Configuration

Before the CTI Client is "enabled" for all users, he should first be configured as it should be run later on the terminal clients.

Then starting the application for first time, a dialog appears, that helps you to configure the TAPI devices and phonebook folder.

Important: To be able to assign every user an individual TAPI device, first a TAPI device must be assigned and configured for the administrator. Guide to TAPI Configuration...


Additional configuration steps that may necessary, are

Set permissions for TAPI lines in the Windows system: If you are using a Multiline TAPI driver in conjunction with the CTI Client, you can set the user authorization for TAPI lines using the Windows Telephony service (TAPI Server). For information, see:Network TAPI.

Protect configuration with administration password: You can password protect the configuration as a whole or partially. It is also possible to block, to disable or hide individual functions, menus or parameters for the user. These settings are available under [Options > Administration / Extended Settings]. For more information on administrator settings...

Enable/disable Components and Plug-ins: In the dialog [Options > Customize > Components and Plugins] you have the option to turn off unneeded components and thus to save resources.

Customize window layout: Determine which dialogs are displayed in the main application window and if so, how they were arranged. In the basic configuration, a Desktop-Sidebar is included which can also be pre-configured or even turned off.
For more information about window management...

Manage TAPI Profiles: Under [Options > Administration > Local Profiles / Terminal Server] you can make settings for the TAPI profiles. In this dialog you have to select "Terminal Server" or "Terminal Server Farm" as "Environment".
More information to local profiles...
For more information to Terminal Server options...

Mobile Users: For mobile users who log on to different terminals and thereby gain access to the local telephone next to this terminal, the option "%CLIENTNAME%" is to select under [Directory name for local TAPI profile].

Terminal Server Farm: For a terminal server farm, where users are assigned to terminal servers depending on the load balance, the value "Terminal Server Farm" is to select for [Environment].


Provide configuration for user

To provide the CTI Client configuration for other users, start the Setup Builder via the main menu [File > Administration > Generate Setup ...].

On the first dialog, select "Terminal Server Configuration" and if you want to provide central telephone books and/or notes, the option "Expanded to a central configuration directory".

For more help on this topic can be found at:

Follow the dialog-wizard with the dialogs:

  • Central configuration directory
  • Setup Settings
  • PhoneBook
  • Speed Dial
  • Working Directories
  • Create Setup
  • Autoconfiguration
  • Adapt existing installation

On the last dialog, the path to the created "working directory template" is displayed. Open this folder, if necessary, make further manual adjustments to the configuration files.

Enable "CTI Client Start" for other terminal user: Use the appropriate prompt when closing the Setup Generator or the "Terminal Server Settings" under [Options > Administration].

To test the configuration, you can unlock it for individual terminal user. Add the appropriate user names in the file "%PROG_DIR%\cfg\admin.xml" under "AllowStartForUsers" separated by a comma.

Example: AllowStartForUsers="Administrator, User1, User2"

Autostart only for individual users:

  • Remove the CTI Client program link from AllUsers-Autostart.
    • The AllUsers autostart is under: C:\Users\All Users\Microsoft\Windows\Start Menu\Programs\Startup
    • Or: [Windows]+[R] and in the Run menu type "shell:Common Startup".
  • Add the CTI Client program link to the respective user's autostart folder.
    • C:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup
    • Or: [Windows]+[R] and in the Run menu type "shell:startup"
More information
  • After completing "Generate Setup", the CTI Client is basically installed for all users.
  • There is no need to run the setup again in the user context.
  • When a user starts the CTI Client for the first time, the created working directory template is copied to their user profile. Individual settings may then need to be made manually.
  • To force a complete new onfiguration for a user, you can delete or rename their working directory.
  • You can access the currently used working directory via: [CTI Client main menu > File > Working directory > Open]

Transfer configuration to new terminal server

With the following instructions you should be able to move a CTI Client installation/configuration to a new terminal server.

Transfer CTI Client configuration directories (working directories).
  • You can see which working directories are currently being used in the CTI Client via [File > Working Directory > Open].
  • These directories must be copied to the new server.
  • Further information about the working directory can be found at:Working Directory
Optional: Transfer configuration from the "CTI Client TAPI Connector (Multiline)".
  • This step only needs to be carried out if you use the "CTI Client TAPI Connector (Multiline)" in other TAPI applications (e.g. CRM) on the TS.
  • The configuration is saved in the registry under:
    • HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Telephony\CTI_Client_MultiUser_TAPI
    • Select this path in the registry editor and then execute [File > Export...].
    • On the new server you would have to run [File > Import...] in the registry editor.
  • The TAPI driver is installed during the CTI Client Setup.
Transfer CTI Client program directory
  • Copy the "C:\Program Files (x86)\xtelsio_CTI_Client" directory to the new server.
    • The subdirectories "auto_config" and "cfg" are particularly important.
  • Now run the CTI Client Setup.
Optional: Transfer configuration from "xtelsio TAPI for Asterisk".
  • This step can only be carried out if you have also installed the "xtelsio TAPI for Asterisk" driver.
  • The configuration is saved under:
    • C:\Windows\System32\xtelsio_TAPI_for_Asterisk_cfg
    • Copy this folder to the new server and then run the "xtelsio TAPI for Asterisk" setup.
Optional: Transfer configuration from "xtelsio TAPI for Snom".
  • This step can only be carried out if you have also installed the "xtelsio TAPI for Snom" driver.
  • The configuration is saved under:
    • C:\Windows\System32\xtelsio_TAPI_for_snom_cfg
    • Copy this folder to the new server and then run the "xtelsio TAPI for Snom" setup.


Terminal Server Farm

Distribute CTI Client installation in a terminal server farm
  • Initial state
    • You have installed the CTI Client on the master terminal server or have just installed an update.
    • If you have made configuration changes to the master, you may need to run "Create Setup" again.
  • For the initial installation, it is recommended to run the official "xtelsio CTI Client" setup once on all servers in the farm.
  • Deployment:
    • Copy the CTI Client program directory from the master to the other terminal servers in the farm. The program directory also contains the preconfiguration for the users' future working directories.
  • Update:
    • For later updates it would be sufficient if you copy the CTI Client program directory from the master to the other terminal servers in the farm.

FAQ

1.) Can the CTI Client be used as a SIP-Softphone in a terminal session?

For information, see:Integrated SIP SoftPhone in a terminal session

 

2.) Can a local TAPI device / IP phone be used in a terminal session?

As of CTI Client Version 3.1.009 you can connect a local CTI Client instance to a CTI Client instance in a terminal session. This is helpful, for example, if:

  • a TAPI driver is only available locally,
  • an IP telephone can only be integrated locally.
  • More infos...

 

3.) Can the CTI Client, installed locally on the client machine, dial a phone number which is shown in the terminal window?

  • Option A: As of CTI Client Version 3.1.009 you can connect a local CTI Client instance to a CTI Client instance in a terminal session.More infos...
    Thus, all possible dialing functions are available.

  • Variant B: For this feature you have to activate [Options > Telephony > Dialing from within other applications > via mouse click on any phone number].
    Restriction: Only dialing is supported. Within the terminal session there is no reaction on incoming calls.

  • Variant C: Dial by Ctrl+C+C:More infos...