iCDS Installation and Configuration Guide · 5 iCDS Installation & Configuration Guide About this...

Installation &Configuration Guide

iCDS

Reordering Info: IGICDS/R6, Jun 2014

All rights reserved © Copyright 2014, Speakerbus Technology

Printed in the UK 2014.

Speakerbus Technology Limited reserves the right to make changes to the information in this document at any time without notice. Information published in this document is believed to be reliable. However, Speakerbus Technology Limited assumes no liabilities for inaccuracies or omissions in this document, or liability arising from the use of such information.

Speakerbus Technology Limited assumes no liability for the infringement of patents or other intellectual property rights owned by third parties which may result from the application of this information.

No part of this document may be reproduced or transmitted in any form or by any means electronic or mechanical, for any purposes, without the written permission of Speakerbus Technology Limited.

Trademarks

Speakerbus Technology company logo is a registered trademark of Speakerbus Technology Limited. Speakerbus is a trademark of Speakerbus Technology Limited.

Statement of Conditions

Speakerbus reserves the right to make changes to the products described in this document without notice.

Speakerbus Technology Limited does not assume any liability that may occur due to the use or application of the product(s) describes herein.

Previous Revision(s)

Revision 1 September 2008

Reviision 2 June 2013

Revision 3 August 2013

Revision 4 December 2013

Revision 5 March 2014

3

iCDS Installation & Configuration Guide

ContentsAbout this Guide ........................................................................5

Using this Guide ............................................................................................. 5Further Help ..................................................................................................... 5Related Manuals .............................................................................................. 6Software Version ............................................................................................. 6

iCDS Overview ...........................................................................7

Prerequisites ..............................................................................8

Installation and Configuration Overview ................................. 9

System Requirements .............................................................10Supported Operating Systems .................................................................... 10Hardware Requirements ............................................................................... 10

Physical Requirements .......................................................................................... 10Additional Virtualisation Requirements ................................................................... 10

Software Requirements ................................................................................ 11

Software Installation ...............................................................12Installing the iCDS Server Application ........................................................ 12

Software Upgrade ....................................................................17System Requirements .................................................................................. 17

Supported Operating Systems ............................................................................... 17Hardware Requirements ........................................................................................ 17Software Requirements .......................................................................................... 17

Upgrading the iCDS Server Application ..................................................... 17

Configuration ...........................................................................22Configuring the iCDS File ............................................................................ 22iManager Configuration ................................................................................ 23

iManager Deskstation Configuration ...................................................................... 23iD 712 Deskstations .......................................................................................... 23iTurret Deskstation ............................................................................................ 26

Using iCDS Monitor for Testing & Diagnostic Purposes ..... 30

Uninstalling the iCDS Server Application ............................. 32

4


Screen Reference ....................................................................34iCDS Configuration File ................................................................................ 34

iCDS Section .......................................................................................................... 34ServerIPAddress ............................................................................................... 34DeviceServerPort .............................................................................................. 34ThirdPartyServerPort ........................................................................................ 35MonitorPort ........................................................................................................ 35LogCDR_Events ............................................................................................... 35

ThirdPartyDevice Section ....................................................................................... 35DeviceXProtocol ................................................................................................ 36DeviceXIP ......................................................................................................... 36DeviceXPort ...................................................................................................... 36

iCDS Monitor Application ............................................................................. 36Introduction ............................................................................................................ 36Starting the iCDS Monitor Application ................................................................... 37Tree Structure Description ..................................................................................... 37

iCDS Server ...................................................................................................... 38Devices ............................................................................................................. 403rd Party Devices .............................................................................................. 41

5


About this GuideUsing this Guide

This guide describes how to install and configure the iManager Call Data Services (iCDS) System. The iCDS system is middleware which handles call data records (CDR), allowing third party devices such as voice recorders or call loggers to receive the call data records.

Before operating the iCDS system, please read these instructions carefully.

