You are viewing an old version of this page. View the current version.
Compare with Current ·
View Page History
To get enhanced call logging data, install our CXD Connector tool to act as a relay between your TIM Enterprise product and your 3CX PBX.
CXD Connector circumvents the built-in SMDR functionality of the 3CX, so there's no need to configure any SMDR settings.
You can install the Linux version of CXD Connector directly onto your 3CX if you have root access to it, or you can install the Windows version to a separate computer, such as the one which your TIM Enterprise is installed on.
 | CXD Connector is a read-only tool. It neither modifies your 3CX configuration nor directly accesses any 3CX internal databases. |
Installing CXD on your 3CX
Using SSH, connect to your 3CX using a privileged user account, then enter the following commands:
This will start the text-based installer which consists of a series of prompts to enter the settings described below. To accept a prompt's default value (shown in square brackets) just press ENTER.
If you enter an invalid value (e.g. a port is already in use) you will be prompted again until a valid value has been entered. To abort the installation, press CTRL+C.
| Prompt | Description |
|---|---|
| HTTP port [5080] | The default HTTP port to use for web requests. |
| HTTPS port [5443] | The default HTTPS port to use for web requests. |
| TCP port [7000] | The port used by CXD to emit live event data over a TCP connection. This is the port used when setting up the connection in TIM Enterprise. |
| Authentication Key [xxxxxxxxxxxxxxxx] | Choose a secret that you will also use when setting up the connection in TIM Enterprise. Press ENTER without typing a secret if you want to accept the random secret the installer has generated for you. |
| Register product [YES] | You can choose to register the installation with your Tri-Line account. If you select YES, you'll be asked for your Tri-Line Gateway login details: username (email) and password. If you skip this step, you can assign the installation to a customer account later in the Tri-Line Gateway using your web browser. |
After completing the steps above, the installer automatically enrols with the licensing service and starts CXD automatically.
To connect TIM Enterprise to your newly-installed CXD service, see Configure TIM Enterprise below.
Installing CXD on on a separate Windows computer
To get a copy of the Windows version of the CXD Connector, submit a support ticket through our online Gateway or send an email to [email protected].
Once you have the installation package, before you begin installation, please check you have the following information to hand:-
- IP address of your 3CX PBX
- A username and password of a privileged account (e.g. root) that the installer can use to SSH in to your 3CX.
Once you have obtained your copy of the CXD Connector installation package, run it and follow these steps:
- Choose an installation location.
- On the “Select Components” section, leave all options selected as default and click 'Next'.
- On the “ready to install” section please click on 'Install'. The Wizard will now attempt to install it.
- Once the installation is complete, the CXD configuration screen will pop up.
- There are three options that need to be configured. Enter the details as shown below:
3CX Host/IP = Please enter the IP address of the 3CX PBX
Username = username used to connect to the 3CX
Password = password user to connect to the 3CX
- Once this has been configured, please click 'Next'. If successful, CXD will attempt to establish a connection to the 3CX. Please note that an account that has SSH permission will be needed in order to connect successfully.
- You will be presented with the option to set web ports and an API Secret key that the CXD service will require when connecting with TIM Plus. Please make a note of this information as it will be needed later.
- Click 'Next' the Wizard will confirm that the configuration is complete, and the CXD service will be started.
Configuring TIM Enterprise
- If the 3CX is serving multiple sites, skip to step 5. If you are adding a new site with a 3CX, click on the 'Directory' tab.
- Click on 'New object'
- Select 'Site', and type the name of the site as follows:
- Go to the Site, and click on 'Open' as shown below:
- Select 'PBX' from the 'Other objects' list and type in the name of the 3CX site e.g. Manchester 3CX
- Select 'Establish a TCP connection to PBX' as the connection method.
- Then select '3CX CXD' from the IP script drop-down list and enter the details as shown above.
- Host: The IP address of the machine where the CXD server was installed.
Port: Enter the default Port number.
Username: Leave blank.
Password: This is the ‘API Secret’ created earlier.
IP script: Select '3CX CXD' from the drop-down list. - An additional benefit of using CXD as the connection method is that TIM Enterprise can sync with the 3CX Server.
A sync will allow you to pull a list of users and devices from the system.
This allows you to configure and set up the directory much faster.
To add a 'Directory Sync' object, select and name as shown in the example below:
- Once the Sync Object has been added to your Directory, you have the option to 'Sync now' or return at any
time and select 'Properties' to sync again later.
- After selecting 'Properties', simply choose how often you would like to synchronise as shown below:
