Clear-Com Concert for Newsroom User Manual
PN: 810557Z Rev: A OCT 01 12
Clear-Com Concert
Administrator Guide
V.2.7
TM
2
Administrator Guide
Document Reference
Clear-Com Concert Administrator Guide
Part Number: 810555ZG
Legal Disclaimers
Copyright © 2012 HME Clear-Com Ltd.
All rights reserved.
Clear-Com, the Clear-Com logo, and Clear-Com Concert are trademarks or registered trademarks of HM
Electronics, Inc.
The software described in this document is furnished under a license agreement and may be used only in
accordance with the terms of the agreement.
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be reproduced in any
form by any means without prior written authorization of Clear-Com, an HME Company.
Clear-Com Offices are located in California, USA; Cambridge, UK; Montreal, Canada; and Beijing, China.
Specific addresses and contact information can be found on Clear-Com’s corporate website:
www.clearcom.com
Clear-Com Contacts
Americas and Asia-Pacific Headquarters
California, United States
Tel: +1.510.337.6600
Email: CustomerServicesUS@clearcom.com
Europe, Middle East, and Africa Headquarters
Cambridge, United Kingdom
Tel: +44 1223 815000
Email: SalesSupportEMEA@clearcom.comf
Canada Office
Quebec, Canada
Tel: +1 (450) 653-9669
China Office
Beijing Representative Office
Beijing, P.R.China
Tel: +8610 65811360/65815577
3
Administrator Guide
Contents
1 Introduction ........................................................................................................... 5
2 Accessing the CMI ................................................................................................ 6
3 Administration ....................................................................................................... 7
3.1 Viewing version information for installed services ........................................................................... 7
3.2 Client version notification ................................................................................................................. 8
3.3 License information .......................................................................................................................... 9
3.3.1 License types ................................................................................................................................... 9
3.3.2 Viewing and updating your license ................................................................................................ 10
3.4 Access ............................................................................................................................................ 11
3.5 Viewing and configuring the Codec ............................................................................................... 11
3.6 Database ........................................................................................................................................ 12
3.6.1 Database backup ........................................................................................................................... 12
3.6.2 Database restore, download and remove ...................................................................................... 13
3.6.3 Uploading a database from a PC ................................................................................................... 13
3.7 Event log ........................................................................................................................................ 14
3.7.1 Collect Logs ................................................................................................................................... 14
4 Node ..................................................................................................................... 15
4.1 Adding and removing a node ......................................................................................................... 15
4.2 Modifying the details of a node ...................................................................................................... 15
4.3 IV-Routers ...................................................................................................................................... 16
4.3.1 Adding and removing an IV-R ........................................................................................................ 16
4.3.2 Modifying the details of an IV-R ..................................................................................................... 16
4.3.3 Information pages for each IV-R .................................................................................................... 17
4.4 Interface Gateway nodes ............................................................................................................... 18
4.4.1 Viewing the Interface Gateways page ........................................................................................... 18
4.4.2 Adding and removing an Interface Gateway node ......................................................................... 19
4.4.3 Modifying the details of an Interface Gateway ............................................................................... 21
4.4.4 Information pages for the Interface Gateway ................................................................................. 21
4.4.5 Associating a server channel to an unassigned device port .......................................................... 23
4.5 Eclipse Frame ................................................................................................................................ 24
4.5.1 Adding and removing an Eclipse Frame ........................................................................................ 24
4.5.2 Modifying the details of an Eclipse Frame ..................................................................................... 25
4.5.3 Information pages for the Eclipse Frame ....................................................................................... 25
5 Partition ................................................................................................................ 27
5.1 Adding and removing a partition .................................................................................................... 27
4
Administrator Guide
5.2 Modifying the details of a partition ................................................................................................. 27
5.3 Users .............................................................................................................................................. 27
5.3.1 Adding Concert users ..................................................................................................................... 28
5.3.2 Removing Concert users................................................................................................................ 30
5.3.3 Modifying the details of a Concert user .......................................................................................... 30
5.4 Roles .............................................................................................................................................. 30
5.4.1 Adding a role .................................................................................................................................. 31
5.4.2 Removing a role ............................................................................................................................. 31
5.4.3 Modifying the details of a role ........................................................................................................ 31
5.4.4 Managing role associations ........................................................................................................... 32
5.5 Conferences ................................................................................................................................... 33
5.5.1 Adding conferences ....................................................................................................................... 33
5.5.2 Removing conferences .................................................................................................................. 33
5.5.3 Modifying the details of a conference ............................................................................................ 34
5.5.4 Associating a conference with a role ............................................................................................. 34
5.5.5 Associating a conference with a channel ....................................................................................... 34
5.6 Client channels ............................................................................................................................... 35
5.6.1 Adding channels ............................................................................................................................. 35
5.6.2 Removing channels ........................................................................................................................ 36
5.6.3 Modifying the details of a channel .................................................................................................. 36
5.6.4 Associating a Client channel with a role ........................................................................................ 36
5.6.5 Associating a channel with a conference ....................................................................................... 37
5.6.6 Associating users with a channel ................................................................................................... 37
5.7 Server channels ............................................................................................................................. 38
6 Troubleshooting .................................................................................................. 39
6.1 Connection issues .......................................................................................................................... 39
6.2 Logging into the CMI ...................................................................................................................... 41
6.3 Licensing issues ............................................................................................................................. 44
6.4 Interface Gateway / Channel issues .............................................................................................. 45
6.5 Eclipse issues ................................................................................................................................ 47
6.6 Audio issues ................................................................................................................................... 48
5
Administrator Guide
1 Introduction
This guide is designed to help system administrators configure, manage and monitor Clear-Com
Concert™ (v2.7), a multi-user conferencing and intercom application.
The main administrative tool for Concert is the Concert Management Interface (CMI). The CMI
is used to administer the following system resources:
Users and user roles.
Conferences, channels and access to Clear-Com Eclipse.
Interface Gateway and IV-Router applications.
Codecs, licensing and event logging.
The CMI features a web-based interface and an AJAX-enabled navigation tree structure.
Note:
For all Concert v2.7 release software and documentation, see your Concert DVD.
For information specifically about installing and managing the Concert Server applications,
see the Concert Server Installation Guide.
System requirements
The CMI is installed with the Concert Server software. For more information about installing the CMI, see
the Concert Server Installation Guide.
To access the web-based CMI, use any of the following Internet browsers:
Google Chrome (all versions).
Apple Safari 5 or higher.
Mozilla Firefox v1.0.7 or higher.
Microsoft Internet Explorer v6.0 or higher.
Opera v10.0 or higher.
6
Administrator Guide
2 Accessing the CMI
To log into the web-based Concert Management Interface (CMI):
1. In the address field of your Internet browser, enter the IP address of the Concert Server.
Note:
If multiple Concert Servers exist within your Concert system, in the case of having multiple
Interface Gateway instances, one of the servers will need to be designated as the EMS server
which will be the only one accessed using the CMI.
2. When prompted, enter the access credentials which are defaulted to:
Username = admin
Password = admin
The CMI site is displayed.
Modifying the CMI access credentials
To modify the administrator credentials for the CMI:
1. Go to Administration > Access [ ].
The Access (Web Admin Credentials) page is displayed.
2. In Username, enter a username (the default username is admin).
3. In Password, type a new password. Retype the password in the field below.
4. To apply the change, click Update.
Alternatively:
1. Log into the Concert Server (running the EMS application) :
Username = concert
Password = concert
2. Execute the following command:
# sudo htpasswd -bc /etc/httpd/conf/.htpasswd [username] [password]
Replace [username] and [password] with the new choice of credentials.
7
Administrator Guide
3 Administration
Server
Application
Description
EMS
Element Management System. EMS performs as a login server,
presence server and database manager.
Note:
The web-based CMI interfaces directly with EMS. The CMI is used by the
system administrator to manage, configure and monitor Concert system
resources.
IV-R
IV-Router. The IV-Router is the media router which maintains a dynamic
connection with all the Concert Clients in the system. The IV-R maintains
conference routing tables for all its Client connections and routes audio
between conference participants and text messaging between clients.
Interface
Gateway
Interface Gateway. The Interface Gateway is the processing interface to
the PCIe audio devices on the server.
In Administration [ ], you can:
View version information for installed services and configure the supported Client version.
View and update your Concert license.
View and configure the system-wide audio Codec.
View the system event log.
3.1 Viewing version information for installed services
The top part of the Version page shows:
The names and versions of the three types of Concert Server application
(EMS, IV-Router and Interface Gateway) installed on the Concert Server running the EMS server
application.
The install date for each of the applications.
The applications perform the following tasks:
Table 1: Concert Server applications
8
Administrator Guide
3.2 Client version notification
The lower section of the Version page displays the Client Version Notification area. This is used to
notify connecting clients of available upgrades to the Client software.
Tip: The Concert Server contains a directory with all the Client installer files, which you can access
through the web server (http://[concert_server_ip]/client).
To send a version upgrade notification to Concert users:
1. In Minimum Client Version, ensure that the version stated (for example, 2.7.0.1), matches the
version of the installer files located within the area specified by Location.
2. In Location, enter a URL in the form of http://domain/folder. This URL will be included within
the Concert Client notification window as shown below:
Tip: Provided the Clients are installed to a network where the Concert Server is accessible on
port 80, you can enter the IP address of the Concert Server, specifying the client directory, in the
Location field (http://[concert_server_hostname]/client). Otherwise, you’ll need to specify a
location accessible by clients regardless of location.
Concert users can then download and upgrade the Client application by clicking the notification
that is displayed in the Client at log in.
3. To register the notification, click Update.
9
Administrator Guide
3.3 License information
3.3.1 License types
The EMS application (see Table 1: Concert Server applications) is installed when you install the
Concert Server software (see the Clear-Com Concert Server Installation Guide).
During the installation of the EMS application, the 5-User Perpetual license is automatically copied to
the Concert directory: /usr/local/clearcom/concert/concert_demo.lic.
When EMS is first started, the 5-User Perpetual license activates. You have full access to the Concert
system for an unlimited time period and the ability to create up to 5 Concert users, 5 Client channels
and 8 Server channels. There are no other access restrictions.
Note:
Technical support for the 5-User Perpetual license is limited to your Concert documentation and selfserve support resources at the Clear-Com website (http://www.clearcom.com/support).
To use Concert with more than 5 users, you must purchase a Concert license from Clear-Com. See the
Licensing Quick Start Guide, located on the Concert DVD, for more information.
There are two types of licenses:
Timed (1 year) license.
Perpetual license (license does not expire).
Note:
A Perpetual license only works for the Concert Server release it was purchased for (for example,
v2.7). To upgrade the Concert Server software, you must purchase a new license. If the Concert
Server is never upgraded, the license works forever.
Important note:
Re-enabling the 5-User Perpetual license restores the limits described above. You must reduce the
number of users and channels to those limits, otherwise all Client login attempts will be denied.
10
Administrator Guide
3.3.2 Viewing and updating your license
License information
Values / Description
Type
5-User Perpetual License, Timed License
(1 year), or Perpetual License.
User Limit
Demo License
5 users
Timed
10, 15, 20, 30, 55, 105 users
Perpetual
Client
Channel Limit
Demo License
5 Client channels
Timed
10, 15, 20, 30, 55, 105 Client channels
Perpetual
Server
Channel Limit
Demo License
8 Server channels
Timed
12, 16, 24, 40, 72 Server channels
Perpetual
Expiration
Expires in [number of] days at midnight on
[Month - DD - YYYY].
If the Timed license is nearing its expiry date, the
expiration text is displayed in red.
If the Timed license has expired, the following text is
displayed:
No Valid License Found.
If the 5-User Perpetual license has been activated or
you have purchased and installed a Perpetual
license, the following text is displayed:
Never (perpetual license).
Serial Number
Required when updating the Concert license
(see the next steps in this procedure).
To view and update your license:
1. Go to Administration > License [ ].
The following license information is displayed:
Table 2: Administration: License information
11
Administrator Guide
2. Copy the license file (*.lic) to your PC.
3. In the CMI, navigate to Administration > License [ ].
Under Update License, click Browse. Locate and select the license file (*.lic).
Note:
Browse may be labeled Choose File, depending on your browser.
4. To upload the license file to the Concert Server and activate the license, click Apply.
A notification is displayed on the license page stating that the license was validated
[ License key validation successful! ].
The license information changes to the new license details.
Important note:
The license is only valid for the server for which it was issued. The license invalidates if the license file is
modified in any way.
If you have a Timed license, the license will also invalidate if:
The system clock is set back more than 24 hours in the past. Correcting the time renders the
license valid again (except when the license has reached its expiration date).
The system clock is set forward more than 24 hours in the future. This is not recoverable. The full
OS (CentOS 5 and the Concert Server applications) must be reinstalled.
The license expires normally.
3.4 Access
Administration > Access [ ] displays the Access (Web Admin Credentials) page in the right-hand
pane. The page enables administrators to change their CMI credentials.
See Modifying the CMI access credentials.
3.5 Viewing and configuring the Codec
To view and configure the Codec:
1. Go to Administration > Codec [ ]. The Codec page (Router Codec Configuration) is
displayed in the right-hand pane.
2. In Active Codec, the name of the current Codec is highlighted
(the default is ).
3. To configure (change) the Codec, select another Codec from the drop-down list in Codec
Selection.
4. To confirm the configuration, click Submit.
12
Administrator Guide
Note:
Configuring (changing) the Codec causes a temporary loss of service to all connected Clients, while they
reconnect and synchronize with the new Codec.
3.6 Database
The database management page facilitates backing up and restoring a database, uploading a database
archive from your PC as well as downloading a database archive from the Concert Server to your PC.
Multiple database backups may be created at any time.
To view and manage the Concert Database:
Go to Administration > Database [ ]. The Database page is displayed in the right-hand pane.
3.6.1 Database backup
To create a backup of the existing Concert database, click on the button located under
Backup Database. This action will instantaneously create a full backup of the existing Concert database
and will appear under Database Archives. It may be performed while the Concert services are running.
13
Administrator Guide
3.6.2 Database restore, download and remove
Action
Description
To restore the Concert system to the state it was in when the
archive was created, click [restore].
To download the archive to your PC, click [download].
To remove the archive entirely from the server, click [remove].
Database Archives contains an entry for each database archive on the server. The following information
is presented for each archive entry:
The date when the archive was created.
The size of the archive (in either Kilobytes or Megabytes).
The name of the archive as it exists on the server.
The actions that may be performed on each archive:
Table 3: Database archive actions
Note:
When you click restore, you will be asked to confirm the action before the restore operation
begins. If you confirm the restore operation, the page will go blank for approximately 30 seconds
before being refreshed. Do not manually refresh or resubmit your restore request during this
time. Concert services will be temporarily lost during the restore operation.
Warning:
All Concert data within the existing database (users, roles, conferences, channels and devices) will be
permanently lost when you perform a restore operation. Backup the database first if you believe you will
require this data in future.
3.6.3 Uploading a database from a PC
To upload a database archive, stored on your PC, to the Concert Server:
1. Locate the database archive by clicking the Browse or Choose File button
Figure 1: Copy Local File to Database Archive on Server
2. Select the file you want to upload.
3. Click Upload.
14
Administrator Guide
3.7 Event log
To view the Concert event log, navigate to Administration > Event Log [ ]. The Event log page is
displayed in the right-hand pane.
The Event Log page records many significant events that occur across the Concert system, from
conferencing events (such as a Concert user joining and leaving a conference) to errors (such as a
Concert user entering incorrect login credentials).
The record includes:
The date and timestamp for the event.
The relevant server application (EMS, IV-Router or Interface Gateway).
A detailed description of the event.
To clear the Event Log, click Clear All.
Note:
When the Event log reaches its maximum capacity, a block of the oldest items is removed to create
space.
3.7.1 Collect Logs
If you encounter an issue that requires the assistance of a Clear-Com support representative, you can
assist their diagnosis of the issue by emailing them a compressed archive of all the Concert logs and
configuration files.
To create and download a compressed archive of the Concert logs and configuration files:
1. Click Collect Logs [ ]. Creating the archive may take up to 20 seconds.
2. To download the archive to your PC, either:
Click on the displayed filename
Click on the download link [ ].
The downloaded archive can now be emailed to the Clear-Com support representative.
3. To delete the archive from the server, click remove [ ].
Note:
Any pre-existing archive is deleted when you click Collect Logs. Only one compressed archive of the
logs and configuration files may exist on the server at any given time.
15
Administrator Guide
4 Node
Node [ ] comprises all the system nodes within your Concert system. Nodes represent a logical
grouping of the following system resources:
IV-Router server application(s) [ ].
Interface Gateway server application(s) [ ].
Eclipse frame(s) [ ].
If all your system resources are located locally, you may choose to organize those resources under a
single node. If your system resources are located at remote locations, then you may choose to organize
those resources under two or more nodes. The arrangement of nodes does not affect system operation.
Note:
For a description of the IV-Router and the Interface Gateway applications, see
Table 1: Concert Server applications.
4.1 Adding and removing a node
To add a node:
1. In Node, type the name of the node.
2. Optional: In the Description, type a brief description of the node
(for example, Physical location of Concert Server and all equipment).
3. Click [add].
To remove a node:
1. Locate the node you want to remove in the list. In Action, click [remove].
2. A message is displayed [ ] asking if you want to remove the node. Click OK.
4.2 Modifying the details of a node
To modify the name and description of a node:
1. Locate the node you want to modify in the list. In Action, click [modify].
2. Make the changes you require to the name and description for that node.
3. Click Submit.
Loading...