The iCDS Installation & Configuration Guide comprises of the following sections:

● iCDS Architecture

● Prerequisites

● Solution Installation and Configuration Overview

● Software Installation

● Software Upgrade

● Configuration

● Using iCDS Monitor for Diagnostic & Testing Purposes

● Uninstalling the iCDS Server Application

● Screen Reference

Further HelpIn all instances, first seek help from your System Administrator. If necessary, your System Administrator can email the Speakerbus Global Helpdesk at [email protected].

Please supply the following from the iCDS server:

● Speakerbus Log files for the period around the problem:

● File location C:\Program Files\Speakerbus Technology Ltd\i cds\LogFiles.

● A copy of the iCDS.ini file:

● File location C:\Program Files\Speakerbus Technology Ltd\i cds\bin.

● Microsoft Windows Event Logs:

● Application Log

● Security Log (if available)

6


● System Log

● System Information:

● Host name and IP Information (LmHost/Hosts file)

● Speakerbus Software levels

● Any other pertinent information.

Related ManualsThis document needs to be used in association with the following documents:

● iManager Installation Guide

● iManager Administrator’s Guide

Software VersionThis document is written for iCDS software version 2.2 (and above).

7


iCDS OverviewiCDS is the middleware software which handles call data records. The diagram below displays the iCDS network architecture.

If the voice recorder supports RTP audio the turrets send recording streams direct to voice recorders through voice over internet protocol (VOIP).

If the voice recorder does not support RTP audio, the recording streams can be sent via a Speakerbus analogue or digital gateway to accommodate legacy recording solutions.

8


PrerequisitesThis document assumes the iCMS server is already installed and the appropriate deskstations (iD 712 and iTurret Deskstations) have users seated on them. It also assumes a third party voice recorder is installed and configured.

Please note that the machine that the iCDS Server Application is being upgraded on will require a system restart after the installation process.

9


Installation and Configuration OverviewTo install and configure the iCDS solution please complete the following steps:

1. Install or upgrade the iCDS Server Application. For more information, see the Software Installation section on page 12 or the Software Upgrade section on page 17.

2. Configure the appropriate settings within the CDS.ini file for iCDS and voice recording. For more information, see the Configuring the iCDS File section on page 22.

3. Restart the Speakerbus iCDS service using the Computer Management console.

4. Configure the appropriate settings and options using iManager. For more information, see the iManager Configuration section on page 23.

If the iCDS Server Application needs to be uninstalled please refer to the Uninstalling the iCDS Server Application section on page 32.

10


System Requirements

Supported Operating Systems

iCDS ServerMicrosoft Windows Server 2003Microsoft Windows Server 2003 R2Microsoft Windows Server 2008 R2

Microsoft Windows Server 2012 R2

iCDS MonitorMicrosoft Windows XPMicrosoft Windows Server 2003Microsoft Windows Server 2003 R2Microsoft Windows VistaMicrosoft Windows Server 2008Microsoft Windows Server 2008 R2Microsoft Windows 7

Hardware RequirementsPhysical Requirements

Processor Intel Pentium 4 Processor (or 100% compatible)

RAM 1Gb RAM (512 RAM Minimum)Network Ethernet card with TCP/IP installed

Additional Virtualisation Requirements

iCDS can be supported on either VMWare or Microsoft Hypervisor virtualised environments. Speakerbus supports VMWare Server ESXi V4.1 and V5 along with Microsoft Hyper ‘V’ 2008 R2.

The minimum host server specification is based on a Speakerbus Appliance Server and is as follows:

● Processor: Intel XEON (E5520 8MB Cache 2.26Ghz)

● RAM: 2GB

● Hard Disk: 135GB

Guest configuration for iCDS is as follows:

● CPU: 2 Processors minimum, 4 Processors recommended

● RAM: 1Gb RAM minimum, 4Gb RAM recommended

