TeamCall Server Getting Started Guide

This document describes the installation, testing and troubleshooting of TeamCall Server for UNIX and Windows NT platforms using a PBX with an Ethernet interface and is organized as follows:

1 Basic Requirements
1.1 PBX Requirements
1.2 Hardware and Software Requirements
2 Installation
2.1 Installation Under UNIX
2.2 Installation Under Windows NT
3 Configuring TeamCall Server
4 Testing
4.1 Starting TeamCall Server
4.2 Testing the Installation Using STLI
5 Troubleshooting
5.1 General Troubleshooting
5.2 Log files
5.3 Additional documentation

1 Basic Requirements

In order to install TeamCall Server the following minimum hardware and software are required:

1.1 PBX Requirements

TeamCall Server currently supports the following PBX types with an installed CSTA interface:

1.2 Hardware and Software Requirements

1.2.1 Hardware Requirements

Windows NT 4
UNIX

1.2.2 Software Requirements

1.2.2.1 Windows NT
1.2.2.2 UNIX

2 Installation

2.1 Installation Under UNIX

To unpack and install TeamCall Server under UNIX, follow these steps:

  1. Log in as "root".
  2. Copy the TeamCall Server binary package to a temporary location in your computer, e.g. /tmp.
  3. Extract the package using the commands "gtar" and "gzip":

    4. # gtar -xvpzf tcserver.tgz

    A directory "teamcall" will be created that contains the following two files and single directory:

    - CSTAServer (The TeamCall Server binary.)
    - Default.conf (The main configuration file.)
    - S99CSTAServer (Script used by init.)
    - tcdoc (Directory containing the TeamCall Server documentation as HTML files.)

  4. Change to the directory "teamcall" using the "cd" command:

    5. # cd teamcall

  5. Copy the binary file to a location where you usually install 3rd party software, e.g. /usr/local/bin or /opt/bin using the "cp" command:

    6. # cp -p CSTAServer /usr/local/bin/

  6. Copy the configuration file to a location where you usually install 3rd party configuration files, e.g. /usr/local/etc/:

    7. # cp -p Default.conf /usr/local/etc/

  7. Copy the directory containing the documentation to a location where you normally install 3rd party documentation files, e.g. /usr/local/doc using the "cp" command:

    8. # cp -pR tcdoc /usr/local/doc/

  8. Edit the configuration file "Default.conf" according to the description below to match your local network configuration.

2.2 Installation Under Windows NT

To install TeamCall Server on a computer running Windows NT, follow these steps: Before you begin, make sure you have the IP-address and the TCP/IP port number of the PBX handy.

  1. Log in as "Administrator".
  2. Unpack the content of the TeamCall.zip package to a temporary location of your hard disk like c:\temp\teamcall using e.g. WinZip.
  3. Double-click on "Setup.exe" to start the installation program.
  4. Follow the on-screen instructions.

    5. The following directories and files will be created in the installation path:

    - CSTAServer.exe (The TeamCall Server binary.)
    - Default.conf (The main configuration file.)
    - doc (Directory containing the TeamCall Server documantation as HTML files.)
    - logs (Directory containing the log files.)

3 Configuring TeamCall Server

Under UNIX, the TeamCall Server configuration file must be modified to match your local network requirements. Under Windows NT this is done during the setup process. Before editing the files, make sure you have the IP-address and the TCP/IP port number of the PBX handy.

To edit the configuraton file, follow these steps:

  1. Locate the configuration file "Default.conf".
  2. Launch your favorite text-editing application e.g. "vi".
  3. Open the file "Default.conf".
  4. Find the entry "cstaLinkAddress".
  5. Change the IP-address after "cstaLinkAddress" to the IP-adress of your PBX.
  6. Find the entry "logDir".
  7. Change the path after "logDir" to the directory where the TeamCall Server log files will be created.
  8. Find the entry "cstaLinkPort".
  9. Change the TCP/IP port after "cstaLinkPort" to the TCP/IP port number of your PBX. The default TCP/IP port number is 2555.
  10. Change the path after "logDir" to the directory where the TeamCall Server log files will be created.
  11. Save your changes and exit the text-editing application.

4 Testing

After you have installed and configured TeamCall Server you need to check that it works properly. To do so, you have to run TeamCall Server and perform a quick test.

4.1 Starting TeamCall Server

4.1.1 Starting TeamCall Server for Windows NT

