Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Info

CXD Connector is a read-only tool.  It ; it neither modifies your 3CX configuration nor directly accesses any 3CX internal databases.

 

Installing CXD on your 3CX

...

Code Block
themeRDark
languagebash
 
 cd /var/tmp
 wget https://esd.tri-line.com/open/cxd/cxd_latest_amd64.deb
 apt install -f ./cxd_latest_amd64.deb
  

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 Press ENTER at any prompt to accept the default value ( shown in square brackets) just press ENTER.

If you enter an invalid value (e.g. a port you've chosen is already in use) you will be prompted again until a valid value has been entered.  To abort the installation, press

Buttonmacro
LabelCTRL+C
.

PromptDescription
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.

...

To connect TIM Enterprise to your newly-installed CXD service, see Configure TIM Enterprise below.


Installing CXD on a separate Windows computer

...

  1. Choose an installation location.:

  2. On the “Select Components” section, leave all options selected as default and click 'Next'click 
    Buttonmacro
    LabelNext
    .
  3. On the “ready Ready to install” section please , click on 'Install'. The Wizard will now attempt to install it. 
    Buttonmacro
    LabelInstall
    .
  4. 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 be displayed:

    Image Added

    Enter the IP address of the your 3CX PBX

    Username = username used to connect to the 3CX

    Password = password user to connect to the 3CX

    Image Removed
  5. 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.
  6. 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.

    Image Removed

  7. Click 'Next' the Wizard will confirm that the configuration is complete, and the CXD service will be started.

    Image Removed

 Configuring TIM Enterprise

 

...

  1. in the first field.  The username and password fields should be those of a privileged SSH user on your 3CX.

    When you've entered the details, click 
    Buttonmacro
    LabelNext
     to attempt the connection to the 3CX.



  2. After a successful connection has been established, the next screen allows you to set the ports that CXD will provide, as well as an API Secret:

    Image Added

    The API Secret is randomly generated, but you can choose your own.


    When you've made a note of these details - they'll be needed when connecting TIM Enterprise to CXD - click 
    Buttonmacro
    LabelNext
    .

  3. When the wizard completes, it automatically starts the CXD Service:

    Image Added
HTML
<a id="ConnectusingCXD-configuringtimenterprise"></a>

Configuring TIM Enterprise

Now you've installed CXD, either directly on to your 3CX or on a separate Windows computer, you need to log in to TIM Enterprise and create a connection to the CXD service:

  1. Add a new site object by first navigating to the Directory tab.
  2. Click on 'New object'

  3. Select 'Site', and type the name of the site as follows:

  4. Go to the Site, and click on 'Open' as shown below:

  5. Select 'PBX' from the 'Other objectsobject' list and type in the name of enter a name for the 3CX site, e.g. "Manchester 3CX", then click 
    Buttonmacro
    LabelAdd
     at the bottom right.



  6. Select Choose 'Establish a TCP connection to PBX' as the connection method Method. 

    Image Removed

    Then select '3CX CXD' from the IP script drop-down list and enter the details as shown above.
  7. In the Details panel, enter the following details:

    Host: The IP address of the machine where the CXD server was installed.computer you installed CXD on (either the 3CX itself or another computer running Windows)
    Port: Enter the default Port number.TCP port you chose during CXD setup
    Username: Leave blankempty.
    Password: This is the The API Secretyou created earlierwhen setting up CXD.
    IP script: Select '3CX CXD' from the drop-down list. 

    An additional benefit of using CXD as the connection

    Image Added
  8. One of the benefits of using the CXD Connector 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 synchronise its user details with those on your 3CX automatically; if you change a user's details on your 3CX, it will automatically update in TIM Enterprise's directory.

    Add a new object of type 'Directory Sync' object, select and name as shown in the example belowenter a name, then click 
    Buttonmacro
    LabelAdd
    :


  9. 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.

    Image Removed
  10. After selecting 'Properties', simply choose how often you would like to synchronise as shown below:

    Image Removed

    Right-click on the sync object you just created, and choose 'Properties...':

    Image Added
  11. Select how often you'd like TIM Enterprise to synchronise its directory with your 3CX, then press 
    Buttonmacro
    LabelSave
    :


    Image Added

You should now have a working connection via CXD to your 3CX!
Make a test call, then select the 'Call View' tab at the top of the screen to show your calls.