● Network: Directly connected to the physical network using auto detect (switch port connected to should be a minimum of 100/Full). For ESXi you must use E1000 as the network adapter.

11


● Hard Disk: Minimum 20GB avaliable. This can be thin provisioned.

Software RequirementsMicrosoft .NET Framework 2.0.

12


Software InstallationInstalling the iCDS Server Application

To install the iCDS Server Application:

1. Locate the iCDS installation files and double click Setup.msi.

This displays the iCDS Main Menu.

2. Click Install iCDS.

This displays the Welcome InstallShield.

The installation checks if the server has Microsoft .NET Framework 2.0 already installed. If it is not installed you will be invited to install Microsoft .NET Framework 2.0.

3. Click Next.

This displays Customer Information.

13


4. Type a user name and company name in User Name and Company Name respectively.

5. Click Next.

This displays Choose Destination Location.

6. If the default installation location is appropriate click Next.

This displays Select Features.

14


Typically both the Monitor and Server components will both be installed on the server machine. However you can install the Monitor component separately on a machine other than the server to use it as a diagnostic tool, to ensure the iCDS is running correctly.

7. Click Next.

This displays the Speakerbus Software License Agreement.

8. Accept the license agreement and click Next.

This displays the Apache License Agreement.

15



This displays Ready to Install the Program.

10. Select Install.

The installation process will now take place.

The InstallShield wizard below is displayed when the installation is complete.

16


11. Click Finish on the InstallShield wizard ensuring the Start the iCDS Server service check box is selected.

17


Software UpgradeSystem RequirementsSupported Operating Systems

iCDS ServerMicrosoft Windows Server 2003Microsoft Windows Server 2003 R2Microsoft Windows Server 2008 R2

Microsoft Windows Server 2012 R2

Hardware Requirements

Processor Intel Pentium 4 Processor (or 100% compatible)

RAM 1Gb RAM (512 RAM Minimum)Network Ethernet card with TCP/IP installed

Software Requirements

Microsoft .NET Framework 2.0.

Upgrading the iCDS Server ApplicationPlease note that the machine that the iCDS Server Application is being upgraded on will require a system restart after the installation process.

To upgrade the iCDS Server Application:

1. Locate the iCDS installation files and double click Setup.msi.

This displays the iCDS Main Menu.

iCDS MonitorMicrosoft Windows XPMicrosoft Windows Server 2003Microsoft Windows Server 2003 R2Microsoft Windows VistaMicrosoft Windows Server 2008Microsoft Windows Server 2008 R2Microsoft Windows 7

18


2. Click Install iCDS.

This displays the Welcome InstallShield.

The installation checks if the server has Microsoft .NET Framework 2.0 already installed. If it is not installed you will be invited to install Microsoft .NET Framework 2.0.

3. Click Next.

This displays Select Features.

19


Typically both the Monitor and Server components will both be installed on the server machine. However one may install the Monitor component separately on a machine other than the server to use it as a diagnostic tool, to ensure the iCDS is running correctly.

4. Click Next.

This displays the Speakerbus Software License Agreement.


This displays the Apache License Agreement.

20



This displays Ready to Install the Program.

7. Select Install.

The installation process will now take place. Any previous installed versions of the iCDS Server Application will be uninstalled and removed before the new version is installed.

The InstallShield wizard below is displayed when the installation is complete.

21


8. Click Finish.

You will be prompted to restart the machine.

9. Ensure the Yes, I want to restart my computer now option is selected, and click OK to restart the machine.

When the machine has restarted the Speakerbus iCDS Service will automatically start running.

22


ConfigurationConfiguring the iCDS File

The iCDS Configuration filename is CDS.ini and is typically located at the following directory path:

C:\Program Files\Speakerbus Technology Ltd\iCDS\Bin

This section will briefly described how to set up the file for a single third party voice recorder. For more information on each setting within the CDS.ini file, see the Screen Reference section on page 34.

