In this dialog all clients which should receive access on xtelsio CTI Server are to be declared. The TAPI devices for which they should receive authorisations (owner's rights or monitor rights) are to be assigned to the clients.

Then the clients see only the TAPI devices which are registered in the server for them.


Columns of the Client List

The Client list shows all configured Clients with their essential properties, such as connection status, client and user name, assigned TAPI devices, authorizations and others. You can get a complete overview of all available columns via the "Column selection" tool button. To sort the client list, just click on the respective column header. A "multiple selection" (e.g. for deleting several clients) is supported.

The following connection statuses are displayed:
Active Client is connected to the CTI Server and logged on.
Offline Client is offline.
Offline Monitor Client is offline. There is a running offline monitor for this client, that means that calls are logged in the client offline journal.

The following columns can be selected or deselected via the "Column selection" dialog:
IP address  
Username Shows surname and first name in combination.
TAPI device (owner) Shows the 1st TAPI device for which the client has owner rights.
If "[C]:" is in front of the TAPI device name, then it is a temporary device permission related to the client computer name. So under [Devices] a computer name was assigned to the TAPI device. For more information see:Client Privileges
Other TAPI devices Shows all other TAPI devices for which the Client has owner rights.
Monitor devices Shows all TAPI devices for which the client has monitor rights.
Department Department (initially only used by the administrator to keep track of things).
E-Mail E-mail address
Main journal Shows the respective write and read rights for the server journal
in the form of "RW" (Read / Write).
external PC ID  
external user ID  
Logout time Shows when the Client last logged off.
Version Shows the program version of the CTI Client. Is only supported from CTI Client version 2.2.046.
phone number phone number

Add, edit, delete Clients

The functions for editing the clients can be called up via the corresponding tool buttons or via the context menu.

Functions:
New Add a new Client. See dialog: Add/Edit Client
Edit Edit the configuration of the current selected Client.
See dialog: Add/Edit Client
Delete The selected clients are deleted.
Refresh The client list is read in again from the server.
Column Selection Opens a list with all columns available for display.
Common parameters
assign
Allows the simultaneous assignment of some parameters for a larger number of selected clients. See: "Assign common parameters"
Import CTI Clients Opens the client import dialog. See: "Import clients via CSV file"
Assign common parameters

This function enables the subsequent changing of some parameters for a larger selection of selected clients. The client type, password settings, authorizations for the server journal, the behavior of group panel monitoring and the first main TAPI device including offline monitoring can be reassigned.

The respective TAPI devices are selected either "using the phone number" or "using the format for TAPI Device Name". A description of these methods can be found in the paragraph: Import settings - "Automatically assign the first TAPI device". In contrast to the import function, only the placeholder variables %ClientName%, %PhoneNumber%, %LastName% and %FirstName% are available here.


Filter the client list using the search function

The client list has a simple full-text search. The search text is searched for in the columns client name, first name, last name, department, phone number and e-mail, regardless of upper or lower case. The search for TAPI devices is not supported. Entries for which a full or partial match was found appear in the list. All other entries are hidden. The search filter is canceled using the "Reset search filter" tool button or by deleting the search text in the search line.

As an alternative to the search function, the list can also be sorted. All you need to do is click on the respective column header.


Import clients via CSV file

In larger environments with possibly several hundred clients, manual dialog-guided configuration is associated with considerable effort. The management application therefore supports importing clients via CSV file. This CSV file contains the most important information about each individual client and can, for example, be exported from a database or an Active Directory. Some other settings, which are usually identical for several clients, such as the client type, write and read rights for the server journal or authorizations for monitoring TAPI devices, can be assigned with the help of predefined parameters.

The following import modes are supported
  • Add: Only new clients are added. Existing clients remain unchanged.
     
  • Refresh: Only existing clients are updated. No new clients are added or deleted.
     
  • Add and update: Combination of adding and updating.
     
  • Delete: Exactly the clients contained in the import file are deleted.
     
  • Clean up: All redundant clients that are not contained in the import file are deleted.
     
  • Synchronize: Combination of adding, updating and cleaning.
Structure of the CSV file

The file to be imported is a simple text file in CSV format, the data fields of which are separated by semicolons or tabs. The respective column names must be entered in the first line.
The "ClientName" column serves as a reference for the respective client and must always be available. All other columns are optional and therefore only need to be present if the corresponding parameters are to be set. For the "Delete" or "Clean up" import mode, it would therefore be sufficient if the CSV file only contained one column with the respective client name.

In order to be able to assign the columns contained in the CSV file for the client import, they must correspond to the specified column names. Upper and lower case and the order of the columns are irrelevant. If the CSV file contains columns that cannot be assigned based on the column name, they will be ignored during the import.

Hint: If it is not possible to adapt the exported column names to the supported column names when creating the CSV file from a database or an Active Directory with the corresponding export function, these can be changed with the help of the configuration file "\mgmt\client_imp_cfg.ini" in the [ColumnMapping] section.

The following column names / parameters are supported:
ClientName The client name serves as a reference for the respective client and must therefore always be available.
ClientNameNew If the client name is to be changed, the new client name must be entered in this column. Otherwise this column can be omitted or left blank.
LastName Last name
First name First name
PhoneNumber phone number
E-mail E-mail address
Department Department (initially only serves the administrator to keep track of things)
TapiDevice The name of a TAPI line can be specified in this column. This is assigned to the respective client as the first main TAPI device.
UserParam1 A value can be entered in this column that is used for the automatic assignment of TAPI devices as the content for a placeholder variable.
Example: "TM Line%UserParam1%"
Import settings - "Default parameters for new imported clients"

The parameters that cannot be imported via CSV file but should apply as default for all newly imported clients are specified in the "Import Settings" dialog. These settings have no effect on existing clients that are simply updated.

The following parameters can be specified:

  • Client type
  • Password settings
  • Server journal permissions
  • Settings for group panel monitoring

A description of the parameters can be found under: Add/Edit Client

Import settings - "Automatically assign the first TAPI device"

The following methods are available for the automatic assignment of the first main TAPI device:

  • using the "TapiDevice" column: The TAPI device is assigned based on the values in the "TapiDevice" column. An assignment is only successful if a valid TAPI line name has been recognized and the corresponding TAPI device is available. No assignment takes place in the case of an empty entry or an unknown name.
    This method assumes that the names of the TAPI lines can be exported from a database or the Active Directory together with the other user-related parameters.

  • using the phone number: The TAPI device is searched for and assigned using the phone number in the "PhoneNumber" column. The prerequisite is that the TAPI driver reports a phone number for the corresponding TAPI device. You can check whether this is the case in the "TAPI devices" tab.

  • per format for TAPI device name: The TAPI device is assigned based on its name. The name of the TAPI line is generated dynamically from a formatted text with placeholder variables. The prerequisite is that the naming scheme of the TAPI lines supports such a procedure. The call number is often part of the name of a TAPI line (e.g. "Auerswald LAN TAPI 20"). However, user names or other possibly configurable name components are also possible. All supported column names with suitable content can be used as placeholder variables (e.g. "Auerswald LAN TAPI% PhoneNumber%").
    The placeholder %UserParam1% can be used if the other columns do not provide suitable content.
Import from Active Directory

The server management tries to execute the following PowerShell script to read the Active Directory and cache it in a CSV file:

  • C:\ProgramData\xtelsio_CTI_Server_Data\mgmt\ClientsImport\active_directory_to_ctisrv_csv.ps1
  • If necessary, you can adjust the LDAP filter in this script to only read the required users.
  • The script can also be started manually using a batch file with the following content:
    • powershell.exe -ExecutionPolicy Bypass -File .\\active_directory_to_ctisrv_csv.ps1
      pause
  •