If you are logged in after restarting your computer as suggested during installation, TeamCall Server should run. If you have not already restarted your computer, please do so now.

4.1.2 Starting TeamCall Server Under UNIX

Under UNIX, you can either start the TeamCall Server binary manually when you need it, or you can configure it to start automatically while booting.

4.1.2.1 Starting Manually

Follow these steps, to start TeamCall Server manually using the configuration file "Default.conf":

  1. Change to the directory, where you installed the TeamCall Server binary using the "cd" command.

    2. # cd /usr/local/bin

  2. Start the binary "CSTAServer" using the "-c" switch to provide the absolute path to the configuration file.

    3. # CSTAServer -c /usr/local/etc/Default.conf

    If the startup was successful, the following message should appear:

    CSTAApplication Created with following Configuration :
    logDir : /tmp
    cstaLinkAddress :
    cstaLinkPort : 2555
    servicePort : 7999
    netTspiPort : 26535
    stliPort : 8000
    adminAddress :
    debugLevel : 0
    deviceMonitorConfFile : ./DeviceMonitor.conf
    crossRefIdFile : /tmp/CrossRefIDs.def
    callLogEnabled : 0
    cstaLogEnabled : 0
    logRotation : 1
    securityEnabled : 1
    supportedRequests :
    snapshotDevicePeriod : 0
    minDebugLevel : 0
    maxDebugLevel : 9
    linkNewA6 : 1
    errorLogFile : /tmp/Error<5-digit number>.log
    deviceLogFile : /tmp/Devices<5-digit number>.log
    callLogFile : /tmp/Calls<5-digit number>.log
    cstaLogFile : /tmp/CSTA<5-digit number>.log

    Connecting to :2555 (IP )...
    SV added.
    STLI added.
    TAPI added.
    Connected to server.
    ===== BEGIN Adaptor description =====
    PBX:
    CSTA Phase:
    ===== END Adaptor description =====

    PBX link up

4.1.2.2 Automatically

You can also install TeamCall Server to start while your OS boots. Please note that this option is for experts only, since we only provide an example init script that must be configured and installed manually. It also requires knowledge of the specific boot process of the type of UNIX you are using. This will only work on Linux or Solaris systems. (On BSD-style systems, TeamCall Server can be started automatically by adding a line to an rc-script like /etc/rc.local, e.g. /usr/local/bin/CSTAServer &)

  1. Log in as "root".
  2. Change to the directory, where you unpacked the TeamCall Server package.

    3. # cd /tmp/teamcall

  3. Copy the file "S99CSTAServer" to a location where start-up scripts for the init process are kept.

    4. # cp -p S99CSTAServer /etc/rc.d/init.d

  4. Install the start-up script according to your version of init.
  5. Customize it according to your needs.
  6. You can also start and stop TeamCall Server manually using the script's start/stop switches, e.g.

    7. # /etc/rc.d/init.d S99CSTAServer start
    # /etc/rc.d/init.d S99CSTAServer stop

4.2 Testing the Installation Using STLI

Using a few simple STLI commands you can check if TeamCall Server works properly. Using STLI, you will place a call from one telephone to a second telephone, answer the call and hang up.

You will need to know the IP-address of the computer where TeamCall Server runs and the TCP/IP port number of the STLI interface. You can check the configured TCP/IP port number of the STLI interface next to the entry "stliPort" within the configuration file "Default.conf". The default TCP/IP port number is 8000. Also, you will need to have access to two telephones connected to the PBX. Windows NT users should start the "Command Prompt" application.