1. Open the CDS.ini file.

You will notice the [iCDS] section within the file displays the following information:

ServerIPAddress=

DeviceServerPort=7788

ThirdPartyServerPort=7789

MonitorPort=8850

LogCDR_Events=0

The ServerIPAddress option will be left blank in most cases. An IP address will only need to be specified if the machine running the iCDS Server Application has multiple network adapters.

The DeviceServerPort number is used by the iD 712 or iTurret Deskstation to connect them to the iCDS Server Application.

The ThirdPartyServerPort number is used by third party voice recorders to connect to the iCS Server Application

The MonitorPort is required when using the iCDS Monitor Application. Upon opening you will be prompted to enter the MonitorPort number.

The LogCDR_Events option is used for logging CDR messages for diagnostic purposes.

The [ThirdPartyDevice] section within the file displays the parameters required to connect to a third party voice recorder. An example of the parameters are displayed below. The values associated with each parameter are used for example purposes.

Device1Protocol=Client

Device1IP=10.1.1.10

Device1Port=8000

23


The Device1Protocol option needs to be set to either Client, UDPClient or Server. Please contact the voice recorder vendor for what this setting should be set to.

The Device1IP option needs to specify the IP address of the third party voice recorder.

The Device1Port option needs to specify the port number of the third party voice recorder.

2. Save the CDS.ini file.

3. Restart the Speakerbus iCDS Server service using the Computer Management console.

iManager ConfigurationiManager, the management application used to manage the iCMS server, is required to configure the iTurret and iD 712 Deskstations for the iCDS Server. This section describes how to set up iTurret and iD 712 Deskstations with third party voice recorders using iManager.

Please note iManager version 2.5 is used to set up the iCDS and voice recording.

iManager Deskstation Configuration

iD 712 Deskstations

In this section you will:

● create an iCDS Server network service

● create an Voice Recorder network service

● connect the Voice Recorder network service to the Default Intercom Recording policy

● connect the iCDS Server network service to the Default Call Logging policy, and

● ensure Default Intercom Recording and Default Call Logging policies are attached to an iD 712 Deskstation.

Using iManager create an iCDS Server network service. To do this:

1. Select Network Services from the side menu and click New.

This displays the small Network Services General tab.

24


2. Type a name for the iCDS Server in the Name text box.

3. Select iCDS Server from the Type.

This displays the iCDS server settings.

4. Type the IP address and port number of the iCDS Server in Private Address and Public Adress Port respectively.

5. Click OK to save the changes.

Create a Voice Recorder network service. To do this:

1. Ensure Network Services is selected again and click New.

This displays the Network Services General tab.

2. Type a name for the voice recorder in the Name text box.

3. Select Voice Recorder from the Type list box.

This displays the voice recording settings.

25


4. Type the voice recorder IP address in Private Address and click OK. Please ensure the IP address matches the Device1IP setting under the ThirdPartyDevice section within the CDS.ini file. For more information, see ThirdPartyDevice Section on page 35.

Connect the Voice Recorder network service to the Default Intercom Recording policy. To do this:

1. Select Policies from the side menu.

2. Select Default Intercom Recording from the list box.

This displays the Default Intercom Recording options.

3. Select the Stream #1 tab to display its settings.

4. Select the voice recording network service that you created earlier (in steps 6 to 9) from the Primary Recorder list box.

5. Type the voice recording port number in the Voice Recorder Port text box and click Apply. Please ensure the port number matches the Device1Port setting under the ThirdPartyDevice section within the CDS.ini file. For more information, see ThirdPartyDevice Section on page 35.

Connect the iCDS Server network service to the Default Call Logging policy. To do this:


2. Select Default Call Logging from the list box.

This displays the Default Call Logging options.

3. Select the iCDS Server network service that you created earlier (in steps 1 to 5) from the Primary iCDS Server list box and click Apply.

26


