avistar c3 call control™1 avistar c3 call control™ 1 1 avistar c3 call control™ 1.1...

Date 10/13/1963

Avistar C3 Call Control™

Administrators Guide

Release 2.0

Avistar C3 Call Control™ Administrators Guide

ii Avistar C3 Connect™ XML API Reference Guide

Important Notices

Copyrights and Trademarks copyrighted material of Avistar Communications Corporation, © 1994-

2012 The Software may also contain copyrighted materials licensed to

Avistar by (i) Microsoft © 2011-2012; (ii) Paradial AS © 2008 – 2011; (iii) Vanguard Software Solutions Inc. © 1995-2011; (iv) Nalpeiron Inc., © 2008 – 2011; and (v) Intel Corporation © 2007 – 2009. Use of

the Software is subject to the terms of the applicable End User License

Agreement ("EULA") included with the Software. All rights reserved.

Avistar, the Avistar logos, Avistar Systems, Avistar C3, Avistar C3

Communicator, Avistar C3 Unified, Avistar C3 Desktop, Avistar C3

Integrator, Avistar C3 Conference, Avistar C3 Tunnel Server, Avistar

C3 Connect, Avistar C3 Command, Avistar C3 Media Engine, vBrief,

Shareboard, AvistarVOS, and World on the Desktop are trademarks or

registered trademarks of Avistar Communications Corporation. All

other names used are the trademarks of their respective owners.

Avistar's products are manufactured under certain US and Avistar's

products are manufactured under the certain US and International

patents a complete list of which can be view at:

<http://www.avistar.com/company/default.aspx?id=74>. Other

pending published patent applications maybe relevant. Portions of the

Avistar products are manufactured under the AVC Patent Portfolio

license and are licensed for the for the personal use of a consumer or

other uses in which it does not receive remuneration to (i) encode video

in compliance with the AVC Standard (“AVC Video”) and/or (ii)

decode AVC Video that was encoded by a consumer engaged in a

personal activity and/or was obtained from a video provider licensed

to provide AVC Video. No license is granted or shall be implied for

any other use. Additional information may be obtained Additional

information may be obtained from MPEG LA, L.L.C. See

http://www.mpegla.com.

In addition, portions of the Software may contain royalty-free

copyrighted material ("Freeware") of the following licensors, copyright

holders and their contributors ("Owners").

Copyright (c) 2001-2003 Ant-Contrib project. Ant-Contrib (subject to

Apache v1.1 Software License). Apache Tomcat; Apache XML RPC;

Commons beanutils; Commons codec; Commons collection; Commons

fileupload; Commons HTTP client; Commons io; Commons lang;

Commons logging; Commons net; Derby; EZMorph; jain-sip; Json-lib;

log4j; Opencsv; OpenJPA; Quartz; Apache Velocity Engine; all

Copyright © 1999-2010, The Apache Software Foundation (subject to

Apache Software v2.0 January 2004). antlr Copyright (c) 2003-2008

Terence Parr. ASM Attribute classes Copyright (c) 2000-2005 INRIA,

France Telecom. Boost.copyright of Boost Software License - Version

1.0 - August 17th, 2003. Bouncy Castle. Copyright © 2000-2009 The