Use the following steps to connect to the STLI interface using the telnet command, place a call from one telephone to a second, answer the call and hang up:

  1. Start telnet with the IP-address of the computer where TeamCall Server runs on, followed by a space and the TCP/IP port number of the STLI interface.

    2. # telnet 192.168.0.1 8000

    The following message should appear:

    Trying 192.168.0.1...
    Connected to 192.168.0.1.
    Escape character is '^]'.

  2. Start a Monitor for two telephones connected to the PBX, e.g. 100 and 101.

    3. MonitorStart 100

    The following message should appear:

    error_ind SUCCESS MonitorStart

    MonitorStart 101

    The following message should appear:

    error_ind SUCCESS MonitorStart

  3. Place a call from telephone 100 to telephone 101 using the MakeCall command.

    4. MakeCall 100 101

    The following message should appear and telephone 101 should ring.
    Please note that the numbers shown in this example may differ from the messages you receive.

    error_ind SUCCESS MakeCall
    Initiated 100 makeCall
    DeviceInformation 100 1 (0070:initiate)

  4. Pick up the receiver from telephone 100 using the AnswerCall command.

    5. When using a PBX from Alcatel, please note that this step is only necessary, if the auto-answer mode is disabled for this telephone. When using a PBX from Siemens, this step can be omitted.

    AnswerCall 100

    The following message should appear and telephone 100 should ring:

    error_ind SUCCESS AnswerCall
    Originated 100 newCall 100 101 ""
    DeviceInformation 100 1 (0070:connect)
    Delivered 100 newCall 101 100 101 ""
    DeviceInformation 100 1 (0070:connect)
    Delivered 101 newCall 101 100 101 ""
    DeviceInformation 101 1 (0070:alerting)

  5. Answer the call at telephone 101 using the AnswerCall command.

    6. AnswerCall 101

    The following message should appear:

    error_ind SUCCESS AnswerCall
    Established 101 newCall 101 100 101 ""
    DeviceInformation 101 1 (0070:connect)
    Established 100 newCall 101 100 101 ""
    DeviceInformation 100 1 (0070:connect)

    Now, telephone 100 and telephone 101 are connected.

  6. Terminate the connection using the ClearConnection command.

    7. ClearConnection 100

    The connection should terminate and the following message should appear:

    error_ind SUCCESS ClearConnection
    ConnectionCleared 100 normalClearing 100 {}
    DeviceInformation 100 0 ()
    ConnectionCleared 101 normalClearing 100 {101}
    DeviceInformation 101 1 (0070:connect)
    ConnectionCleared 101 normalClearing 101 {}
    DeviceInformation 101 0 ()

  7. Quit the STLI session using the BYE command.

    8. BYE

    The following message should appear:

    error_ind SUCCESS BYE
    Connection closed by foreign host.

5 Troubleshooting

5.1 General Troubleshooting

If the installation and start-up of TeamCall Server was successful, you should be able to connect to TeamCall Server's Supervisor interface, STLI interface and NetTSPI interface.

To check the availability of the above mentioned interfaces, follow these steps:

  1. Launch the text editing application of your choice.
  2. Open the Error.log file.
  3. Look for the following three entries:

    4. SV added.
    STLI added.
    TAPI added.

If one of the entries STLI added. or TAPI added. is missing, the connection to the STLI and/or the NetTSPI interface was unsuccessful. A networking problem may have occurred. Check the IP-address of the TeamCall Server and the TCP/IP port numbers of the STLI and NetTSPI interfaces within the "Default.conf" configuration file. You should also check your networking configuration.

5.2 Log files

TeamCall Server logs all of its activities in four different log files when activated and configured within the "Default.conf" configuration file. Only turn on the logging mechanism to debug an error and remember to turn this feature off when no longer needed.

To enable the logging mechanism, follow these steps:

  1. Locate the configuration file "Default.conf".

    2. On a computer running Windows, the file "Default.conf" is located in the installation path.

  2. Launch your favorite text-editing application.
  3. Open the file "Default.conf".
  4. Find the entry "callLogEnabled".
  5. Change the value after "callLogEnabled" to 1 in order to activate call logging.
  6. Find the entry "cstaLogEnabled".
  7. Change the value after "cstaLogEnabled" to 1 in order to activate CSTA logging.

The log files have the following names:

Error log file: Error[<5-digit number>].log
Device log file: Devices[<5-digit number>].log
Calls log file: Calls[<5-digit number>].log
CSTA log file: CSTA[<5-digit number>].log

The Error log file contains everything to be written to stdout. The logging mechanism does not need to be turned on as described above for the error logging feature. The Error log file is created automatically when an error occurs.

The Device log file contains information about the status of the monitored telephones (devices).

The Calls log file contains information about the calls and the telephones that are connected to these calls and their status.

The CSTA log file contains the plain ASN.1 messages that are exchanged between the CSTA Server and the PBX.

The number of messages written to the log files depend on the debug level set within the "Default.conf" configuration file. To learn more about debug levels, please see the main documentation.

5.3 Additional documentation

You will find additional and more detailed documentation within the "tcdoc" directory. To read it, simply launch the web browser of your choice and open the file "index.html".

© 2000 ilink Kommunikationssysteme GmbH
Große Hamburger Straße 32
D-10115 Berlin, Germany
Phone: +49 30 28526-0
Fax: +49 30 28526-199
info@ilink.de
www.ilink.de