Ensure the Default Call Logging and Default Intercom Recording policies are attached to the iD 712 Deskstation. To do this:

1. Select the Deskstations side menu and click the required iD 712 Deskstation.

This displays the iD 712 Deskstation’s tab settings.

2. Select the Recording tab for the iD 712 Deskstation.

3. Ensure the Call Logging Policy option is set to Default Call Logging.

4. Ensure the Recording Policy option is set to Default Intercom Recording.

5. Click Apply if required.

iTurret Deskstation

In this section you will:

● create an iCDS Server network service

● create an Voice Recorder network service

● connect the Voice Recorder network service to the Default Intercom Recording policy

● connect the iCDS Server network service to the Default Call Logging policy, and

● ensure Default Intercom Recording and Default Call Logging policies are attached to an iTurret Deskstation.

Using iManager create an iCDS Server network service. To do this:

1. Select Network Services from the side menu and click New.


2. Type a name for the iCDS Server in the Name text box.

3. Select iCDS Server from the Type.

27


This displays the iCDS server settings.

4. Type the IP address and port number of the iCDS Server in Private Address and Private Adress Port respectively.

5. Click OK to save the changes.

Create a Voice Recorder network service. To do this:

1. Ensure Network Services is selected again and click New.


2. Type a name for the voice recorder in the Name text box.

3. Select Voice Recorder from the Type list box.

This displays the voice recorder settings.

4. Type the voice recorder IP address in Private Address and click OK. Please ensure the IP address matches the Device1IP setting under the ThirdPartyDevice section within the CDS.ini file. For more information, see ThirdPartyDevice Section on page 35.

Connect the Voice Recorder network service to the Default Intercom Recording policy. To do this:


2. Select Default iTurret Recording from the list box.

28


This displays the Default iTurret Recording options.

3. Select the Stream #1 tab to display its settings.

4. Select the voice recording policy created earlier from the Primary Recorder list box.

5. Type the voice recording port number in the Primary Port text box and click Apply. Please ensure the port number matches the Device1Port setting under the ThirdPartyDevice section within the CDS.ini file. For more information, see ThirdPartyDevice Section on page 35.

Connect the iCDS Server network service to the Default Call Logging policy. To do this:

6. Ensure Policies is selected on the side menu.

7. Select Default Call Logging from the list.

This displays the Default Call Logging options.

8. Select the iCDS Server network service created earlier from the Primary iCDS Server list box and click Apply.

29


Ensure the Default Call Logging and Default Intercom Recording policies are attached to the iTurret Deskstation. To do this:

1. Select the Deskstations side menu and click the required iTurret Deskstation.

This displays the iTurret Deskstation’s tab settings.

2. Select the Recording tab for the iTurret Deskstation.

3. Ensure the Call Logging Policy option is set to Default Call Logging.

4. Ensure the Recording Policy option is set to Default iTurret Recording.

5. Click Apply if required.

30


Using iCDS Monitor for Testing & Diagnostic Purposes

This section will describe how to test the configuration of the CDS.ini file (completed in the Configuring the iCDS File section on page 22) and iManager configuration (completed in the iManager Configuration section on page 23). For more information and description on the all the options within the iCDS Monitor application, see iCDS Monitor Application on page 36.

1. Start the iCDS Monitor application.

This displays the IP address and port number options. These are required to connect to the iCDS Server application.

2. Type the IP address and port number of the server used to run the iCDS Application in the IP Address and Port text boxes respectively. Click OK.

The iCDS Monitor should now be connected to the iCDS Server application.

3. Expand the iCDS Server tree option to display the Settings and Threads options.

4. Double click the Threads option to display the Threads dialog

31


5. Ensure the (i) iCDS Server Thread and iCDS Monitor Thread status’ are Running and (ii) 3rd Party Device status’ are Running - Connected.

You should also notice that the deskstation and voice recorder configured earlier is connected to the iCDS Server Application. This is indicated within the tree structure.