Legion of Bouncy Castle (http://www.bouncycastle.org)

dnsjavaCopyright (c) 1999-2005, Brian Wellington.

expat Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center

Ltd. jaxenCopyright 2003-2006 The Werken Company.

jQueryCopyright(c) 2010 John Resig, http://jquery.com/

libsrtp Copyright (c) 2001-2005 Cisco Systems, Inc.

SLF4J (API); SLF4J (Log4J);SLF4J (Full) all Copyright (c) 2004-2008

QOS.ch. Speex © 2002-2003, Jean-Marc Valin/Xiph.Org Foundation.

YUI © 2010 Yahoo!, Inc. WiX © 2005-2010 Microsoft Corporation.

(Subject Common Public License v1.0). hibernate AG45 Copyright (C)

1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth

Floor, Boston, MA 02110-1301 USA. (subject LGPL v2.1 February

1999). hibernate AG45; hibernate-annotations; hibernate-commons-

annotations; hibernate-entitymanager; all Copyright (C) 1991, 1999 Free

Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA

02110-1301 USA. (subject LGPL v2.1 February 1999)

c-ares Copyright 1998 by the Massachusetts Institute of Technology.

zLib Copyright (C) 1995-2010 Jean-loup Gailly and Mark Adler

OpenLDAP Copyright 1999-2003 The OpenLDAP Foundation,

Redwood City,California, USA+AG53. OpenSSL Copyright Copyright

(c) 1998-2008 The OpenSSL Project. (C) 1995-1998 Eric Young

([email protected]) © Tim Hudson ([email protected]).

IPP Software. Intel Corporation © 2007 – 2009

Polycom® Siren 14 (a.k.a. G.722.1c) audio codec. Copyright © Polycom,

Inc. ASG.WEB.CUM.EDU © 2001 Carnegie Mellon University

Computing Services at Carnegie Mellon University

(<http://www.cmu.edu/computing/>) and John Meyers, Netscape

Corporation (subject LGPL v2.1 February 1999)

Mobicents Sip Servlets (jain); (sip); (stun4) (mail) all © 2003-2010

Mobicents and individual contributors (subject to LGPL License v2.1 -

1999). OPAL and PTLIB © 2008 - 2010 Craig Southern and Robert

Jongbloed (Subject to Mozilla v1.0 License)

Windows SDK Copyright (c) 2006 Microsoft Corporation. All Rights

Reserved. MS SQL JDBC © 2005-2010 Microsoft Corporation

The PHP License, version 3.01 Copyright (c) 1999 - 2006 The PHP

Group. All rights reserved. Independent JPEG Group (c) 1991-1998,

Thomas G. Lane.

Unless otherwise noted above (i.e. where the Freeware is subject to

specific named license agreements), permission is hereby granted by

the Owners, free of charge, to any person obtaining a copy of Software

to deal in the Software without restriction, including without limitation

the rights to use, copy, modify, merge, publish, distribute, sublicense,

and/or sell copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to strict adherence to the

following conditions:

(i) The above copyright notice, listing each Copyright Holder, and this

permission notice along with the disclaimer notice in (iii) below shall be

included in all copies or substantial portions of the Freeware.

(ii) The Freeware is provided by the Owners "AS IS" AND ANY

EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY

AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED,

INCLUDING ANY WARRANTIES OF MERCHANTABILITY AND

FITNESS. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT

OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR

OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR

PERFORMANCE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

POSSIBILITY OF SUCH DAMAGE.

(iii) The name of the Owners may not be used to endorse or promote

products derived from this software without specific prior written

permission of the Owners.

(iv) Disclaimer Notice - Redistribution and use of this software in

source and binary forms, with or without modification, is permitted

provided that the following conditions are met: Redistributions must

retain the above copyright notice, the above list of conditions and

disclaimers in all copies.

Version Information Avistar Part Number 20-05-1115-2.0 February 2012

Avistar Communications Corporation

1875 South Grant Street

Suite 1000

San Mateo, CA 94402

Voice +650.525.3300

Fax +650.525.1360

http://www.avistar.com

Avistar Technical Support

In the U.S.A. and Canada 1.800.803.0153

All other countries +650.525.3333

[email protected]

iii

Table of Contents

1 Avistar C3 Call Control™ ........................................................................................... 1

1.1 Introduction ........................................................................................................................ 1

1.2 Features ............................................................................................................................... 2

1.3 About This Manual ............................................................................................................ 2

2 Installation ..................................................................................................................... 3

2.1 Installation Prerequisites .................................................................................................. 3

2.1.1 Host Specifications ........................................................................................................ 3

2.1.2 Scalability Considerations ............................................................................................ 4

2.1.3 Selecting Databases ....................................................................................................... 4

2.1.4 Installation Files ............................................................................................................. 5

2.1.5 Initial Account Details .................................................................................................. 5

2.2 Running the Installer ......................................................................................................... 6

2.3 Installing the License File ................................................................................................. 9

2.4 Uninstalling Avistar C3 Call Control™ .......................................................................... 9

3 Starting Avistar C3 Call Control™ .......................................................................... 10

3.1 Check C3 Call Control Services ..................................................................................... 10

3.2 Log In ................................................................................................................................. 10

3.3 The Dashboard ................................................................................................................. 11

3.4 The Navigation Bar .......................................................................................................... 11

4 Monitoring ................................................................................................................... 12

4.1 Monitoring SIP Registrations ......................................................................................... 12

4.1.1 Filtering the Endpoint List ......................................................................................... 12

4.1.2 Unregistering an Endpoint ......................................................................................... 12

4.1.3 Viewing Registration Details ..................................................................................... 13

4.2 Monitoring Current Calls ............................................................................................... 13

4.2.1 Displaying Current Calls ............................................................................................ 13

4.2.2 Viewing Call Details ................................................................................................... 14

4.2.3 Ending a Call ................................................................................................................ 14


iv

5 Configuration .............................................................................................................. 15

5.1 System ............................................................................................................................... 15

5.1.1 Viewing System Information ..................................................................................... 15

5.1.2 Importing a Software License .................................................................................... 15

5.1.3 Saving Configuration Settings ................................................................................... 16

5.2 Settings .............................................................................................................................. 17

5.2.1 Administration Settings .............................................................................................. 18

5.2.2 Registration Settings ................................................................................................... 18

5.2.3 SIP Settings ................................................................................................................... 18

5.2.4 Network Settings ......................................................................................................... 19

5.3 Certificates ........................................................................................................................ 20

5.3.1 Importing an HTTPS Certificate ................................................................................ 21

5.3.2 Importing a TLS Certificate ........................................................................................ 21

5.3.3 Certificate Verification ................................................................................................ 22

5.3.4 Importing a Trusted ROOT Authorities Certificate ................................................ 22

5.4 Domains ............................................................................................................................ 23

5.4.1 Adding a Domain ........................................................................................................ 24

5.4.2 Editing a Domain ......................................................................................................... 25

5.5 Routes ................................................................................................................................ 26

5.5.1 Routes Information...................................................................................................... 26

5.5.2 Adding a Route ............................................................................................................ 26

5.6 Avistar C3 Command™ .................................................................................................. 27

5.6.1 The Avistar C3 Command™ Page ............................................................................ 27

5.6.2 Configuring Avistar C3 Command™ ....................................................................... 28

5.7 H.323 .................................................................................................................................. 29

5.7.1 The H.323 Page ............................................................................................................ 29

5.5.2 Configuring the H.323 Gateway and Gatekeeper ................................................... 30

5.8 Database ............................................................................................................................ 31

5.8.1 CAA Log Data .............................................................................................................. 32

5.8.2 Call Logging Database ................................................................................................ 32

6 Users .............................................................................................................................. 35

6.1 Administering User Accounts ........................................................................................ 35

6.1.1 Adding a New User .................................................................................................... 35

6.1.2 Editing an Existing User ............................................................................................. 37

6.1.3 Removing a User ......................................................................................................... 37

6.2 Administering User Roles............................................................................................... 38

v

6.2.1 Viewing Role Descriptions ......................................................................................... 38

6.2.2 Administering Role Assignments ............................................................................. 39

6.3 Administering User Aliases ........................................................................................... 39

6.3.1 Configuring H.323 Aliases ......................................................................................... 39

6.3.2 Importing an H.323 Alias File .................................................................................... 40

7 Reports .......................................................................................................................... 42

Appendix: Call Logging Database Schema .................................................................. 44

Call Control Logging Database ................................................................................................... 49


0

1 Avistar C3 Call Control™

1

1 Avistar C3 Call Control™ 1.1 Introduction

Avistar C3 Call Control™ is a flexible and robust SIP server that provides full videoconferencing support for Avistar clients, including Avistar C3 Unified™ and Avistar C3 Communicator™, as well as for third-party SIP clients.

The diagram below shows Avistar C3™ Call Control with Avistar C3™ endpoints and other Avistar C3™ server products:

The Avistar C3 Conference™ solution is an industrial-strength, software-only MCU that makes it easy and cost-effective to deploy multiparty business-class videoconferencing.

The Avistar C3 Command™ solution is an intelligent, flexible bandwidth management solution that enables videoconferencing to scale to thousands of users without requiring significant new network investments.

The Avistar C3 Tunnel™ solution is an all-software, standards-compliant, scalable firewall traversal solution with an encrypted pathway to safeguard transmissions outside the company and no VPN requirement.


2

1.2 Features

Avistar C3 Call Control™ includes the following features:

SIP endpoint registration

Shared Domain Management with other Avistar C3 Call Control servers

Domain-based routing

Web-based management and monitoring of registrations and active calls

Support for encrypted signaling using transport layer security (TLS), which has been added in release 2.0, and certificate management

Seamless integration with Avistar C3 Command™ bandwidth management

H.323 to SIP bridge with H.323 user extensions for SIP clients

Logging of all usage and system data to a Microsoft SQL server configuration/access/audit (CAA) database.

Call detail reporting

Optional internal database for small to medium business applications, up to 500 endpoints

Three levels of administrative access using Windows domain authentication and local system authentication: Viewer, Administrator, and Superuser.

1.3 About This Manual

This document lists the prerequisites for installing Avistar C3 Call Control™ and tells how to install the program. It then describes the features and functions of the Avistar C3 Call Control™ program.

This manual is intended for Avistar software installers and Avistar network administrators. It assumes reasonable familiarity with networking terms and concepts and with your own enterprise network.

2 Installation

3

2 Installation 2.1 Installation Prerequisites

Before you run the installer, verify that you are completely prepared:

Check your host system specifications

Obtain the installation and licensing files

Select a CAA database type, and if necessary, set up an external database

Optionally, set up an external database for call logging

Decided on the username and password of the initial account

2.1.1 Host Specifications

The host computer on which you install Avistar C3 Call Control™ must meet these requirements:

Resource Requirement

Operating system Microsoft Windows Server 2008

CPU Dual core processor or higher required for operation.

Memory Minimum 2 GB

Disk space At least 5 GB available (with logging enabled)

Network interface Single, 100 Mbps full-duplex Ethernet TCP/IP local network connection

Privileges Administrator privileges are required for installation

Databases Internal database (included) or Microsoft SQL Server 2008 database

(optional) to support call logging (configured after installation)

Virtual servers Supported; requires dedicated resources

Scalability The above configuration supports up to 500 users with as many as 250

concurrent calls. Additional processing power and memory is required for

increased scalability. See the following section.

Web-browser Internet Explorer v7.0 – v9.0

Firefox v3.5 – v10.0


4

2.1.2 Scalability Considerations

The default installation of Avistar C3 Call Control™ is designed for minimal processor and memory resources. The table below shows the CPU, memory and environment settings recommended for different deployments:

Maximum Number of Users

Maximum Concurrent Calls CPU

Application Memory

Environment Configuration Settings

1000 500 Quad-core processor at 2.0

GHz or higher

2 GB JvmMx=512

5,000 2,500 Dual CPU Intel Xeon

X5450 processor at 3.0

GHz or higher

4 GB JvmMx=1024

10,000 5,000 Dual CPU Intel Xeon

X5450 processor at 3.0

GHz or higher

4 GB JvmMx=1224

Use the table above to determine the processor and memory requirements for your deployment. In addition, administrators must tune the Avistar C3 Call Control™ configuration based on the scalability requirements.

For deployments greater than 1000 users, run REGEDIT to modify the default JvmMx values. Here is the location of the JvmMx environment configuration settings:

Registry Key Location: HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software

Foundation\Procrun

2.0\AvC3CallControl\Parameters\Java

Value Name: JvmMx (value must be in decimal measurement)

Before editing the environment configuration settings, stop the Avistar C3 Call Control™ MS Windows service. After the settings have been changed, start the Avistar C3 Call Control™ MS Windows service.

2.1.3 Selecting Databases

Avistar C3 Call Control™ uses two separate databases:

1. A configuration/access/audit (CAA) database

2. A call logging database

2.1.3.1 CAA Database

Before starting the installation process, determine the type of configuration/access/audit (CAA) database best suited for your deployment.

2 Installation

5

Installation allows the selection of either an internal database or an external Microsoft SQL server database for storing configuration and state information.

For small to medium installations, where the number of registered endpoints is not expected to exceed 500, the Avistar C3 Call Control™ internal database, added in release 1.1, is suitable.

For installations intended or expected to support more than 500 endpoint registrations, an external SQL server is recommended to store configuration, accounts, and audit logs. Create the SQL database and both installation and operation accounts and passwords before installing Avistar C3 Call Control™. The database account for installation must have the following permissions: db_datareader, db_datawriter, and db_owner. The database account for operations must have the following permissions: db_datareader and db_datawriter.

Either database can support up to 500 users. For deployments intended to support more than 500 users, Avistar recommends installing with Microsoft SQL as the CAA database.

2.1.3.2 Call Logging Database

If you wish to log call detail records, during the installation you need to enter the database name and account information for the external SQL Server database that you plan to use for call logging.

2.1.4 Installation Files

Avistar provides these files for installation:

C3CallControlSetup.msi

An XML license file, such as C3CallControl-license.xml

Obtain the installation file from Avistar Support. For installation, place it on an available network drive or on a local device, such as a USB flash drive.

Contact Avistar Support to obtain your license file. If you are deploying Avistar C3 Call Control™ on more than one server, obtain a license file for each server.

2.1.5 Initial Account Details

The installation program requires you to set up an initial administration account. Avistar recommends that you enter your own username,


6

domain and password initially. You can add additional administrators using the program web-based user interface at a later date.

2.2 Running the Installer

Avistar C3 Call Control™ uses a standard Windows installer file. Upon activation, the installer checks the host machine to ensure that it meets minimum requirements and that no previous versions of Avistar C3 Server™ or Avistar C3 Connect™ software are installed.

1. Log in to the host machine as Administrator.

2. Double-click the installer file, C3CallControlSetup.exe, to start the installation wizard.

3. After accepting the license agreement, choose a destination folder for Avistar C3 Call Control™, or click Next to accept the default location.

4. Configure port values for HTTP, HTTPS, SIP and SIPS communication. The defaults are 80, 443, 5060 and 5061, respectively. If any of these values are in use on the machine on which you are installing the program, you are prompted to enter different port values.

2 Installation

7

If the Avistar C3 Call Control™ installer reports a conflict with port 80, check to determine if the World Wide Web Publishing Service has been installed and is currently running on your target host machine. The default port for the WWW Publishing Server is port 80. Because Avistar C3 Call Control™ performance recommendations are based on a dedicated machine, Avistar recommends that you abort your Call Control installation and disable the WWW Publishing Service first. When you restart the Avistar C3 Call Control™ installation process, the default selection of port 80 should be accepted. If your particular deployment requires that your host machine run WWW Publishing Services, select a different port for Avistar C3 Call Control™ during the installation.

5. Select a required CAA database type: a. Use Internal Database for Avistar C3 Call Control This is the default selection for Avistar C3 Call Control™ installations. The internal database is a convenient for small companies with a limited number of users. For installations expected to grow beyond 500 users, a dedicated Microsoft SQL server is recommended for optimal performance. b. Use Microsoft SQL Server for Avistar C3 Call Control Enter SQL database information: database server, database name, installation account and password, operation account and password.


8

See section 2.1.3, above, for more information about CAA database requirements and types.

6. If you wish to log call detail records, enter the database name and account information for the external SQL server database that you plan to use for call logging. This information is also required when upgrading Avistar C3 Call Control™. Although the option for Enable external logging can be disabled during an installation or upgrade and then manually configured using the Avistar C3 Call Control™ web GUI, if the option is disabled during an upgrade, logging is also disabled after the upgrade.

7. Configure the initial default administration account. The initial account specified during installation has Superuser rights.

8. Click Next. The installation program then verifies the user account information. If the account name or password cannot be verified, the installation cannot continue.

9. Click Install. You may be prompted to restart the host system to complete the installation.

2 Installation

9

2.3 Installing the License File

Avistar C3 Call Control™ requires a valid license. The license is in the form of an XML file. Contact Avistar Support to obtain your license file. If you are deploying Avistar C3 Call Control™ on more than one server, obtain a license file for each server. The license requires the fully qualified name and the MAC address of the host server.

License installation, described in section 5.1.2 on page 15, is accomplished after the program is installed, through the web-based administration program.

2.4 Uninstalling Avistar C3 Call Control™

To uninstall Avistar C3 Call Control™, go to Control Panel > Programs

and select Uninstall a Program. Select Avistar C3 Call Control™ 2.0 from the program list, and click Remove.


10

3 Starting Avistar C3 Call Control™ 3.1 Check C3 Call Control Services

After successful installation, the following services should be running on your server host machine:

Avistar C3 Call Control

Avistar C3 Connect

To verify that the services are running, open the Window Server Administration Tools > Services window. You should see the above services listed there.

3.2 Log In

To log in to the Avistar C3 Call Control™ web interface:

1. Click on the Avistar C3 Call Control™ shortcut on your desktop. Or you can open a web browser. In the browser’s address line, enter the IP address or host name of the Avistar C3 Call Control™ server, as shown in this example:

NOTE: Avistar C3 Call Control™ uses HTTPS. Unless a custom port is

defined during installation, the default port of 443 is assumed when

connecting.

2. The Avistar C3 Call Control™ login page opens. Enter your username, password, and domain information. Then click Login.

The program opens, displaying the Dashboard.

3 Starting Avistar C3 Call Control™

11

3.3 The Dashboard

The Dashboard is where you monitor the overall system status of Avistar C3 Call Control™. You can view the number of active calls and local registrations, as well as basic system information and status.

Note that the figures showing the number of Concurrent Calls and Local

Registrations link to corresponding pages in the Monitoring section.

3.4 The Navigation Bar

At the top of every Avistar C3 Call Control™ page is a navigation bar:

Links in navigation bar links open pages of the major program functions, described in the remaining sections of this guide.

Links to

Monitoring

pages


12

4 Monitoring

In the Monitoring section, you can monitor registered endpoints and calls.

4.1 Monitoring SIP Registrations

Choose Monitoring > Registrations to see all endpoints registered through their client software, such as Avistar C3 Unified™, Avistar C3 Communicator™, or some other H.232 endpoint client software with this local instance of Avistar C3 Call Control™.

NOTE: Only local SIP registrations appear in the Registrations list. SIP

registrations on remote Avistar C3 Call Control™ servers, even if

multiple servers are configured to manage the same domain, are not

displayed.

You can view the name, security status, address, and connection duration associated with each endpoint, filter the endpoint list, or unregister an endpoint.

4.1.1 Filtering the Endpoint List

You can filter the list of registered endpoints by the name of the user currently logged in on each registered endpoint , or the SIP address of the endpoint.

1. Select whether to filter by Name or [SIP] Address.

2. Type characters in the entry field. As you enter characters, the list is filtered to show only endpoints whose name (first or last) or address starts with those characters.

4.1.2 Unregistering an Endpoint

You can remove an endpoint from registration on this server and end any active calls for that endpoint. Simply click the Unregister link under the Action heading at the far right.

NOTE: This function is available only to Administrators or Superusers.

4 Monitoring

13

4.1.3 Viewing Registration Details

To view details about a registered endpoint, select the endpoint row in the Registrations list in the upper part of the screen.

The Details tab in the lower part of the screen shows the following information for the selected endpoint:

Display Name Typically the Windows login name of the endpoint user

SIP Connection TLS

SIP Address The SIP address an endpoint would call to contact the selected endpoint.

Contact URI The resolved address for the registered endpoint.

User Agent User agent information depends on the endpoint client application. Examples: Avistar C3 Unified client AVSR-C3-ME/2.0.1.40 Avistar C3 Conference AVSR-C3-Conference/3.2.0.55

Connected Since Time the endpoint started the current connection.

4.2 Monitoring Current Calls

Avistar C3 Call Control™ can display information about current calls if at least one of the participating endpoints is registered with the local instance of the program.

4.2.1 Displaying Current Calls

To open the Calls page, select Monitoring > Calls. The calls are displayed in a table with each row representing a call between two endpoints. Each row shows the call originator and recipient, call state (Active, Ringing, Hold, Disconnecting), encryption status (lock icon), start time and duration of the call, and an End Call action button.


14

4.2.2 Viewing Call Details

To view the details of a call, select a row in the Current Calls list.

The Details tab shows the following information about the selected call:

Call ID A unique string generated for each call.

Next Hop The next Call Control server, SIP Server, or “originator server” if local.

Media Displays either Media Encrypted or Media Unencrypted depending on negotiated call

Originator Display name of the client initiating the call.

Recipient Display name or SIP address of the call recipient.

SIP ID Unique SIP identification string and IP address. Each participant in the call is assigned a unique SIP ID.

SIP Address

The SIP AOR (Address of Record) for both originator and recipient.

Contact URI

The resolved SIP addresses for both originator and recipient.

User Agent

Client and version information obtained from the SIP records for both originator and recipient.

4.2.3 Ending a Call

To end a current call, click End Call under the Action heading at the far right of the Current Calls list.

NOTE: This function is available only to Administrators or Superusers.

5 Configuration

15

5 Configuration

The Configuration section of Avistar C3 Call Control™ gives you a wide range of configuration selections and options:

NOTE: Only Administrators and Superusers can add or modify

Configuration settings and options.

5.1 System

5.1.1 Viewing System Information

The Configuration > System page displays the following information:

From this screen you can add or update a product license(Import) and a download a summary of the system configuration.

5.1.2 Importing a Software License

The license file specifies an expiration date and the MAC address of the host machine. To install or update your license, follow these steps:


16

1. Go to Configuration > System.

2. Click Import at the bottom of the screen.

3. Your browser may ask that you verify your desired action. Then the Upload License box opens.

Enter the filename and location of the new license. Click Browse if necessary to locate the file on your machine.

4. Click Import.

Avistar C3 Call Control™ verifies the new license file before it replaces an existing license file.

5.1.3 Saving Configuration Settings

You can save all Avistar C3 Call Control™ configuration settings to a text file for troubleshooting purposes. The file lists all the static information displayed in all the Configuration pages.

1. In the Configuration > System page, click Download Configuration.

2. Your browser asks what to do with this downloaded file – open it or save it. If you decide to save the file a standard Save As dialog can be used to change the default file name or destination folder as needed. Check your browser configuration if you are not prompted with a Save As dialog.

5 Configuration

17

5.2 Settings

In the Settings page you can view and manage user account time limits, registration time limits, and network settings.

To configure general Avistar C3 Call Control™ system settings:

1. Choose Configuration > Settings.

2. Click Edit. The Edit Settings screen opens. Screen clips are shown in the following sections that describe the setting options.

3. Configure Administration, Registration, SIP or Network settings as needed.

4. Click Save to save changes or Cancel to exit without saving changes.


18

5.2.1 Administration Settings

Inactive accounts suspend after. The time limit, in days, after which a user account becomes inactive if the user does not log in to Avistar C3 Call Control™. Range is 1-365 days; default value is 60 days.

NOTE: This setting does not affect users who are set to Not Expire in their

user settings. The default administrator account created during

installation is automatically configured to never expire. See section

6.1 on page 35for more information.

Inactive sessions expire after. The time limit in minutes, after which administrative sessions expire. Range is 1-60 minutes; default value is 30 minutes.

5.2.2 Registration Settings

Registration expires after. Time limit after which registration sessions expire. Range is 5-1440 minutes; default value is 10 minutes.

5.2.3 SIP Settings

Inactive SIP session timeout. The time limit after which SIP sessions are removed. Range is 1- 24 hours; default value is 8 hours.

5 Configuration

19

Ringing timeout The time limit SIP calls are allowed to ring before being terminated by the server. Range is 30 - 86400 seconds; default value is 120 seconds.

5.2.4 Network Settings

Only two network settings are configurable in this screen.

UDP/TCP Port. Default port setting is 5060.

TLS Port. Disabled by default (as shown above). Default port is 5061. If the Administrator attempts to enable the TLS port before installing a valid certificate for secure communication (i.e., TLS) a warning appears, as shown in the screen shot portion below.


20

Network Adapter. The dropdown list shows network adapters for each configured IP address. If your host machine has multiple NIC cards installed, select the network adapter that corresponds to the IP address used by clients and servers on your network to connect to Call Control.

5.3 Certificates

Certificates are used to support both encryption and authentication. For encryption, certificates provide a secure method to exchange password “keys” shared only between the two host machines establishing the connection. For authentication, a certificate can identify what generated the certificate. For additional security, certificates can be rejected if the authority that generated the certificate is not trusted.

Avistar C3 Call Control supports the following types of certificates:

Name Alias Usual Extension

Could Contain Suitable for

PKCS #12

Personal Information Exchange

PFX pfx Certificates,

private keys

HTTPS, TLS,

trusted roots

PKCS #7

Cryptographic Message Syntax

Standard

P7B p7b Certificates Trusted roots

5 Configuration

21

Name Alias Usual Extension

Could Contain Suitable for

PEM

Base64-encoded X.509

– cer Certificates,

private keys

HTTPS, TLS,

trusted roots

DER

DER-encoded binary X.509

– cer Certificates,

private keys

HTTPS, TLS,

trusted roots

JKS

Java keystore

– – Certificates,

private keys

HTTPS, TLS,

trusted roots

5.3.1 Importing an HTTPS Certificate

Browser sessions to administer Call Control require a secure session using HTTPS. Call Control installs a default HTTPS certificate to enable access initially, but Avistar recommends replacing the default HTTPS certificate with one generated by a Trusted Root Authority. This recommendation applies even for deployments where Call Control is only accessed internally.

5.3.2 Importing a TLS Certificate

For secure registration of endpoints, media encryption, and encrypted communication with remote servers, Call Control requires installing a valid TLS certificate before additional ports and configuration options for TLS can be enabled. When a certificate is generated for HTTPS, the same certificate can also be imported for TLS.


22

5.3.3 Certificate Verification

For additional security, Call Control can be configured to only maintain connections with servers presenting certificates generated by hosts configured as a Trusted Root Authorities in Call Control. Before Verify

Certificates can be enabled, at least one certificate from a machine serving as a Root Authority must be imported into the Trusted Root Authorities portion of the Certificate configuration page.

If Verify Certificates is not enabled, a valid TLS certificate is still required for secure communication but, even if a Trusted Root Authority certificate has been imported, certificates are not checked to verify they were generated by one of the Trusted Root Authorities.

It is possible to deploy self-generated certificates throughout an organization and disable Verify Certificates if there are no security concerns about server connections within the deployment.

5.3.4 Importing a Trusted ROOT Authorities Certificate

Call Control supports importing as many Trusted Root Authority certificates as needed for your organization. In practice, most deployments configure a single machine as Trusted Certificate Authority (Trusted CA). The Trusted Certificate Authority is used to generate the required certificates. Depending on your deployment, you may require certificates for multiple Call Control servers, C3 Conference, and C3 Command. By importing a certificate from the Trusted CA that created those certificates into the Trusted Root

Authorities section in each server, communication among multiple servers can be verified and secure without risk of an unauthorized server maintaining a connection.

Because the process to generate certificates for each host machine is somewhat involved, Avistar does not require endpoints registering with Call Control to present a certificate. When TLS and Verify Certificates are enabled, Call Control still accepts connections without requiring a certificate to be presented for the connection. This practice enables endpoints to register securely without requiring a certificate to be generated for every host machine where endpoint software is installed.

5 Configuration

23

For connections that attempt communication other than registration, the connection is dropped if the configuration in Call Control either requires a certificate and none is presented or if the certificate presented is not from a recognized (imported) Trusted Root Authority.

5.4 Domains

Avistar C3 Call Control™ can serve as a SIP registrar and SIP proxy for one or multiple domains. Use settings in the Domains section to configure those domains you to want manage in this program. Endpoint registrations are only allowed for domains that you configure as managed domains.

The upper Domains section of the screen shows currently managed domains, including domain name and status (Active or Disabled). Links in the Action column on the right enable you to edit domain settings and to disable or remove a managed domain.

The lower Servers section of the screen shows any other Avistar C3 Call Control™ servers associated with the selected domain, including server hostname, a checkmark if the connection to the remote Call Control should use TLS, and status (Active, Disabled or Invalid). Links in the Action column enable you to Enable/Disable or Remove a server.


24

5.4.1 Adding a Domain 1. Select Configure > Domains.

2. In the Domains (upper) section, click Add Domain. The Add Domain dialog box opens:

3. Enter the domain name in the Domain field.

4. If you are configuring a single Call Control server, you need not enter its name. Simply click Save to add the domain to the list of domains managed by Call Control. If you are deploying two or more Call Control servers to manage the same domain, enter the hostname of the first server in the Server field and Click Add.

5. Repeat the previous step for each additional server associated with the domain name. Server names accumulate in the box titled Other

servers managing this domain.

6. For the added domain, check the Use Secure Signaling (TLS) box to enable TLS for the domain.

7. To remove one or more servers that you have added, select the server(s) and click Remove. Keep in mind, when the confirmation box appears, that the important word is selected, not all.

5 Configuration

25

8. Click Save when you finish adding a domain and server(s).

5.4.2 Editing a Domain

Editing an existing domain is similar to adding a domain, described above.

In the Action column of the (upper) Domains section, select Edit. This box opens:

You can add servers, remove existing servers, and enable or disable TLS for a selected server.


26

5.5 Routes

In the Routes page (Configure > Routes) you can enable Avistar C3 Call Control™ to route call requests to endpoints in domains managed by other SIP servers.

5.5.1 Routes Information

The Routes page displays each configured route in its own row. Each row shows the Host (server name or IP address), Domain name, whether TLS is required, whether media encryption is allowed (a lock icon) and Status (Active, Disabled or Invalid).

The Action column has links so you can Edit, Disable, or Remove a configured route. For a disabled route, the configuration information is preserved, but no registration queries or call invites are sent to the server specified in that route.

You can sort the displayed routes by the Domain or Host columns. Click a column heading to make that the sort column. Click the heading again to reverse the sort order: for example, if the Domain column is the current sort column, you can display domains in forward or reverse alphabetical order.

5.5.2 Adding a Route

Click Add Route to create a new route entry in the list.

5 Configuration

27

In the Add Route dialog, enter the domain name and the associated server name or IP address. Both fields are required and must consist of a valid domain name and either a hostname or an IP address

If you enable Use Secure Signaling (TLS), you can then select to Reject or Allow Unencrypted Media Requests.

5.6 Avistar C3 Command™

5.6.1 The Avistar C3 Command™ Page

Avistar C3 Call Control™ supports bandwidth management when configured to operate with Avistar C3 Command™. Choose Configure >

Avistar C3 Command to display the status of Avistar C3 Command™.

The first three parameters in the Avistar C3 Command™ page are described in section 5.6.2, following. Here are descriptions of the last two parameters:


28

Status. Confirms connectivity after Avistar C3 Command™ is first configured, then monitors the connection. Status may be Active,

Inactive (disabled) or Not Responding, depending on whether bandwidth management is enabled or disabled and whether Avistar C3 Command™ is responding.

Last Response. Displays the date and time for either the last response to a call routed to Avistar C3 Command™ for bandwidth management, or the last connectivity ping to Avistar C3 Command™ that received a response.

5.6.2 Configuring Avistar C3 Command™

To set or modify Avistar C3 Command™ settings, click Edit to open the configuration dialog:

Avistar C3 Command™ Hostname. The hostname of the Avistar C3 Command™ server. When entering hostname information, you can also enter a port number, in the format <hostname>:<port>. If no port is entered, the port number defaults to 5062.

Bandwidth Management. Enabled or Disabled. If Disabled, Avistar C3 Call Control does not send call requests to Avistar C3 Command to check for available bandwidth.

Contingency Mode. Determines Avistar C3 Call Control™ behavior if the Avistar C3 Command™ server is not available.

5 Configuration

29

5.7 H.323

Avistar C3 Connect™, a SIP- to-H.323 gateway, is installed by default along with Avistar C3 Call Control™ on your host machine. The Avistar C3 Connect™ gateway allows registered SIP endpoints to call H.323 endpoints and H.323 endpoints to call registered SIP endpoints (if an H.323 alias has been configured for the SIP endpoint’s SIP address).

5.7.1 The H.323 Page

The H.323 page (Configuration > H.323) shows configuration of the H.323 gateway and gatekeeper:

The gateway Q931 and H.245 settings are their operational ports. Gateway and gatekeeper status settings may be Up, N/A, Down. Other parameters are described in section 5.7.2, following.


30

5.5.2 Configuring the H.323 Gateway and Gatekeeper

Click Edit to open the H.323 configuration window:

In the two sections of this window, you can enable or disable the gateway and the gatekeeper and enter or modify their settings.

Internal Calls Alias Separator. Choose a separator from the pull-down list. The separator is used to parse internal H.323 calls and identify the user alias extension.

Outgoing Calls H.323 Dialrule. Enter a string here. This prefix identifies SIP calls that should be routed to Avistar C3 Connect™ to be placed as outgoing H.323 calls.

See section 6.3 on page 39 for more information about H.323 aliases.

Gatekeeper address. If you have deployed an H.323 gatekeeper on the premises to manage H.323 calls, enter the IP address of the gatekeeper to support Call Control routing of H.323 calls to the gatekeeper.

Gateway prefix. Enter the prefix Call Control must use when registering with the gatekeeper. The gatekeeper uses this prefix to route calls from H.323 room systems to Call Control.

5 Configuration

31

5.8 Database

Avistar C3 Call Control™ supports two databases:

A required Configuration/Access/Audit (CAA) database stores configuration information, administrative account information, and audit logs. For small-to-medium installations (<500 endpoints), this database may be the internal database that comes integrated into Avistar C3 Call Control™. Larger installations (>500 endpoints) require an external SQL database, which is identified during program installation.

NOTE: Access to data in the required CAA database is by external

means only. Avistar C3 Call Control™ does not provide any

reports from this database.

A second, optional SQL database may be used to log call usage data. This Call Logging database can be specified during the installation or after Call Control has been installed.

Choose Configuration > Database to view database configurations.

The upper part of the screen shows information about the required CAA database; the lower part of the screen shows information about the optional Call Logging database.


32

5.8.1 CAA Log Data

The required CAA database logs the following information and configuration changes:

Administrator login attempts (username, domain, result, date/time)

Unregister Endpoint

End Call

Import License

Edit Settings

Add Domain

Remove Domain

Add Route

Remove Route

Edit C3 Command Configuration

Edit H.323 Configuration

Edit Database Configuration

Create User Account

Modify User Account

Delete User Account

Add H.323 Alias

Import H.323 Alias File

As mentioned before, this information must be accessed by external means. Avistar does not provide any reports from the CAA database.

5.8.2 Call Logging Database

The Call Logging database must be a pre-existing SQL database, with installation and operational accounts already set up. The Call Logging database records the following detailed information:

Each registration attempt processed by Avistar C3 Call Control™

Successful call, including call originator, call recipient, start and stop time, and bandwidth allocation

Unsuccessful call attempts (same information as for successful calls)

For details about the Call Logging database structure, see Appendix: Call

Logging Database Schema.

5.8.2.1 Configuring the Call Logging Database

If you did not configure an optional Call Logging database during program installation, you can configure one any time after installation.

1. Create a new database in Microsoft SQL Server 2008. Keep track of the database name and an account name and password that have permission to write to the database during configuration in Call Control.

2. In Avistar C3 Call Control™, choose Configuration > Database.

3. Click Edit to open the Edit Call Logging Database dialog box.

5 Configuration

33

4. Change Status to Enabled.

5. Enter the SQL Server name and confirm the default SQL Port (1433) of the computer hosting the database or click the Edit port box to change the port number in the field.

6. Enter the Database Name.

7. In the Database Account for Operation section at the bottom of the dialog box, enter the Account name and Password required to access the SQL database.

NOTE: These fields are only displayed when configuring the Call Logging

database for the first time or modifying the SQL server, port, or

database name.


34

5.8.2.2 Reconfiguring Databases During a Software Upgrade

If you upgrade Avistar C3 Call Control™, be prepared to supply account information during the upgrade process for any SQL (external) database that you use.

If you are using an external SQL database for the required CAA database you must provide account and password information during the upgrade.

If you have configured an optional call logging database, during an upgrade you are prompted for the database name, account and password used for the this database as well.

If you uncheck the option for Enable external logging during the upgrade process, call logging is disabled when you restart. You can enable call logging after the upgrade by reconfiguring the Call Logging database, as described in the previous section.

6 Users

35

6 Users

Choose Users > Users to view current user accounts.

For any selected user in the Users list, additional information appears in the Details section below. Links in the Action column open an Edit or Remove dialog for the selected user, as described in section 6.1, below.

Enter a letter in the Filter by Last Name field to display only users whose names start with that letter. Enter additional letters to make the filter more specific.

6.1 Administering User Accounts

You can add users and then edit or remove them.

6.1.1 Adding a New User

When you click Add New User, a dialog similar to this opens in front of the Users screen:


36

1. Fill in all the starred (*) fields. The other fields are optional. All fields can be edited later, except Login ID and Domain.

2. In the Login ID field, type the user's Windows login username.

3. Select the Domain from the domains listed in the pull-down menu.

4. Enter the user's first and last names

5. Enter the email address if desired.

6. In the Client Ref ID field, you may insert any ID used by your organization as a unique employee identifier.

6 Users

37

7. The Division, Job Function, and Title fields contain optional information that may be helpful.

8. Select one or more roles (Viewer, Administrator, Superuser) for the new user. A user may have more than one role. See section 6.2 for information about user roles.

9. An Active user can log into and administer Avistar C3 Call Control™ according to his assigned role. If a user is not active, his account information remains in the program database, but he does not have access to the program and to administrative functions.

10. Click Yes in Not Expire for a certain number of users to grant them immunity from having their account expire if they don't log in after the specified number of days (see the System Settings tab). The account of at least one Super User must not be allowed to expire, to prevent the possibility (however remote) of all users being locked out of the system.

When you have filled in the fields, click Save. The new user is added to the list of users in the Users page.

6.1.2 Editing an Existing User

Here you can change the role assignment and update personal information about existing users. To edit a user:

11. Click on a line to select a user.

12. Do one of the following:

Click the Edit link in the Action column.

Click the Edit button in the Details area.

The Edit User dialog opens. It is structured just like the Add User

dialog shown in section 6.1.1, above.

13. When you finish making changes, click Save.

6.1.3 Removing a User 1. Click on a line to select a user.

2. Do one of the following:

Click the Remove link in the Action column.

Click the Remove button in the Details area.

3. When prompted to delete the user, click Yes.


38

6.2 Administering User Roles

Roles define the privileges of users. Avistar C3 Call Control™ supports three levels of administrative roles: Viewer, Administrator, and Superuser.

6.2.1 Viewing Role Descriptions

Choose Users > Roles > Details to view user roles. Click on a role in the top part of the screen to view the privileges associated with that role.

Shown below are the specifics of the Superuser role, which has the most privileges. Administrators and viewers each have a subset of Superuser privileges.

6 Users

39

6.2.2 Administering Role Assignments

Choose Users > Roles > Users to view a list of users assigned to any one role.

1. Select a role in the upper Roles section of the page. A list of users assigned to that role appears below:

2. In the Action column, click Remove to remove the currently selected role from a user. Any remaining roles for that user are left unchanged. Because every user must have at least one role, the sole or last remaining role of a user cannot be removed.

Users' names are linked to their information in the Users tab.

6.3 Administering User Aliases

You can create H.323 aliases for Avistar C3 Call Control™ endpoints in the Users > Aliases screen. The use of aliases enables direct routing of calls from outside H.323 room systems to Avistar C3 client software and compatible third-party SIP clients.

6.3.1 Configuring H.323 Aliases

The Aliases screen displays the endpoint name, SIP address, and H.323 address for each configured alias. In the Action column you can Edit or Remove an alias.

Click Add to open the Add Alias dialog box, where you can create a new alias.


40

In the Add dialog, enter the endpoint SIP address of record (AOR), name information, and extension number. Extensions must be a numeric string (up to 12 digits), without spaces or other characters.

To search for an alias, enter the first and/or any subsequent letters or numbers of the alias name or SIP address in the Filter by field. As you enter letters or numbers, the list is filtered to show only aliases whose name or address starts with those characters.

You can also create aliases in a batch process by importing an Excel file. See 6.3.2 Importing an H.323 Alias File, below.

6.3.2 Importing an H.323 Alias File

You can batch import H.323 aliases by adding entries to an Excel file and saving it as a CSV text file. Avistar C3 Call Control™ includes a sample Excel file with predefined H.323 alias column headers, shown below. This example file was installed in the program’s parent folder as H323_Alias_Import_Example.csv.

If the example file is opened in Notepad the entries look like this:

SIP Address,First Name,Last Name,Extension

[email protected],John,Baldwin,4158796352

[email protected],Kathy,Novak,4567

[email protected],Grant,Peterson,3333

[email protected],Videoconference 1,,2912345678

6 Users

41

The same file opened in a spreadsheet looks like this:

SIP Address First Name Last Name Extension

[email protected] John Baldwin 4158796352

[email protected] Kathy Novak 4567

[email protected] Grant Peterson 3333

[email protected] Videoconference 1 2912345678

The first header row is required in a file that you plan to import. The next four rows contain sample data. The sample data is ignored when importing and data is only imported starting from row six. Either enter data you want to import beginning with row six, using the example file provided, or create your own file with four rows of redundant data at the start after the header information.

1. Choose Users > Aliases.

2. In the Aliases screen, click Import.

3. In the dialog that opens, browse to the file location, then click Import.

NOTES:

Import files are limited to 10,000 lines.

The import operation checks lines for format and type errors, field

length, and duplicate extensions. Duplicate names are allowed.

After importing, Avistar C3 Call Control™ displays the number of

entries imported on a new browser page. An additional browser page

reports the number of entries successfully added, followed by all

erroneous entries, beginning with the entry’s line number in the

import file.


42

7 Reports

To help administrators troubleshoot user problems, Avistar C3 Call Control™ can generate a Call Detail report. The Call Detail report contains information on a specific user’s recent calls.

To enable Call Detail reporting, you must configure a call logging database first, either during initial program installation (see section 2.1.3 on page 4) or during program operation (see section 5.7.2 on page 32).

1. Choose Reports. This page opens:

2. Select a Time Range, either using presets from the pull-down list or by entering a start and end date.

3. Choose a filter option: by Name (first names and last names are searched) or by SIP AOR. Each character you enter further narrows the search. As characters are entered, matching names or SIP addresses are displayed in the list box below.

4. Make a selection from the filtered list of names or SIP AORs.

5. Click View.

A new browser window or tab opens to display the Call Detail Report for the selected user. The top section of the report contains a row for each call made by the user, showing the call recipient, start and stop time, and duration of the call.

7 Reports

43

For a selected row, the Details section of the report shows SIP ID and address information and URI information for both the caller and the call recipient.


44

Appendix: Call Logging Database Schema

CAA Database

Avistar C3 Call Control™ logs call usage data in the following SQL database tables:

CC_DOMAINS

The CC_DOMAINS table stores served domains:

Column Name Column Type Value

DomainId INT,

Primary Key

Unique identifier of domain, primary key.

Name NVARCHAR(128),

NOT NULL

Domain name. Unique value.

Disabled CHAR(1),

NOT NULL

Specifies if domain is disabled or not. Contains 'Y'

or 'N' character.

CC_SERVERS

The CC_SERVERS table stores servers that are also serving our domains:


ServerId INT,

Primary Key

Unique identifier of server, primary key.

DomainId INT,

NOT NULL,

Foreign Key

Domain identifier, foreign key to DOMAINS table.

Hostname NVARCHAR(128),

NOT NULL

Hostname of server that also serves specified

domain name. Unique value.

Disabled CHAR(1),

NOT NULL

Specifies if server is disabled or not. Contains 'Y' or

'N' character.

Tls CHAR(1),

NOT NULL

Indicates if server requires communication over

TLS (‘Y’) or not (‘N’). Default value is ‘N’

CC_ROUTES

The CC_ROUTES table stores routing rules:


45


RouteId INT,

Primary Key

Unique identifier, primary key.

Domain NVARCHAR(256),

NOT NULL

Domain name.

Host NVARCHAR(256),

NOT NULL

Host to which we forward requests if request URI is

addressed to specified domain.

Disabled CHAR(1),

NOT NULL

Specifies if route is disabled or not. Contains 'Y' or

'N' character.

Tls CHAR(1),

NOT NULL

Indicates if route requires TLS communication (‘Y’)

or not (‘N’). Default value is ‘N’

MediaEncryption CHAR(1),

NOT NULL

Indicates if route has media encryption support

enabled (‘Y’) or not (‘N’)

CC_REGISTRATIONS

The CC_REGISTRATIONS table stores endpoints’ registrations:


RegistrationId BIGINT,

Primary Key

Unique identifier of registration, primary key.

AOR NVARCHAR(256),

NOT NULL

Address of record to register.

DisplayName NVARCHAR(256) Display name of registered user.

DomainId INT,

NOT NULL,

Foreign Key

Domain identifier, foreign key to DOMAINS table.

Requester NVARCHAR(256),

NOT NULL

From header value of register request.

CallId NVARCHAR(MAX),

NOT NULL

Call-ID header. Client uses the same value to

refresh registration.

CSeq BIGINT,

NOT NULL

CSeq header to skip late requests.

ContactURI NVARCHAR(MAX),

NOT NULL

Client Contact URI.

Expires INT,

NOT NULL

Indicates how long the UA would like the binding to

be valid for. The value is a number indicating

seconds.

Priority INT,

NOT NULL

Priority of the particular contact.


46


RegistrationTime DATETIME,

NOT NULL

Time of the first register request.

UpdateTime DATETIME,

NOT NULL

Last update time.

UserAgent NVARCHAR(MAX),

NULL

Contains value of User-Agent header.

Tls CHAR(1), NOT NULL Indicates if endpoint registered using TLS (‘Y’) or

not (‘N’). Default value is ‘N’

A new record is added to this table on every successful registration, and updated during refresh registration request. Additional records are added if REGISTER request contains multiple contact addresses.

CC_SIGNALING_INFO

The CC_SIGNALING_INFO table stores information about call signaling (SIP) for originators and recipients for active calls:


SignalingId CHAR(32),

Primary Key

Unique identifier generated by application, primary

key.

RequestURI NVARCHAR(MAX),

NOT NULL

Request URI of incoming/outgoing request.

DisplayName NVARCHAR(256),

NULL

Display name from From header if entity represents

incoming message, otherwise it’s display name

from To header.

Uri NVARCHAR(256),

NOT NULL

URI from From header if entity represents incoming

message, otherwise it’s URI from To header.


NULL

URI from Contact header. It can be NULL and

updated later if additional responses contain it.


NOT NULL

Value of Call-ID header.

Route NVARCHAR(MAX),

NULL

The route set for the call. The route set may be

updated by Route headers in outgoing messages

(to remove hops of C3 Command and link to us).

This property includes zero or more SIP URLs

separated by pairs of CR LF characters

(\u000D\u000A).

RecordRoute NVARCHAR(MAX), The route set for the call. The route set may be


47


NULL updated by Record-Route headers in incoming

messages. This property includes zero or more SIP

URLs separated by pairs of CR LF characters

(\u000D\u000A).

Vias NVARCHAR(MAX),

NULL

The set of Via header fields for the call. This

property returns a non-empty value only if one or

more SIP requests are received for this call. This

property includes zero or more SIP Via header field

values separated by pairs of CR LF characters

(\u000D\u000A).

UserAgent NVARCHAR(64),

NULL


InviteResponseCod

e

INT, NULL Contains response code for SIP INVITE.

InviteResponseMes

sage

NVARCHAR(256),

NULL

Contains response message for SIP INVITE.

InviteWarningCode INT, NULL Contains warning code for SIP INVITE. Only valid

for calls that fail and return a response with a

Warning header field; NULL otherwise.

InviteWarningHost NVARCHAR(64),

NULL

Contains warning host for SIP INVITE. Only valid



InviteWarningMess

age

NVARCHAR(256),

NULL

Contains warning message for SIP INVITE. Only

valid for calls that fail and return a response with a


A new record is added to this table for every new originator or new recipient.

CC_CALLS

The CC_CALLS table stores call history:


CallId CHAR(32),

Primary Key

Call identifier, primary key. The value is

automatically generated by Call Control engine for

new call.

OriginatorId CHAR(32),

NOT NULL,

foreign key

Identifier of originator call signaling record,

foreign key to CC_SIGNALING_INFO.

RecipientId CHAR(32),

NULL,

foreign key

Identifier of recipient call signaling record,

foreign key to CC_SIGNALING_INFO.


48


Status VARCHAR(32),

NOT NULL

String representation of CallStatus enumeration.

StartTime DATETIME,

NOT NULL

Start time of the call, in GMT. Must be indexed.

AcceptTime DATETIME,

NULL

The accept time of the call, in GMT. The accept

time is defined as the when Call Control receives

the 200 response to the INVITE for calls. It is NULL

if the call never gets answered.

CallRate INT,

NOT NULL

Call Rate of the call. It is updated if bandwidth is

limited by C3 Command or if re-INVITE is received.

MediaType VARCHAR(64),

NULL

String representation of MediaType enumeration.

BandwidthSessionId NVARCHAR(64) Identifier of the bandwidth session received from

C3 Command in special header.

Tls CHAR(1), NOT NULL Indicates if call was made using TLS (‘Y’) or not

(‘N’). Default value is ‘N’

A new record is added to this table for every call.

CC_H323_ALIASES

The CC_H323_ALIASES table stores mapping of H323 extension to AOR:


AliasId INT,

Primary Key

Unique identifier, primary key.

Extension VARCHAR(10),

NOT NULL

H323 extension. Unique value.

AOR NVARCHAR(256),

NOT NULL

Address of record associated with specified H323

extension.

FirstName NVARCHAR(64),

NOT NULL

User first name.

LastName NVARCHAR(64),

NULL

User last name.

CC_VERSION

The CC_VERSION table stores current database scheme:


Major INT, Major version number


49

NOT NULL

Minor INT,

NOT NULL

Minor version number

Call Control Logging Database

CC_REGISTRATION_HISTORY

The CC_REGISTRATION_HISTORY table stores history of endpoints’ registrations:


HistoryId BIGINT,

Primary Key

Unique identifier of history record, primary key.

Host NVARCHAR(256),

NOT NULL

C3 Call Control hostname to separate logs from

different servers

AOR NVARCHAR(256),

NOT NULL

Address of record to register.

DisplayName NVARCHAR(256) Display name of user.

Requester NVARCHAR(256),

NOT NULL

From header value of register request.


NOT NULL

Call-ID header. Client uses the same value to

refresh registration.

CSeq BIGINT,

NOT NULL

CSeq header of the last request.


NOT NULL

Client Contact URI.

Expires INT,

NOT NULL

The last expires value. The value is a number

indicating seconds. It’s zero for un-registration

request.

Priority INT,

NOT NULL

Priority of the particular contact.

RegistrationTime DATETIME,

NOT NULL

Time of the first register request.

UpdateTime DATETIME,

NOT NULL

Last update time.

ExpirationTime DATETIME,

NOT NULL

Time when registration expires.

UserAgent NVARCHAR(MAX),

NULL


SipResponseCode INT, Contains response code sent to client for


50


NULL REGISTER request.

UnregistrationTime DATETIME,

NULL

Time of un-registration. It’s time of un-register

request or time when contact was expired.

Unregistration

Reason

VARCHAR(64),

NULL

Reason of un-registration. Value is string

representation of UnregistrationReason

enumeration.

Tls CHAR(1), NOT NULL Indicates if endpoint was registered using TLS (‘Y’)

or not (‘N’). Default value is ‘N’

A new record is added to this table on every registration, and it is updated during refresh registration request.

CC_SIGNALING_HISTORY

The CC_SIGNALING_HISTORY table stores information about call signaling (SIP) for originators and recipients:


SignalingId CHAR(32),

Primary Key

Unique identifier generated by application, primary

key.

RequestURI NVARCHAR(MAX),

NOT NULL

Request URI of incoming/outgoing request.

DisplayName NVARCHAR(256),

NULL

Its display name in From header if entity represents

incoming message, otherwise its display name in To

header.

Uri NVARCHAR(256),

NOT NULL

Its URI in From header if entity represents incoming

message, otherwise its URI in To header.


NULL

URI in Contact header. It can be NULL if recipient

contact is unknown, and it is updated late when

response contains it.


NOT NULL

Value of Call-ID header.

Route NVARCHAR(MAX),

NULL


updated by Route headers in outgoing messages (to

remove hops of C3 Command and link to us). This

property includes zero or more SIP URLs separated

by pairs of CR LF characters (\u000D\u000A).

RecordRoute NVARCHAR(MAX),

NULL


updated by Record-Route headers in incoming

messages. This property includes zero or more SIP

URLs separated by pairs of CR LF characters

(\u000D\u000A).


51


Vias NVARCHAR(MAX),

NULL

The set of Via header fields for the call. This

property returns a non-empty value only if one or

more SIP requests are received for this call. This

property includes zero or more SIP Via header field

values separated by pairs of CR LF characters

(\u000D\u000A).

UserAgent NVARCHAR(64),

NULL


InviteResponseCode INT, NULL Contains response code for SIP INVITE.

InviteResponse

Message

NVARCHAR(256),

NULL

Contains response message for SIP INVITE.

InviteWarningCode INT, NULL Contains warning code for SIP INVITE. Only valid



InviteWarningHost NVARCHAR(64),

NULL

Contains warning host for SIP INVITE. Only valid for

calls that fail and return a response with a Warning

header field; NULL otherwise.

InviteWarning

Message

NVARCHAR(256),

NULL

Contains warning message for SIP INVITE. Only

valid for calls that fail and return a response with a


A new record is added to this table for every new originator or new recipient.

CC_CALL_HISTORY

The CC_CALL_HISTORY table stores call history:


CallId CHAR(32),

Primary Key

Call identifier, primary key. The value is

automatically generated by Call Control engine for

new call.

Host NVARCHAR(256),

NOT NULL


different servers

OriginatorId CHAR(32),

NOT NULL,

foreign key

Identifier of originator call signaling record,

foreign key to CC_SIGNALING_HISTORY.

RecipientId CHAR(32),

NULL,

foreign key

Identifier of recipient call signaling record,

foreign key to CC_SIGNALING_HISTORY.

StartTime DATETIME,

NOT NULL

Start time of the call, in GMT. Must be indexed.


52


AcceptTime DATETIME,

NULL

The accept time of the call, in GMT. The accept time

is defined as the when Call Control receives the 200

response to the INVITE for calls. It is NULL if the call

never gets answered.

EndTime

DATETIME,

NULL

End time of the call, in GMT. Set to NULL if the call

is still in progress.

EndReason VARCHAR(64),

NULL

Records the reason for ending the call. Value is

string representation of EndReason enumeration.

CallRate INT,

NOT NULL

Call Rate of the call. It is updated if bandwidth is

limited by C3 Command or if re-INVITE is received.

SessionType VARCHAR(16),

NULL

Identifies the call by media type as Audio or Video.

It’s NULL if session type is undefined

BandwidthSessionId NVARCHAR(64) Identifier of the bandwidth session received from C3

Command in special header.

A new record is added to this table for every call. Several records are added with the same OriginatorId and with different RecipientId when AOR has multiple destinations.

CC_LOST_STATISTICS

The CC_LOST_STATISTICS table stores information lost statistics records:


LostId INT,

Primary Key

Lost statistics identifier, primary key. The value is

automatically generated for new records.

Hostname VARCHAR(256),

NOT NULL


different controllers

StartTime TIMESTAMP,

NOT NULL

Time of the first missed record, in UTC.

Reason NVARCHAR(MAX),

NOT NULL

Error description which cause lost records.

EndTime TIMESTAMP,

NOT NULL

Time when logging was restored, in UTC.

Count BIGINT,

NOT NULL,

DEFAULT 0

Number of missed records/updates.

A new record is added to this table when connection to database is restored, or just after queue overflow or after database error during call logging.


53

CC_LOGGING_VERSION

The CC_LOGGING_VERSION table stores current logging database scheme:


Major INT,

NOT NULL

Major version number

Minor INT,

NOT NULL

Minor version number

avistar c3 call control™1 avistar c3 call control™ 1 1 avistar c3 call control™ 1.1...

Documents