The number in the brackets for Devices indicate the number of connected deskstations. The deskstation’s IP address and port number is also displayed when the Devices option is expanded.

The number in the brackets for 3rd Party Devices indicate the number of connected voice recorders. The voice recorder’s IP address and port number is also displayed when the 3rd Party Devices option is expanded.

32


Uninstalling the iCDS Server ApplicationTo uninstall the iCDS server application:

1. Open Add or Remove Programs through the Windows Control Panel.

2. Select iCDS from the list of currently installed programs and click Remove.

3. Confirm you wish to remove the iCDS Server Application by selecting OK on the Confirm Uninstall information box.

This displays the InstallShield wizard.

33


Click Next.

The iCDS InstallShield wizard will now begin uninstalling the iCDS Server Application.

The InstallShield wizard below is displayed when the uninstallation process is complete.

You will also notice the iCDS Server Application has been removed from the Add or Remove Programs software list.

34


Screen ReferenceThis section describes the parameters and functions on both the iCDS Configuration file and iCDS Monitor Application.

iCDS Configuration FileThe iCDS Configuration File is used to specify the configuration parameters for the iCDS server. The default configuration file location is C:\Program\Speakerbus Technology Ltd\bin. The exact filename description is CDS.ini. It is located in the same folder directory as the iCDS server executable file (CDSServer.exe). When opened, the .ini file has two sections: [iCDS] and [ThirdPartyDevice]. These two sections are described in more detail below.

iCDS Section

The iCDS section comprises of the following settings: ServerIPAddress, DeviceServerPort, ThirdPartyServerPort and MonitorPort. These settings are described below. Changes to the ini file may require the iCDS server service to be restarted. Please refer to the information for each setting for details of which settings require a restart of the iCDS server service. Below is an example of the parameters and syntax used for the iCDS settings.

ServerIPAddress=10.1.1.10



MonitorPort=8850

ServerIPAddress

This is the IP address used by the iCDS server to listen for device and third party connections. When the machine running the iCDS has multiple network adapters, specifying a specific IP address in this setting will force the iCDS server to only listen on one specific adapter. If this setting is blank the iCDS server will listen on all available network adapters. The iCDS Server service must be restarted for changes to this setting to take effect. Below is an example of the parameter and syntax used for ServerIPAddress setting.

ServerIPAddress=10.1.1.10

DeviceServerPort

This is the port number that the iCDS server uses to listen for device connections. The default value is 7788. The iCDS Server service must be restarted for changes to this setting to take effect. Below is an example of the parameter and syntax used for DeviceServerPort setting.


35


ThirdPartyServerPort

This is the port number that the iCDS server uses to listen for third party device connections. The default value is 7789. The iCDS Server service must be restarted for changes to this setting to take effect. Below is an example of the parameter and syntax used for ThirdPartyServerPort setting.


MonitorPort

This is the port number that the iCDS server uses to listen for iCDS monitor connections. The default value is 8850. When no value is set the monitor port is disabled. To change this at runtime, the setting must be configured as blank first, saved, and then a new value entered and saved. Below is an example of the parameter and syntax used for MonitorPort setting.

MonitorPort=8850

LogCDR_Events

This option is used for logging CDR messages for diagnostic purposes. Please note that enabling this may cause iCDS performance issues, especially if the configuration contains a large number of iTurret Deskstations. For this reason, this should only be enabled if instructed to do so by a member of the Speakerbus Technical Operations Team.

In new installations from software version 2.2 and above the CDS.ini file within the [iCDS] section will contain the following string by default:

LogCDR_Events=0

The 0 in the above string means CDR message logging is disabled.

The 0 needs to be replaced with a 1 as shown below to enable CDR message logging.

LogCDR_Events=1

Entering anything other than 1 after the = symbol will default CDR message logging.

Please note that if the iCDS software has been upgraded from a pre 2.2 software version to software version 2.2 and above, you will need to manually change the CDR message string from LogCDR_Events=true to either LogCDR_Events=0 or LogCDR_Events=1.

ThirdPartyDevice Section

This section details the configuration for third party device connections, (for example, call loggers and voice recording devices). The details of each connection must be configured in this section. The iCDS server can accommodate up to sixteen third party device connections. The sixteen third party device connection parameters and syntax is laid out in the iCDS

36


configuration file. An example of the parameter detail for the first third party device connection looks as follows:

Device1Protocol=Client

Device1IP=10.1.1.10

Device1Port=8000

The above will almost be identical for other third party device connections accept where each parameter has the number ‘1’ after the word ‘Device’, the number ‘2’ for example, will be used for the second third party device connection. As previously mentioned above a maximum of sixteen third party device connections can be accommodated. The line parameters (DeviceXProtocol=, DeviceXIP=, and DeviceXPort) are described in the sections below.

DeviceXProtocol

Where X is the arbitrary third party device number, this is the protocol used to the third party device. This should be set to Client when the iCDS server connects to the third party device, UDPClient when iCDS connects to a third party using UDP or Server when the third party device connects to the iCDS server. Please contact the voice recorder vendor for what this setting should be set to. A blank setting disables this device connection. The iCDS Server service must be restarted for changes to this setting to take effect.

DeviceXIP

Where X is the arbitrary third party device number, this is the IP address of the third party device. A blank setting disables this device connection. The iCDS Server service must be restarted for changes to this setting to take effect.

DeviceXPort

Where X is the arbitrary third party device number, this is the port number of the third party device. A blank setting disables this device connection. The iCDS Server service must be restarted for changes to this setting to take effect.

iCDS Monitor ApplicationIntroduction

The iCDS Monitor Application is a diagnostic tool used to test the connection of the iCDS Server Application with connected deskstations and voice recorders. This section will describe:

● how to start the iCDS Monitor Application, and

● the parameter settings within the application.

37


Starting the iCDS Monitor Application

When attempting to start the iCDS Monitor application the screen the main graphical user interface application is displayed.

A small dialog, Connect to iCDS Server, is also displayed. Below is an explanation of what is required in the text box options:

● The IP Address - The IP address in this option needs to match the IP address used to run the iCDS Server application.

● Port - The port number in this option needs to match the port number used to run the iCDS Server application. The port number can be obtained from the CDS.ini file alongside the MonitorPort option.

Lastly, the OK button needs to be selected when the IP address and port number has been typed into the IP Address and Port text boxes respectively.

Tree Structure Description

The iCDS Monitor Tree Structure has three main sections: iCDS Server, Devices and 3rd Party Devices. The iCDS server refers to the iCDS Server application. Devices refers to deskstations and can include iD 712 or / and iTurret deskstations. These three sections are described further below.

38


iCDS Server

The iCDS Server tree structure has two options when expanded: Settings and Threads. These two options are fully explained below.

Settings Dialog

The Settings information dialog is displayed when one double clicks the Settings tree option. This action displays the Settings dialog which contains a number of read only settings. Most of these settings can be changed in the CDS.ini Configuration file. For more information, see iCDS Configuration File on page 34.

The above read only options are described below.

● iCDS Server IP Address - This is the IP address used by the iCDS server to listen for device and third party connections. When the machine running the iCDS has multiple network adapters, specifying a specific IP address in this setting will force the iCDS server to only listen on one specific adapter. If this setting is blank the iCDS server will listen on all available network adapters.

● Device Server Port - This is the port number that the iCDS server uses to listen for device connections. The default value is 7788.

● Third Party Server Port - This is the port number that the iCDS server uses to listen for third party device connections. The default value is 7789.

● Monitor Port - This is the port number that the iCDS server uses to listen for iCDS monitor connections. The default value is 8850. When no value is set the monitor port is disabled.

● Heartbeat Interval - This is the interval time period the device sends a heartbeat to the third party voice recorder. The interval period is 60 seconds. If the device does not receive a heartbeat from the third party voice recorder within 60 seconds the socket to the voice recorder is closed.

● Device Timeout - This is the timeout period in seconds for the device heartbeat to the iCDS Server Application. The timeout period is 90 seconds. If the device does not receive a heartbeat within 90 seconds the

39


socket to the iCDS Server Application is closed.

Threads Dialog

The Threads dialog is displayed when one double clicks the Threads tree option. Its main purpose is to provide a real time visual indication of connected and running components. Components being the iCDS Server Application, iCDS Monitor Application and Third Party Voice Recorders.

Below provides a description of the parameters and settings:

● Thread - This column details the different threads and described below.

● iCDS Server Thread - This option refers to the iCDS Server Application and contains a green indicator when it is running and a red indicator when it is not running.

● iCDS Monitor Thread - This option refers to the iCDS Monitor Application and contains a green indicator when it is running and a red indicator when it is not running.

● 3rd Party Device Thread - This option refers to the third party voice recorder and contains a green indicator when it is running and a red indicator when it is not running. The iCDS Server Application can accommodate a maximum of sixteen voice recorders.

● Status - This column contains the following status: Running, Running - Connected and Not Running.

● Message Queue - This is a real time count of the message waiting to be sent to the iCDS Server Application. Most of the time the value should be 0 or very low. If the number is high this may indicate a message traffic issue.

40


Devices

Devices Dialog

The Devices tree structure when expanded displays connected deskstations (iD 712s and iTurrets). The IP address and port number of the connected deskstation is displayed within the tree structure. Double clicking the link displays the Device dialog. An illustration of this dialog is shown below.

The available settings in the above dialog are listed and described below.

● IP Address - This displays the IP address of the deskstation.

● Port - This displays the port number of the deskstation.

● Protocol Version - This displays the deskstation version number.

● User id - This displays the extension of the deskstation.

● Username - This displays the name of the person who owns the user id or extension number.

● Connected - This displays the date and time when the iCDS Server Application connected to the deskstation.

● Last Message Received - This displays the date and time the device last sent a message to the iCDS Server Application.

● Sequence Number - Sequence numbers are displayed in the blank space in the bottom half of the Device dialog. The sequence number refers to an events undertaken by the connected deskstation.

41


3rd Party Devices

The 3rd Party Devices tree structure when expanded displays connected third party voice recorders. The IP address and port number of the connected voice recorder is displayed within the tree structure. Double clicking the link displays the 3rd Party Device dialog. An illustration of this dialog is shown below.

The above read only options are described below.

● IP Address - This is the IP address of the voice recorder. A blank setting disables this device connection.

● Port - This is the port number of the voice recorder. A blank setting disables this device connection.

● Protocol - This is the protocol used to the third party voice recorder. This will be set to either Client when the iCDS server connects to the voice recorder, or Server when the voice recorder connects to the iCDS server. Please contact the voice recorder vendor for what this setting should be set to. A blank setting disables this device connection.

● Connected - This displays the date and time when the iCDS Server Application connected to the third party voice recorder.

● Last Message Sent - This displays the date and time the voice recorder last sent a message to the iCDS Server Application.

● Send Queue - This is a real time count of the message waiting to be sent to the iCDS Server Application. Most of the time the value should be 0 or very low. If the number is high this may indicate a message traffic issue.

© Speakerbus Technology Limited 2014

Registered Office: Fourways House, 4 - 10 Ware Road, Hoddesdon, Hertfordshire EN11 9RS

Registered in England No: 04415859

iCDS Installation and Configuration Guide · 5 iCDS Installation & Configuration Guide About this...

Documents

Transcript of iCDS Installation and Configuration Guide · 5 iCDS Installation & Configuration Guide About this...