Professional Documents
Culture Documents
04-603508
Issue 1
June 2010
Contents
Index.......................................................................................................................................601
IP H.323
IP SIP
Languages
SNMP alarming
Adhoc conferencing
Disaster recovery
Video
Multiple codecs
Applications
Conference Viewer
Audio Console
Self Registration
Billing
Reporting
Multiple cabinets
Adobe Connect
Note:
You may also have to apply some patches.
The full installation steps are included here for your information only. In the majority of cases,
you should never have to use these steps and you can proceed to the configuration steps after
you change the IP information and apply a license.
Related topics:
A series of short tasks on page 20
Applying a Conferencing license on page 57
Related topics:
Updating network information on System Platform on page 21
Verifying network information on System Platform on page 24
Verifying connectivity on page 25
Manually restarting the Avaya Management Service on AWC on page 26
Updating network information on Conferencing Manager on page 27
Updating information on the CRS virtual machine on page 29
Prerequisites
Create new IP addresses and/or hostnames and make a note of them. You require seven IP
addresses for each deployment of Conferencing.
The purpose of this task is to update the IP and hostname details of the Conferencing instance
on System Platform.
1. If you do not have network connectivity to System Platform, which is the case when
you first change from the default IP addresses, you must use a crossover cable from
your services laptop to access the management port, which is Eth1/Gig2:
a. Configure your laptop with the following details:
IP address: 192.11.13.5
Field Information
Default Gateway <The IP address of the Conferencing Manager virtual
machine>
Primary DNS Domain name server
Secondary DNS Optional field. You can leave this field blank
Domain Search List Optional field. You can leave this field blank
Cdom Hostname Hostname
Dom0 Hostname Hostname
b. On the same screen, scroll to the Domain Network Interface section edit the
avpublic IP address field in the Domain-0 sub-section and the avpublic IP
address field in the Console Domain sub-section.
Do not edit the avprivate IP address fields or any other field in the Domain-0
or Console Domain sub-sections.
Here is an example of the Domain Network Interface section on the Network
Configuration screen.
Next steps
Now you can verify that the changes have saved successfully.
Prerequisites
Before you verify the IP and hostname details on System Platform, you must update them on
System Platform.
The purpose of this task is to check that the details that you updated in the first task are
successfully saved on the System Platform.
Example
Sometimes, the old gateway address still displays on the Network Configuration screen.
You must ensure that when you finish this task, the new gateway address is correctly
displaying.
Next steps
Now you can verify network connectivity.
Verifying connectivity
This is the third task.
At this point, the Conferencing server should be on the network. You can unplug the crossover
cable.
When the System Platform virtual machine is not on the network and you only have access
to it using a crossover cable and a terminal emulator, you can only browse directly to System
Platform and not to any of the other Conferencing components. For example, you cannot
browse to the Conferencing Manager virtual machine.
So now, you need access to a PC or a laptop on the customer network.
Prerequisites
Before you 'ping' the various virtual machines that comprise the Conferencing solution, you
must update the network information on System Platform and verify that the newly updated
information is correctly displaying on System Platform.
The purpose of this task is to ensure that you have network connectivity with each of the
Conferencing virtual machines. Traditionally, this task is also known as pinging the virtual
machines. Pinging ensures that the virtual machines are reachable across the customer's
Internet Protocol (IP) network.
Next steps
Now you must manually restart the Avaya Management Service on AWC.
Prerequisites
Before you manually restart the Avaya Management Service, you must update the network
information on System Platform and verify that the newly updated information is correctly
displaying on System Platform.
The purpose of this task is to restart the management server on the AWC so that Conferencing
Manager can successfully connect to the AWC and query its status. You can use the remote
desktop feature to access the AWC virtual machine.
Next steps
Now you can update the IP and hostname information on Conferencing Manager.
Prerequisites
Before you update the network information on Conferencing Manager, you must update it on
System Platform, verify your updates, and manually restart the AWC service.
The purpose of this task is to update the Conferencing Manager with the same changes that
you made on System Platform.
Next steps
Now you must update the Client Registration Server (CRS) virtual machine with the new
application server (bridge) details.
Prerequisites
Before you enter the application server (bridge) details on the Client Registration Server (CRS)
Front End, you must update the details on System Platform and Conferencing Manager, verify
your updates, and manually restart the AWC service.
The purpose of this task is the enter the details of the application server in the Client
Registration Server (CRS) Front End. This task ensures that the network information is
consistent across all applications. On the CRS Front End, you must update the Bridge name
field. You can use the remote desktop feature to access the CRS virtual machine.
Next steps
Now you are finished. You have successfully updated the IP and hostname information for your
instance of Conferencing.
Preinstallation steps
You can obtain the Conferencing files in a number of ways. One of these ways is called PLDS.
The other ways are via a DVD or a HTTP shared network location.
Avaya makes the Conferencing files available online, within the Product License and Delivery
System (PLDS) framework. PLDS is comprised of three components: license management,
software entitlement management, and software delivery. PLDS connects to a third party
delivery engine to facilitate the delivery of software.
Note:
Downloading the Conferencing files from the PLDS website can take a number of days.
Avaya recommends the DVD or HTTP methods, rather than the PLDS method.
If you choose to use the PLDS method of obtaining the Conferencing files, there are a number
of preinstallation steps which you must complete before proceeding to the installation steps.
If you choose to obtain the Conferencing files using a DVD or the HTTP method, you do not
need to complete these steps. Instead, you can proceed directly to the installation steps.
Within the PLDS framework, you can locate the files required for your Conferencing installation
by searching under:
• Application Name: Conferencing
• Version: 6.0
The files consist of three .iso images. An ISO image is an archive file of an optical disc in a
format defined by the International Organization for Standardization (ISO). This format is
supported by many software vendors. ISO image files typically have a file extension of .iso.
After you download these three .iso images, you must extract them to a single directory. When
you extract the .iso images, you can access the content within each .iso image.
The content in the .iso images consist of a number of . gz files and some other files such as .ovf
and .sh files. Here are some of the files, as an example:
• smgr-6.0.0.0.XX.gz
• bridge-6.0.0.0.XX.gz
• Conf_Standard_6.0.0.0.XX.ovf
• Conf_Standard_6.0.0.0.XX.mf
There may also be patches on the .iso images.
It is a good idea to read and review the Avaya Aura™ Conferencing Implementation Workbook
prior to commencing your installation.
Related topics:
Conferencing installation on page 39
Avaya Aura Conferencing implementation workbook on page 585
1. Go to the Avaya Product Licensing and Delivery System (PLDS) Web site (https://
plds.avaya.com).
You will be redirected to the Single sign-on (SSO) Web site.
2. Log in to SSO using SSO ID and Password.
You will be redirected to the PLDS registration page.
3. If you are registering:
• as an Avaya Partner, enter the Partner Link ID. If you do not know your Link
ID, send an e-mail to prmadmin@avaya.com.
• as a customer, enter one of the following:
- Company Sold-To
- Ship-To number
- License Authorization Code (LAC)
4. Click Submit.
Avaya will send you the PLDS access confirmation within one business day.
Use this procedure to verify that the md5 checksum of the downloaded ISO image matches
the md5 checksum that is displayed for the ISO image on the PLDS Web site.
1. Enter md5sum filename, where filename is the name of the ISO image. Include
the .iso file extension in the filename.
2. Compare the md5 checksum of the ISO image to be used for installation with the
md5 checksum that is displayed for the ISO image on the PLDS Web site.
3. Ensure that both numbers are the same.
4. If the numbers are different, download the ISO image again and reverify the md5
checksum.
Use this procedure to verify that the md5 checksum of the downloaded ISO image matches
the md5 checksum that is displayed for the ISO image on the PLDS Web site.
Use this procedure if you downloaded ISO images to a Windows-computer.
1. Download a tool to compute md5 checksums from one of the following Web sites:
• http://www.md5summer.org/
• http://zero-sys.net/portal/index.php?kat=70
• http://code.kliu.org/hashcheck/
Note:
Avaya has no control over the content published on these external sites. Please
use the content only as reference.
2. Run the tool on the downloaded ISO image and note the md5 checksum.
3. Compare the md5 checksum of the ISO image to be used for installation with the
md5 checksum that is displayed for the ISO image on the PLDS Web site.
4. Ensure that both numbers are the same.
5. If the numbers are different, download the ISO image again and reverify the md5
checksum.
DVD recommendations
Avaya recommends use of high quality, write-once, blank DVDs, such as Verbatim DVD-R or
DVD+R. Multiple rewrite DVDs are prone to error and should not be used.
When writing the data to the DVD, Avaya recommends a slower write speed of 4X or at a
maximum 8X. Attempting to write to the DVD at higher or the maximum speed rated on the
disc is likely to result in write errors.
Note:
If the software files you want to write on media are less than 680 Mb in size, you can use
a CD instead of a DVD.
This procedure requires a computer or server that has a DVD writer and software that is
capable of writing ISO images to DVD.
Important:
When the ISO image is being written to the DVD, do not run other resource-intensive
applications on the computer. Any application that uses the hard disk intensively can cause a
buffer underrun or other errors, which can render the DVD useless.
The purpose of this task is to convert the three ISO images into the constituent Conferencing
files. You can perform this task on a machine with the Windows operating system or the Linux
operating system.
Related topics:
Extracting the files to a Linux machine on page 36
Extracting the files to a Windows machine on page 38
Conferencing installation on page 39
Prerequisites
Before you extract the contents of the ISO images, you must download the ISO images using
the PLDS framework. You must also download PuTTY.
The purpose of this task is to convert the three ISO images into the constituent Conferencing
files.
There must be 10.5 GB of free disk space available. You can check if there is
sufficient space in the target directory using the following command:
df -hP ${TEMPLATE_DEST_DIR} | awk '{print $4}'
6. Specify a directory to contain DVD mount points, as follows:
export MNTDIR=/
7. Create the mount points, as follows:
mkdir -p ${MNTDIR}/DVD1
mkdir -p ${MNTDIR}/DVD2
mkdir -p ${MNTDIR}/DVD3
8. Mount the ISOs to those mount points, as follows:
mount Conf_Standard_6.0.0.0.X_DVD1.iso ${MNTDIR}/DVD1 -t
iso9660 -o loop
mount Conf_Standard_6.0.0.0.X_DVD2.iso ${MNTDIR}/DVD2 -t
iso9660 -o loop
mount Conf_Standard_6.0.0.0.X_DVD3.iso ${MNTDIR}/DVD3 -t
iso9660 -o loop
9. Create the destination directory, as follows:
mkdir -p ${TEMPLATE_DEST_DIR}
10. Copy the contents of the DVDs to destination directory, as follows:
/bin/cp ${MNTDIR}/DVD*/data/* ${TEMPLATE_DEST_DIR}
11. Un-mount mount points, as follows:and remove the directories:
umount ${MNTDIR}/DVD1
umount ${MNTDIR}/DVD2
umount ${MNTDIR}/DVD3
12. Remove the directories, as follows:
rmdir ${MNTDIR}/DVD1
rmdir ${MNTDIR}/DVD2
rmdir ${MNTDIR}/DVD3
13. Run a checksum on contents of ${TEMPLATE_DEST_DIR}, as follows:
cksum ${TEMPLATE_DEST_DIR}/*
The list of Conferencing files should be displayed. For a full, up-to-date list of these
files, see the Avaya Aura™ Conferencing Release Notes, which are available from
support.avaya.com.
Next steps
Now, you can begin the steps to install Conferencing using the HTTP method.
Related topics:
Installing Conferencing using HTTP on page 44
Prerequisites
Before you extract the contents of the ISO images, you must download the ISO images using
the PLDS framework. You must also download IsoBuster.
The purpose of this task is to convert the three ISO images into the constituent Conferencing
files.
Next steps
Now, you can begin the steps to install Conferencing using the HTTP method.
Related topics:
Installing Conferencing using HTTP on page 44
Conferencing installation
Avaya Aura™ Conferencing is an integrated multimedia conferencing solution, consisting of
five virtual machines, which you must install in your customer network. The five virtual
machines are:
• An application server
Within the Conferencing environment, this is called a bridge.
• A central management and configuration console
Within the Conferencing environment, this is called Conferencing Manager. It enables you
to manage and configure the other four virtual machines. Some of the fields on the
interface refer to Conferencing Manager as SMGR. It is a good idea to keep this point in
mind while you are navigating through the Conferencing installation pages.
• A data conferencing server
Within the Conferencing environment, this is called Avaya Web Conferencing, or AWC.
• A customer booking server
Within the Conferencing environment, this is called a Client Registration Server or CRS.
This server also has conference management and reporting functions.
• A customer booking Web server
Within the Conferencing environment, this is called Web Portal. This server also has
conference management and reporting functions.
Before you install Conferencing, you must install and configure Avaya Aura™ System Platform.
System Platform is a virtual server that allows solution templates, or applications, to co-
reside on a single server. You use System Platform to obtain and install the Conferencing
template.
It is a good idea to read and review the Avaya Aura™ Conferencing Implementation Workbook
prior to commencing your installation. The Avaya Aura™ Conferencing Implementation
Workbook is available here as an appendix. Avaya also recommends completing the Avaya
Aura™ Conferencing Implementation 6.0 Standard Edition training course, which is training
course number ATI00102VEN on https://www.avaya-learning.com/.
Conferencing consists of all the virtual machine elements that are necessary for successful
conferencing. The virtual machine files are defined in a file called an open virtualization format
file. This file has the file extension .ovf. You can install the Conferencing installation files using
one of the following methods:
• DVDs
• HTTP
Important:
Before you install the Conferencing files, you must ensure that the timezone setting on
System Platform is the one that you require in your Conferencing deployment. If it is not,
Avaya recommends changing the timezone setting so that it reflects the time setting that
you require for Conferencing. There are two formats in the System Platform timezone list.
There are short forms of timezones, such as ETC/GMT and there are long forms of
timezones, such as Europe/Dublin. Always use the long form of the timezone.
DVD installation
Avaya ships Conferencing on a series of DVDs. Typically, three DVDs are required for each
deployment. The DVDs contain the Conferencing files, the operating systems, and the folders
and files that are necessary for successful operation of the Conferencing solution. To install
Conferencing, you must follow a procedure to copy the contents of each of the DVDs to the
System Platform server machine and install the files from the System Platform server machine.
An automatic script installs the files into the correct folder on the System Platform server
machine.
Note:
The DVD method is a method of obtaining and installing the Conferencing files.
HTTP installation
If you copy the Conferencing installation files to a local Web server, you can install them using
the HTTP method. As with the DVD option, you must install the files using the System Platform
server machine.
Note:
The HTTP method is a method of installing the Conferencing files. Before you use the HTTP
method, you must first obtain the files, using another method, such as PLDS or on DVDs.
Avaya makes the Conferencing files available online, within the PLDS framework. PLDS is
comprised of three components: license management, software entitlement management, and
software delivery. PLDS connects to a third party delivery engine to facilitate the delivery of
software. Downloading the files from the PLDS website can take a number of days. This time
delay is due to the large size of the Conferencing template. The time delay varies depending
on your connection to the Internet. Avaya recommends the DVD method, rather than the PLDS
method. If you are using the PLDS method, download the files in advance of your customer
site visit. Once you have the files from PLDS, you can save them to a shared location on the
customer network and use the HTTP installation steps from that point. If you choose to obtain
the files using PLDS, you must complete some preinstallation steps relating to PLDS
registration. Using PLDS, you download the files in an .ISO format and then extract the .ISO
files to a single directory.
Note:
The PLDS method is a method of obtaining the Conferencing files. After you obtain the files
from PLDS, you must install them using another method, such as HTTP or DVD.
Summary table
How do I install the • You can copy the files to a shared location on the customer
Conferencing template? network and use the HTTP method of installation.
• Alternatively, you can bring DVDs to the customer site and use
the DVD method.
All installation methods use the System Platform server machine. You require System Platform
in order to install the Conferencing template.
Related topics:
Preinstallation steps on page 31
Extracting the content of the ISO images on page 36
Installing Conferencing using DVDs on page 41
Installing Conferencing using HTTP on page 44
Avaya Aura Conferencing implementation workbook on page 585
Architecture overview on page 586
These settings ensure that the customer network can establish a link to the Conferencing
application server.
• Download an application called PuTTY from http://www.chiark.greenend.org.uk/
~sgtatham/putty/download.html. PuTTY is a Windows SSH client that allows you to
access the Windows virtual machines (the CRS and AWC virtual machines) by way of
System Platform (Dom0), giving you a terminal window.
The purpose of these steps is to install the Conferencing files. These files contain all the virtual
machine elements that are necessary for Conferencing. There are five virtual machine
elements in the package.
1. Log in to the System Platform server machine using a Command Prompt window.
The System Platform server machine is sometimes called Domain 0 or Dom0. The
System Platform server machine also has a virtual machine called Cdom (previously
called Udom). The IP address of Cdom refers to a Web console, which enables you
to manage System Platform. For the purposes of this step, you must log in to the
Command Prompt window and the PuTTY application.
a. On the PuTTY dialog, enter the hostname or IP address of the System Platform
machine.
b. Enter the username admin and the password admin01.
c. Run the command su root to increase the access permissions.
The password is root01.
Note:
These usernames and passwords are the System Platform default
usernames and passwords. Avaya configures these values when they ship
a new System Platform. It is likely that an administrator has updated this
information following the installation of System Platform in your site.
2. Put the first DVD into the CD Rom drive of the System Platform server machine.
3. Mount the DVD by running the command mount -r /dev/cdrom /media.
4. Run the following script, setup_install_data, to ensure that the template folders
install in the correct location on the System Platform server machine.
This script is located in script/media. When you run setup_install_data, the
script displays a series of prompts. Follow the prompts as they instruct you to insert
the second and third DVDs. Conferencing has three DVDs in total.
5. Log in to System Platform by entering the System Platform virtual machine IP
address in a Web browser. The System Platform documentation is available from
support.avaya.com.
By default, the User ID is admin and the password is admin01.
6. On System Platform, navigate to Virtual Machine Management > Solution
Template.
7. On the Search Local and Remote Template screen, select SP Server from the
Install Template From list.
8. Click Search and locate the Conf_Standard_6.x.x.x.x.ovf file. This is the Open
Virtualization Format file that contains the templates. There should only be a
single .ovf file in the directory.
This file is located in /vsp-template/Conf_Standard_6.x.x.x.x/.
9. Highlight the file and click Select.
10. On the Template Details screen, review the installation requirements and click
Install.
You can see more details about each virtual machine by clicking the CRS, Web
Portal, AWC, and Bridge buttons. System Platform displays the detailed
information at the bottom of the screen.
11. On the Template Network Configuration screen, select an ethernet port from the
Dedicated NIC drop-down list and click Save.
Conferencing uses two NICs. It uses ethernet port 0 (which is port 1) for the CRS,
Web Portal, and AWC virtual machines and one of the remaining ethernet ports for
the application server. The application server is also called the bridge. Ensure that
the ethernet port that you select is physically connected to a switch with 100Mb/s
or higher. The bridge link defaults to 100 Mb/s. The corresponding switch port must
be configured for auto negotiation and must be connected and have carrier (NIC
LED illuminated) prior to the installation of the template.
If you are deleting a template and re-installing it, System Platform may display an
error message referring to dedicated NIC connectivity. If you see this error message,
reboot System Platform and start the Conferencing installation again.
12. On the following screen, enter an IP address and a fully qualified domain name
(FQDN) for the bridge, CRS, AWC and Web Portal virtual machines. You must
overwrite the existing text, such as localhost.localdomain. The purpose of
this text is to provide a hint about the required syntax.
A fully qualified domain name (FQDN) is sometimes referred to as an absolute
domain name, It is a domain name that specifies its exact location in the tree
hierarchy of the Domain Name System (DNS). For example, given a device with a
local hostname myhost and a parent domain name example.com, the fully
qualified domain name is written as myhost.example.com. This fully qualified
domain name therefore uniquely identifies the host — while there may be many
resources in the world called myhost, there is only one myhost.example.com.
13. For the SMGR (Conferencing Manager) virtual machine, separate the hostname
and the domain name into the SMGR Host Name and SMGR Domain fields,
respectively. In other words, do not enter the FQDN in the SMGR Host Name field.
14. For the SMGR virtual machine, you must also add the gateway, netmask, DNS, and
search string. The network administrator in the customer site should provide this
information. You do not require this information for the CRS, bridge, AWC, and Web
Portal virtual machines because these machines obtain these settings from System
Platform.
15. Click Install.
The Template Installation screen displays the progress of the installation. The
installation can take up to 90 minutes. When it is complete, System Platform
displays the phrase Template Installation Completed Successfully on the
Template Installation screen.
Next steps
You can now enter the product keys for the Windows license on the CRS and the AWC virtual
machines. These two virtual machines use the Windows operating system. The bridge, the
Conferencing Manager, and Web Portal virtual machines use the Linux operating system and
do not require licensing or have an open source licensing agreement.
Once the installation is complete, you can manage the virtual machines using the System
Platform interface, by navigating to Virtual Machine Management > Manage. In addition, you
can change the networking information of the virtual machines by navigating to Server
Management > Network Configuration.
Related topics:
Windows licensing on page 45
The purpose of these steps is to install the Conferencing files. These files contain all the virtual
machine elements that are necessary for Conferencing. There are five virtual machine
elements in the package.
Note:
In some instances, if you are connecting to the installation files via a proxy server, you are
more likely to experience download difficulties. Potential download difficulties include the
cancellation of the installation, timeouts, and the reaching of the maximum data transfer
limit. If any issues occur, it is a good idea to switch off the proxy. As a matter of good practise,
you should only switch off the proxy if the HTTP server is within the local network.
Next steps
You can now select the .ovf template file, as described as part of the DVD installation. You can
follow the DVD installation steps from step 8 onwards.
Related topics:
Installing Conferencing using DVDs on page 41
Windows licensing
System Platform is a virtual server that allows solution templates, or applications, to co-
reside on a single server. After you install the Conferencing files, System Platform hosts the
five virtual machines that comprise the Conferencing solution. These five virtual machines are:
• Client Registration Server (CRS)
• Avaya Web Conferencing (AWC)
• Web Portal
• Bridge (The bridge is the application server)
• Conferencing Manager (Conferencing Manager is a console or central management
system for configuring Conferencing)
The CRS and the AWC use the Windows operating system. The bridge, Web Portal, and
Conferencing Manager use the Linux operation system. You must comply with the licensing
requirements of the Windows operating system before you continue with the remainder of the
installation tasks. The Linux operating system does not require licensing.
At this stage of the installation, there is no IP connectivity between the host (System Platform)
and the CRS and AWC virtual machines. This lack of IP connectivity is because the Windows
operating systems have not completed their installations. As a result, you must use a special
method, called in-band communication, to access these virtual machines in order to enter the
Windows product keys. Avaya recommends using an X Windows server, such as Xming and
a terminal emulator application, such as PuTTY to access the virtual machines through System
Platform. After you enter the license keys, the Windows operating system reboots. At this point,
you must also adjust the time and date on the CRS and AWC virtual machines.
Xming and PuTTY
Xming and PuTTY are freely available as standalone open source applications.
PuTTY is a Windows SSH client that allows you to access the Windows virtual machines (the
CRS and AWC virtual machines) by way of System Platform (Dom0), giving you a terminal
window.
Xming is an X Server for Windows. An X server enables you to access the graphical user
interface of the Windows virtual machines.
Location of the license keys
The license keys are usually displayed on a sticker attached to the Windows installation CD
or attached to the Conferencing server hardware.
Anti-virus policy
After you enter the license keys for the Windows operating system, Avaya recommends
installing anti-virus software in accordance with the current policy in the deployment site.
Windows updates
After you enter the license keys for the Windows operating system, Avaya recommends
complying with the Windows updates policy in the deployment site.
Related topics:
Entering Windows keys using Xming and PuTTY on page 46
Setting the time after entering Windows keys on page 48
The purpose of this task is to enter the license keys for the Windows operating system on the
CRS and AWC virtual machines. These steps describe how to connect to CRS and AWC when
you are running a Windows operating system. If you are running a Linux or a Macintosh
operating system, you must use their generic utilities to perform the PuTTY and Xming
functions.
1. If you are using a Windows operating system on your computer, download Xming
from http://sourceforge.net/projects/xming/ and download PuTTY from http://
www.chiark.greenend.org.uk/~sgtatham/putty/download.html.
When downloading Xming, It is a good idea to select the option to create a shortcut
to Xming on your desktop.
There are many different PuTTY downloads listed. Typically, your deployment
requires the putty.exe file.
2. Right-click on the Xming shortcut on your desktop and select Properties.
3. Replace all the text in the Target field with this text: xming.exe :0 -clipboard
-multiwindow –ac
4. Start Xming and PuTTY.
The taskbar displays an icon to show that Xming is running.
5. On the PuTTY dialog, enter the hostname or IP address of the System Platform
machine.
The System Platform is displayed as Dom0 in the System Platform graphic user
interface.
6. On the PuTTY left pane, ensure that Connection > SSH > X11 > Enable X11
Forwarding is selected.
7. Click Open.
8. Log in to System Platform using the username admin and the password admin01.
9. Run the command su root to increase the PuTTY access permissions.
The password is root01.
Note:
These usernames and passwords are the System Platform default usernames
and passwords. Avaya configures these values when they ship a new System
Platform. It is likely that an administrator has updated this information following
the installation of System Platform in your site.
10. Run the command xm vncviewer awc to access the AWC virtual machine.
This command displays a Windows dialog in which you can enter the Windows
license keys.
If the VNC Viewer utility does not launch:
a. Enter the command export DISPLAY=<IP address of the current
desktop machine>:0.0 and press the Enter key.
b. Run the command xm vncviewer awc again.
11. Enter the Windows license keys using the regular Windows steps.
12. Run the command xm vncviewer crs to access the CRS virtual machine.
This command displays a Windows dialog in which you can enter the Windows
license keys.
13. Enter the Windows license keys using the regular Windows steps.
After you enter the keys and restart Conferencing, the Windows virtual machines
are available from that point onwards.
You can display the Log-in dialog by pressing the F8 key. The F8 key, when pressed
within the PuTTY dialog, behaves like the Windows command CTRL+ALT
+DELETE. The password for the log in on the CRS virtual machine is Avaya123.
The password for the log in on the AWC virtual machine is gatekeeper. The
passwords are case-sensitive.
If you want to return to the System Platform Dom0 virtual machine, close the
Windows dialog or enter the following command in the PuTTY dialog:
<CTRL> ]
In other words, press the CTRL key and enter the square right close bracket symbol.
Next steps
Now you must adjust the time and date settings on the CRS and AWC virtual machines.
Related topics:
Entering Windows keys using VNC Viewer
System Manager/Conferencing Manager and virtual machines on page 54
Prerequisites
Before you configure the time and date on the CRS and AWC virtual machines, you must enter
the Windows license keys
The purpose of this task is to manually adjust the time and date settings on the CRS and AWC
virtual machines to align them with the other Conferencing components.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
Next steps
Now it is a good idea to install any patches that are required. Avaya recommends that you
ensure that you have IP connectivity to each of the virtual machines at this point. IP connectivity
is essential for the deployment of patches.
You can install anti-virus and Windows update software in accordance with the current policy
in the deployment site. You must install any anti-virus or update software on the C drive. Avaya
uses the D drive for the Conferencing software. If you perform the backup and restore function
for the Conferencing software, the process may remove any non-Conferencing software from
the D drive.
Patch management
Patch management is the process of obtaining a fix and applying it to your software. From time
to time, after Avaya releases software, Avaya releases a fix for a known issue in the software.
You can use the patch management process to obtain the fix and update your software. Avaya
deploys patches using Avaya Aura™ System Platform. System Platform is a virtual server that
allows solution templates, or applications, to co-reside on a single server. You use System
Platform to obtain and install the Conferencing files.
Just like the other virtual machines that make up the Conferencing solution, System Platform
is a virtual machine. The System Platform server machine is sometimes called Domain 0 or
Dom0. The System Platform server machine also has a virtual machine called Cdom. The IP
address of Cdom refers to a Web console, which enables you to manage System Platform.
Just like Conferencing, you can obtain fixes using a number of methods:
• DVDs
• PLDS
Avaya recommends obtaining the patches from PLDS because PLDS always lists the latest
versions of each patch. A DVD could contain an older version of a patch.
Note:
Avaya recommends that you ensure that you have IP connectivity between System Platform
and each of the virtual machines at this point, before you install any patches. You can verify
connectivity using a ping command. Ping is a computer network administration utility used
to test whether a particular host is reachable across an Internet Protocol (IP) network and
to measure the round-trip time for packets sent from the local host to a destination computer.
On the System Platform interface, each of the virtual machines is listed along with the status
of each virtual machine. The status 'running' means that the operating system on that virtual
machine is running. It does not mean that the Conferencing applications on each virtual
machine are running. Furthermore, it does not mean that there is IP connectivity to each of
those virtual machines.
Related topics:
Installing and activating Conferencing Manager patches on page 50
Installing and activating regular patches on page 52
The purpose of this task is to obtain and apply any fixes which are currently available for your
Conferencing software. These steps are for Conferencing Manager patches. Recall that within
the Conferencing environment, Conferencing Manager is sometimes known as SMGR. These
steps describe how to install the patches when you are running a Windows operating system. If
you are running a Linux or a Macintosh operating system, you must use their generic utilities
to perform the WinSCP and PuTTY functions.
Example
The patch file has the file extension .sh. For example, runInstaller.sh.
Next steps
Now you can install the regular patches, which are distributed using System Platform.
The purpose of this step is to obtain and apply any patches which are currently available for
your Conferencing software. There may be multiple, separate patches.
Note:
You may have to click Refesh to display the correct state.
After you install the AWC patch, you must repeat these steps for each patch file.
As an aside, if the patch supports rollback, you can click Deactivate to roll it back.
At any time, you can use System Platform to navigate to Server Management >
Patch Management > Manage. The Patch List page lists all the patches that are
installed or activated in your deployment. It may take approximately one minute
before the patch is displayed in the Patch List.
Next steps
You can now add the Conferencing virtual machine elements to Conferencing Manager.
Conferencing Manager is a central management console, which enables you to configure the
other virtual machines, and in doing so, configure many aspects of your Conferencing
deployment. This is a required step to register the Conferencing virtual machines with
Conferencing Manager.
The process of rollback is similar to the undo feature. Rollback means returning to the state
prior to the installation of the patch. Some patches support rollback and some others do not
support rollback. The release notes associated with each patch indicate which patches support
rollback and which do not. If a patch supports rollback, you can rollback by selecting the
Deactivate button on the patch management screen. For more details on rollback support, it
is a good idea to read the release notes. The Avaya Aura™ Conferencing Release Notes are
available on support.avaya.com.
Conferencing Manager patches do not support rollback.
Related topics:
Manually starting AWC on page 244
Related topics:
Adding virtual machines to Conferencing Manager on page 55
Next steps
You can now connect the CRS, Web Portal, and AWC virtual machines to the bridge virtual
machine. This step is necessary to ensure connectivity between all the Conferencing virtual
machines on the network. It is one of the final tasks in the installation process.
connections between the virtual machines. Specifically, you must assign a bridge, Avaya Web
Conferencing (AWC), and Web Portal virtual machine to the CRS virtual machine.
This step involves configuring the CRS virtual machine to communicate with the other
Conferencing virtual machines. This association means that when operators and moderators
book conferences, the bridge allocates resources and delivers the conferencing experience.
This is one of the final stages in the installation of the Conferencing solution.
Related topics:
Assigning virtual machines to the CRS on page 56
Importing the customer model at the customer site on page 403
Next steps
At this point, you have installed Conferencing Manager, licensed the Windows operating
system, added the virtual machines to the Conferencing Manager and assigned the virtual
machines to the CRS virtual machine. You are now ready to connect Conferencing to your
network.
You may want to initiate a backup of your configurations at this point. You can initiate a backup
using System Platform.
Note:
If Avaya has made a fix available for your Conferencing software, you may have to install it
before you connect Conferencing to your network. You can install fixes using the patch
management process.
Related topics:
CRS virtual machine connectivity on page 55
Related topics:
Applying a Conferencing license on page 57
Prerequisites
Before you apply a license to your Conferencing server, you must obtain the license from the
PLDS Web site.
Example
The solution is licensed against the MAC address of the Conferencing Manager. The unique
index for the license is the LAN MAC address of the Conferencing Manager. You can view
the MAC address using System Platform.
Next steps
Now you can configure the Conferencing solution to suit the customer requirements.
Troubleshooting installation
The purpose of this task is to provide some suggestions for overcoming any installation issues.
• Ensure that there are no download size constraints implemented in the network. The
Conferencing installation files are very large. Issues in relation to download size are
more likely to occur if you are downloading the Conferencing installation files via a proxy
server.
• If you experience difficulties downloading the Conferencing installation files via a local
Web server (referred to in this document as the HTTP method), use an alternative
method, such as the DVD method.
• Consider the impact of the firewall rules in your deployment. You may have to customize
the Conferencing firewall rules to accommodate the requirements of your deployment.
a. Log in to the application server (bridge) virtual machine using PuTTY.
b. Enter the name craft and the password craft01.
c. Use the sroot command to change from craft to sroot access.
The sroot command is:
su sroot
The password is root01.
d. Navigate to /root2/etc/firewall/conf/mx_firewall.rules.
e. Enter the following command to stop a service:
service iptables stop
f. Make a back-up copy of the mx_firewall.rules file.
g. Edit the mx_firewall.rules file to suit your deployment.
h. Enter the following command to restart the service:
service iptables restart
• To find out about license information, you can follow these steps:
Enter the following line in the Address field of a Web browser:
http://<Application server virtual machine>:18080/info
The application server returns the license status, for example:
edition=Standard Edition
audio-ports=300
license-status=LICENSE_GRACE
version=6.0.0.0.1
productId=bridge
• To query the status of the operating system on the management servlet running on
each of the virtual machines that comprise the Conferencing solution:
On a Web browser, enter the following: http://<IP address of virtual
machine>:18080/status.
• If you are deleting a template and re-installing it, System Platform may display an error
message referring to dedicated NIC connectivity. If you see this error message, reboot
System Platform and start the Conferencing installation again.
• To enter the Windows license keys on the CRS and AWC virtual machines, you require
a utility called VNC Viewer. If the VNC Viewer utility does not launch:
Related topics:
Location of additional logs of interest on page 109
Note:
The requirements of your network infrastructure may differ from those described here.
Use these instructions as a general guide.
The Conferencing solution also supports a number of other integrations and several hardware
options from other vendors. For more information on these deployments, contact your Avaya
Support Representative.
The main configuration settings that are relevant to connect Conferencing to the network are
the SIP settings.
The Avaya DevConnect Web site contains a large number of Solutions and Interoperability
Lab (SIL) application notes at: https://devconnect.avaya.com/public/dyn/d_dyn.jsp?fn=314,
such as The Application Notes for configuring Avaya Aura™ Communication Manager 6.0 and
Avaya Aura™ Session Manager 6.0 to allow interoperability between Avaya Aura™
Conferencing Standard Edition 6.0 using SIP Trunks. This Web site is an excellent resource
for deployment information.
Related topics:
Conferencing and Communication Manager on page 62
Conferencing and Session Manager on page 63
Conferencing and Audiocodes on page 63
Conferencing and Communications Server 1000E (CS1K) on page 64
Related topics:
What is Session Manager? on page 63
SIP settings
The main configuration settings that are relevant to connecting Conferencing to the network
are the SIP settings. The Session Initiation Protocol (SIP) is a signaling protocol, widely used
for controlling multimedia communication sessions such as voice and video calls over Internet
Protocol (IP). Within a SIP communications framework, the method of transmission is
configurable.
The SIP communications across your network must use one of the following methods of
transmission:
• Transport Layer Security (TLS)
• Transmission Control Protocol (TCP)
• User Datagram Protocol (UDP)
Related topics:
SIP listener URI on page 64
Response contact on page 65
Session refresh timer on page 65
Min session refresh timer allowed on page 66
Configuring SIP on page 66
In the case of a TLS configuration, you should enter the port number 5061 instead of 5060.
Also, you should add an s to sip at the beginning of the string.
Note:
The transport protocol that you select for the SIP Listener URI field must match the transport
protocol that you select for the Response Contact field.
Response contact
Response Contact is also a string that specifies the address of the Conferencing application
server and the transport method for connecting with the application server. You can configure
the TCP, UDP, or TLS method of transmission, using the following syntax:
Response Contact=sip:Digit String@Conferencing application server IP:5060;transport=tcp
Response Contact=sip:Digit String@Conferencing application server IP:5060;transport=udp
Response Contact=sips:Digit String@Conferencing application server IP:5061;transport=tls
As with the SIP Listener URI field, the digit string is simply an identifying number for the
Conferencing application server. You can enter any value but it defaults to 6000.
In the case of a TLS configuration, you should enter the port number 5061 instead of 5060.
Also, you should add an s to sip at the beginning of the string.
Note:
The transport protocol that you select for the Response Contact field must match the
transport protocol that you select for the SIP Listener URI field.
Configuring SIP
Prerequisites
Before you configure the SIP settings, you must install Conferencing and configure a media
gateway.
The purpose of this task is to configure the transport protocols for communications from the
Conferencing server.
Next steps
Now you can configure the telephone numbers.
Call routing
Call routing describes a number of mechanisms which Conferencing uses to provide
conference participants with a customized conferencing experience, depending on the
telephone number they used to access the conference. Conferencing experience consists of
audio messages, languages, and conference call flow.
Call routing also refers to the way Conferencing interprets the telephone numbers that
participants use to dial a conference and the telephone numbers that participants use to dial
out from a conference to another potential participant.
To configure call routing, you must customize a number of settings in your deployment of
Conferencing.
Related topics:
Call routing on page 136
Your customer should provide the telephone numbers which they wish to use for
conferencing. These telephone numbers should be dialed number identification
service (DNIS) numbers. In some regions, DNIS numbers are called direct dial inward
(DDI) numbers.
Example
For example, if you have 100 licensed ports, you could allocate the range 2710600 to
2710699 to Conferencing.
Next steps
Now you can configure the number of digits to match.
Related topics:
Configuring the number of digits to match on page 68
The purpose of this task is to specify the number of digits which Conferencing selects from a
full telephone number.
Next steps
Now you can configure the Conferencing call branding table.
Related topics:
Call branding on page 69
Call branding
Call branding overview
Call branding is a feature that enables you to configure the participants’ conference experience,
based on the telephone number that they use to dial Conferencing.
When conference participants dial the Conferencing server to enter their conference, the
Conferencing server plays them a series of audio prompts. Avaya provides customers with the
flexibility to configure different telephone numbers that will all dial into the same server.
Customers can link customized audio prompts with each of these different telephone numbers.
By default, Avaya configures Conferencing with eight languages.
Customers can also link different call flows with each of these different telephone numbers.
These telephone numbers are called Direct Dial Inward (DDIs) or Dialed Number Identification
Service (DNISs). A call flow refers to the sequential experience of the conference participant
as they dial into a conference or listen back to a conference recording.
Avaya also allows customers to limit the length of the DDI which Conferencing processes. For
example, if customers use the telephone numbers 1234001, 1234002, 1234003, 1234004, and
so on, you can configure Conferencing to read only the digits that vary. Conferencing does not
need to process all digits. The number of digits that you configure to be processed by
Conferencing is called the Number of digits to match.
The configuration of processing preferences such as limiting the number of digits to match and
linking various call flows is called call branding. Call branding occurs when Conferencing
collects the digits that the participant dials, matches them to an entry in a call branding table,
then processes the call in accordance with the instructions that you have configured in that
call branding table.
The call branding table enables you to assign a specific annunciator message, line name,
company name, system function, and audio prompt sets. You must ensure that the final entry in
the call branding table is the wild card entry, which is ????. If Conferencing collects a DNIS
that is not listed in the table, it processes the call based on the instructions that you have
configured in this entry. By default, Avaya ships Conferencing with this entry already configured
in the call branding table.
When a caller first uses a DNIS, Conferencing checks the call branding table. Conferencing
then routes the call in accordance with the configuration settings for that DNIS. After this initial
check, Conferencing caches the call branding routing instructions in the shared memory
database. Caching the instructions means that Conferencing avoids having to check the call
branding table each time.
Variable Description
DDI Specifies the digit pattern of the DNIS. In certain regions, this is
known as Direct Dial Inward (DDIs). You can specify the number
of digits that Conferencing collects using the Number of digits
to match field.
Variable Description
Name An optional line name that you can associate with the DNIS. The
name can contain up to 20 characters. Conferencing displays
this name to the operator and also displays it in call and
conference detail records (CDRs and CODRS). This optional
line name is especially useful for calls destined for the Enter
Queue because it helps operators to provide custom greetings.
The default is blank. If you leave this field as blank and you have
configured SCAN or FLEX in the func field, Conferencing uses
this field to display the last passcode that the participant enters.
The Standard Edition of Conferencing does not support Bridge
Talk. Bridge Talk is the Avaya application that enables operators
to monitor live conferences and perform actions on live
conferences, such as attended conferences. If your customer
has their own application which provides a similar function, you
can configure Conferencing to use this external application. You
can do this using the Avaya Conferencing Provider Application
Programming Interface (ACP API). For more information about
configuring Conferencing to operate with external applications,
contact your Avaya Support Representative. The Standard
Edition of Conferencing supports Bridge Talk.
Organization Name An optional company name to associate with the DNIS. The
name can contain up to 20 characters. Conferencing displays
this name to the operator and also displays it in call and
conference detail records (CDRs and CODRS). The default is
blank.
Reservation Group The Standard Edition of Conferencing does not support this
feature.
Message Number The annunciator message, listed by number, that Conferencing
plays to the participant before it processes the call in
accordance with the instructions that you have configured for
this entry.
Message Set Number The number of the audio prompt set, from 0 to 20, that
Conferencing uses to play the annunciator messages.
Conferencing supports up to 21 languages.
Use Conf Message Set Specifies if Conferencing plays the audio prompt set from the
language that the moderator or operator has assigned to the
conference or if it plays the audio prompt set from the language
that you have configured, using the call branding table, for this
entry. The valid values are Y and N.
On entry Specifies how Conferencing processes a call that matches the
incoming digits. The valid values are:
Direct to enter queue
Conferencing places the call in the Enter Queue. The Enter
Queue is where participants await the attention of an operator.
Variable Description
This is the most common choice for a conference in Attended
Mode.
Direct to conference
Conferencing places the call directly in a conference without a
request for a passcode. This a common choice for unattended
calls. This function does not support flex flow conferences. If
you require the DNIS to dial a flex flow conference, configure
the On entry value to Flex call flow.
Scan call flow
Conferencing plays an annunciator message to prompt the
participant to enter the passcode for the conference. This a
common choice for unattended calls.
Disconnect
Conferencing ends the call.
Auto virtual link line
This field is reserved for a multisite conference. Multisite refers
to a network of Conference Reservation Servers (CRSs)
located in different geographical locations.
Flex call flow
Conferencing identifies the call as a flexflow call. A flexflow
conference is a specific type of on-demand conference. In
flexflow conferences, all call routing is based on the conferee
passcode. In addition to the conferee passcode, moderators
enter a moderator passcode, which grants access to a
moderator-specific menu.
Playback
Conferencing routes the call to the repository of conference
recordings. Conferencing prompts the user for a conference
reference number and a passcode and plays the appropriate
conference recording, if it is available.
On failure Specifies how Conferencing deals with failed actions that the
participant makes, such as entering an incorrect passcode.
Conferencing places the participant in the enter queue (Direct
to enter queue) or ends the call (Disconnect). This field is not
valid if you set the On entry drop-down list to Direct to enter
queue, Disconnect, or Direct to conference. If you select
Default, Conferencing uses the failure instructions that you
have configured using the Invalid Code parameter. The Invalid
Code parameter is a global parameter. Conferencing applies
the Invalid Code value to all conferences unless you configure
a value using the call branding table. A call branding value of
Direct to enter queue or Disconnect overrides the Invalid
Code value. On the other hand, a call branding value of Default
will apply the Invalid Code values.
Note:
Another value, outside of call branding, also exerts an influence
over the functionality of this variable. That value is called
Variable Description
Security Code Error3. For the call branding value to operate
successfully, you must set Security Code Error3 to Tone. If you
set it to any value other than Tone, Conferencing uses the
Invalid Code value.
Conference Room Start An optional starting Bridge Talk conference room assigned to
this DNIS. This setting along with conference room end sets a
range of rooms. When callers call the DNIS, Conferencing
places them into the conference room. Operators, using Bridge
Talk, can see the callers in the Conference Room dialog.
Customers can use this feature to assign responsibility for
specific conference rooms to specific operators. Customers can
also use this feature, along with Name and Organization Name
to ensure that operators customize the conferencing experience
for callers.
The Standard Edition of Conferencing does not support Bridge
Talk. Bridge Talk is the Avaya application that enables operators
to monitor live conferences and perform actions on live
conferences, such as attended conferences. If your customer
has their own application which provides a similar function, you
can configure Conferencing to use this external application.
Conference Room End An optional ending Bridge Talk conference room assigned to
this DNIS. This setting along with conference room start sets a
range of rooms.
The Standard Edition of Conferencing does not support Bridge
Talk. Bridge Talk is the Avaya application that enables operators
to monitor live conferences and perform actions on live
conferences, such as attended conferences. If your customer
has their own application which provides a similar function, you
can configure Conferencing to use this external application.
Conference Security An optional setting that is only used with the Direct to
Code conference value from the On entry drop-down list. When you
configure the Direct to conference call flow from the On entry
drop-down list., Conferencing places the call directly in a
conference. Using this Conference Security Code field, you
can enter a conference code for use with a Direct to conference
call flow.
For example, consider a deployment with the following values:
• DNIS: 1234
• On entry: Direct to conference
• Conference Code: 5678
When a caller dials in with DNIS 1234, Conferencing places
them in a conference with the passcode 5678. Using this
feature, it is possible to have any number of Direct to conference
call branding entries putting callers into the same conference.
If you do not configure the Conference Security Code field,
Conferencing places a caller who dials in with DNIS 1234 into
Variable Description
a conference that has the passcode 1234. This passcode can
be a moderator passcode, a conferee passcode, or a co-chair
passcode, so at most, Conferencing can route three Direct to
conference call branding entries to a given conference. The
Conference Security Code field eliminates this restriction.
This feature is sometimes called Unlimited DDIs
DDI phones
The DDI phones functionality is optional. DDI Phones configuration is not required for the
successful operation of call branding. The DDI Phones table enables you to associate DDI
telephone numbers with the call branding entry. For example, these telephone numbers are
displayed to conference participants on e-mail invitations.
Reservation groups
The reservation groups functionality is optional. Reservation groups configuration is not
required for the successful operation of call branding. The reservation groups feature enables
participants to use a single conference passcode to enter a number of different conferences.
Reservation groups are not supported in the Standard Edition of Conferencing. They are
supported in the Enterprise Edition of Conferencing.
Related topics:
Configuring the number of digits to match on page 68
Adding a call branding entry on page 73
Editing a call branding entry on page 75
Deleting a call branding entry on page 75
System language on page 283
Participant experience on page 284
Configuring audio messages for your system on page 296
Configuring the playback call flow on page 309
The purpose of this task is to create an association between a particular DDI and a
Conferencing call flow. A call flow refers to the sequential experience of the conference
participant as they dial into a conference or listen back to a conference recording.
Example
For example, you can configure specific conference call flow for each department in
customer site, such as Sales, Finance, and Marketing. You can also configure Conferencing
to route any callers who incorrectly enter the conference telephone number to a help queue,
so that they can speak to an operator. Operators can see a display of the help queue using
the Bridge Talk application or a similar external application. The help queue is also known
as the enter queue.
This example uses the telephone number range from 2710600 to 2710699. In this example
range, only the final two digits vary. All the other digits are the same. This example also
assumes that the Number of digits to match has the value of 4. So, Conferencing reads
the final four digits of an incoming telephone number.
• For the wildcard entry, ensure that ???? is in the DDI field and DDI Unknown is in the
Name field. Select Direct to enter queue from the On entry drop-down list.
• For the Sales department, enter a DDI such as 0601 in the DDI field and Sales
Department in the Name field. Select Scan call flow from the On entry drop-down list.
• For the Finance department, enter a DDI such as 0602 in the DDI field and Finance
Department in the Name field. Select Scan call flow from the On entry drop-down list.
• For the Marketing department, enter a DDI such as 0603 in the DDI field and
Marketing Department in the Name field. Select Scan call flow from the On entry
drop-down list.
In this example, Conferencing routes callers who dial any number in the range 2710604 to
2710699 into the help queue. Conferencing routes callers who dial 2710601, 2710602, or
2710603 to a customized conference call flow for a particular department. The reason for
allocating separate call flows in this example is to enable operators to record a customized
welcome message for each department. This flexibility is useful in enterprise or service
provider deployments. To use this feature, you must configure also the Message Number
field in the call branding table. Conferencing ships with 2000 slots for audio messages but
reserves the first 460 (approximately) for the required messages. Operators using Bridge
Talk could record a message into one of the remaining slots. You must enter this slot number
in the Message Number field.
By default, the On failure drop-down list is set to Direct to enter queue. This means that
if a caller dials the correct telephone number but subsequently enters an incorrect
conference passcode a configurable number of times, Conferencing routes them to the help
queue to be intercepted by an operator.
The purpose of this task is to remove a call branding entry from the Conferencing server.
DDI phones
The DDI Phones functionality is optional. DDI Phones configuration is not required for the
successful operation of call branding.
The DDI Phones table enables you to associate DDIs and telephone numbers in the following
ways:
• You can associate a single DDI with multiple telephone numbers. For example, you can
link a single DDI with an internal telephone number and an external number.
• You can associate a single telephone number with multiple DDIs. For example, you can
specify a single phone number that has multiple DDIs used to access several
conferences.
When you add a DDI phone, you must enter the location of the telephone number and a
description. The location is significant because telephone numbers can be location-specific to
ensure more economical rates.
Related topics:
Adding DDI phones on page 76
Deleting DDI phones on page 77
The purpose of this task is add a telephone number with the aim of creating an association
between DDIs and telephone numbers. Once you add a DDI phone, you cannot edit the details.
To update the details, you must delete the DDI phone and add a new one.
Next steps
Now you can configure Conferencing to handle a number it does not recognize.
The purpose of this task is to remove the DDI phone from the Conferencing server.
added a wildcard entry when you added the regular call branding entries for your telephone
number range. If not, it is a good idea to do it now.
Note:
By default, Avaya ships Conferencing with this wildcard entry already added.
These features enable Conferencing to respond to incorrect or unexpected telephone
numbers.
When Conferencing receives collects too few DNIS/DDI digits. It attempts a partial match in
right to left order. For example, if Conferencing only collects the digits 127 when four digits are
required, it matches these digits to the first entry in the Call Branding table having 127 as its
right most three digits. Conferencing searches the Call Branding table in ascending order until it
finds the first match. This feature, which is enabled by default, works in tandem with the
wildcard entry in the Call Branding table. Using the wildcard feature and the partial match
feature, you can configure how Conferencing handles a telephone number that it does not
recognize. Using these features, Conferencing can handle a partial match or no match at all.
Related topics:
Adding a wildcard on page 78
Adding a wildcard
Avaya recommends adding an entry to the call branding table to deal with situations when
participants dial a telephone number that the Conferencing server does not recognize. You
may already have added a wildcard entry when you added the regular call branding entries for
your telephone number range. If not, it is a good idea to do it now.
Note:
By default, Avaya ships Conferencing with this wildcard entry already added. You cannot
delete the wildcard. These steps are for your information only.
Prerequisites
Before you add a wildcard, you must install Conferencing.
The purpose of this task is to specify how Conferencing deals with a DNIS that is not listed
in the call branding table.
For example, select Direct to enter queue to ensure that Conferencing routes the
caller to the help queue.
Next steps
Now you can configure pattern matching.
Pattern matching
Within the Conferencing environment, pattern matching is necessary because callers use
telephone numbers but Conferencing uses URIs. To enable successful conferencing, you must
match telephone number patterns to URIs. The pattern matching files are called URIToTelnum
and TelnumtoURI.
Simply speaking, the URIToTelnum file states that the Conferencing application server should
recognize a given URI and identify this URI’s corresponding DNIS. The call branding file states
that the Conferencing application server should recognize this DNIS and handle the call in a
certain way, for example, by routing the call into a conference call flow or a conference playback
call flow. Similarly, the TelnumtoURI file states that the Conferencing application server should
recognize a DNIS entered by a moderator during a conference and dial out using a
corresponding URI.
Conference participants dial telephone numbers to access Conferencing. Similarly,
participants dial telephone numbers once they are in a conference to dial out to other potential
participants. These two types of calls are called incoming calls and outgoing calls.
Conferencing changes each telephone number to a URI. A URI consists of a string of
characters used to identify or name a resource on the Internet.Conferencing contains two files,
which translate telephone numbers to URIs. One file converts incoming URIs to telephone
numbers and the other file converts outgoing telephone numbers to URIs. Essentially, these
files act as a conversion between a traditional form of telephony in the form of DNIS/DDI
numbers and the more modern, SIP form of transmission. Before you deploy Conferencing,
you must configure these files.
The files, TelnumToURI and URIToTelnum, use the same format. They contain three columns of
information. The last column contains a comment or textual information about the first and
middle columns. The first column provides a pattern match for the input value. Conferencing
searches this column in order. This column supports wild cards.
In the files, TelnumToURI and URIToTelnum, the middle column provides the translation for the
entry in the first column. This column supports string substitutions using the syntax, $n, where n
is an integer. Essentially, this file functions by looking for a pattern in the left column and
produces an output based on the middle column.
The middle column uses this syntax:
• $0 substitutes the full input string.
• $1 substitutes the first wild card.
• $n substitutes the nth wild card.
The system considers ??? a single wild card, but treats *?* as three distinct wild cards. It is
also worth noting that while * matches any character, not just digits, it does not match empty
strings at the beginning. For example:
*sip:* matches <sip:xxxx@ but does not match sip:xxxx@
So to alleviate this issue, Avaya normally add one extra entry for the empty character:
*sip:*
sip:*
Related topics:
Tel num to URI on page 80
URI to tel num on page 81
Configuring patterns for dialing in on page 83
Configuring patterns for dialing out on page 83
Following the comments, the file has one or more lines containing data. Each data line contains
three pieces of information: TelnumPattern, TelnumConversion, and Comment.
It is unlikely that you should ever have to access this file in its raw state on the application
server. You can now configure these settings using the Conferencing Manager interface.
Entry Description
Telnum This entry is the telephone number that participants dial. This
entry may contain wildcards for pattern matching. For example,
93???? matches any telephone number that begins with the
digits 9 and 3, such as 931234, 939999, or 938765.
URI Conferencing replaces the Telnum with this entry when it dials
out to the new caller. This entry always begins with the
characters sip: followed by the dial out number, the @ character,
and ends with the IP address of the media gateway or proxy.
For example: sip:6352@10.221.10.111. The characters
$1 in this column replace the first wildcard matched from the
Telnum column.
Comment Any text that provides some information about the pattern.
Some examples are: bridge, media gateway, or proxy server.
This field must not have any spaces so many people use
underbars to separate the words.
Avaya recommends adding an entry to handle situations where a participant does not enter a
dial out telephone number. To configure this row, enter an asterisk * in the Telnum column.
This configuration operates for all Conferencing deployments, with the exception of
deployments that include Avaya Web Portal and Avaya Audio Console. If your deployment
includes the Avaya Web Portal and Avaya Audio Console applications, you must include an
entry for these applications in the TelnumToUri.tab file. During the operation of Avaya Web
Portal and Avaya Audio Console, the Conferencing application server makes an outgoing
telephone call to the Conferencing Web server. From the participants’ perspective, this call
occurs behind the scenes. To ensure that Conferencing can make this outgoing call, you must
include a row that uses the asterisk * symbol, using the following syntax:
* sip:1234@<Web Server IP address>modAPIoperator
server should recognize a DNIS entered by a moderator during a conference and dial out using
a corresponding URI.
The UriToTelNum.tab file is stored in the /usr/ipcb/config directory. The UriToTelNum.tab file is
similar in structure to the TelnumToUri.tab file. Each data line contains three pieces of
information: URI, Telnum Conversion, and Comment.
It is unlikely that you should ever have to access this file in its raw state on the application
server. You can now configure these settings using the Conferencing Manager interface.
Entry Description
URI The IP address of the telephone line that the participant dialed.
This entry always begins with the characters sip: followed by
the dial-in number, the @ character, and ends with the IP
address of the media gateway or proxy. Since Conferencing
may not recognize every dial-in telephone number, this entry
usually contains wildcards for pattern matching. For example,
*@10.221.10.11, matches any call delivered via that IP
address.
Telnum Conversion Conferencing replaces the TelnumPattern with this entry and
then routes it to the corresponding call flow.
Comment Any text that provides some information about the pattern.
Some examples are: bridge, media gateway, or proxy server.
This field must not have any spaces so many people use
underbars to separate the words.
As with the TelnumToUri.tab file, Avaya recommends adding an entry to handle situations
where Conferencing receives a call from a URI that it is not defined in the file. To configure this
row, enter an asterisk *, followed by @, and then another asterisk * in the URI column. In
addition, you can add rows for each operator. These rows are optional and are for situations
where you want to be able to dial into a specific operator. If you add these rows, you can ensure
that operators can dial into the Conferencing application server. Use the following syntax for
these lines:
op<DNIS>x<operator index>@<ip address>
The operator index is the identity number associated with an operator, such as operator 1,
operator 2, and so on, rather than the Logical Channel Number (LCN) of the operator. The call
handler does not perform any processing on the DNIS number at this stage, but it is important to
enter a numeric value at this point in the syntax. You can configure a dial in for other channels in
the same way. The other channels are the link, record/playback, and music channels. For
example, for a music channel:
mu<DNIS>x<operator index>@<ip address>
For the link channel, use LK, for the record/playback channel, use RP.
The purpose of this task is to create a pattern to enable Conferencing to recognize a URI.
The purpose of this task is to create a pattern to enable conference moderators to dial out to
other potential participants. As an aside, you can choose to disable this feature in your
deployment.
Example
In this example, Conferencing is connected to a Communication Manager with the IP address
123.45.678.9:
Telnum: *
URI : sips:$0@123.45.678.9:5061;transport=tls
Comment: CallsThroughCM
This instruction uses the wildcard to represent any telephone number. The instruction states
that Conferencing should direct any attempt to dial out to other telephone numbers from
inside a conference to Communication Manager. Communication Manager will then handle
the call from that point onwards. It also refers to the fact that communications between
Communication Manager and Conferencing should use the TLS method of transmission.
The method of transmission must be consistent with the method entered in the SIP Listener
URI and Response Contact fields.
Just as in the case of Communication Manager, if Conferencing is connected to another
device, such as an Audiocodes or a CS1K gateway, you must enter the IP address of the
Audiocodes or CS1K in the URI field, in place of the Communication Manager IP address.
Next steps
Now you can verify your installation.
Verification
It is a good idea, at this stage, to verify the installation and configuration steps that you have
taken so far.
Verification involves testing connectivity to each of the virtual machines that comprise the
Conferencing solution. Verification also involves making a test call and creating a test
conference.
Application server
The application server is also known as the bridge.
You can verify connectivity to the bridge by placing a test call to the Conferencing bridge. In
order to place a test call, Avaya recommends using Avaya Aura™Avaya one-X Communicator.
You can download Avaya one-X Communicator here: https://support.avaya.com/css /
appmanager/css/support/Downloads/P0516#wlp_Downloads_Page
Related topics:
Key features on page 85
Placing a call on page 87
Key features
Basic feature
The Avaya one-X Communicator offer includes the following Basic features:
• Desktop access to all your communication tools from a single, intuitive user interface
• Telephony features similar to Avaya one-X Desktop Edition and Avaya IP Softphone
• Click-to-Dial from Microsoft Office Communicator via Avaya Aura™ Application
Enablement Services
• Click-to-Dial from Microsoft Office Communicator or IBM Sametime Connect via native
Avaya one-X Communicator integration
• Telephony integration with Microsoft Office Communicator or IBM Sametime Connect
• Desktop video for H.323 softphones for face-to-face communications to streamline
decision making and reduce travel expenses
• Click-to-Dial capability from Microsoft Internet Explorer and Mozilla Firefox
• Click-to-Dial capability from Microsoft Outlook Contacts
• Wipe-to-dial (clipboard dialing) capability from any application
• Contact lookup of Microsoft Outlook or IBM Lotus Notes contact from the Avaya one-X
Communicator user interface
• Contact management tools that help you find contact information quickly
• Telephone share control that provides telephony functionality from a server to your
desktop
• Enhanced login preferences: Automatic login and Autostart
• Emergency call handling (not supported with SIP)
• Docking and undocking of Dialpad and Bridge Conferencing windows
• Expanded video options: Full screen option, Always on top feature, and Screen Saver
and Monitor Power Saving feature
• Customization of the emergency call-handling disclaimer, the Avaya one-X logo, and the
title on the Login and Welcome windows
Unified Communications features
Unified Communications features require integration with one-X Portal. These features
include:
• All of the Basic feature set, as described above
• Intelligent presence to determine the best way to reach a colleague quickly
• Visual Voice Mail that allows you to filter and sort voice messages so you can respond to
the most important messages quickly
• Visual Audio Bridge Conferencing that is easy to start, join, and manage for improved
collaboration and conference call effectiveness
• Communication History logs that help you trace the history of your enterprise calls and
voice messages
• Contact management tools that help you find contact information quickly and view the
presence information of corporate contacts
• Presence access requests control
Some functionality also requires integration with additional products.
Placing a call
It is a good idea to place a call from Avaya one-X Communicator to the Conferencing
application server, or bridge, to test connectivity to the bridge.
Prerequisites
Before you place a test call, you must connect Conferencing to your network and configure
the call branding table with appropriate DDI information.
The purpose of this task is to ensure that you have correctly completed the initial installation
and configuration of Conferencing.
Example
Consider a telephone number range from 2710600 to 2710699, with the following call
branding entries:
• For the wildcard entry, enter ???? in the DDI field and DDI Unknown in the Name field.
Select Direct to enter queue from the On entry drop-down list.
• For the Sales department, enter a DDI such as 0601 in the DDI field and Sales
Department in the Name field. Select Scan call flow from the On entry drop-down list.
• For the Finance department, enter a DDI such as 0602 in the DDI field and Finance
Department in the Name field. Select Scan call flow from the On entry drop-down list.
• For the Marketing department, enter a DDI such as 0603 in the DDI field and
Marketing Department in the Name field. Select Scan call flow from the On entry
drop-down list.
To place a call using these example telephone numbers, enter 2710601 in the Telephone
Number field. Through the headphones, Conferencing should respond with a welcome
message and a request for a passcode. You could also test the wildcard entry by entering a
telephone number such as 2710604. In this case, Conferencing should respond by playing
a message to say that you are in a line to speak with an operator.
Next steps
Now, you can test connectivity to the CRS virtual machine by installing CRS Front End and
creating a test conference.
Related topics:
Installing CRS Front End on the CRS server on page 88
Creating a test conference on page 90
Distributing CRS Front End to the operators on page 91
Note:
Avaya installs an instance of CRS Front End on the CRS virtual machine, by default. The
installation steps are included here for information purposes only.
It is a good idea to install an instance of CRS Front End on the CRS virtual machine. Using
this instance of CRS Front End, you can create a test conference and verify the installation
and configuration steps that you have completed so far. It is a good idea to test the deployment
at this stage, before you distribute the Conferencing applications to the operators and
moderators in your deployment.
Prerequisites
Before you install CRS Front End on the CRS server, you must install Conferencing.
The purpose of this task is to install an instance of CRS Front End so that you can create a
test conference and perform a test call.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
2. In a Windows Explorer dialog, navigate to Avaya > ClientInstall and double-click
crs_client_suite to launch the installation wizard for the CRS Front End.
3. Navigate through the installation wizard. You require the CRS virtual machine IP
address to complete the installation.
On the final dialog of the installation wizard, you can click the Generate an
automatic installation script button to create an installation script which contains
each of the choices you made as you navigated through the wizard. This is useful
for installing the CRS Front End on the client machines for operators.
4. When the installation completes, you can start the CRS Front End on the CRS virtual
machine.
5. Enter admin in the Password field.
6. Click System Administration and click the Bridges tab to verify that the CRS has
visibility of the Conferencing application server.
Next steps
You can now create a conference to verify the installation and configuration steps that you
have completed so far.
Prerequisites
Before you verify the installation, you must install and configure Conferencing and install an
instance of CRS Front End.
The purpose of this task is to create a company, a client, and a conference in order to test the
Conferencing connectivity.
1. On CRS Front End, click Customer Bookings and click Create Company.
2. Create a company for testing purposes. The only mandatory fields on the New
Company dialog are Name and Phone.
3. Select the newly created company and create a client for testing purposes. The only
mandatory fields on the New Client dialog are Name and Phone. However, to
enable access to Web Portal, you must enter a Password and an E-mail address.
4. Make a note of the password and e-mail address.
5. Select the newly created client and click Create Reservation.
6. Verify that the Check Reservation dialog displays the IP address of the
Conferencing application server in the Cabinet drop-down list.
7. Select On Demand to create an on-demand conference that is available at any time
and requires no scheduling.
8. Enter the number of participants in the Participants field. For example, 10.
9. Select Moderator and select Data.
The reason for selecting Moderator is to enable you to test the conference using a
participant entry and using a moderator entry. The reason for selecting Data is to
enable you to test the AWC component.
At any time, you can click DNIS/DDI to view the call branding entries.
10. Click OK and then click Confirm.
11. Enter a name for the conference. For example, Test Conference.
12. Click OK.
13. Make a note of the DDI, the conference reference number, the participant code, and
the moderator code. Click OK.
14. Place a call using Avaya one-X Communicator and enter the moderator code at the
audio prompt.
Next steps
Now you can test connectivity to the Web Portal and AWC virtual machines. Alternatively, you
can distribute the CRS Front End to your team of operators.
Prerequisites
Before you distribute the CRS Front End to the operators, you must install Conferencing and
perform some configuration steps. It is also a good idea to verify the installation before you
make the CRS Front End widely available.
The purpose of this task is to provide operators with a graphic user interface for managing
customer accounts, scheduling conferences, and viewing reports.
Web Portal
The Web Portal is like a Web deployment of the CRS Front End. It provides moderators with
a Web interface for scheduling their conferences. It provides administrators with a Web
interface for managing moderators. However, there are some limitations and it does not provide
access to the full range of CRS Front End functions.
The Web Portal interface is divided into parts defined by unique URLs.
• Moderator’s section
The Web Portal moderator’s section enables moderators to book and manage
conferences, contacts, and account information and view reports. It is a good idea to
provide moderators with the Using Avaya Aura™ Conferencing Guide, which is available
from support.avaya.com. The Web Portal moderator URL is: http://Web Portal virtual
machine IP/webportal/login.
• Administrator’s section
The Web Portal’s Administrator’s section enables administrators to configure available
functionality, define the appearance of the Web Portal, and generate administrator
reports. The Web Portal administrator URL is: http://Web Portal virtual machine IP/
webportal/admin/login.
It is important to note that the Web Portal virtual machine uses the Linux operating system.
As a result, you cannot use the Windows remote desktop feature to access the Web Portal
virtual machine.
Related topics:
Accessing Web Portal on page 92
Accessing Web Portal using PuTTY on page 93
Client registration server on page 249
Login type on page 249
Mail server on page 250
Mail from on page 250
SSL enabled on page 251
SSL certificate on page 251
SSL private key on page 251
HTTPS on page 252
Brand prefix on page 252
Prerequisites
Before you verify the installation, you must install and configure Conferencing.
The purpose of this task is to log in to Web Portal to view the on-demand test conference that
you created using CRS Front End.
1. On any machine in your network, such as the Conferencing Manager server, open a
Web browser.
2. Enter the following URL: http://Web Portal virtual machine IP/
webportal/login and press Enter.
3. Enter the e-mail address and password for the client that you created using CRS
Front End.
Each client that you create using CRS Front End equates to a moderator in the Web
Portal environment.
4. Click Login.
Web Portal displays the My Schedule screen. You should be able to see the on-
demand test conference that you created using CRS Front End in the list of currently
scheduled conferences.
Next steps
As an additional verification step, you could use CRS Front End to create a test administrator
account. Make a note of the name and password that you configure for this test administrator
account. In the browser, enter http://Web Portal virtual machine IP/webportal/
admin/login and enter the name and password of the newly created administrator. Click
Login. Web Portal should display the Admin Reports screen.
Prerequisites
Before you verify the installation, you must install and configure Conferencing.
The purpose of this task is to log in to the Web Portal virtual machine using PuTTY to ensure
connectivity to the virtual machine..
3. On the PuTTY dialog, enter the IP address of the Web Portal virtual machine and
click Open.
4. Log in using the name craft and the password craft01.
The Web Portal virtual machine should respond with a prompt.
Next steps
You can now verify the Avaya Web Conferencing (AWC) virtual machine.
Related topics:
Accessing AWC on page 95
Accessing AWC
Prerequisites
Before you verify the installation, you must install and configure Conferencing.
The purpose of this task is to log in to AWC to view the on-demand test conference that you
created using CRS Front End.
1. On any machine in your network, such as the Conferencing Manager server, open a
Web browser.
2. Enter the following URL: http://AWC virtual machine IP/
conferencing and press Enter.
AWC should display the Avaya Web Conferencing Login Page.
3. Enter a name and telephone number.
4. Enter the conference reference number and the moderator passcode that you made
a note of when you created a test conference.
5. Click Login.
The AWC interface is displayed.
Next steps
Now you have installed Conferencing and verified the installation. You can now configure
Conferencing to match the customer requirements and the customer environment.
Note:
If you change the IP address, host name, or domain name of any of the Conferencing virtual
machines, you must re-configure logs and alarms.
The following tables describe the Conferencing logs and alarms. In the following tables, the
<> symbols represent a variable.
Web Portal logs and alarms
The Web Portal generates a number of logs and alarms. For example, the Web Portal
generates a log when administrators or moderators log in to Web Portal.
Note:
You can view some of this information in a file on the Conferencing Manager virtual machine.
This file is located on the Conferencing Manager virtual machine in the following location:
/var/log/Avaya/mgmt/resource/com/avaya/conferencing/bridge/
EventCodes.properties
Here is an example of the output:
OP-BRIDGE00003 Reserved Port Pool Usage has increased above upper
watermark - up per watermark/max. ports: {0}/{1}
OP-BRIDGE00004 Reserved Port Pool Usage has decreased below lower
watermark - lo wer watermark/max. ports: {0}/{1}
OP-BRIDGE00005 Unreserved Port Pool Usage has increased above upper
watermark - upper watermark/max. ports: {0}/{1}
OP-BRIDGE00006 Unreserved Port Pool Usage has decreased below lower
watermark - lower watermark/max. ports: {0}/{1}
OP-BRIDGE00009 Host server has rebooted OP-BRIDGE00010 Disk is
full. {0}.
OP-BRIDGE00011 High disk utilization. {0} {1} percent used.
OP-BRIDGE00012 High CPU utilization. System idle {0} percent.
Related topics:
SAL connectivity settings
Three pieces of information on page 104
Port pool usage thresholds on page 176
Related topics:
SAL connectivity settings
Logs and alarms on page 97
Enrollment password on page 104
Avaya AuraConferencing 6.0 Managed Element ID on page 104
Avaya Aura Alarming ID on page 104
Enrollment password
An enrollment password is a unique code that Conferencing Manager generates. You require
this code in order to configure logs and alarms. As an alternative to accepting the code that
Conferencing Manager provides, you can enter your own phrase as an enrollment password.
The purpose of this task is to obtain the three pieces of information that are necessary for the
successful operation of logs and alarms.
Next steps
Now you can configure logs and alarms.
Related topics:
SAL connectivity settings on page 147
Next steps
Now you can view the logs and alarms. Optionally, you can configure the logs and alarms to
transmit to a Network Management System (NMS).
Related topics:
SAL connectivity settings on page 147
The purpose of this task is to enable the transfer of logs and alarms to an NMS so that you
can leverage the features of an NMS.
Next steps
Now you can configure more Conferencing settings. It is also a good idea to verify that
Conferencing Manager is successfully generating logs and alarms by viewing them on
Conferencing Manager.
Prerequisites
You must configure logs and alarms before you can view them.
It is a good idea to view the logs and alarms at this stage in order to verify that your configuration
steps have been successful.
Folder Description
Check for communication issues with
Conferencing Manager
/var/log/avaya/spirit.log Conferencing components log to this file using
rsyslog
Lines in this file should be in the correct Avaya
Common Logging Format (CLF)
All CLF lines should be forwarded to Conferencing
Manager as a log and as an alarm
An application server is the location of many of the core Conferencing processes. It is the
"heart" of the Conferencing solution. It handles all telephone calls to Conferencing and selects
a media server on which to terminate each call. It interprets all DTMF inputs, SIP information,
database requests, and it processes billing data. The application server communicates with
the media server to provide a complete Conferencing solution. It is often called a call handler
application server or bridge or audio conferencing server.
In the Standard Edition of Conferencing, the application server and the media server reside
on the same virtual machine. In the Enterprise Edition of Conferencing, the application server
and the media server can reside on separate virtual machines.
The Conferencing media server provides a number of functions, such as, audio mixing, Dual
Tone Multi Frequency (DTMF) detection, message playing, and conference recording. In the
Standard Edition of Conferencing, the media server and the application server reside on the
same box: An IBM 3550 server.
The configuration of the application server involves the configuration of five aspects of
application server properties. The five aspects are:
• Bridge features
• Conference features
• Call routing
• System configuration
• General configuration
Related topics:
Bridge features on page 112
Conference features on page 121
Call routing on page 136
System configuration on page 141
General configuration on page 150
Bridge features
The bridge features consists of five different sections:
• Media servers
• Prompt set management
• Bridge features
• Scheduling
• Sign-in users
In the case of each of these areas, the documentation describes each setting. Following the
field descriptions, there is a description of how to configure a sample setting.
Related topics:
Media servers on page 112
Prompt set management on page 112
Bridge features on page 113
Scheduling on page 116
Sign in users on page 118
Configuring bridge features on page 120
Media servers
In the Standard Edition of Conferencing, the application server and the media server reside
on the same virtual machine. In the Enterprise Edition of Conferencing, the application server
and the media server are separate. In the Enterprise Edition of Conferencing, the media
server(s) are on dedicated servers, rather than virtual machines.
Related topics:
Audio messages and prompt sets on page 291
Viewing prompt sets on page 298
Bridge features
The bridge features settings relate to the behavior of the Conferencing application server, or
bridge, during a live conference. This section contains settings relating to audio messages and
DTMF commands, among other aspects of Conferencing. This section also includes settings
relating to features such as operator assistance and blast dial out.
Related topics:
Name record playback seconds on page 113
Recite wrong passcode on page 114
Mute participants during playback on page 114
Automatic conference clear on page 114
Attended originator dial out on page 115
Operator assistance on page 115
On hold message frequency on page 116
Startup notify time on page 116
An operator must run the Conference Clear_all command in Bridge Talk to remove
features from completed attended conferences.
Operator assistance
Operator Assistance specifies whether operators provide help to entire conferences or only to
the participant who requests help. When an operator provides help only to the participant who
requested the help, Conferencing temporarily removes the participant from the conference to
speak privately with the operator. The default option is INDVL. Conferencing operators
individually help participants requesting help from muted lines, regardless of the setting.
• INDVL
The operator helps only individual conferees who request help.
• CONF
The operator provides help to the entire conference. Conferencing does not remove
anyone from the conference. All conferees hear whatever assistance is provided by the
operator.
Typically, a feature involving operators requires Bridge Talk. Bridge Talk is an application which
enables operators to monitor conferences. The Standard Edition of Conferencing does not
support the Bridge Talk application but it can support an external application with similar
features. You can configure this application to operate with Conferencing using the ACP API.
Scheduling
The Scheduling section contains a list of features. These features are not installed on the
Conferencing server, by default. If you require access to these features, you must enable them.
These features are free. Avaya does not charge for them.
Conferencing Manager only displays the Line overbooking and Overbook percent fields
when it is not associated with a Client Registration Server (CRS). When there is a CRS
association, you can control the overbooking settings on the Elements > Conferencing >
Client Registration > General > General Settings using the Allow Infinite Ports and
Overbook Percent fields.
Related topics:
Pin code on page 117
Line overbooking on page 117
Overbook percent on page 117
Flex call flow on page 118
Pin code
Pin Code specifies whether PIN codes are enabled in your Conferencing deployment. A PIN
code is an identification number that is unique to each participant. In a deployment with PIN
codes enabled, operators and moderators can book unattended conferences which require
participants to enter their conference passcode and their PIN code before accessing the
conference.
Line overbooking
Line Overbooking is the process of reserving more than the maximum number of available
telephone lines for a given time period. This functionality ensures that you can maximize the
use of Conferencing by allowing for the fact that in many cases, full conference attendance
does not occur. Operators and moderators can overbook for scheduled conferences. The
overbooking feature does not impact on-demand conferences.
In a sense, the overbooking feature increases the reserved port pool by providing an additional,
virtual reserved port pool. If the overbooking percentage is too high, Conferencing may reject
participants if too many participants attempt to attend a conference and there are not enough
available ports. It is important to set the overbooking percentage at an appropriate level for the
usage pattern associated with your deployment of Conferencing.
To enable the overbooking feature in your deployment, you must enable this parameter. You
must also configure the overbooking percentages on the CRS server. The CRS parameter is
called Overbook Percent.
Overbook percent
The overbooking feature increases the available ports by providing a pool of additional virtual
ports. These virtual ports are available for reserved conference bookings. This functionality
ensures that customers can maximize the use of Conferencing by allowing for the fact that in
many cases, full conference attendance does not occur.
The Overbook Percent parameter specifies the percentage of Conferencing lines that
operators and moderators can overbook for scheduled conferences. This parameter does not
impact on-demand conferences. By default, the value of the Overbook Percent parameter is 0.
• If the value of the Overbook Percent parameter is between 1and 100:
Operators and moderators can reserve a percentage from 1% to 100% more than the
maximum number of lines available for a given time period. Lines configured for operators,
music, record/playback, or link lines are not included in the line count. For example, if
your deployment of Conferencing has 1000 lines available for scheduled conferences and
you set this parameter for 10%, you can schedule 1100 lines.
• If the value of the Overbook Percent parameter is 0:
Conferencing allows infinite conference overbooking.
Related settings
To make overbooking available in your deployment, you must also enable the Line
Overbooking feature on the Conferencing application server, or bridge.
A related parameter is the On Demand Pct % parameter.
Example scenario
In practice, it is a good idea to set the Overbook Percent parameter to 0 which is infinite and
On-Demand Pct (%) to 50%. Avaya sets the On-Demand Pct (%) to 50%. These values allow
for 50% of the ports to be allocated to on-demand conferences and 50% to be allocated to
scheduled conferences. The available ports is the total number of telephone lines with the total
number of FDAPI resources subtracted from this total. FDAPI resources include operator
telephone lines and playback telephone lines.
Sign in users
A sign-in consists of a login name and a password created to enable an application or a user to
connect to the Conferencing application server. Each application that uses the ModAPI
conventions to connect to the application server requires a sign-in. Similarly, each user, such
as an administrator or an operator, requires a sign-in.
Each sign-in type also has a privilege level. The privilege level for a sign-in specifies which
resources that sign-in can use and what management interface menus the sign-in can access.
Users with the higher-level sign-ins can access more resources than users with lower-level
sign-ins.
Sign ins were particularly important in older versions of Conferencing because system
administrators had to perform many of the configuration tasks using the command line menu.
Although the Standard Edition of Conferencing does not support Bridge Talk, sign ins are still
important. For example, you require a sign in for some integrations, such as the Conferencing
Plug in for IBM Lotus Sametime.
There are four sign-in levels.
Note:
The Standard Edition of Conferencing does not support Bridge Talk.
Related topics:
Configuring sign ins on page 120
The purpose of this task is to make changes to the Conferencing default properties to match
the requirements of your deployment.
Example
For example, if you wish to enable dial out for moderators during live conferences, select
Attended ODO.
Conference features
The conference features consists of several different sections:
• Conference defaults
• Conference settings
• Conference error behavior
• Conference features
• Ad-hoc conferencing
In the case of each of these areas, the documentation describes each setting. Following the
field descriptions, there is a description of how to configure a sample setting.
Related topics:
Conference defaults on page 122
Conference settings on page 125
Conference error behavior on page 131
Conference features on page 133
Adhoc conferencing on page 134
Configuring conference features on page 135
Conference defaults
The Conference Defaults settings are the automatic values that are assigned to conferences,
outside of moderator intervention. A moderator or an operator can overwrite some of these
values at conference booking time. These conference default values are similar to preset
properties.
Related topics:
Tone type on participant entry on page 122
Tone type on participant exit on page 122
Play first person message on page 123
Single person (SP) 1st period on page 123
Number of SP subsequent prompts on page 123
SP prompt waiting period on page 123
Auto extend conference duration on page 123
Auto extend conference ports on page 124
Early start minutes on page 124
Conference passcode on page 125
uses an External Passcode Validation (EPV) process, Auto Extend Conference Duration is
always disabled.
• Default on
Conferencing attempts to extend unattended conferences. Successful extension
depends on the availability of telephone lines and passcodes. Operators and moderators
can change this setting on a per-conference basis, using many of the Conferencing
booking applications.
• Default off
Conferencing does not attempt to extend unattended conferences. Operators and
moderators can change this setting on a per-conference basis, using many of the
Conferencing booking applications.
• Always off
Conferencing does not attempt to automatically extend unattended conferences.
Operators and moderators cannot change this setting on a per-conference basis.
default value is Off. Two or more conferences may have conflicting passcodes if you enable
Early Start Minutes and an operator or moderator extends an earlier conference. Conferencing
detects when a conflict will occur. As a result, if Conferencing detects a conflict, operators and
moderators cannot edit and save their reservation until they change the conference start or
end time.
• Off
Participants cannot enter conferences earlier than the scheduled start time.
• 1 - 10, 15, 20, 25, 30
Participants can enter conferences earlier than the scheduled start time. The setting
specifies how early, in minutes, that participants can enter conferences.
Conference passcode
In a flexflow conference, Conference Passcode allows for an additional passcode that
participants must enter on their telephone keypad to join the flexflow conference. A moderator
creates the passcode using DTMF commands when starting the conference. Conferencing
does not save the passcode after the conference ends. This parameter does not apply to
regular conferences, which are sometimes called scan conferences.
Conference settings
Using the Conference Settings section, you can configure a large number of settings for
conferences, such as how long to retain conference records and the number of available lines
for on-demand conferences. These values are global values.
Using the Conference Settings section, you can configure Conferencing to play a tone, a voice
message, or both to notify participants of conference events, provide instructions for
conference functions, and announce how much time is left in a conference.
• If you select Tone, Conferencing sounds the currently defined tone to indicate a condition.
• If you select Message, Conferencing plays a preassigned voice message (msg nnn) to
indicate a condition.
• If you select Both, Conferencing sounds the tone and plays a preassigned voice message
to indicate a condition.
Tip:
Avaya recommends using Tone or Both when an immediate warning is required. The
Message setting could delay the warning message if all annunciators are busy when the
condition requiring the warning occurs. The settings apply to every conference supported
by Conferencing. You do not have to reboot the system after changing settings. You can
also configure entry and exit tones on a per-conference basis using any of the Conferencing
booking applications.
Related topics:
Scan time on page 126
Scan attempts on page 126
Auto hang-up on page 127
Warning tones on page 127
Originator dial out on page 127
Automatic security codes on page 128
Conference retention on page 128
On demand percentage on page 128
Conf name required on page 129
ODO messages on page 129
Security on message on page 130
Security off message on page 130
Conference entry message on page 130
Conference exit message on page 130
Security error 1 and 2 message on page 130
Security error 3 message on page 130
PIN code error 1 and 2 messages on page 130
PIN code error 3 message on page 131
Termination warning (15-1 min) messages on page 131
Termination now message on page 131
Scan time
Scan Time represents the number of seconds (5 to 20) that Conferencing scans for additional
passcode digits after a participant enters the first digit. The default is 20 seconds. Avaya
recommends adjusting this parameter to accommodate the longest passcode on your system.
This parameter applies to blast dials only. In a blast dial, the called party must acknowledge
the call using a DTMF command within a configurable time. This step ensures that
Conferencing quickly disconnects calls that are answered by voicemail.
Scan attempts
Scan Attempts specifies the number of times that Conferencing prompts for a passcode. The
possible values are 1, 2, or 3 times. The default value is 3.
Auto hang-up
Auto Hang-Up specifies whether Conferencing disconnects all lines when the conference
duration expires. This feature is especially important in a deployment in which there are no
operators. Another parameter, the Auto Extend Duration parameter enables moderators to
extend their conferences up to 100 minutes beyond the specified end time. By default, Auto
Hang-Up is not enabled.
• If you enable Auto Hang-Up:
Conferencing disconnects all lines when a conference duration expires. All lines become
immediately available.
• If you do not enable Auto Hang-Up:
Conferencing does not automatically disconnect all lines.
Warning tones
Warning Tones specifies whether Conferencing plays warning tones to remind participants that
conference time is about to expire. By default, Warning Tones are not enabled.
• If you enable Warning Tones:
Conferencing plays warning tones before disconnecting conference lines.
• If you do not able Warning Tones:
Conferencing does not play warning tones before disconnecting conference lines.
Unattended moderators of unsecured conferences can access free lines for dial out, if
sufficient channels are available based on the conference reservation.
• All
Moderators can dial out for both secured and unsecured conferences.
Conference retention
Conference Retention sets the number of weeks that Conferencing retains conference records.
The default value is 52 weeks.
• 1 to 52
The number of the most recent weeks for which you want to retain conference records.
For example, if you want to retain conference records from the last ten weeks, enter 10
for this parameter.
•0
Do not retain any records expired as of midnight of the previous day.
On demand percentage
On Demand Pct % specifies the percentage of Conferencing telephone lines or ports available
for on-demand conferences. On-demand conferences are unattended conferences that can
be convened on an ad hoc, first-come, first-served basis. The remaining percentage of
Conferencing capacity is designated for regularly scheduled conferences.
An on-demand conference is a conference that is available whenever the conferees require it.
On-demand conferences are also known as demand conferences. Each instance of an on-
demand conference requires no additional scheduling. Participants can access the on-
demand conference provided they have the appropriate telephone number and passcodes.
A scheduled conference is a conference that has a defined start time and end time. When
operators or moderators book a scheduled conference, Conferencing reserves system
resources to cater for the duration and size of the conference.
It is important to take account of the Conferencing usage pattern when assigning the allocation
of ports for scheduled and on-demand conferences. For example, consider the following
scenario: If the customer buys a 500 port license, they have 500 ports available for allocation to
either scheduled or on-demand conferences. If you set On-Demand Pct (%)=0, all available
ports are available for scheduled conferences only. In this configuration, there is no on-
demand capability and Conferencing cannot cater for on-demand conferences. However, if
you set On-Demand Pct (%)=100, all available ports are available for on-demand conferences
only. In this configuration, there is no scheduled conference capability and Conferencing
cannot cater for scheduled conferences.
A related parameter is the Overbook Percent parameter.
Related topics:
User access on page 310
ODO messages
Conferencing plays this tone/message when a moderator attempts to dial out to another
telephone line during a conference but Conferencing is unable to accommodate the request.
Security on message
Conferencing plays this tone/message when an operator or moderator locks a conference.
Related topics:
Invalid code on page 131
Timeout on page 132
Conference secured on page 132
Max lines reached on page 132
Invalid time of day on page 133
Invalid code
Invalid Code specifies the Conferencing response to participants who enter an invalid
passcode. The Scan Time parameter specifies the allowed time. The default value of Invalid
Code is ENTER.
• ENTER
Conferencing places the participant in the Enter conference to wait for operator
assistance.
• HANG-UP
Timeout
Timeout specifies the Conferencing response to participants who do not enter the digits within
the time allowed. The Scan Time parameter specifies the allowed time. The default value of
Timeout is ENTER.
• ENTER
Conferencing places the participant in the Enter conference to wait for operator
assistance.
• HANG-UP
Conferencing disconnects the caller.
Conference secured
Conference Secured specifies the Conferencing response to participants who enter invalid
passcodes for conferences that have been secured by a moderator. The default value is
ENTER. Moderators press *7 on their telephone keypad to secure a conference.
• ENTER
Conferencing places the participant in the Enter Conference to wait for operator
assistance.
• HANG-UP
Conferencing disconnects the caller.
Conference features
The Conference Features section contains a short list of features. If you require access to
these features, you must enable them.
Related topics:
Digital conference record playback on page 133
Unattended blast on page 133
Unattended blast
Unattended Blast relates to the ability of moderators to dial out to a group of potential
participants during an unattended conference call. In a typical blast dial, Conferencing dials
an entire list of phone numbers simultaneously. When potential participants answer the call,
an audio message prompts them to press specific digits on their telephones to join the
conference. The blast dial feature uses dial lists to store the information that it requires.
• If you select Unattended blast:
Moderators can dial out to a list of telephone numbers simultaneously.
• If you do not select Unattended blast:
Moderators cannot dial out to a list of telephone numbers simultaneously.
Adhoc conferencing
Conferencing provides adhoc conferencing functionality for video conferences.
Adhoc video conferencing is the instant creation of a video conference. An adhoc video
conference does not require an on-demand conference reservation. Typically, an adhoc video
conferences is created when two people, talking on the telephone, decide that they require the
participation of a further person (or people). One of the original people can press the
Conference button on their telephone keypad to instantly create an adhoc video conference
hosted by the Conferencing server. The adhoc video conferencing feature requires a video-
enabled deployment.
In a non video-enabled deployment, two people can instantly create an audio conference. As
with the adhoc video conferencing feature, they do not require an on-demand conference
reservation. One of them can press the Conference button on their telephone keypad to add
participants to their call. This type of call is hosted on Communication Manager. Currently,
Communication Manager uses the application server (bridge) for ad-hoc video conferences.
It does not use the bridge for ad-hoc audio conferences.
By allocating telephone lines, or ports, to the adhoc video conferencing feature, you may risk
resource shortages for regular conferencing. To determine how many adhoc video
conferencing ports that you require in your organization, you must consider a number of points:
• You should consider the number of users to whom you intend to allocate the adhoc video
conferencing capability. Using the Communication Manager Class of Service (COS)
setting, you can control the allocation of this feature to certain individuals.
• You should also consider the bandwidth usage patterns of each individual. For example,
using Communication Manager Priority Video Calling, you can choose to allocate a higher
bandwidth to selected VIP users. These users will each now occupy multiple ports.
• You should consider whether you intend to isolate a certain number of ports for selected
VIP users. In this scenario, you can segregate a number of ports to ensure guaranteed
port availability even during high usage peak times. This configuration limits port
availability for regular users.
• Lastly, before making a decision on the number of ad hoc video conferencing ports that
you require, it is a good idea to monitor general usage patterns over time. For example,
it may be the case that consumption patterns peak at certain times or it may be the case
that consumption is spread over a number of timezones, creating a flatter pattern. You
can perform an audit on the CDR files to obtain this information.
Related topics:
URI pattern on page 135
Min ports available on page 135
Default conference size on page 135
URI pattern
URI Pattern is the pattern used in the construction of the unique conference Uniform Resource
Identifier used to join the conference. It is of the form sip:AdhocDirect$1@$2 where $1 is
replaced by the conference passcode and $2 is replaced by the Conferencing IP address.
The purpose of this task is to make changes to the Conferencing default properties to match
the requirements of your deployment.
Example
For example, if you wish to configure Conferencing to disconnect any caller who enters an
invalid passcode, select HANG-UP from the Invalid Code drop-down list.
Call routing
For the most part, call routing is described as part of configuring the Conferencing telephone
numbers. The remaining aspects of call routing involve dialing out from a conference to a
potential participant or a group of potential participants.
Related topics:
Call routing on page 67
Dial out on page 137
Blast dial settings on page 138
Dial out
Conferencing can dial out to a group of participants and invite them to join the conference. For
the successful operation of this feature, Conferencing must have access to a dial list or an
LDAP dial list. The parameters in this section refer to the LDAP dial list feature.
Dial list
Conferencing automatically saves the current conference participant list as a dial list using the
conference reference number as the filename. Conferencing makes this file available for
transfer to a dial list directory on the Conferencing application server. An operator or a
moderator can also associate a dial list that is currently saved in the dial list directory on the
Conferencing application server with the current conference.
LDAP dial list
Operators can also link an LDAP dial list with the conference using the CRS Front End. In
simple terms, an LDAP (Lightweight Directory Access Protocol) is a list of details about
members of an organization in a series of groups. Operators can choose one of these groups
and link it to the conference. Moderators and operators can then perform a blast dial, which
is a simultaneous dial out to the dial list. When a moderator initiates the blast dial feature in a
conference with an LDAP dial list, Conferencing calls these group members. Moderators can
initiate a blast dial by entering *92 on their telephone keypad or using the Audio Console or
Roster View interface. Operators can initiate a blast dial using Bridge Talk. During an LDAP
blast dial, Conferencing adds an international, country, and local prefix to the telephone
numbers listed in the LDAP dial list. Conferencing supports the + character in these fields.
Note:
The Standard Edition of Conferencing does not support the Bridge Talk application.
Related topics:
Country code on page 137
International prefix on page 138
Local prefix on page 138
Blast dial settings on page 138
Configuring blast dial settings on page 372
Country code
Country Code is a numeric sequence that Conferencing adds to a telephone number when a
moderator or operator uses an LDAP dial list for a blast dialout. This field accepts a maximum of
three digits. The country code identifies the country. Examples include 44, 1, 61, and so on.
International prefix
International Prefix is a numeric sequence that Conferencing adds to a telephone number when
a moderator or operator uses an LDAP dial list for a blast dialout. This field accepts a maximum
of three digits. The international prefix identifies the call as an international call. For example,
011.
Local prefix
Local Prefix is a numeric sequence that Conferencing adds to a telephone number when a
moderator or operator uses an LDAP dial list for a blast dialout. This field accepts a maximum of
three digits. The local prefix identifies an area or region within a country.
Aside from the blast dial list feature, Conferencing enables moderators to dial out to multiple
participants using another method. Using Web Portal, moderators can add participants to their
personal address book. Using Avaya Audio Console, moderators can dial out to single or
multiple participants from their address book. They can also edit and save their address book
as a .csv file. There is no direct relationship between blast dial lists stored on the application
server and the address book feature. For more information on the address book feature, see
Using Avaya Aura™ Conferencing Guide, which is available from support.avaya.com.
Note:
The Standard Edition of Conferencing does not support the Bridge Talk application.
Related topics:
Dial out on page 137
Maximum concurrent channel blast on page 139
Delay between blasts on page 139
Invalid code entered on page 139
Scan time on page 140
Call progress timeout on page 140
Configuring blast dial settings on page 372
The participant is placed in the Enter Conference queue to wait for operator assistance.
• HANG-UP
Conferencing disconnects the caller.
The Invalid Code setting also specifies the Conferencing response to participants entering
codes for secured blast conferences. This parameter applies to coded blast dials only. In coded
blasts, the called party must acknowledge the call using a DTMF command within a
configurable time. This step ensures that Conferencing quickly disconnects calls that are
answered by voicemail.
Scan time
Scan time is the number of seconds (5 to 20) that Conferencing scans for additional passcode
digits after a participant enters the first digit. The default is 20 seconds. Avaya recommends
adjusting this parameter to accommodate the longest passcode on your system. This
parameter applies to coded blasts only. In coded blasts, the called party must acknowledge
the call using a DTMF command within a configurable time. This step ensures that
Conferencing quickly disconnects calls that are answered by voicemail.
System configuration
The system configuration consists of four different sections:
• Networking
• NFS mounts
• SAL connectivity settings
• Miscellaneous
In the case of each of these areas, the documentation describes each setting. Following the
field descriptions, there is a description of how to configure a sample setting.
Related topics:
Networking on page 141
NFS mounts on page 145
SAL connectivity settings on page 147
Miscellaneous on page 148
Configuring system configuration on page 149
Networking
The Networking section lists a number of settings relating to the Conferencing media server.
The media server component of Conferencing provides a number of functions, such as, audio
mixing, Dual Tone Multi Frequency (DTMF) detection, message playing, and conference
recording.
Related topics:
Network type on page 141
Diff serv signalling TOS value on page 142
Diff serv media TOS value on page 142
Ethernet signalling VLAN value on page 142
Ethernet media VLAN value on page 143
Enable firewall service on page 143
Enable SIP proxies on page 143
SIP proxy configuration on page 143
Network type
Network Type represents the speed of the customer network.
When Avaya ships Conferencing to a customer site, Avaya configures it to fit to a 100 megabit,
full duplex network. This is 100BASE-TX and it is the default setting. If the customer’s network
is a gigabit network, you must change this configuration setting to 1000BASE-T. Also, if a
customer has more than 700 telephone lines with a single connection to the switch, you must
change this configuration setting. It is likely that the Conferencing server will drop calls if you
do not change the default megabit setting in a customer site with over 700 ports connected
with a single connection to the switch.
Related topics:
Configuring SIP proxies on page 144
The purpose of this task is to enable Conferencing to route SIP calls via an SES proxy.
Next steps
Now you can configure further settings, such as NFS mounts.
NFS mounts
Typically, customers use an external Network File System (NFS) server to store conference
recordings. An external NFS server offers more space for recordings than an NFS server that
resides on the application server. An NFS server is a key component of the Conferencing
solution. You should always consider the robustness of connections and hardware. You should
also consider the NFS server when planning outages that impact the Conferencing experience.
Each Conferencing server has two LAN NIC connections that you can use to bind to virtual
Linux interface bond0:
• Eth0
• Eth2 or Eth 3
Eth1 is always the services port.
Avaya recommends that you connect all systems to the customer LAN infrastructure with
resilience in case of unforeseen outages between the NFS client and the NFS server which
disrupt conferencing. Also, ensure that you connect the NFS server into the same LAN
switching infrastructure as the Conferencing solution
The NFS server, which the customer provides, should have similar capabilities to the
application server. It should be dual-homed and be able to detect and switch over without
interruption. Ideally, you should hard wire the NFS server into the same LAN switching
infrastructure as the Conferencing server.
Related topics:
NFS server IP address
Configuring the external recording server (NFS) on page 146
The purpose of this task is to make Conferencing aware of an external server for storing
recordings. These steps also describe the configuration tasks on the external NFS server-side.
When you apply changes, Conferencing restarts. It is a good idea to apply changes
only when you are finished all your configuration tasks.
9. Access the NFS server box.
You can use PuTTY to access the NFS server box:
a. Download PuTTY from http://www.chiark.greenend.org.uk/~sgtatham/putty/
download.html.
b. Start PuTTY.
c. On the PuTTY dialog, enter the IP address of the NFS server and click Open.
10. Create a directory called /var/usr3/confrp.
11. Edit the /etc/hosts file to add the Conferencing application server.
12. Add the following line to the /etc/exports file:
/var/ <name of application server>(rw, async, no_root_squash)
The NFS server is now configured.
Next steps
Now you can configure further settings, such as the notification service. It is also a good idea to
verify the operation of the NFS server.
Related topics:
Enrollment password on page 104
Avaya AuraConferencing 6.0 Managed Element ID on page 104
Obtaining the three pieces of information on page 105
Configuring logs and alarms on page 106
Miscellaneous
The Miscellaneous section lists the Flexible Digital Auxiliary Port Interface (FDAPI) resources.
If you are familiar with previous version of Conferencing, the FDAPI settings were located in
the System Maintenance Main Menu > FDAPI Configuration section.
Related topics:
Flex DAPI configuration on page 148
Related topics:
Operators on page 148
Music on page 149
Number of annunciator channels on page 149
Operators
Operators schedule and attend conferences. Operators also manage company and client
accounts. Operators use Bridge Talk and the Client Registation Server (CRS) Front End to
perform their duties.
You must configure a Flexible Digital Auxiliary Port Interface (FDAPI) resource for each
operator in your deployment. You need an FDAPI resource for each concurrent operator. For
example, if there are five operators on duty simultaneously, you must configure five FDAPI
operator resources.
Music
The Conferencing product has music included with it. For example, participants who are on
hold hear the Conferencing music tracks. These are default music tracks. In some
deployments, you might want to play a certain piece of music, such as a company
advertisement jingle. Any customized music of this kind is stored on an external server. You
must configure a Flexible Digital Auxiliary Port Interface (FDAPI) resource for each music track
on an external server. In your deployment. You need an FDAPI resource for each concurrent
external music track that you want to play.
The purpose of this task is to make changes to the Conferencing default properties to match
the requirements of your deployment.
4. Click Configure.
5. On the Audio Conferencing Configuration screen, click System Config.
6. Click Expand All to display all the configurable settings.
7. Update the settings as necessary.
8. Click Save.
9. If you wish to apply those updates to the Conferencing network, click Apply
Changes and then Apply Changes again.
When you apply changes, Conferencing restarts. It is a good idea to apply changes
only when you are finished all your configuration tasks.
Example
For example, if your network is a gigabit network, you must change the Network Type from
the default value of 100BASE-TX to 1000BASE-TX.
General configuration
The general configuration consists of eight different sections:
• General
• DTMF controls
• Recording and playback
• Logging
• Flex settings
• Billing
• RAI configuration
• Port pool usage thresholds
In the case of each of these areas, the documentation describes each setting. Following the
field descriptions, there is a description of how to configure a sample setting.
Related topics:
General on page 151
DTMF controls on page 157
Recording and playback on page 168
Logging on page 170
General
The General section includes many configuration parameters relating to the conference
recording feature. It also includes a number of settings in relation to DTMF suppression.
Related topics:
Bridge ID number on page 151
Licensed audio ports on page 152
Playback roll call on page 152
Automatic record all on page 153
Secure blocks record on page 153
PIN mode on page 153
Flex leader code on page 154
DTMF regeneration on page 154
DTMF passthrough on page 155
Billing code length on page 155
System alert enabled on page 155
System alert message on page 156
Playback small jump on page 156
Playback medium jump on page 156
Playback long jump on page 156
Bridge ID number
This number uniquely identifies the Conferencing application server, or bridge. The
Conferencing recording feature uses this number for all recording filenames. If Conferencing
automatically names a recording, it uses the following conventions:
<Conference confirmation number><Bridge ID number>XXXX
The value of XXXX grows sequentially, as follows:
• If the operator or moderator stops and then restarts recording during the conference,
Conferencing increments the value of XXXX.
• Similarly, if all participants leave the conference and later re-join, Conferencing
increments the value of XXXX. As an example, this scenario occurs when moderators
use their on-demand conference for a weekly meeting. Conferencing views this weekly
recurring meeting as multiple instances of a single conference.
If your deployment consists of a number of application servers, called a multicabinet
environment, there are implications for the automatic naming convention. Conferencing
encodes all recording filenames on a given bridge with the bridge number. This fact can be
used to keep recordings from difference bridges from having name conflicts if customers copy
them to a common playback device. Conversely, if customers can guarantee that name
conflicts will not occur due to other factors, such as configuring confirmation numbers to be
unique across all recording source bridges, then customers can set the Bridge ID Number
values to be the same on all bridges. In this scenario, users can play multi-sourced files from
a single-source playback. This scenario only operates successfully in a deployment that
includes a CRS server. If there is no CRS server, you must set the Bridge ID Number to a
unique value on all servers. Avaya recommends consulting with your Avaya Support
Representative for advice if your deployment includes a complex server environment. As an
aside, operators and moderators can manually specify the filename of a conference recording.
They can enter almost any digit string for this purpose but it must not start with zero. Automatic
filenames always start with zero. This filename forms the XXXX portion of the complete
recording filename:
<Conference confirmation number><Bridge ID number>XXXX
Note:
In the Standard Edition of Conferencing, there is no support for a multicabinet environment.
The Enterprise Edition of Conferencing supports multicabinet.
PIN mode
PIN mode specifies the PIN code requirements for unattended conferences scheduled on the
Conferencing system. The default value is Optional.
DTMF regeneration
Each time a conference participant enters a dual tone multifrequency (DTMF) keypad
sequence, their telephone emits a tone. Under normal circumstances, Conferencing
participants do not hear DTMF tones. This is called clamping. In certain circumstances,
operators may wish to allow the DTMF tones to play to the conference. Operators may also
request that Conferencing ’cleans’ the tones before playing them into the conference to remove
any distortion.
This parameter enables the display of a drop-down menu on Bridge Talk called DTMF
Regeneration, which has three options:
• System
This value enables all conferences to hear the regenerated DTMF tones, by default.
• ON
This value enables the regenerated DTMF tones for the particular conference.
• OFF
This value ensures that participant do not hear the DTMF tones.
The DTMF Passthrough parameter enables a related drop-down menu. Both options only
operate for in-band DTMF. You cannot enable both simultaneously.
DTMF passthrough
Each time a conference participant enters a dual tone multifrequency (DTMF) keypad
sequence, their telephone emits a tone. Under normal circumstances, Conferencing
participants do not hear DTMF tones. This is called clamping. In certain circumstances,
operators may wish to allow the DTMF tones to play to the conference.
This parameter enables the display of a drop-down menu on Bridge Talk called DTMF Pass
Through, which has three options:
• System
This value enables all conferences to hear the DTMF tones, by default.
• ON
This value enables the DTMF tones for the particular conference.
• OFF
This value ensures that participants do not hear the DTMF tones.
The drop-down menu is on the Bridge Talk Schedule Conference dialog. The DTMF
Regeneration parameter enables a related drop-down menu. Both options only operate for
in-band DTMF. You cannot enable both simultaneously.
Related topics:
System alert message on page 156
Audio messages and prompt sets on page 291
Related topics:
System alert enabled on page 155
Audio messages and prompt sets on page 291
DTMF controls
Dual Tone Multi Frequency (DTMF) Controls refer to the extent to which moderators can
change conference properties using their telephone keypad. Moderators can use their
telephone to enter keypad sequences which influence conference behavior.
Conferencing Manager lists the default keypad codes which participants enter on their
telephone keypad to attend and participate in regular conferences. It also lists the default
keypad codes which participants enter to listen to conference recordings.
When attending and participating in conferences, moderators can access a larger number of
options than conferees. When listening to conference recordings, moderators and conferees
have access to the same options.
For the purposes of DTMF mappings, Conferencing effectively supports two different
conference types. These conference types are commonly called scan conferences and flex
flow conferences. The conference recording playback options are the same for both
conference types. For flex flow conferences, moderators are often called leaders.
Related topics:
Scan flow DTMF mapping on page 157
Flex flow in conference DTMF mapping on page 161
Flex flow account management DTMF mapping on page 164
Configuring mapping on page 165
Ignore DTMF commands on page 166
Moderator conference hangup on page 166
Moderator lecture mode on page 166
Sub-conferencing on page 166
Self-mute on page 167
DTMF acknowledge on page 167
Moderator commands
reqRecordingName *94 Replay the last or current conference recording file number.
enterWebID *95 Associate a Web conference with the audio conference.
moHangToggle *98 Toggle moderator hang-up.
Conferee commands
This program parses the input file and reports any errors.
If you make any changes to the default DTMF mappings, you must ensure that you also
configure the audio prompt messages to play the correct message.
• 1 Records a greeting.
• 2 Plays the current greeting.
• 3 Deletes the current greeting.
Configuring mapping
Prerequisites
Before you configure DTMF mapping, you must install Conferencing and configure connectivity
between the virtual machines.
The purpose of this task is to change the default DTMF commands for moderators and
conferees.
Next steps
Now you can configure further settings.
Sub-conferencing
Sub-conferencing specifies whether a participant can create a sub-conference from a main
conference by pressing *93 on their telephone keypad. If Conferencing cannot fulfill a sub-
conference request, it plays message 24, “This operation is currently unavailable.” By default,
Sub-conferencing is Off.
• Anyone
Any participant can create a sub-conference.
• Moderator
Only a moderator can create a sub-conference.
• Off
Sub-conferencing is disabled.
Self-mute
Self-mute specifies whether participants can mute their own lines. If an operator mutes or
unmutes a participant, this operator action always overrides the participant mute status. If an
operator mutes a line, a participant cannot unmute it. By default, this setting is off.
• Off
No one can mute their own line.
• Participant
Conferees can mute their own lines.
• Anyone
All participants, including moderators, can mute their own lines. Muted moderators retain
all moderator privileges such as lecture and moderator hang-up, but their audio input is
not fed into a conference.
DTMF acknowledge
DTMF Acknowledge specifies whether Conferencing sounds a tone when it receives DTMF
dialing input. These acknowledgment tones assure participants that Conferencing received
their DTMF input. By default, this setting is not selected.
• If you select DTMF acknowledge:
Conferencing emits an acknowledgment tone when participants press valid DTMF digits
on their telephones to enter a response to a poll question or to place themselves in either
the Help or Q&A queues.
• If you do not select DTMF acknowledge:
Related topics:
Bridge record on page 168
Phone number on page 169
Dial string on page 169
Pre dial delay period on page 169
DRP auto gen fname on page 170
Introduction to recording on page 301
Bridge record
Bridge Record specifies whether Conferencing records conference information on the
application server or to an external device. The application server is also called the bridge.
Typically, conference recordings are stored on the usr3/confrp drive of the IBM 3650 M2. By
default this setting is set to On-bridge. If you configure Bridge Record to Off-bridge and
operators are using Bridge Talk Conference Scheduler, you must also configure Bridge Talk
Conference Scheduler to Off-bridge. If you do not configure Off-bridge recording in both
locations, Conferencing defaults to On-bridge.
• On-bridge
Conferencing records conference information to the bridge.
• Off-bridge
Conferencing records conference information to an external device. In an Off-bridge
deployment, you must enter a value in the Phone Number and Dial String parameters.
When you configure Conferencing for Off-Bridge recording and an operator or moderator
schedules a conference for a maximum of 10 participants, the conference can have either:
9 participants and an external recording, or 10 participants and no external recording.
Phone number
Phone Number specifies the number to dial when Bridge Record is set to Off-bridge. This is
the telephone number of the external recording device.
Dial string
Dial String specifies the DTMF digits that Conferencing sends to the external recording device
after the recorder answers the call. Some of the information contained in the Dial String may
be vendor-specific. Some information may be derived at run time. Use these values in the
string to specify run-time values:
• %P
This value is expanded at run time to contain the conference passcode.
• %T
This value is expanded at run time to contain conference start time in Linux time format
(seconds since 1/1/1970).
• %C
This value is expanded at run time to contain conference confirmation number.
For example, if you set the Dial String to *000#*%P#*%T#%C## and the following conference
properties apply in your conference:
• The Passcode is 1234
• The conference starts on August 3, 2010 at 9:58 AM
• The confirmation number is 123456789012
Under these conditions, Conferencing sends the string
*000#*1234#*1280829516#*123456789012## to the external recording device.
Logging
Logging refers to the properties and extent of the audit trail that Conferencing produces during
the course of regular conference activity. For example, Conferencing produces operator logs
that report a number of operator actions and user logs that report a number of moderator and
participant actions. These logging settings specify a number of properties relating to the logging
feature.
Related topics:
Operator transaction logs on page 170
User transaction logs on page 171
Automatic CDR print on page 171
Date format on page 171
Time format on page 171
Date format
Date Format specifies one of the following system date formats for the logging files. Date
Format has no effect on date formats in CDRs and CODRs. The default value is the US
standard date format: mm/dd/yyyy.
• mm/dd/yyyy
• yyyy/mm/dd
• dd/mm/yyyy
Time format
Time Format specifies whether Conferencing uses a 12–hour or 24–hour clock format for all
time references on the application server, including system time, schedule times, and operator
screens. Time Format has no effect on time formats in CDRs and CODRs. The default value
is 12–hour clock.
• 24–hour clock
• 12–hour clock
Flex settings
A flex flow conference is a specific type of on-demand conference. In flex flow conferences,
all call routing is based on the conferee passcode. In addition to the conferee passcode,
moderators enter a moderator passcode, which grants access to a moderator-specific menu.
Using this menu, moderators can edit conference attributes via DTMF from their telephone
keypad. You can configure a number of properties relating to flex flow calls.
Related topics:
Flex short time on page 172
Flex short attempts on page 172
Flex long time on page 173
Flex long attempts on page 173
Flex minimum dialout digits on page 173
Flex maximum dialout digits on page 173
Flex leader PIN modify on page 173
NRP operator timeout on page 174
The moderator can modify the moderator passcode by pressing 2 on a telephone keypad
to access the Default Conference Options menu before the conference starts.
• If you do not select Flex Leader PIN Modify:
The moderator cannot modify the moderator passcode in the Default Conference
Options menu before the conference starts.
This setting only applies to flex flow conferences.
Billing
The Billing section contains a single feature, which is not installed on the Conferencing server
by default. If you require access to this feature, you must enable it. This feature is free. Avaya
does not charge for it.
Related topics:
CDR end date filename on page 174
soon as midnight passes, Conferencing creates a new CDR file. The CDR End Date feature
refers to conferences that start before midnight and span into the following day. The CDR End
Date Filename parameter indicates that the CDRs of these conferences should go into the
new CDR file.
• If you select CDR End Date Filename:
The CDRs are based on the end date of the conference, rather than the start date.
Effectively, the CDRs go into the new CDR file, rather than the one from the previous day.
• If you do not select CDR End Date Filename:
The CDRs are based on the start date of the conference, rather than the end date.
Effectively, the CDRs go into the old CDR file, rather than the new one for the following
day.
Related topics:
Introducing billing on page 313
RAI configuration
Resource Availablility Indicator (RAI) is a message that Conferencing sends out to external
devices. The message shows the current status of the Conferencing server. The message
contains the current availability of telephone lines, or ports. It is a usage status information
message.
Note:
Communication Manager uses the RAI when it is configured to an application server, or
bridge, which supports video. Communication Manager sends a SIP subscribe message to
the bridge and the bridge then periodically sends RAI notifications. Communication Manager
only sends the subscribe message if it is configured to connect to a video bridge. Currently,
Communication Manager uses the bridge for ad-hoc video conferences. It does not use the
bridge for ad-hoc audio conferences.
Related topics:
Notification interval on page 175
High threshold on page 176
Low threshold on page 176
Max subscribers on page 176
Notification interval
Notification Interval is the Resource Availablility Indicator (RAI) notification interval.
Conferencing sends out a message to an external device to indicate the current availability of
telephone ports. This parameter specifies the interval, in seconds, between status messages.
For example, if it is set to 60, Conferencing sends out an RAI status message every minute.
An example of an external device is Communication Manager. In a deployment that uses video
conferencing, Communication Manager needs to know how many ports are available on the
Conferencing server.
High threshold
High Threshold relates to the RAI feature. When the telephone port usage on the Conferencing
server exceeds a certain percentage, Conferencing enters a high usage state. The message
that Conferencing sends to external devices to indicate its current availability, states that
Conferencing has entered a high usage state. This parameter specifies the percentage that
represents high usage. For example, if this parameter is set to 90, Conferencing will enter a
high usage state when 90% of the telephone ports are being used. Conferencing will only exit
the high usage state when the usage drops below the percentage indicated in the Low
Threshold parameter.
Low threshold
Low Threshold relates to the RAI feature. This parameter specifies the percentage of use that is
required to exit a high usage state. Conferencing enters a high usage state when a large
percentage of the telephone ports are currently in use. Conferencing can exit the high usage
state when the current load reduces and more telephone ports are made available. For
example, if this parameter is set to 75, Conferencing will exit a high usage state when 75% of
the telephone ports are available.
Max subscribers
Max Subscribers relates to the RAI feature. Max Subscribers indicates the number of external
devices to which Conferencing can send an RAI status message. If this parameter is set to 10,
Conferencing can send a status message to 10 external devices. An example of an external
device is Communication Manager.
access an on-demand conference provided they have the appropriate telephone number and
passcodes.
A scheduled conference is a conference that has a defined start time and end time. When
moderators book a scheduled conference, Conferencing reserves system resources to cater
for the duration and size of the conference.
Port Pool Usage Thresholds refer to the usage levels that trigger an alarm. When Conferencing
reaches these levels, it sends an alarm, or a trap, using the SNMP system. The usage levels
are calculated in terms of a percentage of telephone lines, or ports.
Related topics:
Logs and alarms on page 97
Reserved low on page 177
Reserved high on page 177
Unreserved low on page 178
Unreserved high on page 178
Reserved low
Reserved Low is a percentage threshold to indicate the point at which Conferencing resets the
high usage SNMP alarm for scheduled conference port usage. Once Conferencing resets the
high usage alarm, the alarm is available for activation if the it exceeds the high usage parameter
for scheduled conferences. This reset mechanism means that Conferencing does not send
large numbers of alarms if the port usage varies around the high usage threshold point. For
example, consider a configuration where the high usage threshold is 80% and the reset point is
70%. Conferencing sends an alarm once the usage reaches 80%. Following this point, the
usage could fall to 78% but then rise again to 80%, only to fall again to 76% and rise again to
80%. In the absence of the reset mechanism, Conferencing would send alarms to the network
management system each time the usage reached 80%. With the reset mechanism,
Conferencing does not send an alarm until usage falls to 70% and rises again to 80%. Once
usage falls to 70%, it resets the high usage parameter and it is available for activation once
again.
Reserved high
Reserved High is a percentage threshold to indicate the point at which Conferencing sends an
alarm to warn the network management system that it is experiencing high usage. The
Reserved High parameter relates to the percentage of telephone lines, or ports, available for
scheduled conferences only. For example, if you enter 80%, Conferencing sends an alarm to
the network management system if it is currently using more than 80% of the ports that are
available for scheduled conferences.
Unreserved low
Unreserved Low is a percentage threshold to indicate the point at which Conferencing resets
the high usage SNMP alarm for on-demand conference port usage. Once Conferencing resets
the high usage alarm, it is available for activation if it exceeds the high usage parameter for
on-demand conferences. This reset mechanism means that Conferencing does not send large
numbers of alarms if the port usage varies around the high usage threshold point. For example,
consider a configuration where the high usage threshold is 80% and the reset point is 70%.
Conferencing sends an alarm once the usage reaches 80%. Following this point, the usage
could fall to 78% but then rise again to 80%, only to fall again to 76% and rise again to 80%.
In the absence of the reset mechanism, Conferencing would send alarms to the network
management system each time the usage reached 80%. With the reset mechanism, the
conferencing system does not send an alarm until usage falls to 70% and rises again to 80%.
Once usage falls to 70%, it resets the high usage parameter and it is available for activation
once again
Unreserved high
Unreserved High is a percentage threshold to indicate the point at which Conferencing sends
an alarm to warn the network management system that it is experiencing high usage. The
Unreserved High parameter relates to the percentage of telephone lines, or ports, available
for on-demand conferences only. For example, if you enter 80%, Conferencing sends an alarm
to the network management system if it is currently using more than 80% of the ports that are
available for on-demand conferences.
The purpose of this task is to make changes to the Conferencing default properties to match
the requirements of your deployment.
Example
For example, if you do not want Conferencing to automatically allocate a filename to a
conference recording when an operator or moderator manually initiates a recording, ensure
that DRP: Auto-gen fname is not selected.
Related topics:
Audio quality on page 181
Video quality on page 183
TTY on page 183
SRTP on page 184
Network performance on page 185
Audio quality
Avaya has implemented a number of features to ensure that audio quality during conferences is
optimized. These features include the generation of a subtle background sound (called comfort
noise) and a deliberate lack of acknowledgment of sounds below a certain threshold (called
silence suppression). These features and others relating to audio quality are configurable.
Related topics:
Automatic gain enabled on page 182
AGC target power level on page 182
AGC noise floor on page 182
Comfort noise enabled on page 182
Comfort noise level on page 183
Silence suppression enabled on page 183
Silence suppression energy threshold on page 183
Packet loss concealment enabled on page 183
Video quality
The Standard Edition of Conferencing does not support video.
TTY
A telecommunications device for the deaf (TDD) is an electronic device for text communication
via a telephone line, used when one or more of the parties has hearing or speech difficulties.
Other names for TDD include TTY (telephone typewriter or teletypewriter, although TTY is also
a term used for teletypes in general). You can configure support for TTY in the Conferencing
environment.
Related topics:
TTY support enabled on page 184
TTY redundancy support enabled on page 184
SRTP
SRTP defines a profile of RTP (Real-time Transport Protocol), intended to provide encryption,
message authentication, and integrity, and replay protection to data. Conferencing now
supports this protocol for all audio transfers.
Related topics:
Encryption enabled on page 184
SRTP crypto suite on page 185
Encryption enabled
Select this parameter to enable SRTP for audio streams.
Network performance
You can configure three settings in relation to Conferencing and the customer network.
Alternatively, you can accept the default values.
Related topics:
Base RTP port on page 185
Min RTCP transmission interval on page 186
VLAN service on page 186
VLAN service
This value determines the VLAN service on RTP packets. The default is 0.
Before you configure this value, you must create the actual VLANs on the Conferencing
application server. This task is technical and requires expertise.
Related topics:
SIP settings on page 64
General on page 186
Media codecs on page 187
General
The General section includes parameters relating to speaker thresholds and active speaker
notification.
Related topics:
ASN interval on page 187
Audio talker interval on page 187
Wav file clip on page 187
ASN interval
By default, Conferencing checks each channel every 2000 milliseconds to see if someone is
speaking. The active speaker notification (ASN) interval parameter controls this timer. For
example, if ASN interval is 500, Conferencing checks each channel every 500 milliseconds.
The ASN interval value overrides the default value on the application server.
Media codecs
A codec is a device or computer program capable of encoding and/or decoding a digital data
stream or signal.
In relation to audio codecs, the Standard Edition of Conferencing supports the G.711 codec.
The Standard Edition of Conferencing does not support any other codecs. G.711 represents
logarithmic pulse-code modulation (PCM) samples for signals of voice frequencies, sampled
at the rate of 8000 samples/second.
The Standard Edition of Conferencing does not support video conferencing and so does not
support video codecs.
Related topics:
Audio codecs on page 187
Video codecs on page 188
Configuring codecs on page 188
Audio codecs
In relation to audio codecs, the Standard Edition of Conferencing supports the G.711 codec.
The Standard Edition of Conferencing does not support any other codecs. G.711 represents
logarithmic pulse-code modulation (PCM) samples for signals of voice frequencies, sampled
at the rate of 8000 samples/second.
Video codecs
The Standard Edition of Conferencing does not support video conferencing and so does not
support video codecs.
Please contact your Avaya Support Representative to discuss alternative methods of obtaining
video support. The Avaya product suite contains a number of alternative options that may suit
your requirements.
Configuring codecs
In relation to audio codecs, the Standard Edition of Conferencing supports the G.711 codec.
There are two flavors of G.711: The µ-law algorithm (used in North America & Japan) and A-
law algorithm (used in Europe and the rest of the world).
Both are logarithmic, but A-law was specifically designed to be simpler for a computer to
process. The standard also defines a sequence of repeating code values which defines the
power level of 0 dB. The µ-law and A-law algorithms encode 14-bit and 13-bit signed linear
PCM samples (respectively) to logarithmic 8-bit samples. Thus, the G.711 encoder will create a
64 kbit/s bitstream for a signal sampled at 8 kHz.[5] G.711 μ-law tends to give more resolution to
higher range signals while G.711 A-law provides more quantization levels at lower signal levels.
By default, Conferencing supports both compression algorithms. The µ-law algorithm is called
PCMU. The A-law algorithm is called PCMA. You can disable one of them, if required.
When the Conferencing server makes a telephone call, it includes a SIP_INVITE message.
The SIP_INVITE request that the Conferencing server sends out when it places an external
telephone call includes a list of the codecs which Conferencing supports. The list order
specifies a selection preference. By default, Conferencing supports PCMU first and then
PCMA. You can change this order, if required.
As an aside, the telephone-event codec refers to a method of support for out-of-band DTMF
processing. Typically, Conferencing sends DTMF signals along the same stream as audio
information. However, you can configure Conferencing to send DTMF signals along a different
stream. This is called out-of-band DTMF processing.
Prerequisites
Before you configure codecs, you must install and configure Conferencing.
The purpose of this task is to make changes to the default configuration of codecs.
SIP settings
The main configuration settings that are relevant to connecting Conferencing to the network
are the SIP settings. The Session Initiation Protocol (SIP) is a signaling protocol, widely used
for controlling multimedia communication sessions such as voice and video calls over Internet
Protocol (IP). Within a SIP communications framework, the method of transmission is
configurable.
The SIP communications across your network must use one of the following methods of
transmission:
• Transport Layer Security (TLS)
• Transmission Control Protocol (TCP)
• User Datagram Protocol (UDP)
Related topics:
SIP listener URI on page 64
Response contact on page 65
Session refresh timer on page 65
Min session refresh timer allowed on page 66
Configuring SIP on page 66
Configuring SIP
Prerequisites
Before you configure the SIP settings, you must install Conferencing and configure a media
gateway.
The purpose of this task is to configure the transport protocols for communications from the
Conferencing server.
Next steps
Now you can configure the telephone numbers.
Related topics:
Installing CRS Front End on the CRS server on page 88
Creating a test conference on page 90
Distributing CRS Front End to the operators on page 91
CRS configuration
The configuration of CRS involves the configuration of a number of aspects of CRS properties.
The aspects are:
• General settings
• Timezones
• Users
In the case of each of these areas, the documentation contains a description of the concept,
followed by the steps required to configure a sample setting for that concept.
Tip:
Rather than reading the full list of CRS configuration settings, you can use the search tool
to locate a description of any setting.
In the System Administration section of the CRS Front End, you can configure a number of
these concepts. However, Avaya recommends that you configure the CRS settings using
Conferencing Manager, despite this support on the CRS Front End.
Related topics:
General settings on page 192
Reseller settings on page 223
Timezone settings on page 223
User settings on page 224
Wholesaler settings on page 229
General settings
Within CRS configuration, the general settings is the largest area. It consists of several different
sections:
• Components
• General Settings
• Features
• Reservation and Conference Settings
• User Settings
• Notification Settings
• Billing Settings
• Perpetual Conference Settings
• Groupware clients
• SAL connectivity settings
In the case of each of these areas, the documentation describes each setting. Following the
field descriptions, there is a description of how to configure a sample setting.
Related topics:
SAL connectivity settings on page 147
Components on page 193
General settings on page 193
Components
The Components section contains a list of the IP addresses of the virtual machines that
operate alongside the CRS virtual machine to deliver the Conferencing experience. The other
virtual machines in the Conferencing network are:
• Application server or bridge
In the Conferencing Manager interface, this is called Conferencing Server(s)
• A data conferencing server
In the Conferencing Manager interface, this is called Web Conferencing Server
• A customer booking Web server
In the Conferencing Manager interface, this is called Web Application Server
When you add the virtual machines to the Conferencing network, you must establish
connectivity between the virtual machines that you have added. You can do this, using this
Components section.
General settings
The General settings section contains a list of settings which you can configure to match your
customer requirements. The Conferencing solution is highly configurable. You can customize
many aspects of the Conferencing experience using the CRS parameters.
Tip:
If you cannot find the a particular setting in the Client Registration > General section, it is
likely that you will find it in the Audio Conferencing > Bridge Features or Audio
Conferencing > Conference Features sections. Together, these three sections contain the
most customizable aspects of Conferencing.
Related topics:
Overbook percent on page 117
Overbook percent
The overbooking feature increases the available ports by providing a pool of additional virtual
ports. These virtual ports are available for reserved conference bookings. This functionality
ensures that customers can maximize the use of Conferencing by allowing for the fact that in
many cases, full conference attendance does not occur.
The Overbook Percent parameter specifies the percentage of Conferencing lines that
operators and moderators can overbook for scheduled conferences. This parameter does not
impact on-demand conferences. By default, the value of the Overbook Percent parameter is 0.
• If the value of the Overbook Percent parameter is between 1and 100:
Operators and moderators can reserve a percentage from 1% to 100% more than the
maximum number of lines available for a given time period. Lines configured for operators,
music, record/playback, or link lines are not included in the line count. For example, if
your deployment of Conferencing has 1000 lines available for scheduled conferences and
you set this parameter for 10%, you can schedule 1100 lines.
• If the value of the Overbook Percent parameter is 0:
Conferencing allows infinite conference overbooking.
Related settings
To make overbooking available in your deployment, you must also enable the Line
Overbooking feature on the Conferencing application server, or bridge.
A related parameter is the On Demand Pct % parameter.
Example scenario
In practice, it is a good idea to set the Overbook Percent parameter to 0 which is infinite and
On-Demand Pct (%) to 50%. Avaya sets the On-Demand Pct (%) to 50%. These values allow
for 50% of the ports to be allocated to on-demand conferences and 50% to be allocated to
scheduled conferences. The available ports is the total number of telephone lines with the total
number of FDAPI resources subtracted from this total. FDAPI resources include operator
telephone lines and playback telephone lines.
Site timezone
There are two aspects to timezones:
• Site timezone
• Operating system timezone
The Site Timezone parameter specifies the timezone of the CRS database, which is called
BSRes2. The CRS uses this timezone for booking and scheduling.
The Site Timezone drop-down list is populated using the list of timezones in the Elements >
Conferencing > Client Registration > Timezones menu in Conferencing Manager. The
Timezone list contains a default list of the most common timezones. If your timezone is not in
the list of timezones, you can add it using Conferencing Manager.
After you install Conferencing, you must always manually configure the Site Timezone drop-
down list to set the site timezone.
It is important, at this stage to distinguish between the site timezone and the operating system
timezone. You must manually configure the site timezone after you install Conferencing.
The operating system timezone is different. Conferencing inherits the operating system
timezone from System Platform. When you install Conferencing, System Platform pushes the
timezone setting to all Conferencing operating systems and virtual machines. Before you install
Conferencing, check that the timezone setting on System Platform is the setting that you
require in your Conferencing deployment. If it is not, it is a good idea to change the timezone
setting on System Platform before installing Conferencing.
CRS Front End users are defined as operators, supervisors, administrators, user-
administrators, and user-auditors.
Authentication Required At Login is a CRS server-side setting. There is a related setting called
ValidationRequired in the bands.ini file. The bands.ini file resides on each client machine and
contains the CRS client-side settings. If the two values (Authentication Required At Login and
ValidationRequired) are inconsistent, the CRS server imposes synchronization by propagating
the server-side value to the client side. In this event, the first log-in attempt by the CRS client
fails and the CRS server resets the value. Any subsequent log-in attempt should be successful.
The maximum password length is 20 characters. You can set the minimum password length
using the Minimum Password Length parameter. The default value for Minimum Password
Length is four. You can also set the password complexity using the Minimum Password
Complexity parameter. There are four levels of complexity. You can also set password expiry
using the Period to Password Expiry parameter.
If you enable Authentication Required At Login, the Web Portal application verifies the
password that Web Portal administrators and wholesalers enter when they access Web Portal.
Dialout prefix
The Dialout Prefix parameter specifies the number that Conferencing places before the
telephone number when operators and Web Portal moderators dial out to other telephone
numbers while in a conference.
Moderators can dial out by pressing *1 or *92 on their telephone keypad. If they press *1, they
can dial a single telephone number. If they press *92, they can trigger a blast dial.
Blast dial refers to a feature whereby operators and moderators can dial a large group of
potential participants using a single command. For the successful operation of this command,
the operator, using CRS Front End, or the moderator, using Web Portal, must enable Blast Dial
for the conference. In addition, you must create and save blast dial lists.
Features
The Features section contains a single field, relating to data conferencing.
Data conferencing is the simultaneous sharing of voice and visual information using a Web
Front End called Avaya Web Conferencing (AWC). Using AWC, moderators can share their
desktop, a whiteboard, or a Microsoft™ Powerpoint presentation. Moderators and participants
can also share messages and video using AWC. If your deployment requires either of these
features, you must enable them here.
In previous releases of Conferencing, you could enable this feature using a file on the
application server called featcfg.
Related topics:
Disable data on page 197
Disable data
The Disable Data checkbox specifies whether the Data checkbox on the CRS Front End
Check Reservation dialog is accessible to operators. Operators select the Data checkbox to
schedule a telephone conference with a Web component. Using the Web component,
moderators can share slides, share their desktop, and stream video. The Web component is
provided by an application called Avaya Web Conferencing (AWC).
• If you select Disable Data:
The Data checkbox is not selected and is inaccessible to operators.
• If you do not select Disable Data:
The Data checkbox is accessible to operators.
Related topics:
Maximum conference duration on page 197
Minimum conference duration on page 198
Maximum conference size on page 198
Minimum conference size on page 198
Minutes between DDI reuse on page 198
Maximum number of conferences per booking on page 198
Auto generated passcode length on page 199
Minimum passcode length on page 199
Maximum passcode length on page 199
Period until conference disabled on page 199
Conferences Per Booking=100, then only one hundred conferences can be associated with a
reservation.
User settings
The User Settings section contains a number of parameters relating to account numbers,
passwords, passcodes, and unique identifying numbers (secret PIN). In the CRS Front End
environment, conference users who have Conferencing accounts are called clients. In the Web
Portal environment, conference users who have Conferencing accounts are called
moderators.
Related topics:
Account number length on page 200
Period to conference passcode renewal on page 200
Period of passcode overlap on page 202
Maximum number of login attempts on page 202
Minimum password length on page 203
Minimum password complexity on page 203
Period to password expiry on page 203
Default client phone number on page 204
Period until user disabled on page 205
Period until client disabled on page 205
URL to reset participant secret PIN on page 206
External user participant identifier on page 206
External user participant PIN on page 207
The CRS automatically generates new pass codes for on-demand conferences if the owner
of the demand conference does not change their pass code within a configurable period of
time. The CRS directs the Notifications Subsystem to generate an e-mail notification to inform
the conference owner of their new pass codes. For a configurable period of time, the old pass
codes are still valid. This period gives the conference owner the time to adjust their conference
details. When the overlap period ends, the CRS directs the Notifications Subsystem to
generate an e-mail notification to inform the conference owner that their old pass codes are
no longer valid.
At Company level, operators can configure:
• The time period between automatic pass code refresh cycles.
Operators can modify this time period by entering a new value in the Renew Days field
in the New Company and Edit Company dialogs. The CRS Front End obtains the default
value for the Renew Days field from the Period to Conference Passcode Renewal
parameter in the Company table in the BSRes2 database. The Period to Conference
Passcode Renewal parameter has a range of 0 to 365.
• The time period for which the old pass codes are still valid.
Operators can modify this time period by entering a new value in the Overlap Days field in
the New Company and Edit Company dialogs. The CRS Front End obtains the default
value for this field from the Period of Passcode Overlap parameter in the Company table in
the BSRes2 database. The Period of Passcode Overlap parameter has a range of 0 to 30.
Note:
The CRS performs a check to ensure that the Period to Conference Passcode Renewal
parameter is less than the Period of Passcode Overlap parameter.
You can set the default value to display in the CRS Front End New Company and Edit
Company dialogs by setting the value of the Period of Passcode Overlap and Period to
Conference Passcode Renewal parameters in the Company table in the BSRes2 database.
The Conference table also contains two parameters that enable this functionality.
• PassCodeChangedDT stores the date and time that the pass codes were last changed.
• OverlapStartDT stores the date and time that the overlap period started.
In order for the overlap aspect of this feature to operate successfully, two demand conferences
co-exist:
• The old on-demand conference with the old pass codes.
• The new on-demand conference with the new pass codes.
These two conference co-exist for the duration of the Period of Passcode Overlap parameter.
Each night, the CRS runs a scheduled task called DoRenewPassCodes. DoRenewPassCodes
performs the following actions:
• Creates a new demand conference where:
PassCodeChangedDT + (Period to Conference Passcode Renewal - Period of Passcode
Overlap) < NOW()
• Generates an e-mail notification for each new demand conference.
• Removes or cancels all demand conferences where:
OverlapStartDT + Period of Passcode Overlap < NOW()
• Generates an e-mail notification for each removed demand conference.
When DoRenewPassCodes creates a new conference, it moves all participants to the new
conference. DoRenewPassCodes also moves the Import Utility identification (ImportID) to the
new conference. The new conference becomes the primary conference. If an operator changes
the old conference during the overlap period, the changes will not be reflected in the new
conference. DoRenewPassCodes only selects on-demand conferences that match the
following criteria:
• Type: Meet-me, unattended, or flex flow
• State: Confirmed, in-progress, completed, billed
The state of a conference influences how DoRenewPassCodes handles it once the overlap
period ends. DoRenewPassCodes removes billed conferences but cancels confirmed, in-
progress, and completed conferences.
You can investigate any problems that occur during the renewal process by examining the
RenewConferencesHistory table in BSRes2. The Conferencing Import Utility application does
not import the Period to Conference Passcode Renewal and Period of Passcode Overlap fields
when you instruct it to import a Company record. This means that imported companies do not
use the passcode expiry feature.
Web Portal application. If their number of attempts exceeds the value in Maximum Number Of
Login Attempts, the CRS server disables their account.
prompts Web Portal administrators, wholesalers, and moderators to enter a new password if
they attempt to log in to the Web Portal using an expired password. The Period To Password
Expiry parameter forces CRS Front End operators, supervisors, and system administrators to
update their password following a configurable period of time.
For Period To Password Expiry to operate correctly for Web Portal Administrators and Web
Portal Wholesalers, you must ensure that Authentication Required at Login=1. Authentication
Required at Login is a parameter in the BSRes2 database.
For example;
• To ensure that all users update their password every 28 days, set Period To Password
Expiry=28. In this scenario, their password expires after 28 days and when they next log
in, the Web Portal prompts them to enter a new one. It is worth noting that if they are an
infrequent user, their next log in could occur on, for example, the 40th day.
• To ensure that all users never have to update their password, set Period To Password
Expiry=0. If Period To Password Expiry=0, no password expiry takes place.
When the period specified by Period To Password Expiry elapses, the CRS Front End prompts
the user to enter a new password. In this situation, the CRS Front End prompts the user for
the following information:
• Their old password
• A new password
• Confirmation of the new password
The Database users table stores a parameter, called PasswordChangedDateTime to record
the date that a user updates their password. Passwords are case-sensitive.
The Period To Password Expiry parameter also impacts client passwords. Operators create
new clients, edit clients, and delete clients.
As in previous releases of Meeting Exchange, CRS passwords are subject to the system
parameters Minimum Password Complexity and Minimum Password Length.
as another conferencing database, The data must conform to a format that Conferencing
recognizes.
In the case of the DSCA and Import Utility, if there is no telephone number associated with a
client record, Conferencing will associate the value in the Default Client Phone Number with
the record.
A parameter in the BSRes2 database, called LastLoginDateTime, records the date and time
when a user logs in to the CRS. This parameter is in the database client table.
A database stored procedure called, p_DisableInactiveLogons, disables any CRS client that
has exceeded the value in the Period Until Client Disabled parameter. You can schedule this
job to run at a configurable frequency. Avaya recommends that you configure this stored
procedure to run on a daily basis.
When a CRS user re-enables a disabled client account, the CRS resets the date and time in
LastLoginDateTime to the current date and time.
Notification settings
The Notification Settings section contains a large number of parameters relating to e-mail
notifications. If you enable e-mail notifications, Conferencing sends conference participants an
invitation e-mail to invite them to upcoming conferences.
Related topics:
Conference reminder X minutes before on page 208
Activate e-mail notifications on page 208
Activate attachments on page 209
Attachments directory on page 209
Activate attendance notifications on page 210
Web conferencing URL on page 210
Activate vcalendar on page 210
Activate SMTP on page 210
SMTP server address on page 210
SMTP server port on page 211
SMTP username on page 211
SMTP password on page 211
E-mail sender on page 211
Authenticate on page 211
HTML format on page 211
Attendance record processing delay on page 212
Introduction to notifications on page 323
Activate attachments
The Activate Attachments parameter specifies whether moderators can send attachments with
conference invitations using the Web Portal application. To enable moderators to send
attachments in Web Portal, you must enable this parameter.
Using Web Portal, moderators can invite conferees to their conference using a number of
methods. The Activate Attachments parameter applies to situations whereby a moderator
invites conferees using the on-board Web Portal address book.
Attachments directory
The Attachments Directory parameter specifies a folder that the Notifications Subsystem
checks for files to send as attachments to conference invitations sent from Web Portal.
Using Web Portal, moderators can invite conferees to their conference using a number of
methods. If they invite conferees using the on-board Web Portal address book, they can add
attachments to the conference invitation.
The Notifications Subsystem is the application which provides e-mail and SMS broadcast
services for Conferencing.
When moderators, using Web Portal, attach a file to a conference invitation, the Web Portal
copies the file to a folder on the Conferencing application server. The Notifications Subsystem
checks this folder on the application server and attaches the file to the conference invitation.
This parameter specifies the folder on the application server that the Notifications Subsystem
checks for files. You must ensure that you configure a value on the Web Portal to ensure that the
Web Portal copies the file to the same folder. The two values must be consistent in order for
the feature to operate successfully. The Web Portal parameter is in webportal.properties and
is called AttachmentsFolder.
An issue arises because the Web Portal virtual machine uses the Linux operating system and
the CRS virtual machine uses the Windows operating system. The Notifications Subsystem
resides on the CRS virtual machine. The CRS virtual machine has difficulties reading the Linux
syntax for the folder location. As a result, you have to perform some manual configuration. On
the CRS virtual machine, you must map a new network drive for \\<Web Portal virtual machine
IP address>\attachments. Ensure that you select Reconnect at Login and set avaya as both
the username and password.
Related topics:
Configuring the attachment folder and security
Activate vcalendar
The Activate vCalendar parameter specifies whether Conferencing generates a vcalendar file
for each scheduled conference. If you enable the Activate vCalendar parameter, Conferencing
generates a vcalendar file and attaches it to conference invitation notification e-mails.
vCalendar is an industry standard format for exchanging scheduling and activity-recording
information electronically. If Conferencing sends a vCalendar attachment in an invitation e-
mail, participants can drag-and drop it (or otherwise move it) to a personal information manager
(PIM) type of application program and integrate with or relate it to their own schedule.
vCalendar was developed along with the vCard electronic business card specification.
Activate SMTP
The Activate SMTP parameter specifies whether Conferencing uses the Simple Mail Transfer
Protocol (SMTP) protocol for e-mail notifications.
Simple Mail Transfer Protocol (SMTP) is an Internet standard for electronic mail (e-mail)
transmission across Internet Protocol (IP) networks.
By default, the Activate SMTP parameter is not selected.
Address parameter. The p_CheckMailAndSend stored procedure checks for e-mails in the
EMailMessage table and sends them.
SMTP username
The SMTP Username parameter specifies a username that Conferencing uses to log in to the
e-mail server for all e-mail notifications. The e-mail server requires a username and a password
if Authenticate is selected. The Authenticate parameter adds a layer of security to the e-
mail communications.
SMTP password
The SMTP Password parameter specifies a password that Conferencing uses to log in to the
e-mail server for all e-mail notifications. The e-mail server requires a username and a password
if Authenticate is selected. The Authenticate parameter adds a layer of security to the e-
mail communications.
E-mail sender
The E-mail Sender parameter specifies the name or phrase that Conferencing enters in the
From field of the e-mail notifications that it sends. For example, if the E-mail Sender parameter
is conferencing@customername.com, participants receive e-mail notifications from this
e-mail address.
Related topics:
Ensuring that Conferencing notification e-mails are not classified as junk on page 480
Authenticate
The Authenticate parameter specifies whether Conferencing requires a username and a
password to log in to the e-mail server. The Authenticate parameter adds a layer of security
to the e-mail communications.
HTML format
The HTML Format parameter specifies whether Conferencing uses Hyper Text Markup
Language in the e-mails that it sends. If you do not select the HTML Format parameter,
Conferencing uses plain text in the e-mails that it sends.
Billing settings
The Billing Settings section contains a large number of parameters in relation to the production
of Conferencing bill files.
Related topics:
Primary bill file location on page 212
Secondary bill file location on page 212
Bill file extension on page 213
Bill file prefix on page 213
Bill frequency on page 213
Bill start offset (mins) on page 213
Bill at time on page 214
Bill file header on page 214
Bill file trailer on page 214
Period to retain CDR files on page 214
Free if cancelled X minutes before on page 214
Introducing billing on page 313
There is a special situation if you configure the Bill File Prefix parameter to the value <date>. In
this situation, Conferencing uses a special, date-based file name format. If the Bill File Prefix
parameter has the value <date>, Conferencing ignores the Bill Stamp number. Instead,
Conferencing names the files according to the current date, using the following format and
syntax:
YYMMDDNN.bil
• YY=year, where 2000=00
• MM=month, where October=10
• DD=day, such as 31
• NN=the file number on that particular day
For the first bill of the day, NN=00. The number increases incrementally from then
onwards. If the NN number reaches 99, Conferencing does not run until the date changes.
Bill frequency
The Bill Frequency parameter specifies how often Conferencing runs the billing cycle. If the
Bill Frequency parameter is 0, Conferencing generates a bill every day at the time specified
by the Bill At Time parameter.
When Bill Start Offset (mins) is 0, this feature is turned off. When this setting is 0, then the
billing schedule depends on the time at which you start the application.
Bill at time
The Bill At Time parameter specifies the time that Conferencing produces billing data.
Conferencing uses this parameter solely for daily bills. By default, the Bill At Time parameter
is 0100.
To book a perpetual conference, an operator must schedule a repeat booking in which the
number of conferences exactly equals the maximum possible conferences in a single
reservation. A parameter called, Maximum Number of Conferences Per Booking, determines
the maximum number of conferences that can be booked in a single reservation. For example,
if Maximum Number of Conferences Per Booking=100, operators can book conferences that
repeat up to 100 times. If an operator attempts to book a conference that repeats 101 times,
an error message is displayed. If they book fewer conferences, the repeating conference is
not interpreted as a perpetual conference.
A parameter called Perpetual Conference PreBook Period specifies the number of days by
which a conference booking should be extended. If Perpetual Conference PreBook Period=30,
the system extends all perpetual conferences to 30 days from the current date. Perpetual
Conference PreBook Period is located in the BSRes2 database.
Conferencing checks for conferences that may need to be extended via a scheduled job, called,
ExtendPerpetualConferencesJob. By default, ExtendPerpetualConferencesJob is scheduled
to run on a weekly basis. The ExtendPerpetualConferencesJob:
• Checks for reservations that may need to be extended.
• Extends reservations that meet the criteria for extension.
• Checks for e-mails in the EMailMessage table and sends them.
The following parameters are involved in perpetual conferencing:
• Perpetual Conference PreBook Period
• Perpetual Conference Recipient Email Address
• Perpetual Conference CC Email Address
• Perpetual Conference Sender Email Address
• SMTP Server Address
• SMTP Server Port
The following scheduled jobs are involved in perpetual conferencing:
• p_CheckMailAndSend
• p_ExtendPerpetualConf
• p_ExtendPerpetualConfs
If the Maximum Number of Conferences Per Booking parameter is increased, conferences that
previously qualified as perpetual conferences may no longer qualify. This is because the
number of repeat conferences may no longer equal Maximum Number of Conferences Per
Booking. For conferences to qualify as perpetual conferences, they must be repeat
conferences and the number of repeat conferences must equal Maximum Number of
Conferences Per Booking. As a result, you must adjust perpetual conferences if you the
increase Maximum Number of Conferences Per Booking parameter.
Related topics:
Perpetual conference prebook period on page 216
Perpetual conference recipient e-mail address on page 216
Perpetual conference CC e-mail address on page 216
Perpetual conference sender e-mail address on page 216
Groupware clients
Groupware is a term that Avaya uses to refer to a number of 'plug-in' applications which it has
developed in order to integrate Conferencing functionality with external applications, such as
Microsoft™ Outlook, Live Meeting, and Office Communicator and IBM Lotus™ Notes and
Sametime.
The Conferencing plug-ins manifest themselves as extra buttons or menus on the existing
interfaces of the external applications.
The value of a Conferencing plug-in is that moderators can book and manage their conferences
without having to install and operate a dedicated Conferencing interface, such as Web Portal or
CRS Front End. Avaya has ensured that the plug-ins are easy to deploy and require no
additional technical instruction for regular computer users.
If your deployment includes any of the groupware plug-ins or clients, you must configure these
settings. If your deployment includes the Conference Scheduler Plug-in for Microsoft Outlook,
you must also configure the settings in the Outlook Settings section.
Related topics:
BCAPI username on page 217
BCAPI username
The Bridge Control API (BCAPI) is an object-oriented, programming interface, written in Java.
The API can be used by any application that can make a Java call, such as IBM Lotus Notes.
The BCAPI Username parameter specifies the sign-in name of the Conferencing application
server. By default, it is set to jc3. You must configure this parameter to jc3 if the Conferencing
deployment includes the Avaya Plug-in for IBM Lotus Notes. The BCAPI Username parameter
is essential for the successful operation of the Click-to-Call feature in the Avaya Plug-in for
IBM Lotus Notes.
Override mask
The Override Mask parameter specifies which conferencing options are displayed on the
Conference Scheduler for Microsoft Outlook, by default. For example, you might want to hide
certain options from users, by default.
Some conferencing options have dependencies. For example, for the successful operation of
Roll Call, Name Announcement on Entry, and Name Announcement on exit, you must display
Prompt Conferees For Name On Entry.
You can enable or disable the following settings:
• Play Tone on Entry
• Play Tone on Exit
• Play Name on Entry
• Name Announcement on Exit
• Auto-Generate Codes
• Play Wait for Moderator
• No Operator Allowed
• Request Bill Code
• Prompt Moderator for Security Code on Entry
• Moderator Hand-Up
• Allow Manual Port Extension
• Allow Manual Duration Extension
• Allow Conference Recording
You should not make changes to any settings that are not in this bullet list.
A file called profile.xls contains a list of these settings. The profile.xls file is located in
<Conferencing application server IP address>/outlook/files/profile.xls. Using profile.xls, you
can display or hide the settings in accordance with your requirements. The relevant settings
are in column C, from row 60 to row 112. A function in cell C116 computes a binary value based
on your settings. Using a scientific calculator, you must convert this value to a decimal amount.
You can then enter this decimal value in the Override Mask field.
Attribute mask
The Attribute Mask parameter specifies which conferencing options are enabled on the
Conference Scheduler for Microsoft Outlook, by default. For example, you might want to enable
roll call, by default.
Some conferencing options have dependencies. For example, for the successful operation of
Roll Call, Name Announcement on Entry, and Name Announcement on exit, you must enable
Prompt Conferees For Name On Entry.
You can enable or disable the following settings:
• Play Tone on Entry
• Play Tone on Exit
• Play Name on Entry
• Name Announcement on Exit
• Auto-Generate Codes
• Play Wait for Moderator
• No Operator Allowed
• Request Bill Code
• Prompt Moderator for Security Code on Entry
• Moderator Hand-Up
• Allow Manual Port Extension
• Allow Manual Duration Extension
• Allow Conference Recording
You should not make changes to any settings that are not in this bullet list.
A file called profile.xls contains a list of these settings. The profile.xls file is located in
<Conferencing application server IP address>/outlook/files/profile.xls. Using profile.xls, you
can enable and disable the settings in accordance with your requirements. The relevant
settings are in column C, from row 5 to row 57. A function in cell C115 computes a binary value
based on your settings. Using a scientific calculator, you must convert this value to a decimal
amount. You can then enter this decimal value in the Attribute Mask field.
Outlook settings
If your deployment includes the Conference Scheduler Plug-in for Microsoft Outlook, you must
configure the Outlook Settings. If you wish, you can retain the default values.
Related topics:
Invitation header on page 219
Invitation body on page 219
Audio numbers on page 219
On demand on page 219
Schedule on page 219
Web conference on page 220
Join conference on page 220
Show roster list on page 220
Most recent list size on page 221
Invitation header
The Invitation Header parameter specifies the text in the Subject field of e-mails that
Conferencing sends using the Conference Scheduler Plug-in for Microsoft Outlook.
Invitation body
Invitation Body specifies the text that Conferencing displays in the body of e-mails that it sends
using the Conference Scheduler Plug-in for Microsoft Outlook.
Audio numbers
The Audio Numbers parameter specifies the Conferencing telephone number for recipients of
e-mail invitations that Conferencing sends using the Conference Scheduler Plug-in for
Microsoft Outlook. This is a free text field. You can enter explanatory words and several
numbers.
On demand
You can configure which features are displayed on the Conference Call tab of the New
Appointment dialog. For example, you can configure the Avaya Plug-in for Microsoft Outlook
to display or hide the Use on-demand audio conference checkbox. If you choose to display
the checkbox, you can display it in an available state or in a disabled and inaccessible state.
• Select On from the On Demand drop-down list to display and enable the Use on-
demand audio conference.
• Select Off/Hide from the On Demand drop-down list to ensure that the Use on-
demand audio conference checkbox is not displayed. If you select this option, the
feature is also disabled.
• Select Off/Show from the On Demand drop-down list to display but disable the Use on-
demand audio conference checkbox.
Schedule
You can configure which features are displayed on the Conference Call tab of the New
Appointment dialog. For example, you can configure the Avaya Plug-in for Microsoft Outlook
to display or hide the Schedule an audio conference checkbox. If you choose to display the
checkbox, you can display it in an available state or in a disabled and inaccessible state.
• Select On from the Schedule drop-down list to display and enable the Schedule an
audio conference.
• Select Off/Hide from the Schedule drop-down list to ensure that the Schedule an audio
conference checkbox is not displayed. If you select this option, the feature is also
disabled.
• Select Off/Show from the Schedule drop-down list to display but disable the Schedule
an audio conference checkbox.
This setting also impacts the Conferencing Plug in for IBM Lotus Notes.
Web conference
You can configure which features are displayed on the Conference Call tab of the New
Appointment dialog. For example, you can configure the Avaya Plug-in for Microsoft Outlook
to display or hide the Web Conference checkbox. If you choose to display the checkbox, you
can display it in an available state or in a disabled and inaccessible state.
• Select On from the Web Conference drop-down list to display and enable the Web
Conference.
• Select Off/Hide from the Web Conference drop-down list to ensure that the Web
Conference checkbox is not displayed. If you select this option, the feature is also
disabled.
• Select Off/Show from the Web Conference drop-down list to display but disable the Web
Conference checkbox.
Join conference
You can configure which features are displayed on the Conference Call tab of the New
Appointment dialog. For example, you can configure the Avaya Plug-in for Microsoft Outlook
to display or hide the Join a Conference button. If you choose to display the checkbox, you
can display it in an available state or in a disabled and inaccessible state.
The Join a Conference button enables participants to enter the conference telephone number
in a Join Conference dialog and to click Dial to enter the conference.
• Select On from the Join Conference drop-down list to display and enable the Join a
Conference.
• Select Off/Hide from the Join Conference drop-down list to ensure that the Join a
Conference checkbox is not displayed. If you select this option, the feature is also
disabled.
• Select Off/Show from the Join Conference drop-down list to display but disable the Join
a Conference checkbox.
depiction of the conference, with icons to represent the participants and their states. There are
three possible values:
• Off/Show
Select Off/Show to hide the link to the Audio Console application.
• Off/Hide
Select Off/Hide to hide the link to the Audio Console application.
• On
Select On to display a link to the Audio Console application. Participants can click on this
link at the conference time to see a graphic representation of the conference.
Related topics:
Enrollment password on page 104
Avaya AuraConferencing 6.0 Managed Element ID on page 104
Obtaining the three pieces of information on page 105
Configuring logs and alarms on page 106
Enrollment password
An enrollment password is a unique code that Conferencing Manager generates. You require
this code in order to configure logs and alarms. As an alternative to accepting the code that
Conferencing Manager provides, you can enter your own phrase as an enrollment password.
The purpose of this task is to make changes to the Conferencing default properties to match
the requirements of your deployment.
Example
For example, if you wish to limit the size of conferences to 50 people, change the value of
Maximum Conference Size to 50. The default value of Maximum Conference Size is 180
people.
Next steps
Now, you can make further CRS configuration changes, such as configuring timezones or
adding resellers.
Reseller settings
The Standard Edition of Conferencing does not support resellers.
Timezone settings
You control the number of time zones used with in Conferencing. You can configure numerous
time zones. However, most customers only use a few, major time zones.
In the CRS database called BSRes2, the timezone table also has a Coordinated Universal
Time (UTC) field. It is a read-only field and you cannot edit it. The UTC field ensures that the
SOAP Adaptor treats conference times correctly, even if you delete or move the GMT timezone.
The Conference Scheduler Plug-in for Microsoft Outlook uses the SOAP Adaptor.
Fields Description
Name The time zone name as well as any associated cities.
Offset The standard time difference between each time zone. The offset is calculated
against GMT (0). For example, the offset for New York is -300, which is 300
minutes or 5 hours behind GMT.
Start DST The date and time when Daylight Savings Time starts using the dd/mm/
yyyyhh:mm format. Daylight savings time (DST) occurs on a different date
each year. DST must be configured annually.
DST Offset The time (in minutes) when accounting for annual daylight savings, usually 60
minutes.
Finish DST The date and time when Daylight Savings Time ends using the dd/mm/
yyyyhh:mm format.
Related topics:
Configuring timezones on page 223
Timezones on page 475
Configuring timezones
The purpose of this task is to add, edit, or delete timezones.
Next steps
Now, you can make further CRS configuration changes.
User settings
It is a good idea, at this point, to clarify the term, users. CRS users are:
• Administrators
• Supervisors
• Operators
• User-Administrators
• User-Auditors
The CRS Front End represents each of these users on the Login screen of the Systems
Administration section. People who make use of the audio conferencing facilities that
Conferencing provides, are called clients or, on the Web Portal application, moderators.
Field Description
Name, Description, and E-mail address Enter a name, brief description, and a
contact e-mail address for the user.
Level A user’s system privilege level.
Password The password acts as a second level of
security as the user accesses the CRS Front
End. The maximum password length is 20
characters. You can set the minimum
password length using Minimum Password
Length. You can also set varying levels of
password complexity using Minimum
Password Complexity. There are four
levels of password complexity, as follows:
(1) 7-bit-ascii-lower: This is the most basic
level of complexity.
(2) 7-bit-ascii-upper: You must include some
upper case characters.
(3) Digits: You must include some digits and
some upper case characters
Field Description
(4) Other: You must include digits, upper
case characters, and additional characters,
such as # or =.
If you have advanced knowledge on the
Conferencing solution, you can choose to
enable or disable the password feature. If it
is enabled, users are required to enter a
password when they log on. To enable this
feature, ensure that ValidationRequired=1 in
the bands.ini file and ensure that the system
parameter, ValidationLevel=1, in the
BSRes2 database. If the feature is disabled,
a password is not required for log on. To
disable this feature, ensure that
ValidationRequired=0 in the bands.ini file
and ensure that the system parameter,
ValidationLevel=0, in the BSRes2 database.
ValidationLevel is the CRS server-side
setting. ValidationRequired is the CRS client-
side setting. If the two values are
inconsistent, the CRS server imposes
synchronization by propagating the server-
side value to the client side. In this event, the
first log-in attempt by the CRS client fails and
the CRS server resets the value. Any
subsequent log-in attempt should be
successful.
You can also configure password expiry.
Using this functionality, you can force
operators to update their password following
a configurable amount of time.
Confirm password You must re-enter the password that you
have entered in the Password field.
Disabled You can disable users so that they cannot
access CRS Front End. If a user does not log
in to the CRS Front End for a configurable
period of time, the CRS can also disable the
user.
Owner A user or login can be a system login or a
wholesaler login. System users are not
associated with a Wholesaler. Wholesaler
users are associated with a wholesaler. If you
would like to associate the user with a
wholesaler, you can select the wholesaler
here.
Password expiry
You can force users to update their password following a configurable period of time using
Period to Password Expiry.
For example:
• To ensure that all users update their password every 28 days, set Period to Password
Expiry to 28.
• To ensure that CRS Front End users never have to update their password, set Period to
Password Expiry to 0. If Period to Password Expiry is 0, no password expiry takes
place.
When the period specified by Period to Password Expiry elapses, the CRS Front End
prompts the user to enter a new password. In this situation, the CRS Front End prompts the
user for the following information:
• Their old password
• A new password
• Confirmation of the new password
The Database users table stores a parameter, called PasswordChangedDateTime to record
the date that a user updates their password. Passwords are case-sensitive. Using Avaya Aura™
Conferencing, which is available from support.avaya.com describes this aspect of the
password feature to users. The Period to Password Expiry parameter also impacts client
passwords. Operators create new clients, edit clients, and delete clients. For more information
on operator tasks, see the Operating Avaya Aura™ Conferencing Guide, which is available
from support.avaya.com.
User account expiry
If a CRS user, such as a CRS operator, CRS supervisor, or CRS administrator does not log
in to the CRS Front End for a configurable period of time, the CRS can disable the CRS user.
Once the CRS disables the CRS user, another CRS user, such as a CRS administrator, must
enable the disabled CRS user.
Similarly, if a Web Portal moderator does not log in to the Web Portal for a configurable period of
time, the CRS can disable the Web Portal moderator. Once the CRS disables the Web Portal
moderator, a CRS user, such as a CRS operator, must enable the Web Portal moderator.
As a reminder of the mapping between roles in the booking applications, it is worth stating that
each Web Portal moderator must have a CRS client account. CRS operators can create, edit,
and delete client accounts using the CRS Front End. CRS operators can also create, edit, and
delete conference reservations on behalf of clients on the CRS Front End.
A number of parameters from the CRS BSRes2 database control this feature:
Parameter Description
LastLoginDateTime (Users This parameter records the date and time when a user
table) logs in to the CRS. This parameter is in the database
Users table.
LastLoginDateTime (Client This parameter records the date and time when a Client
table) logs in to the CRS. When a Web Portal Moderator logs in
Parameter Description
to the Web Portal application, they create a Client
connection to the CRS. This parameter is in the database
Client table.
UserInactiveLogonThreshold This parameter is the length of time for which a user must
(Users table) be inactive before the CRS disables their account. If
UserInactiveLogonThreshold=0, the CRS does not
implement account expiry for users.
UserInactiveLogonThreshold This parameter is the length of time for which a client must
(Client table) be inactive before the CRS disables their account. If
UserInactiveLogonThreshold=0, the CRS does not
implement account expiry for clients, and hence, Web
Portal moderators.
When a CRS user, such as a CRS administrator, CRS supervisor, or CRS operator, re-
enables a disabled account, the CRS resets the date and time in LastLoginDateTime to the
current date and time.
A database stored procedure called, p_DisableInactiveLogons, disables any CRS user and
client accounts that have exceeded the value in UserInactiveLogonThreshold. As a CRS
administrator, you can schedule this job to run at a configurable frequency. Avaya recommends
that you configure this stored procedure to run on a daily basis.
Resetting passwords
There are two main reasons for resetting passwords:
• If a user has forgotten their password
• If a user account is disabled due to password expiry
If a user has forgotten their password, simply edit the user account. You can enter a new
password in the Password and Confirm password fields.
If the CRS disables a user account, you must uncheck the Disabled checkbox. You must also
enter a new password in the Password and Confirm password fields.
Related topics:
Configuring users on page 228
Configuring users
Prerequisites
Before you add users, ensure that you add any necessary wholesalers.
Wholesaler settings
The Standard Edition of Conferencing does not support wholesalers.
Related topics:
Accessing AWC on page 95
authenticator uses to connect to the CRS server. The method that the AWC authenticator uses
to connect to the CRS server is unrelated to the participant log-in to the AWC application. When
a participant clicks on an AWC link to access an AWC conference, they must always enter the
conference reference number and the conference passcode. Participants must always enter
a conference reference number and the conference passcode, regardless of the type of
authentication that the AWC authenticator uses to connect to the CRS server.
In addition to configuring the type of authentication that the AWC authenticator uses to connect
to the CRS server, you must also configure AWC licenses, before you deploy the AWC in your
organization. By default, Conferencing ships with seven licenses for AWC. There are five
platinum licenses and two for over-alloaction. This means that you cannot connect more than
seven AWC clients to the CRS server without configuring additional licenses. In other words,
in order to support more clients, you must purchase more licenses.
• To configure the type of authentication that the AWC authenticator uses to connect to the
CRS server, you use the Conferencing Manager management console.
• To configure AWC licenses, you use the AWC virtual machine. You can access the AWC
virtual machine using the remote desktop function.
Related topics:
Login type on page 232
Login type
The Login Type drop-down menu displays the set of security validation methods that you wish
AWC authenticator to use when connecting to the CRS server. You can use this menu to select
an option for your deployment. You can force the authenticator to use both conference
reference and conference passcode. This is called strong authentication. Alternatively, you can
force the authenticator to just use the conference passcode but not the conference reference.
This is called weak authentication. Avaya recommends strong authentication.
As described, the method that the AWC authenticator uses to connect to the CRS server is
unrelated to the participant log-in to the AWC application.
Related topics:
Configuring login type on page 232
The purpose of this task is to make the AWC feature available for your Conferencing
moderators and participants.
Next steps
In previous releases of Conferencing, you had to perform a large number of configuration tasks
on the CRS and AWC virtual machines. In the current release, there is a single configuration
task. The only configuration task is the configuration of a license for telephone ports. You can
proceed to this step now.
Similarly, in order to enable communications between AWC and the external Internet, you must
open several ports.
Communications between application server and AWC
Open the following ports:
• 5020
• 5021
• 5022
• 5023
• 5040
• 20001
• 20002
Communications between AWC and the external Internet
Open the following ports:
• 80
• 443
Internal and external deployments
Some customer sites offer an internal AWC solution, while some customer sites offer an
external AWC solution.
An internal solution means that participants can only access the AWC Web site if they are on
the internal network. An external solution means that anyone can access the AWC Web site.
If you wish to offer an external solution, you must have a Fully Qualified Domain Name (FQDN)
that is resolvable both internally and externally.
Environmental requirements for AWC
Tip:
For more information on the environmental requirements for Conferencing, see the Avaya
Aura™ Conferencing Release Notes, which are available from support.avaya.com.
Compatible cameras
AWC supports video. You can display a video window at the top right of the AWC screen which
sends a live video to the conference participants. This feature supports a large number of video
industry-standard cameras, including the following:
• Microsoft LifeCam VX-3000
• Labtec Pro
• D-Link DSB-C120
• Creative PD1170L4
• Philips SPC315NC
• Logitech - Quick Cam Chat
• Logitech - Quick Cam Zoom
• Logitech - Quick Cam Sphere
• Ezonics EZCam III
• Micro Innovations - Basic Webcam
• Sweex mini USB webcam
• Vimicro webcam
• A4Tech PK-7MA
Note:
Just to clarify, the Standard Edition of Conferencing does not support video in the sense of
the Conferencing application server providing a high quality video feed. However, the
Standard Edition of Conferencing does support the AWC deployment of video, which
consists of a small video window in the top right of the AWC screen.
Related topics:
Avaya Aura Conferencing implementation workbook on page 585
configures the databases, runs the required scripts, and completes most of the other
configuration tasks.
In fact, now there are only two configuration tasks for AWC:
• The application of an AWC license
• The configuration of the Microsoft Windows operating system password
By default, AWC ships to customers with support for five ports, or telephone lines. This
configuration enables you to check connectivity and verify functionality, but for field
deployment, you must upgrade the license to support a greater number of ports.
The AWC virtual machine uses the Microsoft Windows operating system. The AWC has a
Windows password. If this password expires, the AWC functionality does not operate
successfully. You must configure this password to ensure that it does not expire. You must
perform this task as soon as you install the AWC virtual machine.
In terms of ongoing administration tasks, you can log in to the AWC administrator interface to
monitor Conferencing activity.
Related topics:
Licensing AWC on page 236
Configuring the AWC Windows password on page 237
Licensing AWC
Prerequisites
Before you license AWC, you must contact your Avaya Support Representative to obtain a
license. Your Avaya Support Representative has access to a license generator tool and they
can create a license file and send it to you. It is a registry file with a file extension of .reg. There
are five types of license: Bronze, Silver, Gold, Platinum, and Video. These steps assume that
you have obtained a license and copied it to your current computer.
Note:
Just to clarify, the Standard Edition of Conferencing does not support video in the sense of
the Conferencing application server providing a high quality video feed. However, the
Standard Edition of Conferencing does support the AWC deployment of video, which
consists of a small video window in the top right of the AWC screen.
The purpose of this task is to upgrade from the default of five telephone ports to a larger number
of telephone ports.
1. On your computer, share out the folder in which you have saved the license file:
a. Right-click on the license folder and select Properties.
b. Click the Share tab and select Everyone from the sharing list.
2. Access the AWC virtual machine using the remote desktop feature.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the AWC virtual machine IP address.
The password for the log in on the AWC virtual machine is gatekeeper. The
password is case-sensitive.
3. Access the shared folder which you shared out.
This folder contains the license file.
a. On the AWC virtual machine, click Start > Run.
b. Enter //<IP address of the computer on which you have saved
the license folder> in the Run dialog.
4. Select the license folder and copy it to the AWC virtual machine.
5. Doubleclick the license file.
6. Click through the security dialogs to accept the file.
7. Restart the AWC virtual machine.
You must restart the AWC virtual machine because the license file has made some
changes to the registry settings.
8. Log on to the AWC administrator interface to verify that the number of licenses has
changed from five to the amount on the license.
You can log on to the AWC administrator interface by opening a Web browser and
entering the following address: http://<AWC virtual machine IP
address>/Conferencing/admin, using the username administrator and
the password Avaya123. The License limit column on the AWC administrator
interface main page displays the number of licenses.
Next steps
Now you verify the license by checking the AWC administrator interface.
Prerequisites
Before you configure the AWC Windows password, you must install and configure
Conferencing and license the AWC.
The purpose of this task is to ensure that you do not unexpectedly loose the functionality of
Avaya Web Conferencing when the Windows password expires.
1. Access the AWC virtual machine using the remote desktop feature.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the AWC virtual machine IP address.
The password for the log in on the AWC virtual machine is gatekeeper. The
password is case-sensitive.
2. Navigate to Start > Computer > Manage to open the Server Manager screen.
3. In the left panel, select Configuration > Local Users & Groups > Users.
4. Right click on Administrator and display the Properties panel.
5. Select User can not change password and Password never expires.
6. Click Apply then Save.
Next steps
Now you can perform the administrative tasks on the AWC administrator interface, which you
can access using a Web browser.
Administration of AWC
You can perform a number of administration tasks on the AWC administrator interface.
You can open the AWC administrator interface using a Web browser and the following address:
http://<AWC virtual machine IP address>/Conferencing/admin. You can log
on to the AWC administrator interface using the username administrator and the password
gatekeeper.
• View licenses
• Create new administrator logins
• Configure password settings
• View servers
Under normal conditions of operation, there should be no need to access the AWC
administrator interface. Typically, administrators only access the AWC administrator interface
for troubleshooting purposes. In the current release, Conferencing Manager performs most of
the AWC administration.
Related topics:
Verifying the license on page 239
Creating new administrator logins on page 240
Configuring AWC password settings on page 240
Deleting duplicate servers on page 241
The purpose of this task is to check that the number of supported telephone ports is greater
than the default of five.
Next steps
Now you can navigate through any of the other options on the right pane, such as Set up
administrator.
The purpose of this task is to create new administrator logins. AWC ships with a single
administrator login.
Next steps
Now you can navigate through any of the other options on the right pane, such as Admin
settings.
Prerequisites
Before you configure password settings for administrators , you must install and configure
Conferencing and license the AWC.
The purpose of this task is to change some of the default settings in relation to a number of
password settings, such as password expiry intervals.
Example
For example, if you would like passwords to expire every three months, enter 90 in the
Password expiry period (days) field.
Next steps
Now you can navigate through any of the other options on the right pane, such as Manage
Conference Servers or Manage Audio Bridges.
Prerequisites
Before you view the details of the conferencing server, you must install and configure
Conferencing and license the AWC
The purpose of this task is to remove any additional instances of the Conferencing application
server or bridge. The Standard Edition of Conferencing support a single bridge.
Example
If you do not perform this task, it is likely that the AWC will display each participant a number
of times in the roster.
Next steps
Now you can start to use AWC in a production environment.
Prerequisites
Before you install AWC in a DMZ, you must configure your network with a DMZ.
The purpose of this task is to install AWC in a specific configuration that enables participants
from outside the network to access the AWC functionality across the Internet while protecting
the other components in the Conferencing solution from Internet exposure.
This active state means that the internal instance is up and running successfully
and that the DMZ instance of the AWC is associated with the internal instance of
Conferencing Manager.
Next steps
Now you can verify your AWC installation by booking a data conference or changing AWC
settings using the Conferencing Manager interface.
Prerequisites
Before you manually restart AWC from System Platform, you must install Conferencing.
The purpose of this task is to manually start the AWC service in the event that it does not start
automatically.
Example
You may have to perform this step when you install patches.
Related topics:
Installing and activating regular patches on page 52
Prerequisites
Before you can deactivate the AWC virtual machine, you must install Conferencing and add
the AWC virtual machines to your inventory.
The purpose of this task is to render the AWC virtual machine inactive.
Example
Microsoft Live Meeting is an example of an alternative provider of Web conferencing
features.
Next steps
Now you can configure the alternative Web conferencing application.
Audio Console
Audio Console is a Web-based application that enables moderators to control conferences in
real time by displaying a visual representation of the conference. In the Conferencing
environment, Audio Console enables moderators to view participants, mute participants,
initiate sub-conferences, and dial out to individuals or a group of people. Audio Console also
enables moderators to control conference recording. From the Audio Console, moderators can
start, stop, and pause recording.
In addition, moderators can access many of these features using Dial Tone Multi Frequency
(DTMF) keypad sequences, such as *5 to activate lecture mode. However, Audio Console
provides a visual representation and enables moderators to access some features, such as
conference recording.
Related topics:
Client registration server on page 247
Login type on page 248
Login type
The Login Type drop-down menu displays the set of personal validation details that
moderators must supply when they log in to Audio Console. You can use this menu to select
an option for your deployment. The available values are:
• Conference ID and passcode
• Confirmation number and passcode
• Conference ID, confirmation number, and passcode
Web Portal
The Web Portal is like a Web deployment of the CRS Front End. It provides moderators with
a Web interface for scheduling their conferences. It provides administrators with a Web
interface for managing moderators. However, there are some limitations and it does not provide
access to the full range of CRS Front End functions.
The Web Portal interface is divided into parts defined by unique URLs.
• Moderator’s section
The Web Portal moderator’s section enables moderators to book and manage
conferences, contacts, and account information and view reports. It is a good idea to
provide moderators with the Using Avaya Aura™ Conferencing Guide, which is available
from support.avaya.com. The Web Portal moderator URL is: http://Web Portal virtual
machine IP/webportal/login.
• Administrator’s section
The Web Portal’s Administrator’s section enables administrators to configure available
functionality, define the appearance of the Web Portal, and generate administrator
reports. The Web Portal administrator URL is: http://Web Portal virtual machine IP/
webportal/admin/login.
It is important to note that the Web Portal virtual machine uses the Linux operating system.
As a result, you cannot use the Windows remote desktop feature to access the Web Portal
virtual machine.
Related topics:
Accessing Web Portal on page 92
Accessing Web Portal using PuTTY on page 93
Client registration server on page 249
Login type
The Login Type drop-down menu displays the set of personal validation details that
moderators must supply when they log in to Web Portal. You can use this menu to select an
option for your deployment. In Conferencing terminology, moderators are sometimes known
as clients. The available values are:
• E-mail address and password
• Company name, client name, and account reference
• Account reference and password
• Client name and password
• Directory server: User, password, content
The Directory server: User, password, content option relates to the Lightweight Directory
Access Protocol (LDAP) functionality of the Web Portal. LDAP is an open, standardized
method of interface with a directory server. It enables the Web Portal to authenticate users,
query user data, and invite users to a conference. The directory server contains user
information in a standard format. The formats are edited depending on the requirement of the
directory server administrators. The Web Portal can be integrated with any directory server
format, as long as the users Name and e-mail address are contained. LDAP integration in the
Web Portal also provides a log in type to allow authentication against a directory server, a
tool to search the directory server to locate invitees, and a means of adding contacts to your
conference address book.
For an LDAP integration to operate successfully in your deployment, you must follow the steps
to configure the Directory Services Client Application (DSCA) parameters and then select the
Directory server: User, password, content option in the Login Type drop-down menu.
Previous releases of Conferencing referred to the Directory server: User, password, content
option as Login Type 9.
Another log-in method for moderators, called Single Sign On (SSO) is not compatible with
LDAP integration. You can implement SSO or LDAP, but not both.
Related topics:
DSCA parameters on page 356
DSCA parameters on page 356
DSCA and Web Portal on page 365
Single sign on on page 445
Mail server
The Mail Server value is the IP address of the e-mail server that this instance of Web Portal
uses for sending notification e-mails. Conferencing sends a number of notification e-mails,
such as confirmation e-mails and reminder e-mails. This field is necessary for the following
functions:
• The Forgot password? link on the Login screen
• The Create Appointment for Moderator button on the Reservation Created successfully
screen.
Note:
If you click Create Appointment for Moderator, Conferencing sends a Microsoft
Outlook appointment directly to the moderator. This is not a downloadable calendar
file. However, if you click Create Appointment & Invite Conferees, Conferencing
sends a downloadable calendar file.
Mail from
The Mail From value is the word or phrase that displays in the From field of notification e-
mails. For example, you could enter a phrase such as Conferencing System. This field is
necessary for the following functions:
• The Forgot password? link on the Login screen
• The Create Appointment for Moderator button on the Reservation Created successfully
screen.
Note:
If you click Create Appointment for Moderator, Conferencing sends a Microsoft
Outlook appointment directly to the moderator. This is not a downloadable calendar
file. However, if you click Create Appointment & Invite Conferees, Conferencing
sends a downloadable calendar file.
SSL enabled
This field relates to secure communications between the Web Portal server and the Web Portal
browser clients using the Apache HTTPD method.
Secure Socket Layer (SSL) is a cryptographic protocol which provides secure communications
on the Internet for activities such as data transfer. SSL allows the Web Portal clients and the
Web server to communicate across a network in a way designed to prevent eavesdropping,
tampering, and message forgery.
When you install Web Portal, it installs in non-SSL mode. To enable SSL communications in
your Conferencing deployment, select SSL Enabled.
SSL operates using digital public key certificates. Public key certificates are like digital
signatures and can be used to verify identity. Certificates pass between the Web Portal clients
and the Web server. Certificates are issued by a Certificate Authority. Certificate Authorities
are trusted third parties. With the Web Portal, Avaya has provided instructions to obtain a self
signed certificate. As a system administrator, you can use this certificate to verify that SSL is
in operation. Once you verify that SSL is in operation, you must purchase a valid certificate
from a Certifcate Authority. Avaya does not provide this certificate.
SSL certificate
This field relates to secure communications between the Web Portal server and the Web Portal
browser clients using the Apache HTTPD method. For SSL to operate successfully, you must
install a certificate. You can obtain this certificate from a Certificate Authority, such as
Verisign™.
Note:
Do not confuse this SSL certificate for secure communications between the Web Portal
server and the Web Portal browser with the LDAP certificate for secure communications
between an LDAP server and the Web Portal server.
install a private key. You can obtain this private key from a Certificate Authority, such as
Verisign™.
HTTPS
Data conferencing refers to the Avaya Web Conferencing (AWC) functionality. If your
deployment includes an AWC virtual machine, you can offer a data conferencing option to your
conference participants.
In a deployment with AWC, the Web Portal can send an e-mail notification that includes a link to
the AWC Web site. If the Web Portal sends the e-mail notification to a conferee, the AWC link
connects to the AWC Log in screen with the conferee passcode already entered in the AWC
Security Code field. If the Web Portal sends the e-mail notification to a moderator, the AWC
link connects to the AWC Log in screen with the moderator passcode already entered in the
AWC Security Code field. You can also configure the Web Portal properties file to bypass the
AWC Log in screen for moderators. This is called automatic moderator log in.
By default, the AWC link in the Web Portal e-mail invitation uses the regular, non-secure HTTP
syntax. If you configure the AWC virtual machine to use the Secure Sockets Layer (SSL)
security setting, you must select HTTPS here to ensure that the AWC link uses the secure
HTTPS syntax.
Brand prefix
You can customize the look and feel of the Avaya Web Conferencing (AWC) screens. For
example, you can replace the Avaya logo with a customer's logo. Similarly, you can customize
the look and feel of the Web Portal and Audio Console applications. The process of customizing
an interface is called branding.
By default, the AWC screens have the Avaya branding. If you create a branding for your
deployment, you must enter the branding name in this field. To learn more about the process
of customizing the AWC, contact your Avaya Support Representative.
Prerequisites
Before you configure BSMon to monitor an application, you must install Conferencing and
configure connectivity between the virtual machines.
The purpose of this task is to extend the scope of BSMon so that it 'watches' a greater number of
applications.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
2. In a Windows Explorer dialog, navigate to Avaya > BSMonitor and open the
BSMonitorconf.reg file in a text editor, such as the Notepad application.
This file lists the applications that the BSMon monitors by default. There are four
applications in the list and they number from 0 to 3.
3. Copy an existing entry and paste it at the end of the list.
Ensure that you copy a complete single entry from [HKEY_LOCAL_MACHINE
\SYSTEM\ as far as 00000000.
4. Update the number of the entry. If this is the first new entry in a default file, the
number of this entry should be 4.
5. Update the Name parameter by adding the name of the executable that you want
BSMon to monitor.
6. Update the Path parameter by adding the path to the executable that you want
BSMon to monitor.
7. Save the file.
8. In a Windows Explorer dialog, doubleclick the file.
9. Click Yes, followed by OK at the two information dialogs.
10. Restart the application that you have added to the BSMonitorconf.reg file.
11. Verify that BSMon is successfully monitoring the application by closing the
application and viewing the Process tab in Task Manager to see if BSMon restarts
it.
Next steps
If you want to learn more about the BSMon application, you can read the install.txt in the
BSMonitor folder.
then import it to the customer site. This functionality means that the installation and
configuration of Conferencing is fast and highly efficient.
Related topics:
Introduction to the import and export process on page 401
Prerequisites
Before you can activate a virtual machine, it must have the Service State of
Inactive.Conferencing and add the virtual machines to your inventory.
Prerequisites
Before you can deactivate a virtual machine, you must install Conferencing and add the virtual
machines to your inventory.
Example
For example, you may wish to deactivate a virtual machine to perform a maintenance task
on that virtual machine.
Next steps
Now, you can activate the virtual machine.
• Bridge
• AWC
• CRS
• Web Portal
To back up these files, you must perform some additional steps after you use the Backup/
Restore feature within System Platform. So, effectively, there are two phases in the back up
process. You must back up files using System Platform and then you must back up the
additional Conferencing files. You must complete these two tasks for a successful back up.
The first stage is called System Platform backup and the second stage is called Additional
backup.
For the backup, you require a server with a minimum of 1GB of space.
Similarly, for the restore process, there are a number of phases. First, you must disable the
Avaya Web Conferencing restore feature. The Avaya Web Conferencing (AWC) restore feature
can cause some issues with the restoration of the other Conferencing virtual machine files, so
Avaya recommends disabling the AWC restoration and manually restoring the AWC files. After
you disable the AWC restore process, you must use the Backup/Restore feature within
System Platform to restore the files and then you must restore the additional Conferencing files.
Related topics:
Two stages in the backup process, three stages in the restore process on page 260
What is included? on page 261
What is not included? on page 263
Lastly, back up additional Conferencing Second, restore the system by using the
files using PuTTY. System Platform Web Console
Lastly, restore additional Conferencing files
using PuTTY.
You can follow the steps here to perform all of these tasks.
What is included?
The following files are included in the System Platform backup and restore feature. System
Platform copies each of these files to a folder on the machine that you are currently using,
called C:\temp\Avaya.
AWC
CRS
Web Portal
Note:
Excluding subfolders log / logs / *.log / lib / *.jar / modules / run /
temp / tmp / work
More configuration /etc/sysconfig/network-scripts/ifcfg-eth0
files /etc/sysconfig/network
/etc/resolv.conf
/etc/hosts
Bridge
Note:
Excluding subfolders logs / *.log / lib / *.jar
Bridge (application server) Cronjobs
Secure Access Link (SAL) configuration
Bridge database (called Bridgedb)
In addition, it is important to note that you must make separate provisions for conference
recordings. Conference recordings are not included in the System Platform backup and restore
feature.
Special provisions for the bridge database
The bridge database is not part of the backup and restore process. In the unlikely event that
a bridge virtual machine has a fatal error, you can re-populate the bridge database using the
information from the Client Registration Server (CRS). This process of re-population can take a
number of hours. As a workaround, to avoid this delay, Avaya has created a scheduled job that
automatically copies the daily bridge local backup to a remote server. Essentially, this
scheduled job sends a daily copy of the bridge database to a remote FTP server so that you
can use that copy to restore the bridge database in the event of an error on the production
machine.
Related topics:
Copying the bridge database to an FTP server on page 264
The purpose of this task is to configure a scheduled job to send the daily backup copy of the
bridge database to an FTP server.
This command copies the latest bridge database backup at 05:00 each
morning.
c. On the remote server, create the folder <remotedirectory> and ensure that
<myuser> on <remoteserver> can write to it.
d. Inform the crontab of the updated tasks by entering this command:
crontab -u sroot my_cron_jobs
Next steps
It is a good idea to verify the scheduled job before you place the server into production.
Note:
It is not the aim of the backup feature to provide a mechanism to re-enable a failed High
Availability Failover node back to High Availability Failover configuration. Follow the
instructions in this document on how to re-enable failed High Availability Failover node back
to High Availability Failover configuration.
Related topics:
Backing up the system by using the System Platform Web Console on page 266
Scheduling a backup on page 266
Transferring the Backup Archives to a remote destination on page 267
Viewing backup history on page 267
Important:
The backup file size can reach 3 GB. Ensure that you have that much free space
at the location where you are storing the backup archive.
4. Select where to store or send the backup files:
• Local: Stores the backup archive file on System Platform in the /vspdata/
backup/archive directory.
• SFTP: Stores the backup archive file on the designated SFTP host server as
well as on the System Platform server.
• Email: Sends the backup archive file to the e-mail address that you specify as
well as stores the file on the System Platform server.
Note:
Avaya does not recommend that you use the Email option due to the large
size of backup files. The backup file size can reach 3 GB.
5. Enter other information as appropriate.
6. Click Backup Now.
Scheduling a backup
Use this procedure to back up System Platform and the solution template on a regular basis.
Backups are not scheduled by default on System Platform.
following message: Last Backup Failed. The system continues to display the message
until a backup is successful.
Field Descriptions
Names
Backup Select a location to send the backup file:
Method
• Local: Stores the backup archive file on System Platform in the /vspdata/
backup/archive directory.
• SFTP: Stores the backup archive file on the designated SFTP host server
as well as on the System Platform server.
Enter the hostname, directory, user name, and password for the SFTP
server.
• Email: Sends the backup archive file to the e-mail address that you specify
as well as stores the file on the System Platform server.
Enter the e-mail address and the server address of the recipient.
Additional backup
To complete the full back up of all Conferencing data, you must perform some additional steps.
To perform these steps, you require the PuTTY application. PuTTY is a Windows SSH client
that allows you to access the application server, giving you a terminal window. You can
download PuTTY from http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html.
There are many different PuTTY downloads listed. Typically, your deployment requires the
putty.exe file.
Related topics:
Backing up using PuTTY on page 269
do not need to perform any additional back up steps on the Avaya Web Conferencing (AWC)
virtual machine.
Prerequisites
Before you back up the additional Conferencing files, you must back up the Conferencing files
using System Platform.
The purpose of this task is to back up additional Conferencing files that are not included in the
System Platform back up.
For example:
scp /usr3/BACKUPS/outlook_conf_files.tar
admin@XXX.XX.XX.X:/home/admin/
7. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
8. Copy the following files to the secure server on the customer network.
• C:\Windows\*.ini
• D:\Profiles\dsca.pfl
9. Access the Web Portal virtual machine using the same method you used to connect
to the application server virtual machine.
10. Copy the following files to the secure server on the customer network, using the
same method that you used to copy files from the application server virtual machine:
• /home/sroot/keystore.jks (If present)
• /etc/pki/tls/certs/localhost.crt (If present)
• /etc/pki/tls/private/localhost.key (If present)
• /opt/webapps/webportal/WEB-INF
• /opt/webapps/webportal/WEB-INF/default
• /opt/webapps/webportal/customisations/default/default/properties
Next steps
Now it is a good idea to test the restoration process. Recall that you must disable the Avaya
Web Conferencing (AWC) restore process before you restore the files using the System
Platform restore process.
System Platform virtual machine (Cdom). To edit this file, you must use PuTTY to access the
System Platform virtual machine.
After you disable the automatic restore feature of AWC, you must manually restore AWC.
Related topics:
Disabling AWC restore on page 272
The purpose of this task is to disable the AWC restoration process on the System Platform
virtual machine so that it does not cause problems with the restoration of the other
Conferencing components. This task involves changing a phrase of text and adding a single
function.
Example
Here is an example of a section of the file:
#### function doRestore() {
echo NotRunningAWCRestore
}
function donothing() {
RESTORE_DIR="${WORK_DIR}"
#wget --post-data
"action=restore&username=admin&password=admin01&uri=sftp://$
{CDOM_IP}${RESTORE_DIR}" http://${VM_IP}:18080/data -O /tmp/$
{VM_ID}.restore.status
#sleep 60
if [ -f "/home/vspvm/.ssh/id_dsa" ];then
result=`curl -F "file=@/home/vspvm/.ssh/id_dsa"
"http://${VM_IP}:18080/data?
action=restore&username=vspvm&password=&uri=sftp://${CDOM_IP}$
{RESTORE_DIR}"`
if [ "$result" != "true" ];then
echo "$result "
Next steps
Now you can restore the remainder of the Conferencing files using System Platform.
Related topics:
Restoring backed up configuration information on page 274
Note:
The restore operation does not restore the High Availability Failover configuration from the
backup file. It is not the aim of the restore feature to re-enable the failed High Availability
Failover node back to High Availability Failover configuration. Follow the instructions given in
this document on how to re-enable the failed High Availability Failover node back to High
Availability Failover configuration. Avaya recommends that you restore the backup
configuration before configuring and starting High Availability Failover.
Related topics:
Restore field descriptions on page 274
Viewing restore history on page 275
the archive file is located, and user name and password for the SFTP
server.
• Upload: Restores from a file on your computer.
Archive Filenames of the backup archive files at the location you specify.
Filename
Archive Date Date that the file was created.
Selection Select this check box to restore from the archive file.
Restore Displays the restore history for the last ten restores. If an error occurred
History during the last restore, the system directs you to this page after login and
continues to display an error message until a restore is successful.
Button descriptions
Button Description
Search Displayed if you select SFTP. Searches for archive files in the specified
directory of the remote server.
Clear Search Clears the list of archive files found on a remote server after an SFTP
Result search.
Additional restore
After the System Platform restore, you have to perform some manual steps using PuTTY. You
must restore the AWC files as well as several application server, Client Registration Server
(CRS), and Web Portal files.
Related topics:
Restoring using PuTTY on page 276
The purpose of this task is to restore some additional files that were not captured by the System
Platform back up and restore process.
cd branding
tar zxvf awc-branding-[DateStamp]-[TimeStamp].tgz
7. Enter the following command to view the contents of the directory:
ls -al
This directory contains a number of files, including:
• Authenticator.xml
• wp_mappings.conf
• Authenticator.properties
• log4j.properties
8. Use WinSCP to restore the following files and directories:
14. Restore the bridge database file from the secure server to the following location on
the application server virtual machine:
• /var/avaya/backup [the file has a pgc.gz file extension]
• /home/sroot/outlook_conf_files.tar
15. Restore the Conference Scheduler for Microsoft Outlook files from the secure server
to the following location on the application server virtual machine:
/home/sroot
tar xvf outlook_conf_files.tar
mv /home/sroot/usr/ipcb/outlook/files/* /usr/ipcb/outlook/
files/
16. Ensure that the application server (bridge) is not running and that the Client
Registration Server (CRS) is not connected to the bridge database:
SSH to the bridge
service postgresql stop
17. Enter the following command:
/usr/dcb/bin/bridge-restore.sh
18. Restart the application server service.
You can restart the application server on the Conferencing Manager administrative
screens (Elements > Conferencing > Services > Bridge Service Start).
19. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
20. Copy the following files from the secure server on the customer network to the CRS
virtual machine.
• C:\Windows\*.ini
• D:\Profiles\dsca.pfl
21. Access the Web Portal virtual machine.
22. Copy the following files from the secure server on the customer network to the Web
Portal virtual machine
• /home/sroot/keystore.jks
• /etc/pki/tls/certs/localhost.crt
• /etc/pki/tls/private/localhost.key
• /opt/webapps/webportal/WEB-INF
• /opt/webapps/webportal/WEB-INF/default
• /opt/webapps/webportal/customisations/default/default/properties
Introduction to languages
At the present time, the Conferencing audio messages are available in a limited number of
languages. However, the applications are only available in English.
Most people interact with Conferencing as conference conferees or conference moderators.
With this idea in mind, Avaya plans to localize the participant experience by translating the
graphic user interfaces (GUIs) of a number of Conferencing applications and by making
Conferencing audio messages available in a number of languages.
Conferencing applications include booking applications and meeting management
applications such as:
• Web Portal
• Avaya Conference Scheduler for Microsoft Outlook
• Avaya Web Conferencing
• Audio Console
• Avaya Plug-in for Microsoft Live Meeting
• Avaya Plug-in for Microsoft Office Communicator
• Avaya Plug-in for IBM Lotus Sametime
Avaya plans to make each of these applications available in a number of languages. Similarly,
Avaya plans to make all audio messages available in each of the supported languages. Once
this is accomplished, the end-to-end experience of participants engaging in conferencing will
be localizable.
Note:
On the release date, Conferencing supports some of these languages. Conferencing will
support the full list of all languages 90 days after the release date. Please contact your Avaya
Support Representative for more information about release dates for a fully localizable
implementation. During the period of 90 days before Conferencing supports the full list of
languages, if an operator or a moderator chooses an unsupported language when booking a
conference, Conferencing plays the English audio messages in place of the unsupported
language.
The audio messages are available in the following languages:
It is important to note that even after Avaya makes the Conferencing end-user applications
available in a number of languages, system administrators must still understand English in
order to successfully install, configure, and monitor the operation of Conferencing. Similarly,
operators interacting with CRS Front End and Bridge Talk must also understand English.
Note:
The Standard Edition of Conferencing does not support the Bridge Talk application but can
support an external application with similar features. You can configure this application to
operate with Conferencing using the ACP API.
Audio messages inform participants of information and prompt participants for responses.
These audio messages are sometimes called audio prompts or annunciator messages. A
group of audio messages is often called a prompt set.
Related topics:
Audio messages and prompt sets on page 291
Linked files and linking on page 295
Related topics:
System language on page 283
Conference language on page 283
Participant experience on page 284
System language
When you configure call branding, you create an association between a dialed number
identification service (DNIS/DDI) and an audio prompt set. This association determines the
system language. In each row of a call branding table, the DDI field represents the DNIS and
the Message Set Number field represents the audio prompt set. So, for example, you could
create an association between the DDI 12345 and the English audio prompt set. This is the
system language.
Related topics:
Call branding on page 69
Configuring audio messages for your system on page 296
Conference language
When operators or moderators book a conference, using CRS Front End, Bridge Talk, or Web
Portal, they can create an association between the conference and an audio prompt set. This
association creates the conference language. Bridge Talk operators can access the Prompt
Set drop-down list in the Conference Scheduler utility, CRS Front End operators can access
the Prompt Set drop-down list on the Options dialog, and Web Portal moderators can access
the Prompt Set drop-down list on the Advanced Booking Options screen.
Moderators cannot specify an audio prompt set if they book their conference using the
Conference Scheduler Plug-in for Microsoft Outlook or IBM Lotus Notes.
For more information on selecting a prompt set for a conference using Web Portal > Booking
Meeting > Reservation Details > Advanced Options, see Using Avaya Aura™ Conferencing
Guide, which is available from support.avaya.com.
For more information on selecting a prompt set for a conference using CRS Front End >
Customer Bookings > Check Reservation > Confirm Reservation > Options, see
Operating Avaya Aura™ Conferencing Guide, which is available from support.avaya.com.
Note:
The Standard Edition of Conferencing does not support the Bridge Talk application.
Related topics:
Configuring audio messages at conference-level on page 297
Participant experience
When participants dial the DNIS/DDI, Conferencing always plays audio messages in the
system language. For example, if you associate the DNIS with the English audio prompt set,
participants always hear English messages. Once participants enter their conference
passcode, Conferencing has visibility of the conference settings. At this point, there are two
possible outcomes, as follows: Each entry in the call branding table also has a parameter called
Use Conf Prompt Set. By default, Use Conf Prompt Set is disabled.
• If Use Conf Prompt Set is enabled, Conferencing plays the conference audio prompt set
once the participants enter the conference passcode.
• If Use Conf Prompt Set is not enabled, Conferencing plays the system audio prompt set
at all times, even after the participants enter the conference passcode.
Related topics:
Call branding on page 69
Scope of localization
In this release of Conferencing, Avaya has maximized the scope of localization by ensuring
that Conferencing end users are the main priority for all localization efforts. Within the
Conferencing environment, end users are called moderators or participants. These are the
people who book and attend conferences on a regular basis. Where possible, Avaya has
focused localization efforts on the end user experience. For this reason, Avaya has not
localized the administrative elements of the various Conferencing components. As a result,
system administrators must have knowledge of the English language.
At this stage it is a good idea to clarify the terms: Localization and Internationalization
Related topics:
Internationalization on page 285
Localization on page 285
Plug-in components on page 285
Web components on page 287
CRS components on page 287
APIs on page 288
Application server components on page 288
Operator components on page 289
Internationalization
For the purposes of the Conferencing product, the term internationalization refers to the
process of making a component capable of being localized in the future. This means that the
component can support a number of languages, but currently, the component is not shipped
with language files. In addition, internationalization means that the component can store and
transport data that has been input or imported from a number of different source locales. For
example, the internationalized components can process a number of Asian language scripts.
Localization
For the purposes of the Conferencing product, the term localization refers to the process of
providing a component in multiple languages. This means that the component supports a
number of languages. For the most part, Avaya has confined localization to end user
components, such as end user graphic user interfaces (GUIs) and end user audio messages.
Plug-in components
Recall that within the Conferencing solution, Avaya has developed the following plug-in
applications to provide Conferencing capabilities for users who are running a number of IBM
and Microsoft solutions:
• Conference Scheduler for Microsoft Outlook
• Conferencing for Microsoft Live Meeting
• Conferencing for Microsoft Office Communicator
Web components
Recall that within the Conferencing solution, Avaya has developed the following Web-based
applications:
• Web Portal
• Audio Console
• Avaya Web Conferencing
• Conference Viewer
• Conferencing Manager administrative interface
This table shows the aspects of the Web components that Avaya has localized and
internationalized.
CRS components
This table shows the aspects of the Client Registration Server (CRS) components that Avaya
has localized and internationalized.
APIs
Avaya has developed a number of Application Programming Interfaces (APIs) to enable
customers to customize their Conferencing solution and to enable them to develop their own
applications which process Conferencing data.
Some of the APIs are limited by a fixed field size. These APIs are SCHAPI, MODAPI, BCAPI,
and ACAPI. This means that Conferencing may truncate some text strings.
This table shows the aspects of the APIs that Avaya has localized and internationalized.
Operator components
This table shows the aspects of the operator components that Avaya has localized and
internationalized.
Recall that within the Conferencing solution, Avaya has developed two applications specifically
for operators.
Operators differ from moderators and participants. Operators manage large numbers of
conference calls, for example, within a Conferencing provider environment. Operators attend
conferences and control features such as polling, question and answer sessions, and the help
queue. Operators use the Client Registration Server (CRS) Front End and the Bridge Talk
application to perform their tasks. Moderators book their own conferences and attend them.
Moderators use the Web Portal application or one of the plug-ins to perform their tasks.
Participants attend the conferences that moderators and operators book.
Note:
The Standard Edition of Conferencing does not support the Bridge Talk application.
Related topics:
Prompt set management on page 112
System alert enabled on page 155
System alert message on page 156
Introduction to languages on page 281
Per conference messages on page 292
System wide messages on page 293
Message rules on page 293
Audio transcript on page 295
Linked files and linking on page 295
Note:
The Standard Edition of Conferencing does not support the Bridge Talk application. In this
case, you could create recordings using an alternative method. You can then copy these
recordings to the relevant prompt set using an application such as WinSCP, which provides
secure copying.
Note:
A limitation exists in relation to these per-conference and system messages. Specifically,
the Avaya Conferencing Provider Application Programming Interface (ACP API) does not
support these messages. So, if the ACP API is used to route participants to a conference,
the participants do not hear these messages. It is important to note that the Conference
Scheduler Plug-ins for Microsoft Outlook and IBM Lotus Notes use the ACP API to support
the Click to Join button. So, if participants enter a conference by clicking Click to Join,
they do not hear the per-conference or system messages.
A important point to note in relation to system wide messages is that if a caller dials in using
SCAN call flow, Conferencing plays the message in the language configured to the DNIS. If a
caller dials in using the DIRECT call flow, Conferencing plays the message in the language
associated with the conference. This behavior is due to the fact that the DIRECT call flow routes
the call directly to the conference.
Note:
The Standard Edition of Conferencing does not support the Bridge Talk application. In this
case, you could create recordings using an alternative method. You can then copy these
recordings to the relevant prompt set using an application such as WinSCP, which provides
secure copying.
Message rules
By default, Conferencing follows certain rules in relation to playing audio messages. It is
important to consider these rules when recording and configuring new audio messages.
Audio transcript
On the application server virtual machine, there is a file containing a transcript of message
text. System administrators should maintain an up-to-date transcript of message text.
It is a good idea to maintain an up-to-date list of message text. Avaya ships Conferencing with a
list of the default message text. If you intend to customize some of the messages in your
deployment, it is a good idea to keep this list aligned with the audio messages.
This file is located on the application server virtual machine in the usr/dcb/dbase/admin
directory and is called annmsgs.txt. You can access the file if you use PuTTY to log in to
the application server and navigate to the appropriate directory. You can view, copy, and edit it.
You can also view and edit the file using Conferencing Manager by navigating to the Elements
> Conferencing > Audio Conferencing > Bridge features > Prompt set management
screen.
Related topics:
Introduction to languages on page 281
Prerequisites
Before you can configure audio messages for your system, you must install and configure
Conferencing. You must also obtain a list of available DDIs/DNIS telephone numbers which
you can use for conferencing provision.
The purpose of this task is to associate a language and a Conferencing telephone number.
When callers dial this telephone number, Conferencing plays audio messages in the
associated language.
Example
To play Spanish audio messages, enter 15 in the Message Set Number field. It is also a
good idea to enable or disable Use Conf Message Set as required.
Next steps
Now it is a good idea to verify the language by dialling the DDI and listening to the audio
message response from the Conferencing server.
Related topics:
Call branding on page 69
System language on page 283
Prerequisites
Before you can configure a specific language for your conference, you must install and
configure Conferencing. You must also configure a system language.
The purpose of this task is to set a conference-specific language that differs from the configured
system language.
• Book a conference using the CRS Front End.
a. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
b. Open CRS Front End > Customer Bookings and book a conference in the normal
way.
c. On the Options dialog, select a prompt set from the Prompt Set drop-down menu.
The prompt set you select here becomes the prompt set that is associated with the
conference. For example, if you select 4, Conferencing sets the conference
language to Spanish.
d. Finish the booking in the normal way.
• Alternatively, book a conference using Web Portal.
a. Log into the Web Portal moderator interface.
The Web Portal moderator URL is: http://Web Portal virtual machine
IP/webportal/login
b. Book a conference in the normal way.
c. On the Advanced Options screen after the Reservation Details screen, select a
prompt set from the Prompt Set drop-down menu.
d. Finish the booking in the normal way.
Next steps
It is a good idea to dial into the conference to verify the language. Also, it is a good idea to
consult Using Avaya Aura™ Conferencing Guide for more information about Web Portal
conference booking and Operating Avaya Aura™ Conferencing Guide for more information
about CRS Front End conference booking. Both of these guides are available from
support.avaya.com.
Related topics:
Conference language on page 283
Prerequisites
Before you view prompt sets and message text, you must install and configure Conferencing.
The purpose of this task is to view the details of the audio messages in your deployment.
Next steps
It is a good idea to verify that the message transcript file on the application server is correctly
populating the fields in Conferencing Manager. You can do this by making a temporary change
to a specific message in the transcript file on the application server and looking again at the
message text on Conferencing Manager.
Related topics:
Prompt set management on page 112
Introduction to recording
Conferencing includes a feature which enables customers to record their conferences. This
feature is useful for customers who wish to store any or all conferences for security reasons.
It is also useful for customers who wish to make conferences available for playback, for
example, to people who were unable to attend a conference.
Conferencing can store and manage recordings within the Conferencing server environment. If
customers use this option, it is often called on-bridge recording. Alternatively, customers can
send the conferences to an external device for recording, management, and playback. If
customers use this option, it is often called off-bridge recording. If customers use the off-
bridge recording option, they cannot make use of the playback facilities within Conferencing.
The following descriptions and tasks are mainly concerned with on-bridge recording.
As an aside, some people also refer to the recording feature as Digital Record and Playback
(DRP). You can configure settings related to the recording feature using the Elements >
Conferencing > Audio Conferencing > General Config > Recording and playback menu.
Related topics:
Recording and playback on page 168
Related topics:
Digital conference record playback on page 133
Number of annunciator channels on page 149
Bridge ID number on page 151
Automatic record all on page 153
Secure blocks record on page 153
Playback small jump on page 156
Playback medium jump on page 156
Playback long jump on page 156
Bridge record on page 168
Phone number on page 169
Dial string on page 169
Pre dial delay period on page 169
DRP auto gen fname on page 170
Bridge record
Bridge Record specifies whether Conferencing records conference information on the
application server or to an external device. The application server is also called the bridge.
Typically, conference recordings are stored on the usr3/confrp drive of the IBM 3650 M2. By
default this setting is set to On-bridge. If you configure Bridge Record to Off-bridge and
operators are using Bridge Talk Conference Scheduler, you must also configure Bridge Talk
Conference Scheduler to Off-bridge. If you do not configure Off-bridge recording in both
locations, Conferencing defaults to On-bridge.
• On-bridge
Conferencing records conference information to the bridge.
• Off-bridge
Conferencing records conference information to an external device. In an Off-bridge
deployment, you must enter a value in the Phone Number and Dial String parameters.
When you configure Conferencing for Off-Bridge recording and an operator or moderator
schedules a conference for a maximum of 10 participants, the conference can have either:
9 participants and an external recording, or 10 participants and no external recording.
Phone number
Phone Number specifies the number to dial when Bridge Record is set to Off-bridge. This is
the telephone number of the external recording device.
Dial string
Dial String specifies the DTMF digits that Conferencing sends to the external recording device
after the recorder answers the call. Some of the information contained in the Dial String may
be vendor-specific. Some information may be derived at run time. Use these values in the
string to specify run-time values:
• %P
This value is expanded at run time to contain the conference passcode.
• %T
This value is expanded at run time to contain conference start time in Linux time format
(seconds since 1/1/1970).
• %C
This value is expanded at run time to contain conference confirmation number.
For example, if you set the Dial String to *000#*%P#*%T#%C## and the following conference
properties apply in your conference:
• The Passcode is 1234
• The conference starts on August 3, 2010 at 9:58 AM
• The confirmation number is 123456789012
Under these conditions, Conferencing sends the string
*000#*1234#*1280829516#*123456789012## to the external recording device.
Bridge ID number
This number uniquely identifies the Conferencing application server, or bridge. The
Conferencing recording feature uses this number for all recording filenames. If Conferencing
automatically names a recording, it uses the following conventions:
<Conference confirmation number><Bridge ID number>XXXX
The value of XXXX grows sequentially, as follows:
• If the operator or moderator stops and then restarts recording during the conference,
Conferencing increments the value of XXXX.
• Similarly, if all participants leave the conference and later re-join, Conferencing
increments the value of XXXX. As an example, this scenario occurs when moderators
use their on-demand conference for a weekly meeting. Conferencing views this weekly
recurring meeting as multiple instances of a single conference.
If your deployment consists of a number of application servers, called a multicabinet
environment, there are implications for the automatic naming convention. Conferencing
encodes all recording filenames on a given bridge with the bridge number. This fact can be
used to keep recordings from difference bridges from having name conflicts if customers copy
them to a common playback device. Conversely, if customers can guarantee that name
conflicts will not occur due to other factors, such as configuring confirmation numbers to be
unique across all recording source bridges, then customers can set the Bridge ID Number
values to be the same on all bridges. In this scenario, users can play multi-sourced files from
a single-source playback. This scenario only operates successfully in a deployment that
includes a CRS server. If there is no CRS server, you must set the Bridge ID Number to a
unique value on all servers. Avaya recommends consulting with your Avaya Support
Representative for advice if your deployment includes a complex server environment. As an
aside, operators and moderators can manually specify the filename of a conference recording.
They can enter almost any digit string for this purpose but it must not start with zero. Automatic
filenames always start with zero. This filename forms the XXXX portion of the complete
recording filename:
<Conference confirmation number><Bridge ID number>XXXX
Note:
In the Standard Edition of Conferencing, there is no support for a multicabinet environment.
The Enterprise Edition of Conferencing supports multicabinet.
disk. This setting sets the maximum number of those resources that Conferencing uses at any
one time. In an in-service deployment, the record and playback features hold the annunciator
channel resource for long periods of time. For this reason, the record and playback usage is
capped at a sub-set (70%) of the value entered here.
Conferencing reserves 30% for the playing of regular audio messages during conferences.
This metric aims to balance the requirements of the regular conference audio messages and
the recording and playback feature. This parameter represents the number of overall
annunciator channels. The platform limit is 1500. This is also the default value.
Prerequisites
Before you enable the recording feature, you must install and configure Conferencing.
The purpose of this task is to make the recording feature available for your participants.
Next steps
Now you can configure the recording feature.
Prerequisites
Before you configure the recording feature, you must enable the recording feature.
Next steps
Now you can configure the playback parameters.
Related topics:
Call branding on page 69
Managing files
As a system administrator, you must manage the recording files and ensure that users can
access them when required. There are two aspects to this configuration. You must consider
your allocation of on-demand port resource. You must also consider the recording file sizes
and names.
Prerequisites
Before you configure the options for managing files, you must enable the recording and
playback features.
The purpose of this task is to balance file sizes and available resources to ensure that
participants can access recordings when required.
• Ensure access for users.
• Manage recording size and names.
Related topics:
User access on page 310
File sizes and file names on page 310
Legacy Web Portal feature on page 312
User access
Calls to the playback call flow occupy on-demand port resources. Your allocation of on-
demand resources must take account of these lines. You can allocate a percentage of your
telephone ports for on-demand conferences using the On-Demand Pct % field. You can
configure On-Demand Pct % using the Conferencing Manager interface, by navigating to
Elements > Conferencing > Audio Conferencing > Conference Features.
Related topics:
On demand percentage on page 128
• /usr3/pbkroster
• /usr2/roster
This cronjob runs on a daily basis. Avaya enables this cronjob by default on each new instance
of Conferencing. You can disable this cronjob. The cron does not delete from /usr3/
confrp if there is an external NFS server in the deployment.
For the Standard Edition of Conferencing, the bridge number is 0, by default. The Standard
Edition of Conferencing does not support multiple bridges. A deployment with several bridges is
usually referred to as a multicabinet environment.
If you enable automatic naming of the recordings, using the DRP:Auto-gen fname parameter,
the value of XXXX begins with 0001 and grows to 09999999. If you enable automatic naming,
the value of XXXX grows sequentially, as follows:
• If the operator or moderator stops and then restarts recording during the conference,
Conferencing increments the value of XXXX.
• Similarly, if all participants leave the conference and later re-join, Conferencing
increments the value of XXXX.
If you disable automatic naming and opt for manual naming of the recordings, the value of
XXXX begins with 1 and grows to 99999999. Manual names can be any name that does not
already exist.
Related topics:
Disabling the cronjob on page 311
Introducing billing
The Conferencing Billing application provides data that is used as an input to an external billing
application in order to invoice users of the Conferencing system. Any audio and data events
occurring on Conferencing are output in the billing. This application differs from the
Conferencing Reports application in that the Conferencing Billing application runs on a
scheduled basis and produces machine readable output files. The Conferencing Reports
application, on the other hand, is used by administrators or operators to produce intuitive
representation of the same data.
The Conferencing Billing application supports many different billing formats. Here, we describe
billing format 0, which is a customizable billing format and is the recommended format in that
it is the most flexible. Billing format 0 is determined by the settings in the sbill.ini file, which is
located in the Windows directory.
The format of the billing output is defined by the administrator. You can choose which fields
you would like to output. The billing application produces a number of text files per day which
are stored in a designated network location where they can be accessed by the external
invoicing application. The fields included in the file, the sequence of fields, and the separator
must be designated. Also, the file name and the frequency of the billing must be defined.
Records without all fields populated can occur in the case of conference deletion.
Related topics:
CDR end date filename on page 174
Billing settings on page 212
Layout of bills
All fields that are required for billing must be designated in the sbill.ini file. For example, if you
require billing for Avaya Web Conferencing usage, it is necessary to include the Avaya Web
Conferencing fields in the definition of the billing output. All records produced in the bill file
have the same fields, however, some are blank depending on the type of event occurring on
the system. For example, an audio event results in the audio related fields being populated
and the data related fields are blank.
For more information about each of the fields, contact your Avaya Support Representative.
Billing configuration
An initialization file called sbill.ini controls all the billing configuration settings. The sbill.ini file
resides in the billing directory on the CRS virtual machine. In most cases, you do not have to
configure this file because you can configure the most important properties using the
Conferencing Manager administration interface. These properties are listed here.
Related topics:
Primary bill file location on page 212
Secondary bill file location on page 212
Bill file extension on page 213
Bill file prefix on page 213
Bill frequency on page 213
Bill start offset (mins) on page 213
Bill at time on page 214
Bill file header on page 214
Bill file trailer on page 214
Period to retain CDR files on page 214
There is a special situation if you configure the Bill File Prefix parameter to the value <date>. In
this situation, Conferencing uses a special, date-based file name format. If the Bill File Prefix
parameter has the value <date>, Conferencing ignores the Bill Stamp number. Instead,
Conferencing names the files according to the current date, using the following format and
syntax:
YYMMDDNN.bil
• YY=year, where 2000=00
• MM=month, where October=10
• DD=day, such as 31
• NN=the file number on that particular day
For the first bill of the day, NN=00. The number increases incrementally from then
onwards. If the NN number reaches 99, Conferencing does not run until the date changes.
Bill frequency
The Bill Frequency parameter specifies how often Conferencing runs the billing cycle. If the
Bill Frequency parameter is 0, Conferencing generates a bill every day at the time specified
by the Bill At Time parameter.
Bill at time
The Bill At Time parameter specifies the time that Conferencing produces billing data.
Conferencing uses this parameter solely for daily bills. By default, the Bill At Time parameter
is 0100.
Configuring billing
Prerequisites
Before you configure billing, you must install and configure Conferencing.
The purpose of this task is to change the default settings for the Billing application.
Example
For example, you can change the default location for billing files or change the billing time.
CDR Loader application, and so on. If any of the Conferencing applications fails and closes,
BSMon restarts them.
For the majority of customers and deployments, the configuration of the settings in
Conferencing Manager is sufficient to ensure that Billing operates as required.
If you require access to the Billing application to create a bill for a specific date or date range
or for the rebilling function, you must:
• Stop the BSMon monitoring of Billing.
• Stop the Billing task using the Task Manager.
• Access the Billing application and perform the tasks that you require.
• Restart BSMon when you are finished.
The Billing GUI consists of a panel called Databases and a panel called Bill Files.
Databases panel
Item Description
Booking Data Displays the name of the Central Registration Server database.
Call Data Displays the name of the call database.
Login Timeout Displays the time in seconds after which logging into a database fails.
Query Timeout Displays the time in seconds after which a query to a database fails.
Item Description
Bill Delays Displays the time lag between the completion of a conference and the
dispatching of the conference bill. If it is set to “0” then all completed
conferences whose call data has been processed will be billed whenever
the billing generation is run. If it is “1” then any conferences completed in
the previous hour are not billed in the current billing.
Path The file path where billing output files are generated and stored.
Format The billing output format. This is customer specific.
Max Records The maximum number of billing records per bill file. One record is output
for each caller in a conference or for each unused or cancelled conference.
Bill Every The customer can specify (in the INI file) how often automatic billing
generation occurs.
Note:
This is between 1 and 24 hours.
Here are some of the tasks that the GUI enables you to perform.
To... Do This...
Initiate instant billing Click Bill Now.
The billing generation takes place instantly without waiting for the
automatic billing generation to occur.
View logs Click View Log.
The SBill log screen is displayed.
Rebill Click Rebill.
The Rebill dialog is displayed.
View version details Click About.
The billing version details are displayed.
Prerequisites
Before you create a bill for a specific date, it is a good idea to ensure that there was conference
activity on the day that you select. You can generate conference activity by booking some test
conferences and dialing into them.
The purpose of this task is to create a bill file for a specific date to view the billing details for a
single, selected, day.
The purpose of this task is to create a bill file for a specific date range to view the billing details
for that selected period.
Rebilling
The rebill feature enables you to regenerate a bill file for a specific day. It produces a file name
that is the day the data was rebilled (not the current date). You can configure the rebill file name
and where it is saved.
Ensure that the file generated during rebill is not processed by the standard external billing
system. This may create the risk of double billing.
• Rebill only works with “Billed” files. This does not apply to bill files created on the present
day. For example, the billed files must be created on, or before, the previous day.
• Rebill supports SBill formats 0, 6 and 7.
• All data is output to 1 file (format 0) or 2 files (format 6, 7).
Prerequisites
Before you use the rebill functionality, you must create a bill. Rebill only processes billed files.
The purpose of this task is to create a second billing output for a specific day. This feature is
useful if there were issues with the original bill on that day.
Introduction to notifications
The Avaya Notifications Subsystem program is an e-mail and short message service (SMS)
broadcast provider for the Conferencing system. The following types of e-mail, or SMS
broadcasts are currently available:
• Invitations to a booked conference
• Confirmations of a conference booking (sent to the moderator only)
• Reminders to participants of conference details (sent at a configurable time before the
conference start, for example, 15 minutes before the conference)
• Notifications to make conference moderators and conferees aware of any changes or
cancellations to bookings
• Lists of conference attendees after the conference has taken place (sent to the moderator
only)
The Notifications Subsystem runs on the CRS virtual machine and communicates with the
CRS by retrieving details of all notifications to be sent at given times. The requests are queued
until a resource line becomes available. The Notifications Subsystem is a back-end application
that should need little or no interaction with an operator.
Note:
The Standard Edition of Conferencing does not support SMS notifications. The Enterprise
Edition of Conferencing supports SMS notifications.
In previous editions of Conferencing, the Notifications Subsystem consisted of an application
with a graphic user interface (GUI). In the past, administrators used this GUI to configure many
aspects of the operation of notifications. In addition, in previous editions of Conferencing,
administrators also used a Template Editor application to customize e-mail templates. They
could also configure advanced settings in the Notifications Subsystem initialization file, called
broadcast.ini.
In the current edition of Conferencing, the Notification Subsystem is treated like a process or
a service. It runs in the background. Due to security settings in the Windows 2008 operating
system, which runs on the CRS virtual machine, administrators cannot access the Notification
Subsystem GUI while the BSMon is running.
The Booking and Scheduling Monitor (BSMon) is a watchdog. A watchdog is a software timer
that triggers a system reset or other corrective action if the main program enters a faulty state.
BSMon monitors each of the Conferencing applications, such as the Billing application, the
CDR Loader application, and so on. If any of the Conferencing applications fails and closes,
BSMon restarts them.
In the current edition of Conferencing, administrators can configure many aspects of the
operation of notifications using Conferencing Manager. The Notifications Subsystem settings
are located in Elements > Conferencing > Client Registration > General. Administrators
can also customize e-mail templates using a HTML editor.
For the majority of customers and deployments, the configuration of the settings in
Conferencing Manager and the configuration of the HTML template will be sufficient to ensure
that Notifications Subsystem operates as required.
Task Location
Configuring notifications In Conferencing Manager, using the Elements > Conferencing
settings > Client Registration > General menu.
Customizing e-mail On the CRS virtual machine, in the installation directory (typically
templates the C drive) /Avaya/BroadcastScheduler/Booking/email/
email1.html.
However, in exceptional cases, administrators may require access to the advanced settings in
broadcast.ini. If administrators need to make changes to the settings in broadcast.ini, they
must stop the BSMon monitoring of the Notification Subsystem before they save the change.
This is called the back door method.
Related topics:
Notification settings on page 208
Notification settings
The Notification Settings section contains all the configurable options for e-mail notifications.
Related topics:
Conference reminder X minutes before on page 208
Activate e-mail notifications on page 208
Activate attachments on page 209
Attachments directory on page 209
Activate attendance notifications on page 210
Web conferencing URL on page 210
Activate vcalendar on page 210
Activate SMTP on page 210
SMTP server address on page 210
SMTP server port on page 211
Activate attachments
The Activate Attachments parameter specifies whether moderators can send attachments with
conference invitations using the Web Portal application. To enable moderators to send
attachments in Web Portal, you must enable this parameter.
Using Web Portal, moderators can invite conferees to their conference using a number of
methods. The Activate Attachments parameter applies to situations whereby a moderator
invites conferees using the on-board Web Portal address book.
Attachments directory
The Attachments Directory parameter specifies a folder that the Notifications Subsystem
checks for files to send as attachments to conference invitations sent from Web Portal.
Using Web Portal, moderators can invite conferees to their conference using a number of
methods. If they invite conferees using the on-board Web Portal address book, they can add
attachments to the conference invitation.
The Notifications Subsystem is the application which provides e-mail and SMS broadcast
services for Conferencing.
When moderators, using Web Portal, attach a file to a conference invitation, the Web Portal
copies the file to a folder on the Conferencing application server. The Notifications Subsystem
checks this folder on the application server and attaches the file to the conference invitation.
This parameter specifies the folder on the application server that the Notifications Subsystem
checks for files. You must ensure that you configure a value on the Web Portal to ensure that the
Web Portal copies the file to the same folder. The two values must be consistent in order for
the feature to operate successfully. The Web Portal parameter is in webportal.properties and
is called AttachmentsFolder.
An issue arises because the Web Portal virtual machine uses the Linux operating system and
the CRS virtual machine uses the Windows operating system. The Notifications Subsystem
resides on the CRS virtual machine. The CRS virtual machine has difficulties reading the Linux
syntax for the folder location. As a result, you have to perform some manual configuration. On
the CRS virtual machine, you must map a new network drive for \\<Web Portal virtual machine
IP address>\attachments. Ensure that you select Reconnect at Login and set avaya as both
the username and password.
Related topics:
Configuring the attachment folder and security
compiles a list of registered conferees. The conference organizer can use the conferee list to
co-ordinate the conference with maximum efficiency and minimal delay at the start of the
conference. Typically, self registration is used for a type of secure broadcast known as an event
call. Event calls involve the transmission of often highly sensitive information to a group of
interested parties, such as investors.
Activate vcalendar
The Activate vCalendar parameter specifies whether Conferencing generates a vcalendar file
for each scheduled conference. If you enable the Activate vCalendar parameter, Conferencing
generates a vcalendar file and attaches it to conference invitation notification e-mails.
vCalendar is an industry standard format for exchanging scheduling and activity-recording
information electronically. If Conferencing sends a vCalendar attachment in an invitation e-
mail, participants can drag-and drop it (or otherwise move it) to a personal information manager
(PIM) type of application program and integrate with or relate it to their own schedule.
vCalendar was developed along with the vCard electronic business card specification.
Activate SMTP
The Activate SMTP parameter specifies whether Conferencing uses the Simple Mail Transfer
Protocol (SMTP) protocol for e-mail notifications.
Simple Mail Transfer Protocol (SMTP) is an Internet standard for electronic mail (e-mail)
transmission across Internet Protocol (IP) networks.
By default, the Activate SMTP parameter is not selected.
SMTP username
The SMTP Username parameter specifies a username that Conferencing uses to log in to the
e-mail server for all e-mail notifications. The e-mail server requires a username and a password
if Authenticate is selected. The Authenticate parameter adds a layer of security to the e-
mail communications.
SMTP password
The SMTP Password parameter specifies a password that Conferencing uses to log in to the
e-mail server for all e-mail notifications. The e-mail server requires a username and a password
if Authenticate is selected. The Authenticate parameter adds a layer of security to the e-
mail communications.
E-mail sender
The E-mail Sender parameter specifies the name or phrase that Conferencing enters in the
From field of the e-mail notifications that it sends. For example, if the E-mail Sender parameter
is conferencing@customername.com, participants receive e-mail notifications from this
e-mail address.
Related topics:
Ensuring that Conferencing notification e-mails are not classified as junk on page 480
Authenticate
The Authenticate parameter specifies whether Conferencing requires a username and a
password to log in to the e-mail server. The Authenticate parameter adds a layer of security
to the e-mail communications.
HTML format
The HTML Format parameter specifies whether Conferencing uses Hyper Text Markup
Language in the e-mails that it sends. If you do not select the HTML Format parameter,
Conferencing uses plain text in the e-mails that it sends.
Prerequisites
Before you configure the notifications subsystem, you must install Conferencing and open
Conferencing Manager.
The purpose of this task is to configure and customize the operation of e-mail notifications to
match the requirements of your deployment,.
Example
For example, enter the name of the customer in the EMail Sender field, such as
conferencing@companyname.com. Also, if your deployment includes an AWC virtual
machine, ensure that you enter the IP address of the AWC virtual machine in the Web
Conferencing URL field using this syntax: http://AWC virtual machine IP/
conferencing.
Next steps
Now you can configure the e-mail templates for your notifications.
Advanced settings
The majority of customers will never have to make any changes to the Notifications Subsystem
initialization file, broadcast.ini. A limited number of customers may wish to know the location
of the file and an explanation of the significant fields. The information for those customers is
provided here. If you need to make changes to the settings in broadcast.ini, you must stop the
BSMon monitoring of the Notification Subsystem before you save the change. This is called
the back door method.
The broadcast.ini file is located on the CRS virtual machine installation directory (typically the C
drive) /Windows/.
You can access the CRS virtual machine using the remote desktop feature. You can open
broadcast.ini using the Notepad application.
All the parameters in broadcast.ini have default values. If you need to make changes to these
values, you must break the connection between BSMon and the Notifications Subsystem. This
is called the back door method. After you complete the changes, you can restore the BSMon
monitoring of the Notifications Subsystem.
Parameter Description
FileName The name of the logging text file. The default is broadcast.log.
MaxFileSize The maximum size in kilobytes of the logging file. The default is 200KB.
WorkingDir Internal working directory and position of e-mail templates. The default is /
Avaya/BroadcastScheduler/Booking/Email.
DateFormat Sets the mask for all dates in e-mail output. The default is DD/MM/YYYY.
TimeFormat Sets the mask for all times in e-mail output. The default is TTT, which
corresponds to the AM/PM clock.
PollingDir Directory of raw report files by PC Reports. The default is /Avaya/PCReports/
Output.
Variable Description
RNUM Booking reservation number
CNUM Conference reference number
CNAME Conference name
CSTIME Conference start time
CETIME Conference end time
CSDATE Conference start date
CEDATE Conference end date
CMTIME Conference booking modified time
CMDATE Conference booking modified time
FTEXT Comment box/Free text
NAME Participant name
Prerequisites
Before you customize the e-mail templates, ensure that you configure the notification settings
in the Conferencing Manager.
The purpose of this task is to replace the text in the e-mail templates with new text. You can
also cut and paste the variables as necessary.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter the username administrator and the password Avaya123.
2. Navigate to the HTML file in the installation directory (typically the C drive) /Avaya/
BroadcastScheduler/Booking/email/email1.html.
You can open this file using any application that supports HTML editing. This single
template file contains all the text from each of the different types of e-mail
notification.
3. Customize the text as appropriate.
4. Save the file.
Next steps
Now it is a good idea to verify the notifications functionality by booking a test conference and
checking to see if Conferencing sends a notification.
Viewing logs
In previous versions of Conferencing, you could view the logs of the Notification Subsystem
using the Notification Subsystem GUI. In the current release, you must navigate to the log
directory in order to view the logs. If BSMon is running, the Notification Subsystem GUI is not
accessible.
Prerequisites
Before you view logs, ensure that Conferencing generates some notifications so that the log
files have meaningful content.
The purpose of this task is to view the recent activity on Notification Subsystem. This task is
useful for troubleshooting any issues.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
2. Navigate to the HTML file in the installation directory (typically the D drive) /Avaya/
BroadcastScheduler/Broadcast.log.
You can open this file using the Notepad application.
3. View the recent activity on Notification Subsystem.
Term Explanation
Passcode A passcode enables entry to a conference. There are two types of passcode:
conferee passcode and moderator passcode. A conferee passcode grants
access to conferee-level conference features. A moderator passcode grants
access to moderator-level conference features. In the Conferencing
applications, Passcode is often shorted to Code. In the wider Conferencing
environment, many people refer to passcodes as security codes, host codes,
conference codes, access codes, entry codes, and even PIN codes.
Passcodes are specific to conferences.
PIN code PIN code is an identification number that is unique to each participant (both
moderators and conferees). The name of the participant and their unique
identification number are stored in a PIN list. When operators using the CRS
Front End and moderators using the Web Portal, create a new participant, the
CRS generates a PIN code for each new participant. The CRS Front End
interface refers to this field as User PIN. The PINs and the name of the
participant are stored in a database table. If an operator, using the CRS Front
End or a moderator using the Web Portal books an unattended conference,
they can choose a PIN Mode in the Options dialog. If customers require
additional security for their conferences, they can book conferences that
require a conference passcode and the participant’s PIN code to access the
conference.
PIN codes are specific to individuals.
Second If an operator books a flex flow conference using the CRS Front End, they
level can enable Security Passcode at booking time. If the operator enables this
passcode feature, Conferencing plays a message such as "Would you like to associate a
second level passcode with this conference?" to moderators after they enter
their moderator passcode. moderators can then enter a code using DMTF.
Moderators are responsible for distributing this code to conferees. To
successfully access the conference once the moderator has registered the
Term Explanation
code, conferees require their conferee passcode and the Second Level
Passcode.
This feature is not available to moderators who book conferences using Web
Portal.
Secret PIN Secret PIN is a participant’s unique, self-managed, hidden number. Operators
and system administrators cannot see this number. System administrators
can reset this number, using the System Administration section of the CRS
Front End.
Each user knows their own number and can change their number if:
• They have access to the Web Portal.
• A system administrator resets the number using the CRS Front End.
If a system administrator resets the number, the CRS sends a notification to
the participant, which includes a link to a Web location where they can change
the number.
Employee Employee identifying number is also a participant’s unique, personal number.
identifying However, this number is generally widely known or accessible. An example
number is an employee’s human resources number.
Security For operators using CRS Front End and moderators using Web Portal, there is
checkbox a configuration option, which is available during conference booking. This
checkbox is called Security and is unrelated to passcodes, PIN codes, secret
PINs, and employee identifying numbers.
It is mentioned here to prevent any confusion.
The Security checkbox is only available if a moderator is selected for the
conference. When the Security checkbox is selected, the conference is
called a secured conference. In a secured conference, a moderator can
prevent anyone from listening to or joining the conference. Specifically,
operators cannot enter, record, scan, or listen to the conference. Moderators
must press *7 on their telephone keypads during the conference to activate
this feature. Moderators hear a tone or voice message to indicate that the
conference is secured or unsecured.
PIN functionality
At conference booking time, an operator using the CRS Front End or a moderator using the
Web Portal can specify a PIN Mode. The PIN Mode button is displayed in the Options dialog on
CRS Front End and within the Advanced tab on the Web Portal. The PIN mode options are:
• Off
• System
• Conference
Off
If an operator or moderator selects Off, Conferencing does not use PIN codes for the
conference reservation.
System
If an operator or moderator selects System, Conferencing grants conference access to a
participant if they enter the correct passcode and a PIN code which matches any entry in the
system’s PIN list, which is stored in a database table.
The CRS creates this PIN list automatically. When an operator adds new participants to a
Client’s address book or a moderator adds new participants to their own address book, the
CRS allocates a PIN to each new participant. Conferencing stores the PIN in a system-
generated PIN list.
Operators and moderators use System PIN mode when they need to identify attendees. Each
attendee has a unique PIN.
Conference
If an operator, using CRS Front End, selects Conference, Conferencing grants conference
access to a participant only if they have been invited to that particular conference. In other
words, it grants access if a participant enters the correct passcode and a PIN code which
matches any entry in that particular conference’s PIN list. The CRS automatically creates a
conference PIN list for each conference. The conference PIN list contains the PINs of
participants who have been specifically invited to that particular conference.
Operators do not have to enter the name of a PIN list in the PIN List field. Behind the scenes,
Conferencing uses this naming convention: cl_conference reference.txt. If the
conference reference is 123456, Conferencing automatically enters cl_123456.txt in the
PIN List field.
Similarly, if a moderator, using Web Portal, selects Conference, they do not need to enter the
name of a PIN list in the PIN List field. On the Web Portal, moderators cannot edit the PIN
List field. Conferencing automatically allocates the cl_conference reference.txt PIN
list to the conference.
Operators and moderators use Conference PIN mode when they need to add security to the
conference. This mode guarantees that the participants have been specifically invited.
Related topics:
PINs in use on page 339
PINs in use
PINs and conference types
PIN functionality varies depending on the type of conference that the operator or moderator is
booking.
Conference Functionality
Unattended For Unattended conferences, operators and moderators can choose
conferences Off, System, or Conference PIN mode.
Attended For Attended conferences, Conferencing disables PIN mode
conferences functionality.
Flex flow For flex flow conferences, operators and moderators can choose Off,
conferences System, or Conference PIN mode.
Self Registration If an operator using CRS Front End books a self registration
conferences conference, Conferencing disables the PIN mode options on the
interface. The PIN mode options are inaccessible to operators
because, for self registration conferences, Conferencing automatically
uses the Conference PIN mode. The CRS generates a subset of the
PIN List database table for each self registration conference. This
subset contains only the invited, or registered, participants.
Note:
In the Standard Edition of Conferencing, there is no support for self
registration.
It is important to note that if operators enable the Participant ID Mode option, Conferencing
ensures that the PIN Mode is set to Off. You cannot use both features in a single conference.
Off
If an operator or moderator selects Off, Conferencing disables the Participant ID Mode feature.
Identify
If an operator or moderator selects Identify, Conferencing ensures that all conference
participants must enter an identifying number on their telephone keypad prior to entering the
conference. In some cases, this number identifies an individual participant. In other cases, this
number identifies a participant as an external guest participant.
Identify & Validate
If an operator or moderator selects Identify & Validate, Conferencing ensures that all
conference participants must enter an identifying number and a PIN on their telephone keypad
prior to entering the conference. In some cases, this number identifies and validates an
individual participant. In other cases, this number identifies and validates a participant as an
external guest participant. CRS system administrators can reset PIN numbers on behalf of a
participant but operators cannot reset or change PIN numbers.
Related topics:
Secret PINs in use on page 341
Secret PIN administration on page 342
identifying number and a guest PIN number, which validates them as a guest. All guests use
the same numbers.
change their secret PIN to a value which they can easily remember. This is potentially a
regular task.
• You must customize the e-mail that participants receive when you reset their PIN. There is
a single e-mail for all companies in your CRS. You cannot customize the text on a per-
company basis. This is a task that you should only have to do when you install or upgrade
Conferencing.
• You must allocate values for the guest identifying number and guest secret PIN. This is
a task that you should only have to do when you install or upgrade Conferencing.
• You must configure the Web Portal settings, such as Mail server and Mail from using
Conferencing Manager by navigating to Elements > Conferencing > Web Applications
> Web Portal. This is a task that you should only have to do when you install or upgrade
Conferencing.
Related topics:
Configuring guest numbers on page 343
Configuring PIN Management Web site on page 344
Customizing e-mail on page 345
Resetting a secret PIN on page 347
The purpose of this task is to enable participants from outside of the company to enter a
conference that has been booked with the Identify or Identify and Validate Participant ID
Mode.
The External user participant identifier is the guest equivalent of the participant
identifying number. It is necessary when Participant ID Mode is Identify.
The External user participant PIN is the guest equivalent of the participant secret
PIN. It is necessary when Participant ID Mode is Identify and Validate.
7. Click Save.
8. If you wish to apply those updates to the Conferencing network, click Apply
Changes and then Apply Changes again.
When you apply changes, Conferencing restarts. It is a good idea to apply changes
only when you are finished all your configuration tasks.
Next steps
Now it is a good idea to verify the secret PIN functionality by booking a conference with the
Identify and Validate Participant ID Mode.
Prerequisites
Before you configure the PIN Management Web site, ensure that you install Conferencing and
configure the Web Portal and CRS virtual machines.
The purpose of this task is to configure the address of the PIN Management Web site. By
default, there may already be a value configured, but it is a good idea to verify the value before
deploying Conferencing in your network
Next steps
Now, you can customize the e-mail that participants receive when you reset their PIN.
Customizing e-mail
When you reset a secret PIN, Conferencing sends the participant an e-mail containing the PIN
Management Web site link.
In most cases, when Conferencing sends e-mails, it uses a mechanism called the Notifications
Subsystem. For example, Conferencing uses the Notifications Subsystem when it sends
conference reminder e-mails or conference cancellation e-mails. You can customize the
Notifications Subsystem e-mail templates using a HTML file on the CRS virtual machine.
For the reset secret PIN notification e-mail, Conferencing does not use the Notifications
Subsystem. You cannot customize the reset secret PIN notification e-mail using the CRS virtual
machine. You must customize the reset secret PIN notification e-mail using the Web Portal
virtual machine. The Web Portal virtual machine uses the Linux operating system. You cannot
use the remote desktop feature to access the Web Portal virtual machine. Instead, you must
use a terminal emulator, such as PuTTY.
Prerequisites
Before you customize the e-mail template that Conferencing sends when you reset a secret
PIN, ensure that you have a knowledge of the commands that the Linux operating system uses
and a knowledge of the VI text editor.
The purpose of this task is to customize the e-mail containing the PIN Management Web site
link that Conferencing sends when you reset a secret PIN. For example, you can add the
customer name to the default text.
There are many different PuTTY downloads listed. Typically, your deployment
requires the putty.exe file.
2. Start PuTTY.
3. On the PuTTY dialog, enter the hostname or IP address of the Web Portal virtual
machine.
4. Log in using the name craft and the password craft01.
5. Use the sroot command to change from craft to sroot access.
The sroot command is:
su sroot
The password is root01.
6. Navigate to the folder which contains the e-mail template by entering this command:
cd /opt/webapps/part-pin-webapp/customisations/default/
default/email/reset_pin_mail.tpl
7. Open the template in a text editor, such as vi.
vi is a modal text editor. The name vi is derived from the shortest unambiguous
abbreviation for the command visual in ex; the command in question switches the
line editor ex to visual mode.
The default text is as follows:
MX Conferencing Self Admin Pin Change Notification
Hello %Name%,
your new pin has been reset to %Pin% by a system
administrator.
regards,
The MX Conferencing Team
Please do not reply as this is not a monitored address.
The text between %% is replaced by live values. If a participant e-mail is empty,
Conferencing sends the e-mail to the client e-mail address. If the client e-mail
address is empty, Conferencing sends the e-mail to the client contact e-mail
address. If there is no client contact e-mail address, Conferencing does not reset
the secret PIN.
8. Save your changes.
You do not have to restart the Apache or Tomcat processes.
Example
For example, you could enter the customer's company name in the e-mail text.
Next steps
Now it is a good idea to verify the updates to the e-mail template by resetting a secret PIN and
viewing the text in the e-mail that Conferencing sends.
Prerequisites
Typically, you reset a secret PIN when a participant contacts you to tell you that they have
forgotten or lost their secret PIN.
The purpose of this task is to prompt the Conferencing server to send an e-mail notification
to a participant containing a Web site link to the PIN Management Web Site to enable the
participant to create new secret PIN.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
2. Open the CRS Front End and click the Customer Bookings button.
3. Navigate through the companies and clients to select the client you wish to modify.
4. Click Edit Client and select Participants.
5. On the Participants dialog, click Edit.
6. On the Edit Participants dialog, click Reset Secret PIN.
Passcode functionality
As a system administrator, you must configure a number of CRS parameters in order to
customize passcode functionality to suit your requirements. In previous releases of
Conferencing, system administrators configured these parameters using an initialization file
called bands.ini and a database table called the System Parameters table in the BSRes2
database. The bands.ini file and the BSRes2 database were on the CRS server. The bands.ini
is in the <installation directory>Avaya/CRS Front End and the BSRes2 database is accessible
using Microsoft SQL Server Management Studio™.
For the current release of Conferencing, the parameters are still accessible in these two
locations on the CRS virtual machine. However, you can now configure these parameters using
Conferencing Manager.
The fields relating to passcode functionality are located on the Conferencing Manager interface
Elements > Conferencing > Client Registration > General section.
Related topics:
Auto generated passcode length on page 199
Minimum passcode length on page 199
Maximum passcode length on page 199
Period to conference passcode renewal on page 200
Period of passcode overlap on page 202
Passcodes in use in the Web applications on page 351
The CRS automatically generates new pass codes for on-demand conferences if the owner
of the demand conference does not change their pass code within a configurable period of
time. The CRS directs the Notifications Subsystem to generate an e-mail notification to inform
the conference owner of their new pass codes. For a configurable period of time, the old pass
codes are still valid. This period gives the conference owner the time to adjust their conference
details. When the overlap period ends, the CRS directs the Notifications Subsystem to
generate an e-mail notification to inform the conference owner that their old pass codes are
no longer valid.
At Company level, operators can configure:
• The time period between automatic pass code refresh cycles.
Operators can modify this time period by entering a new value in the Renew Days field
in the New Company and Edit Company dialogs. The CRS Front End obtains the default
value for the Renew Days field from the Period to Conference Passcode Renewal
parameter in the Company table in the BSRes2 database. The Period to Conference
Passcode Renewal parameter has a range of 0 to 365.
• The time period for which the old pass codes are still valid.
Operators can modify this time period by entering a new value in the Overlap Days field in
the New Company and Edit Company dialogs. The CRS Front End obtains the default
value for this field from the Period of Passcode Overlap parameter in the Company table in
the BSRes2 database. The Period of Passcode Overlap parameter has a range of 0 to 30.
Note:
The CRS performs a check to ensure that the Period to Conference Passcode Renewal
parameter is less than the Period of Passcode Overlap parameter.
You can set the default value to display in the CRS Front End New Company and Edit
Company dialogs by setting the value of the Period of Passcode Overlap and Period to
Conference Passcode Renewal parameters in the Company table in the BSRes2 database.
The Conference table also contains two parameters that enable this functionality.
• PassCodeChangedDT stores the date and time that the pass codes were last changed.
• OverlapStartDT stores the date and time that the overlap period started.
In order for the overlap aspect of this feature to operate successfully, two demand conferences
co-exist:
• The old on-demand conference with the old pass codes.
• The new on-demand conference with the new pass codes.
These two conference co-exist for the duration of the Period of Passcode Overlap parameter.
Each night, the CRS runs a scheduled task called DoRenewPassCodes. DoRenewPassCodes
performs the following actions:
• Creates a new demand conference where:
PassCodeChangedDT + (Period to Conference Passcode Renewal - Period of Passcode
Overlap) < NOW()
• Generates an e-mail notification for each new demand conference.
• Removes or cancels all demand conferences where:
OverlapStartDT + Period of Passcode Overlap < NOW()
• Generates an e-mail notification for each removed demand conference.
When DoRenewPassCodes creates a new conference, it moves all participants to the new
conference. DoRenewPassCodes also moves the Import Utility identification (ImportID) to the
new conference. The new conference becomes the primary conference. If an operator changes
the old conference during the overlap period, the changes will not be reflected in the new
conference. DoRenewPassCodes only selects on-demand conferences that match the
following criteria:
• Type: Meet-me, unattended, or flex flow
• State: Confirmed, in-progress, completed, billed
The state of a conference influences how DoRenewPassCodes handles it once the overlap
period ends. DoRenewPassCodes removes billed conferences but cancels confirmed, in-
progress, and completed conferences.
You can investigate any problems that occur during the renewal process by examining the
RenewConferencesHistory table in BSRes2. The Conferencing Import Utility application does
not import the Period to Conference Passcode Renewal and Period of Passcode Overlap fields
when you instruct it to import a Company record. This means that imported companies do not
use the passcode expiry feature.
Passcodes are numeric. You can configure the length of passcodes using the CheckPINSize
parameter in webportal.properties.
If CheckPINSize=1, Conferencing validates the length of the passcodes using the value of
the CRS field, Auto Generated Passcode Length.
If CheckPINSize=0, Conferencing sends any length of passcode to the CRS. However, the
CRS database, BSRes2, may reject the value if it is too long for the database.
Avaya Web Conferencing and passcodes
To enter a data conference hosted by the Avaya Web Conferencing application, participants
must know their moderator or conferee passcode and the conference reference number. For
more information, see the Avaya Web Conferencing Quick Reference Guide, which is available
from support.avaya.com.
Summary
It is easy to get confused between all the terms relating to Conferencing security. There are
many terms and many configurable security features. It is important to be clear about the
various definitions.
A secure conference is a conference in which a moderator can prevent anyone from listening
to or joining the conference. This is also sometimes called a locked or secured conference.
Operators and moderators book a secure conference by selecting the Security checkbox at
booking time. The Security checkbox is only available if a moderator is selected for the
conference. In a secured conference, operators cannot enter, record, scan, or listen to the
conference. Moderators must press *7 on their telephone keypads during the conference to
activate this feature. Moderators hear a tone or voice message to indicate that the conference
is secured or unsecured.
A PIN mode conference is a conference in which participants must enter a PIN code and a
passcode in order to gain access. Operators and moderators book a PIN mode conference by
selecting the Conference or System PIN mode at booking time.
A participant ID identify conference is a conference in which participants must enter an
identifying number and a passcode in order to gain access. Operators and moderators book
a participant ID identify conference by selecting the Identify Participant ID mode at booking
time.
A participant ID identify and validate conference is a conference in which participants must
enter an identifying number, a secret PIN, and a passcode in order to gain access. Operators
and moderators book a participant ID identify and validate conference by selecting the Identify
& Validate Participant ID mode at booking time.
A second level passcode conference is a conference in which participants must enter two
passcodes in order to gain access. Moderators must distribute the second passcode to the
participants by e-mail prior to the conference start time. Operators and moderators book a
second level passcode conference by selecting the Security Passcode checkbox at booking
time. This only applies to flex flow conferences.
• You can check the list of clients in CRS Front End. Every user in your active directory
should have a client account. In addition, if you have configured the creation of an on-
demand conference for each new client, each of your clients should have their own on-
demand conference.
• You can also book a conference with a dial list that obtains the participants from your
active directory server.
Related topics:
DSCA parameters on page 356
User data retrieved on page 363
DSCA demand profile creation on page 364
DSCA and secure sockets layer on page 364
DSCA and Web Portal on page 365
DSCA parameters
This table lists the DSCA parameters. You must configure these parameters to match your
deployment. For example, you must enter the full path name and file name for the CRS SSL
certificate file in the SSLCertificate parameter.
Parameter Description
DirectoryServerHost The IP address of the directory server.
DirectoryServerLdapPort The port number (the default value is 389).
UseSSL Specifies whether SSL is in use.
SSL not in use: UseSSL=0
SSL in use: UseSSL=1
The default value is 0.
DirectoryServerLdapSSLPort The SSL port number (the default value is 636).
SSLCertificate Enter the full path name and file name for the SSL
certificate file.
SSLEncodingFileType Enter the SSL encoding file type
For B64: SSLEncodingFileType=1
For DER: SSLEncodingFileType=2
The default value is 2.
SSLKeystore You only have to configure this parameter if you are using
the Web Portal application in your deployment.
Enter the full path name and file name for the SSL
keystore file.
LoginDN Enter the account name that you created on the directory
server for the DSCA.
Parameter Description
For example, cn=CRSAdmin, cn=Users, dc=DSServer,
dc=com.
The DSCA application does not validate this LoginDN. It
just passes it to the directory server.
Password Enter the password for the LoginDN account.
DirectorySearchBase Enter the search location on the customer directory
server.
For example, - ou=department, dc=DSServer1, dc=com,
cn=users, dc=DSServer1, dc=com.
DirectoryUserSchema Enter the user schema. For example, user.
<USERSCHEMA> in the profile will be replaced with the
value of DirectoryUserSchema. The default is user.
DirectorySearchPath Enter the search path from which the users in directory
server will be retrieved by the DSCA application.
DirectoryContext The DSCA uses this parameter to create a default
company name. If there is no value in this parameter, the
DSCA uses the phrase LDAP as the company name.
If your Conferencing deployment includes the Web Portal
application, the Web Portal uses this parameter to
establish a connection to the directory server.
DirectoryBindFormat This parameter relates to the Web Portal application. An
example is <user>@<context>
SecurityPrincipal This parameter relates to the Web Portal application.
SecurityCredentials This parameter relates to the Web Portal application.
DirectoryBindMethod This parameter relates to the Web Portal application.
An example is simple or DIGEST-MD5
CurrentUserFilterFormat This parameter relates to the Web Portal application. An
example is UserPrincipalName=<user>@<context>
CreateDefaultDemandProfile f you set this parameter to true, the DSCA will create an
on-demand profile when it creates a new client account.
The default is CreateDefaultDemandProfile=1.
D.S. N/W timeout (secs) This parameter relates to the DSCA timeout in seconds.
The default is D.S. N/W timeout (secs)=15.
SPCondition1 This is an optional condition that you can use to restrict
the entries that the search returns.
Comment This is a free text field for profile information.
DirectoryServerType This indicates the type of directory server.
For a generic directory server: DirectoryServerType=0
For an active directory server: DirectoryServerType=1
Parameter Description
Alternative_DN Normally, the client account in the CRS database
(BSRes2) stores the DN from the directory server. You
can use this parameter to store other information that is
more static to that client.
Client Parameters Map the user entries on the directory server with these
fields on the DSCA. For example:
CLIENT_NAME: cn
CLIENT_MAIN_PHONE: telephoneNumber
CLIENT_MAIN_FAX: facsimileTelephoneNumber
CLIENT_EMAIL: mail
CONTACT_NAME: cn
CONATCT_PHONE: telephoneNumber
CONTACT_FAX: facsimileTelephoneNumber
CONTACT_EMAIL: mail
SECONDARY_CONTACT_PHONE: otherTelephone
MOBILE_CONTACT_PHONE: mobile
IMPORTID: initials
Participant Parameters You must configure these values if your Meeting
Exchange deployment includes the Web Portal
application. For example:
PARTICIPANT_NAME cn
PARTICIPANT_DEF_CONTACT_PHONE:
telephoneNumber
PARTICIPANT_DEF_CONTACT_EMAIL: mail
Search Attributes You must configure these values if your Meeting
Exchange deployment includes the Web Portal
application. For example:
SEARCH_NAME: cn
SEARCH_EMAIL: mail
SEARCH_PHONE: telephoneNumber, homePhone,
mobile
Company This is an optional parameter that the DSCA uses to
create a company. If you would like to place the clients
into different companies, for example, based on their
department, you should map this parameter to the
parameter in the directory server that identifies the
client’s department.
ExternalString This is an optional parameter. The DSCA uses it to import
external data into the client’s ClientExternalString field.
EmployeeUID This is an optional parameter and is used for Participant
ID Mode. The DSCA uses it to import external data into
the client’s participant’s EmployeeID field.
UserAccountControl This parameter identifies the user account control details
for the directory server. For example:
UserAccountControl: UserAccountControl
Parameter Description
DisableMask This value, when used with UserAccountControl, will
result in the disabled status of the account. In a non-
Windows directory server environment, you should set
this value to 0.
Setting for Demand Profile Conference Size: Specifies the conference size
Recording On: Indicates whether recording is on or off.
Note:
Recording has to be set to 0 in order to create demand
conferences. Otherwise conferences are not created
and following message is displayed in DSCA logs:
"There are no recording DDIs for this language type
and cabinet combination in the system".
Data On: Indicates the date. The possible values are 1/0.
Entry Tone On: Indicates the type of entry tone. The
possible values are:
System=1
Tone=2
Message=3
Both=4
Leaving Tone On: Indicates the type of leaving tone. The
possible values are:
System=1
Tone=2
Message=3
Both=4
Notification Type: The possible values are:
0 (None)
2 (Email)
4 (SMS)
6 (Email and SMS)
Confirmation Ntf: Indicates whether the Confirmation
Notification is on or off. The possible values are 1/0.
Attendance Ntf: Indicates whether the Attendance
Notification is on or off. The possible values are 1/0.
Disable Non DS Clients When set to 1, the DSCA will disable all CRS clients for
a specific company <DirectoryContext> that were not
returned by the directory server search.
DirectoryPhoneNumbersFiltered When this parameter is enabled, the DSCA removes any
non-numeric characters from the telephone number
fields. Valid characters are '0123456789 +-'.
Disable_On_No_Mand_On When set to 1, the DSCA will disable a user if it their
profile is missing the mandatory fields: ClientName and
ClientPhone.
BinaryAttributes This parameter relates to the Web Portal application.
Parameter Description
By default, the DSCA assumes that attributes are in
ASCII format. On the directory server, some attributes
are in binary format.
ProcessIntervaltype This setting along with ProcessIntervalValue will
determine how often synchronization the process is run.
These values represent each type of time slot:
0: Seconds
1: Minutes
2: Hours
3: Days (Default)
ProcessIntervalValue This setting along with ProcessIntervaltype will
determine how often synchronization the process is run.
For example, to run the process every 30 minutes:
ProcessIntervaltype:1
ProcessIntervalValue:30
For example, to run the process once a day:
ProcessIntervaltype:3
ProcessIntervalValue:1
Last Process Date Time This parameter stores last process date/time .
Use_Config_Date_Time When set to 1, the next process will read the Last
Process Date Time from the configuration file instead of
using the Last process date time from the database.
CRSClientPwd This setting is not in the Configuration dialog. It is in the
Options section of the profile.
Use it to enter a default password when a single sign on
password is required. The client should then change their
password when they first log in. For example:
CRSClientPwd=avaya123
Ensure that the UniquePasswordInd field in the system
parameters table is set to 0.
Secure_Conf_Mode This setting is not in the Configuration dialog. It is in the
Options section of the profile.
If secure conferencing is set to off:
Secure_Conf_Mode=0
If secure conferencing is set to identify:
Secure_Conf_Mode=1
If secure conferencing is set to identify and validate:
Secure_Conf_Mode=2
RunOnStartup This setting is not in the Configuration dialog. It is in the
Options section of the profile.
When RunOnStartup=1, the DSCA sets the process
state to running, by default, and the process will
automatically start.
Parameter Description
When RunOnStartup=1, the DSCA sets the process
state to stopped, by default, and you will have to
manually start the process.
If your Conferencing deployment includes the BSMon
monitoring application, you should set RunOnStartup=1.
DSStatus This is a feature for non-Windows active directory
servers. It disables the client sychronization associated
with an LDAP attribute. For example:
DSStatus=dsStatus
DSDisabledList This is used with DSStatus. It lists the strings associated
with an inactive user. For example:
DSDisabledList=0, false, inaactive, disabled
It is important to note that in oder to switch from the
original active directory method (UserAccountControl
and DisabledMask=2), you must set the
DisabledMask=0 to enable the DSStatus feature.
Related topics:
Login type on page 249
Login type on page 249
Editing parameters on page 361
DSCA and Web Portal on page 365
Single sign on on page 445
Editing parameters
In previous editions of Conferencing, the DSCA consisted of an application with a graphic user
interface (GUI). In the past, administrators used this GUI to configure many aspects of the
operation of the DSCA.
In the current edition of Conferencing, the DSCA is treated like a process or a service. It runs in
the background. Due to security settings in the Windows 2008 operating system, which runs
on the CRS virtual machine, administrators cannot access the DSCA GUI while the BSMon is
running.
The Booking and Scheduling Monitor (BSMon) is a watchdog. A watchdog is a software timer
that triggers a system reset or other corrective action if the main program enters a faulty state.
BSMon monitors each of the Conferencing applications, such as the Billing application, the
CDR Loader application, and so on. If any of the Conferencing applications fails and closes,
BSMon restarts them.
If you require access to the DSCA application, you must:
• Stop the BSMon monitoring of the DSCA.
• Stop the DSCA task using the Task Manager.
• Access the DSCA application and perform the tasks that you require.
• Restart BSMon when you are finished.
To configure the DSCA parameters for your deployment, you can either access the DSCA GUI
as described here or you can edit the DSCA.pfl file using an editor such as the Notepad
application.
Prerequisites
Before you configure the DSCA parameters, you must have an active directory installed and
configured in your network.
The purpose of this task is to configure the LDAP settings to match the settings in your
deployment.
Manager applies this setting, return to the Login Type menu select the
Directory server: User, password, content option and apply this setting. By
freshly selecting the Directory server: User, password, content option, you
prompt the DSCA to resend the DSCA parameters to the Web Portal virtual
machine.
Related topics:
Synchronizing DSCA parameters with Web Portal on page 365
To permit brackets as acceptable characters in the Phone Number field, update the Phone
Number Format Type field to 1. You can access the Phone Number Format Type field using
Conferencing Manager by navigating to Elements > Conferencing > Client Registration >
General menu. The default value of the Phone Number Format Type field is 0. When Phone
Number Format Type is 0, brackets are rejected.
• An example of a phone number with brackets: (353) 895623
• An example of a phone number without brackets: 353 8598623
The DSCA has configurable mappings for CRS fields to LDAP attributes, as attributes are not
standard across LDAP schemas. LDAP attributes to query for name, phone number, and e-
mail searches are set in the DSCA properties file. This file is in the same format as the Web
Portal LDAP. It may possibly be shared out to the Web Portal LDAP, to minimize configuration.
The LDAP search filter used to retrieve user data is “objectclass=<user account schema>”.
For example, the default schema for active directory is ‘user’, so that the LDAP search filter is
“objectclass=user”. The user account schema name is a configurable option for DSCA.
Communication with the LDAP server is done using an LDAP Client API. Communication to
the CRS database is done using the ODBC API, callling the standard Booking and Scheduling
database stored procedures.
Related topics:
Login type on page 249
DSCA parameters on page 356
Synchronizing DSCA parameters with Web Portal on page 365
Prerequisites
Before you synchronize the DSCA parameters with the Web Portal, you must configure the
DSCA parameters.
The purpose of this task is to ensure the DSCA parameters on the CRS virtual machine are
consistent with the LDAP parameters on the Web Portal virtual machine.
• The first time you select the Directory server: User, password, content option on the
Conferencing Manager menu: Elements > Conferencing > Web Applications, the
DSCA pushes the LDAP parameters to the Web Portal.
• If you make any changes to the DSCA profiles at any point, you must re-initiate this
DSCA push. You can do this as follows:
a. Log in to Conferencing Manager.
By default, the username is admin and the password is admin123.
b. Navigate to Elements > Conferencing > Web Applications.
Conferencing Manager may display the IP address of the available Web Portal
virtual machine.
c. Select the Web Portal virtual machine if necessary.
d. Click Configure.
On the interface, the Directory server: User, password, content option should
already be selected from the Login Type menu.
e. Select the E-mail address and password option from the Login Type menu.
f. Click Save.
g. Click Apply Changes and then Apply Changes again.
h. Navigate back to the Login Type menu and select the Directory server: User,
password, content option
i. Click Save.
j. Click Apply Changes and then Apply Changes again.
The DCSA pushes the newly updated LDAP parameters to the Web Portal.
Related topics:
Editing parameters on page 361
Prerequisites
Before you configure LDAP Conferencing integration in your organization, you must have an
active directory installed and configured in your network.
The purpose of this step is to obtain a certificate from an active directory server.
Example
This example shows the steps for the Microsoft active directory. Conferencing also supports
the Sun Java directory server.
Next steps
Now, you can install the certificate and enter the full name and address in the DSCA
configuration setting, SSLCertificate.
Prerequisites
Before you install the certificate for CRS, you must have an active directory installed and
configured in your network. Also, before you install the certificate on the CRS virtual machine,
you must first obtain a certificate from the active directory server. The process of obtaining a
certificate is called exporting the certificate.
The purpose of this task is to make the DSCA aware of the SSL certificate on the CRS virtual
machine.
Next steps
Now you can obtain or export a certificate for Web Portal clients. Alternatively, you can book
a conference using the CRS Front End. You can select the LDAP dial list option for the
conference to see if your active directory list is displayed in the participant selection dialog.
Prerequisites
Before you configure LDAP Conferencing integration in your organization, you must have an
active directory installed and configured in your network.
The purpose of this step is to obtain a certificate from an active directory server.
You can obtain a certificate from the certification authority. However, the easiest way is to
copy the file that the certification authority creates. The file is in the root directory of the
drive in which you installed the certification authority. For example, C:
\dueng04test.punch.home_shark.crt on the active directory server.
The purpose of this task is to make the DSCA aware of the SSL certificate on the Web Portal
virtual machine.
1. Copy the SSL certificate to the /home/craft directory on the Web Portal virtual
machine.
You can use the WinSCP application to access the Web Portal virtual machine (and
copy the file. You can download WinSCP from http://winscp.net/eng/
download.php. WinSCP is an application which enables you to securely copy files
over a network.
2. Download PuTTY from http://www.chiark.greenend.org.uk/~sgtatham/putty/
download.html.
3. Start PuTTY.
4. On the PuTTY dialog, enter the IP address of the Web Portal virtual machine and
click Open.
5. Log in using the name craft and the password craft01.
The Web Portal virtual machine should respond with a prompt.
6. Use the sroot command to change from craft to sroot access.
The sroot command is:
su sroot
The password is root01.
In this example, import is the operation and test is the name or alias.
8. Follow the commands to enter a password.
The default password is changeit.
The keystore.jks is generated in /home/sroot.
Example
You can run a number of other commands on the certificate, such as:
/opt/Avaya/bin/javaCerts.sh list test
/opt/Avaya/bin/javaCerts.sh export test export.crt
/opt/Avaya/bin/javaCerts.sh delete test
To delete the certificate from the java key store, you must run this last command on the Web
Portal virtual machine and enter the same password as before (changeit).
Next steps
Now, you can verify your LDAP and Web Portal integration by selecting the Directory server:
User, password, content option from the Login Type field in the Conferencing Manager
menu: Elements > Conferencing > Web Applications. The Directory server: User,
password, content option was called Login Type 9 in previous releases of Conferencing.
If the LDAP and Web Portal integration is successful, communications between the LDAP
server and the Web Portal server are encrypted.
To encrypt communications between the Web Portal server and Web Portal client browsers,
you must enable SSL in the Conferencing Manager menu: Elements > Conferencing > Web
Applications. You must also configure two other fields on the Conferencing Manager called
SSL Certificate and SSL Private Key. This form of encryption uses the Apache HTTPD
method.
The purpose of this task is to configure a number of settings in relation to blast dial functionality.
These settings apply to both LDAP dial lists and dial lists saved on the application server.
Next steps
Now you can configure the CRS virtual machine to enable the blast dial feature for LDAP dial
lists or configure the application server for dial lists.
Related topics:
Dial out on page 137
Blast dial settings on page 138
Related topics:
Configuration of CRS for LDAP on page 373
Related topics:
Configuring the CRS virtual machine for LDAP on page 373
To configure the CRS virtual machine for LDAP, you must enter values in a CRS database
table called LDAPConfig. The values in this table then populate two stored procedures called
LDAPSearch and LDAPWrite700DialList.
Prerequisites
Before you configure the CRS virtual machine for blast dial and LDAP support, it is a good idea
to configure the blast dial settings.
The purpose of this task is to configure the CRS for LDAP dial list support.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
2. Open Microsoft SQL Server Management Studio.
3. Using Microsoft SQL Server Management Studio, navigate to LDAPConfig table in
the BSRes2 database.
4. Enter values in the LDAPConfig parameters.
Example
Here is an example configuration:
Enabled= 1
Host= 'localhost'
Port= '389'
LoginDN= 'cn=Directory Manager'
LoginPassword= 'administrator'
TimeoutSeconds= '30'
Base= 'o=ExampleCompany'
ObjectGroup= 'ecmailgroup'
ObjectPerson= 'ecperson'
In the example, the CRS connects to the LDAP server on IP address localhost (127.0.0.1),
port 389, using the login cn=Directory Manager and the password administrator. It
allows 30 seconds for LDAP queries to succeed against that server.
Port 389 is the default LDAP port.
When operators select the LDAP Dial List feature, the CRS connects to the LDAP server
and starts a search at the LDAP location o=ExampleCompany. It searches below that object
for any objects of the type ecmailgroup. It presents the groups found to the CRS Front
End user in the LDAP Group Search dialog.
When the CRS user selects an LDAP group as their dial list, the group members (ecperson
in this example) are located and are written to a dial list file for this conference. This file
resides in the file directory \temp\diallist. This file directory should be accessible to the
bridge. During the conference, when the moderator invokes the blast dial command using
their DTMF keys, the application server, or bridge dials out to all members listed in the dial
list file for this conference.
o represents an organization. ecmailgroup represents Example Company Mail Group.
Next steps
Now it is a good idea to test the blast dial feature by booking a conference and selecting an
LDAP list on the Options dialog in CRS Front End.
Related topics:
Configuring the CRS for application server dial lists on page 376
Prerequisites
Before you configure the CRS for blast dial, you must install Conferencing and configure the
virtual machines in the Conferencing network.
The purpose of this task is to configure the CRS to handle blast dial lists that are saved in a
directory on the application server. These saved dial lists can be manually created by a system
administrator or automatically created by Conferencing.
Next steps
Once the scheduled job is up and running, it is a good idea to test the blast dial feature by
booking a conference with a moderator and some participants and selecting a Blast Mode on
the CRS Front End Options dialog. Dial into the conference and press *92 on your telephone
keypad to dial the telephone numbers on the participant list.
When you leave the Dial List field blank at booking time, the CRS automatically populates the
field when you confirm the conference. The CRS automatically creates a dial list that contains
the invited participants and saves it to the C:avaya\diallist directory. The scheduled job
transfers the file to the /usr/dcb/dbase/diallists directory, where the Conferencing
server can access it.
The purpose of this task is to verify that the LDAP blast dial function operates successfully.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
Preparation of data
Before you import companies, clients, and conferences, you must ensure that your data files
conform to a number of requirements. These design considerations and field conventions are
described here. For more information, contact your Avaya Support Representative.
Related topics:
Database compatibility on page 381
Input files on page 381
Orphan clients on page 382
The logging file on page 382
Attribute fields on page 383
Field types on page 384
Existing records on page 385
Significant fields on page 385
The CRS Front End and duplication of content on page 386
Demand conference profiles on page 388
Database compatibility
Ensure that the target BSRes2 database installed. This is the database on the CRS virtual
machine which holds all the company, client, and conference information.
Input files
Database content comes in the form of input files. These are typically .csv file which can be
opened using Notepad. These must conform to a file format that can be processed by the
Import Utility.
An ini file controls the execution of the import process. While the import wizard defines most
of the importable items, other more general items are only editable within the ini file itself.
The main considerations for constructing the input files include:
• Input files must match the field sequence as specified in the wizard
• Files must be in the location specified in the wizard
• Company & client files must be placed in the same directory
• Company & client files must have different names
Once the input files have been processed (either successful or error notified) by the utility, they
are moved to a back-up directory called Processed. This directory contains each *.bak files
processed. Subsequent iterations of the utility should use new input files.
Orphan clients
The design of the utility supports the import of companies independent from clients at the same
time. However, company content has to be imported before client/demand profiles.
All clients/demand profiles must be assigned to a company.
Any information about client/demand profiles missing a link to a company will not be processed.
Details about such clients can be located in the import log file which records all import errors.
...then log errors and warnings will be captured in the log file.
For normal successful processing, the utility can be configured to write such details to the
logging file. Within the ini file, the various configuration items regarding logging are defined.
Directly below are the default log settings, along with explanations for each:
[LogSettings]
MaxLogLines=2000
MaxLogFiles=62
LogSize=100
LogLevel=3
LogDir=c:\Avaya\import
Parameter Description
MaxLogLines This value defines the number of lines in each log file. When this limit is
reached, a new log file is created.
MaxLogFiles This value defines the number of log files that are stored at any time. When
this limit is reached, the oldest log file is deleted.
LogSize Maximum log file size (Kbytes) On reaching this size, the log will start to
rewrite, and the oldest information will be overwritten. [Default = 100KB]
LogLevel Define the level of detail to retain. [Default = 3]
0=No logging active
1=Log errors only
2=Log errors & warnings
3=Log all records – successful or otherwise
LogDir Define the directory location where the log file will be captured.
Attribute fields
The utility is based upon the handling of attribute fields to define the particular item (company,
client or demand profile). These fields are incorporated together by the utility to control how
relevant parameter values are submitted to the Conferencing database.
These fields match the relevant attributes currently supported by the Avaya database system
(irrespective of any import capability). Any fields not defined cannot be stored on the database,
and require database alterations.
• Key fields
• Name fields
• "Skip" fields
Key fields
A basic principle of relational databases is that every row of every table must be uniquely
identified. The attribute field (or combination of attribute fields) that ensures this uniqueness
is called the Key field.
The Import Utility supports the use of two keys giving rise to a composite key field.
Every record type within each input file must have a key field defined for that particular file.
The values of the key field will be placed in the ‘Import_ID’ field within either the company and
client tables, depending on the transaction.
The utility supports two methods of populating the key field:
• Within the wizard, include the ‘Import_ID’ field as one of the required field sequences for
the file input.
• Alternatively, a field can be designated as ‘Key’ within the wizard. In this case, the actual
field (for example the ‘Company_Name’ field will actually be inserted into the database
twice. Once to its original intended attribute (“Company_Name”) and secondly to the
‘Import_ID’ field.
Name fields
The wizard supports two methods of populating name fields within the input data files:
• The name field is populated by a single entry in the input file e.g. “Frank Jones”.
• The name field is populated by two separate entries in the file e.g. “Frank”, “Jones”.
The generic term Name fields covers company contact name; client name; client contact name.
Skip fields
When importing data from an external database, irrelevant fields can often be included. To filter
these out during import, you must identify the “Skip” field as an importable field. Each unwanted
field must be reflected in the Import Utility by a corresponding “Skip” field. To do this continue to
add successive "Skip" fields into the Import Fields section until an account has been made
of all fields.
Field types
The following field type values are supported:
Field Description
String Variable length single byte character string
Numeric 0|1|2|3|4|5|6|7|8|9
Boolean 0|1
The Import Utility only recognizes the following phone/fax numbers 0|1|2|3|4|5|6|7|8|9|,|-|+
Comma (,) denotes extension numbers. These will be placed to the right of the comma. Any
field that includes a comma must be closed using quotation marks.
For example: “1234567,987”. This will be interpreted as extension 987 of main number
1234567.
Within the wizard (general configuration screen), you can select predefined characters to be
stripped and removed from each input. Selecting this option results in the following characters
being removed at import:
Existing records
In addition to supporting the migration of database content into the Conferencing database,
the Import Utility can also be used to make changes to existing company/client/demand
profiles.
When importing modified data, it is important that all existing data is included. If a field is
missing from the imported content, the corresponding field in the existing table will be deleted.
This is illustrated here:
The company file ready for import includes the following entry:
[Avaya,London,””, S012]
Existing database content is overwritten by the new entry. The company table within the
database now includes this entry:
Significant fields
When you select fields for importing, a key field must be defined for both company and client
& demand profiles. If the Import ID field is included, it defaults as the Key field.
• Company
• Client
Company
For company-related input files, the following fields also have particular significance:
• Company Name (this must be unique to the system database)
• Company Phone
If the Company does not include a company name, but has a valid company ID, the utility will
generate a unique company name and also return a warning to the user. If the input file does not
contain a company phone, the utility will insert dummy values of 123 for all such cases.
Client
For Client-related input files, the following fields also have particular significance:
• Client Name (this must be unique within the parent company)
• Client Phone
If the client does not include a client name, but has a valid client ID, the utility will generate a
unique client name and also return a warning to the user. If the input file does not contain a
client phone, the utility will insert dummy values of 123 for all such cases.
Related topics:
Conflicting duplicate entries on page 386
Unique company and client names on page 387
Truncation of company and client names on page 387
After import, this table shows how this data is displayed in the Conferencing database.
Duplicate details are included in the generated import log file as a ‘warning’.
Only 9 duplicate entries are supported. A tenth entry will be rejected with error details written
to the log file.
Other scenarios could result in unintentional duplicated companies, and so on.
Related topics:
Passcode generation on page 388
Multiple profile indicator on page 388
Provision of default values on page 389
Demand profile output reports on page 389
Passcode generation
With respect to pass code generation, there are a number of methods supported:
• AutoGen passcodes - An operator provides personal details for the profiles. However,
Conferencing is responsible for generating unique passcodes used to access the
conference at any time. Conferencing provides two passcodes, the ModeratorPIN and
the ParticipantPIN.
• Supplied passcodes - Where passcodes are predefined, appropriate fields must be
created to ensure successful import.
If an imported supplied passcode number already exists in the system, the new profile is not
created and details are captured in the log file.
Parameter Description
MP=0 One profile only, new details overwrite
existing profile [default]
MP=1 Allows multiple profiles
MP>1 Invalid value. The default value is returned.
It is not possible to edit individual profiles if multiple profiles are defined. To do so you must
use the CRS Front End to manually alter certain attributes.
If only one demand profile is supported, then use the Import Utility to edit attributes (including
passcodes) assuming the attribute is not the key field.
In the ini file, these fields are controlled by the following configuration entry:
ReportSequence=76,102,301,338,339
This can be configured to import a different combination of fields. Field types are denoted by
number which the Avaya database already recognizes. For example, 76 = Company Name.
The BSImport.ini file includes a section called Demand Report. As well as the above entry
the following details are included:
[DemandReport]
ReportSequence=76,102,301,338,339
ReportName=DemandReport.txt
ReportDays=7
Parameter Description
ReportSequence This enables you to define the fields that will be imported and the
sequence they will appear in the demand report.
ReportName This enables you to enter the name of the input file that includes the data
to be imported. This file must be present in the same location as other
input files. For example: c:\Avaya\import
ReportDays This enables you to enter the number of days prior to import that the
utility should consider when including demand profiles.
The Import Utility is presented as a wizard. The wizard enables you to exploit the full capability
and options supported, without causing the database any problems. Using the Import Utility
wizard, you can:
• Configure the import to suit your company needs
• Schedule an import
• Start an import immediately
• View the import log file
• View the demand profile report
The Import Utility wizard is accessible on your CRS virtual machine. It is a good idea to place a
shortcut icon on your desktop so that you can conveniently start the wizard.
Within the Avaya Import Utility screen, two view panels and a number of graphic icons are
displayed.
• Import Data - This provides details about company/client data that will be imported. This
view-only information is based on the previous import configuration and can be changed
using the configuration wizard.
• Import Schedule - This provides details about the daily import schedule provided it has
been set in the import configuration screen. Also included is an Import Now button.
Here is a list of the icons on the interface.
View Log View all details about the previous import procedure.
Exit Import Utility Exit the Import Utility. This will be disabled during
import.
Note:
Avaya recommends that you do not execute the Import Utility at peak traffic times.
Related topics:
Import Utility fields on page 392
Field Description
Import Companies Select this option to inform the Import Utility that company fields
have to be imported into the Conferencing system database. When
it is selected, the Company File name field is enabled.
Import Clients Select this option to inform the Import Utility that client fields have
to be imported into the Conferencing system database. When it is
selected the Client File name and Client Options panel are enabled.
To import demand profile information for each client, the Import
Demand Profiles option must also be selected.
Import Demand The client file can be configured to contain details for conference
Profiles on demand clients or reservation based clients, but not both at the
same time.
Import Path Enter the current directory location for the data file(s) needed for
import. If you are importing more than one input file, they must be
located in the same directory (e.g. c:\Avaya\import).
Company Filename Enter the company file name as it already exists.
Client File name Enter the client file name as it already exists.
Field Separator Within the files, a particular character will separate the individual
fields; the character used should be defined here (separator must
apply to all input files per import sequence).
Field Description
Default null boolean to When this function is enabled any missing boolean data is
false defaulted to false (boolean value=0). This function prevents import
failure due to missing boolean data.
Remove invalid Certain characters displayed in the input file not compatible with
characters (‘‘ <> ` & ’) the Conferencing database can be controlled from here.
Fail on bad data If you select this option, the import process ignores and skips any
bad entry. It moves on to the next entry and continues the import.
Names as a single The Conferencing database recognizes names as a single field.
field First Name and This option is selected by default in the Name Fields panel.
Last Name fields However if the original name fields have two parts (first and last
name) you need to select the First Name and Last Name fields
option. This will result in the two constituent fields being merged
into one field during import.
Disable all client’s not This option when selected will restrict use of the Conferencing
in import file system to only those specified in the data input file.
Note:
The client fields are
only enabled when
you select the
Import Clients
option.
Deny Updating of This option, when selected, will not allow the updating of existing
Existing clients clients.
Scheduling Enables you to define when the Import Utility should execute
(single or daily). You can also initiate the import immediately.
Profile Enables you to create a new client profile. This assists you to save
particular requirements by their name.
Having entered the appropriate information, click Next to proceed and define the field
sequences. These will correspond to input files named in this screen.
• If you select Import Companies, the Import Utility displays the Company Fields.
• If you only select Import Clients, the Import Utility displays the Clients Fields/Client and
Demand Profiles screen
The process for selecting each of the company, client/client and demand profile fields for import
is almost the same.
Related topics:
Selecting fields on page 394
Configuring on demand profiles on page 395
Finishing the import on page 398
Selecting fields
Prerequisites
Before you select fields on the Import Utility, you must install and configure the CRS virtual
machine.
The purpose of this task is to select the pieces of data that you would like to import to the
Conferencing BSRes2 database. The BSRes2 database resides on the CRS virtual machine
and holds all the company, client, and conference data.
Next steps
Now you can configure on-demand profiles. This feature of the Import Utility enables you to
create an on-demand conference for each new moderator that you create as you import them to
the BSRes2 database.
Prerequisites
Before you configure fields on the Import Utility, you must install and configure the CRS virtual
machine.
The purpose of this task is to customize the exact properties of the on-demand conferences
that Import Utility will create for each new moderator.
Field Description
Exit Tone Type You can switch tones on or off. The following options are
available:
• Off: The feature is not active.
• System: The Conferencing server uses a pre-
configured default setting.
• Tone: The Conferencing server sounds a tone.
• Message: The Conferencing server plays a voice
message.
• Both: The Conferencing server sounds a tone and play a
voice message.
Music Source You can set the location of the source file for the music that
is played when a Conferee is on hold.
Prompt Set You can set a default language for audio messages.
NRP Mode If you enable Name Record Playback (NRP), the
Conferencing server prompts all participants to call out their
name before they enter the conference. Moderators can
then play a audio roll call of attendees. There are number
of possible values:
• Off: The Name Record Playback option is not enabled.
• Individual: The system plays a recording only to the
individual.
• Conference: The system plays a recording to the
conference.
Field Description
automatically increases the length of a conference. For on-
demand conferences, this option is on.
Auto Extend You can choose to enable Auto Extend Ports by default.
Ports Auto Extend Ports means that the Conferencing server
automatically increases the number of ports allocated to
the on-demand conference if the number of participants
exceeds the number of booked participants.
Disable Operator Recall enables participants to signal to operators
Operator that they require assistance during a conference.
Recall Participants signal to operators by entering a pre-
configured DTMF key sequence, such as *0, on their
telephone keypad. When participants require assistance,
their name is displayed in the Help Requests dialog in the
BridgeTalk application.
You can set a default value for Disable Operator Recall for
all on-demand conferences that the Import Utility creates.
Block Dial Out The Dial Out feature enables moderators to make external
calls during a conference. Moderators can bring new
participants into the conference using this feature. You can
set a default value for Block Dialout for all on-demand
conferences that the Import Utility creates.
If you enable it, the Conferencing server prevents
moderators from dialling out during a conference. If you
disable it, the Conferencing server permits dial out.
Moderator You can choose a default status for Moderator Hang up for
Hangup the on-demand conference. If you enable Moderator Hang
up, the on-demand conference ends when the last
moderator exits.
Toll Free You can choose to enable toll free calling for the on-
demand conference that is created. The Conferencing
server flags toll free conferences in the billing output to
ensure that the service provider is billed and not the
participants.
Global A feature called multisite dynamically links conferences
distributed over bridges located anywhere in the world. A
caller dials into a local bridge, joins the local conference,
and is connected by audio to other local conferences that
make up the global conference.
Note:
In the Standard Edition of Conferencing, multisite is not
supported.
Next steps
Now you can finish the import.
Prerequisites
Before you view the summary screen at the end of an import, you must select the fields and
configure the on-demand profiles.
The purpose of this task is to complete the import of data and view any errors.
Example
Here is an example log file:
2009-12-20 17:17:41 [E]: => Failed to add S700 6 to the Database. p_S700_MkConf:
p_schapi_MkConf failed RetCode=61211, There are no conferences in this request.
2009-12-20 17:17:41 [I]: => booking details - Requests=0, Confirmed=0, Failed=0
2009-12-20 17:17:41 [W]: -> Record written to fail-schedule file Line: 6
2009-12-20 17:17:41 [W]: Line 8: RetCode = 10214, ConfirmNum=7, Tel=978-552-6268,
UserName=Anderson, ConfType=2
2009-12-20 17:17:41 [E]: => Failed to add S700 7 to the Database. p_S700_MkConf:
10214, in p_S700_ValidateDateTimeRange: End-Date-Time has already elapsed.
2009-12-20 17:17:41 [I]: => booking details - Requests=0, Confirmed=0, Failed=0
2009-12-20 17:17:41 [W]: -> Record written to fail-schedule file Line: 7 2009-12-20 17:17:13
[I]: => S700 Record 8 has been Processed.
2009-12-20 17:17:13 [I]: => booking details - Requests=139, Confirmed=139, Failed=0
2009-12-20 17:17:13 [I]: S700 import file successfully backed up 2009-12-20 17:17:13 [I]:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2009-12-20 17:17:34 [I]: => Conference import summary 2009-12-20 17:17:34 [I]: => - Import
file : c:\avaya\import\import\xsched.csv
2009-12-20 17:17:34 [I]: => - Processed file : c:\avaya\import\import\Processed\xsched.bak
2009-12-20 17:17:34 [I]: => - Failures file : c:\avaya\import\import\Fail
\schfail-20091220171734
2009-12-20 17:17:34 [I]: => - Record(s) Failed : 2
2009-12-20 17:17:34 [I]: => Total booking details - Requests=139, Confirmed=0, Failed=0
2009-12-20 17:17:34 [I]:
Next steps
Now you can view all the imported data using the CRS Front End. It is a good idea to view it
using CRS Front End so that you can verify the import.
products, aside from Conferencing. The Conferencing functionality in System Manager and
Conferencing Manager is identical.
System Manager is the integrated management console that you can use to manage all the
Avaya Aura™ products. System Manager runs on a separate physical server from
Conferencing.
Conferencing Manager is a cut-down version of System Manager and is included in the
Standard Edition of Conferencing. Avaya developed Conferencing Manager for customers who
do not have any additional Avaya Aura™ products and require a single server deployment.
Conferencing Manager only supports a single box deployment. If a customer has multiple
Avaya Aura™ products or even multiple instances of Conferencing, they must use System
Manager to manage their Conferencing servers.
The Solution Modeller is a standalone version of Conferencing Manager which you can use to
model a deployment before any Conferencing servers are available.
Related topics:
Exporting the customer model on page 402
Importing the customer model at the customer site on page 403
The purpose of this task is to export a configuration from Conferencing Manager or Solution
Modeller. You need to export the model to create a file that you can import into the actual
customer deployment at the customer site, using Conferencing Manager. The process of
exporting the model creates a .cfg file from the acsm file.
Conferencing Manager or Solution Modeller downloads the file to your laptop or PC.
Example
In advance of an upgrade, you can follow these steps for exporting current settings using
the Conferencing Manager Elements > Conferencing > Services menu. It is a good idea
to export the configuration settings in advance of an upgrade, to ensure that you retain a
copy of all current selections and IP information.
Next steps
You can now send the configuration file to the customer site using any method such as e-
mail, memory key, or DVD.
The purpose of this task is to upload a set of saved configuration settings and install them into
the customer site.
7. Click Save.
8. Click Apply Changes.
9. Navigate to Elements > Conferencing > Services.
10. Click Import.
11. At the Import configuration file field, select a configuration file and click Next.
Conferencing Manager imports the configuration file.
Example
You can use this feature to mimic the customer site while you are in another location, such
as your office. You can configure the customer's settings and then upload the settings file
once you arrive at the customer site.
Additionally, after an upgrade, you can follow these steps for importing any saved settings.
Next steps
Now you can associate the virtual machines that currently contain the dummy IP information
with the actual IP addresses at the customer site.
Related topics:
CRS virtual machine connectivity on page 55
By default, Solution Modeller starts with a model which does not contain any servers. Before
you can start to configure this model, you must provision at least one server into the model.
Avaya recommends opening the Solution Modeller using Microsoft Internet Explorer 8 or
Mozilla Firefox 3.6. The Solution Modeller uses Java 1.6.0 update 13 or newer. Also, it is
important to ensure that the CLASSPATH variable is not set on the desktop computer. You can
check the CLASSPATH variable as follows:
1. On your desktop computer, navigate to Start > Settings > Control Panel > System.
2. On the System Properties dialog, click the Advanced tab and click Environment
Variables.
3. Ensure that the variable CLASSPATH does not appear in the user variables or
system variables lists.
4. Click OK twice to close the dialogs.
Note:
Avaya has created the Solution Modeller as a test utility and for importing configurations to
the customer site at installation time. Avaya has not designed the Solution Modeller for
exporting and importing the configurations of Conferencing instances that are live and in a
production environment. The import/export process does not guarantee persistence of the
BSRes2 database. For example, during the process, you may loose any scheduled
conferences. On the Solution Modeller interface, the links for buttons such as the About
dialog, Change Password, and Log-off do not operate in the normal way. Solution Modeller
inherits these values from Conferencing Manager.
file which contains the Avaya Conferencing Solution Modeller (ACSM) launcher file called
acsm.exe in a folder called bin.
Prerequisites
Before you create your model, you must obtain the Solution Modeller application from your
Avaya Support Representative.
The purpose of this task is to minimize the time required for configuration activities at the
customer site. By modelling the customer solution in advance, you can provide a far more
efficient services solution.
1. Obtain the Solution Modeller zip file from your Avaya Support Representative.
2. Navigate to \acsm\bin and launch acsm.exe.
3. On the Solution Modeller interface, navigate to Solutions > Servers and click
Provision.
4. Select the type of server.
The Standard Edition of Conferencing supports a single type of server.
Solution Modeller allocates a purchasing code to the server. Solution Modeller also
assigns 'dummy' IP information to the virtual machines that comprise the
Conferencing solution. During the import of the configuration at the customer site,
the import wizard steps through the mapping of the 'dummy' IP addresses to the
real IP addresses of the servers deployed on the customer site.
5. Click Provision.
Solution Modeller provisions the selected server into the model and returns to the
list of servers screen. At this stage, the model contains all the default values that
are present in each new instance of Conferencing.
Next steps
Now you can configure the model to suit the requirements of the customer deployment. At any
point, you can save the model or load an existing model into the Solution Modeller by navigating
to Solutions > Save Model or Solutions > Load Model.
Prerequisites
Before you configure your model, you must either provision at least one server into the model or
load a previous model file as a starting point. The model has the file extension .acsm.
The purpose of configuring your model is to create a file which contains all the Conferencing
properties and configuration settings that the customer requires. You can create this file on
your own laptop or PC, in your own time.
Next steps
Now you can export your model from Solution Modeller.
Related topics:
Exporting the customer model on page 402
Avaya Aura Conferencing implementation workbook on page 585
The purpose of saving your model is to store a file which contains all the Conferencing
properties and configuration settings that the customer requires. You can access it again at a
later time.
Example
For example, you can change the filename to a meaningful customer name.
Next steps
Now, you can access this file at any time to make further configuration updates. To access the
file again, you must load it into Solution Modeller.
The purpose of loading your model is to open a file that you have previously saved and which
contains all the Conferencing properties and configuration settings that the customer requires.
Next steps
Now you can update the model using Solution Modeller.
The purpose of discarding your model is to delete a model and all the configuration settings in
that model.
Example
For example, you can discard a model that you have exported from Solution Modeller after
you import the model on the customer site.
The Form Fields section enables the administrator to configure whether various booking
fields are displayed or hidden. For example, the administrator can make the Best Fit option
available on the User’s Advanced tab of the Booking Menu section of the Web Portal.
• Default Field Values
The Default Field Values section enables the administrator to set what options are set as
default on the Web Portal interface. The default field values configure the default values
for various fields whether they are displayed or hidden. The administrator can hide
functionality for the User interface, by de-selecting it from the Tabs& Buttons or Form
Fields tab and selecting it on the Default Field Values section.
Note:
Avaya recommends that only one person configures the Web Portal at a time. If there
are multiple simultaneous attempts to configure Web Portal settings, the Web Portal
may become unstable.
The purpose of this task is to customize the administrator e-mail address. This is the e-mail
address that moderators can send messages to, if they require administrator assistance.
These steps also describe how to customize the location of the moderator online help file and
how to set the Web site which is opened when a moderator clicks the Web Portal banner.
1. Log into the Web Portal administrator interface at: http://<Web Portal virtual
machine IP address>/webportal/admin/login.
The default username is avaya. The default password is avaya.
2. Click Configuration.
3. Select Global Configuration.
4. Enter the administrator e-mail address in the Administrator email address field.
5. Enter a Web site address in the Banner url field.
6. Enter the location of the online help in the Help file(s) url field.
7. Click Commit.
Example
For example, you can configure the banner URL to display the customer's Web site.
Next steps
Now you can set up a legal disclaimer page, if required.
Legal disclaimer
As a Web Portal system administrator, you can configure the display of a legal disclaimer
screen. This legal disclaimer screen is displayed when Users log on to the Web Portal. To
progress to the My Schedule screen, Users must click OK on the legal disclaimer screen.
Related topics:
Configuring a legal disclaimer on page 413
The purpose of this task is to activate and customize a legal disclaimer screen.
7. Click Commence Wizard and edit the text in the Entry Banner Text field.
8. Click Commit.
If you click the Restore button to restore the default values, the Web Portal does
not restore the default legal disclaimer text. The Restore button only restores
properties, not messages.
You can also customize the text by editing the text file directly. The text file is stored
here:
opt\\webapps\webportal\customisations\default\default\i18n\brand
Ensure that you save the file as a UTF8 file. For this reason, it is a good idea to
edit it using Notepad.
Next steps
Now you can configure passcode functionality.
Passcodes
As a Web Portal System Administrator, you can configure the editing rules for the Moderator
and Conferee Passcode fields. Using the Form Fields screen, you can specify whether Users
can enter their own sequence of numbers for their conference passcode.
Auto-generate passcodes field
On the Web Portal Booking Meeting screen, the Auto-Generate Passcodes option indicates
whether Conferencing generates the passcodes for conference. If Auto-Generate Passcodes
is enabled, Conferencing generates the conference passcodes. When Users access the Book
tab on the Book Meeting screen, the Auto-Generate Passcodes option is always enabled. If
you choose not to allow Users to edit the passcode fields, Conferencing will always generate
conference passcodes and Users cannot disable the Auto-Generate Passcodes option.
Similarly, if you choose not to allow Users to edit one of the passcode fields, such as the
Conferee Passcode field for scheduled conferences, Conferencing will always generate
conference passcodes and Users cannot disable the Auto-Generate Passcodes option. If you
choose to allow Users to edit the passcode fields, Users can disable the Auto-Generate
Passcodes option.
Passcode length
Passcodes are numeric. You can configure the length of passcodes using the CheckPINSize
parameter in webportal.properties.
If CheckPINSize=1, Conferencing validates the length of the passcodes using the value of the
Auto Generated Passcode Length parameter. You can configure the Auto Generated
Passcode Length parameter using the Elements > Conferencing > Client Registration >
General menu.
If CheckPINSize=0, Conferencing sends any length of passcode to the CRS. However, the
CRS database, BSRes2, may reject the value if it is too long for the database.
Four options
There are four options available on the Form Fields screen:
• Moderator passcode for Demand Conferences
Select to provide the User with the option of entering their own Moderator passcode for
demand conference access. Users can edit the passcodes associated with their Demand
conference by clicking the Edit button associated with their Demand conference and
displaying the Edit Conference screen.
• Moderator passcode for Scheduled Conferences
Select to provide the User with the option of entering their own Moderator passcode for
scheduled conference access. The Web Portal displays a text box on the User’s Book
Meeting screen. This enables the User to enter their specific Moderator passcode for
scheduled conferences.
• Conferee passcode for Demand Conferences
Select to provide the User with the option of entering their own Conferee passcode for
demand conference access. Users can edit the passcodes associated with their Demand
conference by clicking the Edit button associated with their Demand conference and
displaying the Edit Conference screen.
• Conferee passcode for Scheduled Conferences
Select to provide the User with the option of entering their own Conferee passcode for
scheduled conferences. The Web Portal displays a text box on the User’s Book Meeting
screen. This enables the User to enter their specific Conferee passcode for scheduled
conferences.
Related topics:
Configuring Web Portal passcodes on page 415
Next steps
Now you can configure secure conferencing.
The purpose of this task is to enable the secret PIN functionality for participants. Once you
enable the secret PIN functionality, operators and moderators can book conferences that
require a secret PIN for access and moderators can access the PIN Management Web site.
7. Click Save.
8. If your deployment includes either of these plug-ins:
• Conference Scheduler Plug-in for Microsoft Outlook
• Conference Scheduler Plug-in for IBM Lotus Notes
You must enter the Microsoft Exchange server address or the IBM Domino server
address here:
WebPortal HOME\webapps\part-pin-webapp\WEB-INF\web.xml, parameter
<param-name>MailServer</param-name>
Next steps
Now you can set the time and date formats.
Option Description
MMMMM dd yyyy Month (5 characters), Date (2 characters), Year (4 characters)
dd MMMMM yyyy Date (2 characters), Month (5 characters), Year (4 characters)
hh:mm aa Hour: Minute (am/pm)
HH:mm Hour: Minute (24 hour)
dd:MMM:hh:mm:a Date (two characters): Month (three characters): Hour: Minute
(am/pm)
MMM:dd:hh:mm:a Month (three characters): Date (two characters):Hour:Minute
(am/pm)
dd:MMM:yy Date (two characters): Month (three characters): Year (two
characters)
MMM:dd:yy Month (three characters): Date (two characters): Year (two
characters)
Time Format 12= 12 hour clock (am/pm) 24= 24 hour clock
EEEEE:MMMMM:dd:yyyy Day of week (five characters): Month (five characters): date
(two characters): year (four characters)
This applies to Self Registration display only.
Option Description
EEEEE:dd:MMMMM:yyyy Day of week (five characters):date (two characters): Month (five
characters): year (four characters)
This applies to Self Registration display only.
EEEE:dd:MMMM Day of week (four characters):date (two characters): Month
(four characters)
EEEE:MMMM:dd Day of week (four characters):Month (four characters): date
(two characters)
EEE:dd:MMM Day of week (three characters): Date (two characters): Month
(three characters)
EEE:MMM:dd Day of week (three characters): Month (three characters): Date
(two characters)
Related topics:
Setting time and date on page 418
The purpose of this task is to set the invitation date and time. You can also set the self
registration date format using these steps.
Next steps
Now you can customize some of the other features on the Web Portal application, such as the
booking options.
The purpose of this task is to configure which booking options are available to moderators on
the Booking section of the Web Portal. As an administrator, you can precisely specify which
options are visible and available for moderators.
6. Click Commit.
The formats are saved.
Next steps
Now you can customize some of the other features on the Web Portal application, such as
setting the navigation menu.
The purpose of this task is to configure which options are available to moderators on the left
hand side of the Web Portal interface. As an administrator, you can precisely specify which
options are visible and available for moderators.
6. Click Commit.
Next steps
Now you can customize some of the other features on the Web Portal application, such as the
advanced booking options.
Related topics:
Disabling/enabling conference booking options on page 421
Disabling/enabling notification options on page 427
Disabling/enabling recurring conference options on page 429
The purpose of this task is to hide features from moderators. Conversely, you can also enable
other features to exactly match your requirements. As an administrator, you can set what
booking options are available on the Web Portal interface using the Form Fields tab. The
selected options are then displayed on the Advanced tab of the Book Meeting section of the
Web Portal. You can also set the default values used for each field on the Default Field Values
tab. The default value is used even if the field is hidden.
Option Description
value of Payment Type field in
UserBooking.properties.
Best Fit If enabled, the best fit feature ensures that if the
necessary conference resources are not available at the
specified conference time, and alternative time and
resource combination is offered.
Attended If enabled here and chosen by a moderator, the
conference is flagged as an operator conference. An
operator monitors the call and can greet participants.
Typically, the Bridge Talk application supports attended
operators. The Standard Edition of Conferencing does
not support the Bridge Talk application. However, in the
Standard Edition of Conferencing, you can enable
attended operators if you configure an alternative
application using the ACP API.
Moderator Hang If enabled, the conference closes once the moderator
Up hangs up or leaves.
Allow Enabling conference lock permits the moderator to lock
Conference Lock the conference. No further participants are allowed into
the conference once it is locked.
Conference This option defines the length of time that the conference
passcode passcode is available.
Duration
Pin Mode A PIN code is an identification number that is unique to
each participant. The name of the participant and their
unique identification number are stored in a PIN list.
When moderators using the Web Portal, create a new
participant, the CRS generates a PIN code for each new
participant. The PINs and the name of the Participant are
stored in a database table.
As a Web Portal system administrator, you can choose
to display a set of PIN Mode options to moderators. Using
these PIN Mode options, moderators can force
participants to enter a passcode and their PIN code in
order to access their conference.
There are three PIN Mode options:
• If a moderator selects Off, Conferencing does not use
PIN codes for the conference reservation.
• If a moderator selects System, Conferencing grants
conference access to a participant if they enter the
correct passcode and a PIN code which matches any
entry in the system’s PIN list, which is stored in a
database table on the bridge. The CRS creates this
PIN list automatically. When a moderator adds new
participants to their own address book, the CRS
Option Description
Billing Code This option prompts the moderator to enter a billing code
Prompt when they access the conference.
PIN List If moderators select the Conference PIN Mode option,
the CRS assigns a dynamically-created PIN list to the
conference. The CRS dynamically creates a PIN list for
each conference. This PIN list contains only the invitees
for that particular conference. Conferencing grants
conference access to participants if they enter the correct
passcode and a PIN code which matches any entry in
this dynamically-created PIN list.
In the Conferencing environment, there are main two
sources of PIN lists.
• As a system administrator, you can create and load PIN
lists into Meeting Exchange.
• Alternatively, the CRS dynamically creates a PIN list
for each conference. This PIN list contains only the
invitees for that particular conference. If moderators
specify Conference PIN as their PIN Mode, they can
restrict conference entry to the invitees only. The CRS
names this PIN list using this naming convention:
cl_conference reference.txt. So, if the
conference reference is 123456, the PIN list is
cl_123456.txt.
On the Web Portal, moderators cannot edit the PIN List
field. The CRS automatically assigns the
cl_conference reference.txt value to the
conference. It is a good idea to provide moderators with
the Using Avaya Aura™ Conferencing Guide, which is
available from support.avaya.com. This guide describes
the PIN mode and PIN lists to moderators.
Name Record This option prompts the participants to enter their name
Playback when they dial into the conference.
Enter Tone Entry tones can be enabled and disabled on a per
conference basis.
Option Description
Leaving Tone Leaving tones can be enabled and disabled on a per
conference basis.
Music Source Moderators can set the location of the source file for the
music that is played when a Conferee is on hold.
Auto Increase Moderators can automatically increase the number of
Participants reserved participants during a live conference.
Auto Extend Moderators can automatically extend the reserved
Duration duration of a live conference.
Biometric Biometric authentication is a feature which uses voice
Authentication recognition software to verify the identity of Participants.
For Conferencing, the biometric authentication feature is
still in development. Avaya recommends that you do not
display this field to moderators.
Dial List If enabled here, a moderator can enter the filename of a
dial list in the Dial List field. A dial list is a list of contact
names and telephone numbers that moderators can
associate with the conference. They can prompt the
Conferencing server to dial all the numbers in this list. It
is important to note that you must create the dial list file
beforehand, if you intend to enable the Dial List field for
moderators. You can create dial lists using any text
editor. No file extension is required. However, the format
for the files must follow a specific pattern. It is particularly
important that the file name does not contain any spaces.
Dial lists are stored on the bridge in /usr/dcb/
dbase/diallists. Typically, operators generate
them or upload them using Bridge Talk. It is a good idea
to provide moderators with the Operating Avaya Aura™
Conferencing Guide, which is available from
support.avaya.com. This guide describes Bridge Talk
and CRS Front End to operators.
Note:
The Standard Edition of Conferencing does not
support the Bridge Talk application.
Mute All If enabled here, moderators can select the Mute All
checkbox to place all conferees in the mute status when
they join the conference. Moderators retain full listen and
talk privileges.
Auto Record If you enable moderators to see this checkbox, they can
select this option to ensure that Conferencing
automatically records the conference as soon as it
begins.
It is important to note that CRS operators and Web Portal
wholesalers can also configure Recording Mode at
Option Description
company-level. The settings that operators and
wholesalers configure override the settings that you
configure on this screen for moderators.
As an aside: To successfully enable the recording
feature, you must also configure the recording settings
using Conferencing Manager. Specifically, you must
enable Digital conference record playback in
Elements > Conferencing > Audio Conferencing >
Conference Features.
Control If you enable moderators to see this checkbox, they can
Recording select this option to enable them, or any participant with
moderator status, to record the conference if they wish.
To start recording, they can press the DTMF keypad
sequence, *2 at any time during the live conference. It
is important to note that CRS operators and Web Portal
wholesalers can also configure Recording Mode at
company-level. The settings that operators and
wholesalers configure override the settings that you
configure on this screen for moderators.
Participant ID You can select this checkbox to enable moderators to
Mode view the Participant ID checkbox on their Advanced
Booking Options screen.
Mandatory Bill If you enable this feature, moderators can view the
Code Mandatory Bill Code checkbox on their Advanced
Booking Options screen. If they select this checkbox,
moderators must enter a valid billing code on their
telephone keypad before they join their conference.
Using this feature, you can ensure that moderators
cannot access the conference usless they have a valid
billing code.
Client password This option controls the password field on the my account
tab.
Editable My- This option enables moderators to edit client account
Account details such as timezone.
Information
Participant If enabled here, the Preferred Notification Language
Language field is displayed on the Participant Self Registration
screen. Participants who are self registering, can select
which language they would prefer for their notification e-
mails.
Simultaneous Enables the moderator to reserve a data conference. For
Data Conference more information on data conferences, see the Avaya
Web Conferencing Quick Reference Guide, which is
available from support.avaya.com. This displays as a
standard booking option. If you are using Adobe
Option Description
Connect, this option also enables the user to reserve a
data conference. For more information on data
conferences, see the Adobe Connect User Guide. This
displays as a standard booking option.
Advertise Advertised conferences are conferences whose access
Conference details are displayed on the Web Portal. Web Portal
moderators with a valid account and company name can
view the list of advertised conferences associated with
their company. Advertising means that anyone, using an
appropriate account and company name, can view the
starting time and entry codes associated with
conferences. This option is hidden by default and is a
standard booking option.
6. Click Commit.
The formats are saved.
Next steps
Now you can customize some of the other features on the Web Portal application, such as the
notification options.
The purpose of this task is to configure the notification options which are available to
moderators. As a system administrator, you can define the notification settings for two separate
areas. You can configure the display of the E-mail invitations and Outlook Calendar area of
the ‘Reservation Created Successfully’ screen You can also configure which notification
options are selected as default from the Notification tab. The Notification tab displays when
the User is editing an existing reservation.
To configure the notification options, you must navigate to the Tabs & Buttons section and the
Default Field Values tab on the Web Portal administrator interface.
8. Click Commit.
The formats are saved.
Next steps
Now you can customize some of the other features on the Web Portal application, such as the
attachment functionality.
Option Description
Exclude Saturday Enables moderators to set a daily booking excluding
Saturdays.
Excluding Sunday Enables moderators to set a daily booking excluding
Sundays.
7. Select Default Field Values and scroll down until the recurring functions are
displayed.
8. Select Recurring Conference.
9. Select the options that you want to set as default on the Web Portal interface.
This means that these options are automatically selected on the Web Portal
moderators interface.
10. Click Commit.
The formats are saved.
Next steps
Now you can customize some of the other features on the Web Portal application, such as the
recording options.
Recording
To successfully enable the recording feature, you must also configure the recording setting in
the Conferencing Manager menu: Elements > Conferencing > Audio Conferencing >
General Config.
In addition, there are a number of other considerations with regard to conference recording:
• As a system administrator, you can configure recording at moderator, or client, level.
• Moderators can configure recording at conference level.
From the company level downwards, the settings at each level determine the options available
at the following level. You can configure these settings using the CRS Front End. For more
information about the CRS Front End, see the Operating Avaya Aura™ Conferencing Guide,
which is available from support.avaya.com.
• If wholesalers select Mandatory from the Recording Mode drop-down list at company
level, Conferencing automatically records all conferences for that company. Also,
Conferencing selects the Auto Record check box and makes it inaccessible at
conference level to ensure that it is always on for that company. As with many booking
options, Web Portal system administrators can set a default value for Auto Record. They
can also choose to display the Auto Record checkbox or hide it. If wholesalers select
Mandatory from the Recording Mode drop-down list at company level, system
administrator settings have no impact.
• If wholesalers select DTMF-Menu, Conferencing enables moderators to choose to record
their conferences if they wish. To start recording, they press the DTMF keypad sequence,
*2. Also, Conferencing selects the Control Recording check box and makes it
inaccessible at conference level to ensure that it is always on for that company. As with
many booking options, Web Portal system administrators can set a default value for
Control Recording. They can also choose to display the Control Recording checkbox
or hide it. If wholesalers select DTMF-Menu from the Recording Mode drop-down list at
company level, system administrator settings have no impact.
• If wholesalers select Conference, Conferencing enables moderators to choose between
automatic recording (Auto Record) and manual recording (Control Record) on a per-
conference basis. If wholesalers select Conference from the Recording Mode drop-
down list at company level, system administrator settings do have an impact. If system
administrators enable Auto Record and hide the checkbox, Conferencing automatically
records all conferences for that company. If system administrators enable Control
Recording and hide the checkbox, Conferencing enables moderators to choose to record
their conferences if they wish.
Hiding functionality
Administrators can hide functionality from moderator’s Web Portal interface. For example, the
administrator can have the Best Fit value set to on and the form field set to off. Best fit is then
always configured on and moderators cannot change it since it is not presented to them on
the advanced tab.
Prerequisites
Before you hide functionality for Web Portal, you must you must install and configure the Web
Portal virtual machine.
Example
For example, if you do not have Avaya Web Conferencing installed in your deployment, you
may wish to disable and hide the Simultaneous Data Conference option from moderators.
Next steps
Now you can customize some of the other features on the Web Portal application, such as the
cascading style sheet (CSS).
Ensure that you have enter the Web Portal admin URL. This is your Web Portal URL with /
admin/login added.
Related topics:
Uploading files on page 434
Uploading graphics on page 435
Deleting customizations on page 437
Searching for customizations on page 437
Uploading files
Prerequisites
Before you customize the Web Portal look and feel, you must install and configure the Web
Portal virtual machine. Before you upload a customized CSS, you must download the CSS
and edit a copy of it.
The purpose of this task is to upload previously saved cascading style sheets. This enables
you to configure the Web Portal’s interface appearance.
1. Click Upload. It is necessary to upload all nine files before completing uploading.
The Avaya Audio Console customization screens display.
There are two Avaya Audio Console customization screens. The first screen
enables you to customize the Avaya Audio Console toolbar. The second screen
enables you to customize the Avaya Audio Console participant states. If you do not
want to customize the Avaya Audio Console, you can click Skip to proceed to the
final step in the customization of the Web Portal. The Skip button is at the bottom
of the screen
The final screen in the branding process displays.
2. Select Create Branding Now.
The Branding created screen is displayed. The File is uploaded and the Web Portal
interface changes to reflect the new specifications. If the company name contains
a special character, such as Company$a, the Web Portal creates a branding alias
called Companya.
3. Save a copy of the default CSS to a location on your hard drive, rename it, then edit
it.
4. Navigate to Branding > Web Portal Branding.
5. Select the applicable company name by click the Company Search icon.
6. Select the Company and click Start Branding Wizard.
7. Click Browse in the Full Path to branded CSS section.
Next steps
Now you can customize other aspects of the Web Portal interface, such as the graphics.
Uploading graphics
Prerequisites
Before you customize the Web Portal look and feel, you must install and configure the Web
Portal virtual machine.
The purpose of this task is to exchange the default Web Portal logos with different logos.
File Description
Company logo: You can place a company’s logo in the
<companyname>.gif Web Portal interface. This displays on all
pages.
Phone: Phone.gif You can place a phone icon in the Web
Portal interface. This displays beside
applicable phone numbers.
Menu arrows: Menu_arrow.gif / You can configure the appearance of the
Menu_arrow_selected.gif/ arrow along the left hand side of the menu
screens. They can configure the
appearance of both the selected and
unselected arrow.
Separator: Menu_separator.gif You can configure the appearance of the
separator. The default is a dotted line.
Help graphic: Help.gif You can insert a help graphic.
Information image: You can insert an information image in the
Information.gif Web Portal interface. This is used to
access pertinent conference details from
a conference entry on the schedule.
Recurrent image: You can insert an image that signifies a
Recurrence.gif recurring conference reservation on the
Web Portal interface.
7. Click Upload. It is necessary to upload all nine files before completing uploading.
The Avaya Audio Console customization screens display.
There are two Avaya Audio Console customization screens. The first screen
enables you to customize the Avaya Audio Console toolbar. The second screen
enables you to customize the Avaya Audio Console participant states. If you do not
want to customize the Avaya Audio Console, you can click Skip to proceed to the
final step in the customization of the Web Portal. The Skip button is at the bottom
of the screen
The final screen in the branding process displays.
8. Select Create Branding Now.
The Branding created screen is displayed. The File is uploaded and the Web Portal
interface changes to reflect the new specifications. If the company name contains
a special character, such as Company$a, the Web Portal creates a branding alias
called Companya.
Next steps
Now you can customize other aspects of the Web Portal interface, such the graphics in the
online help file. The easiest way to customize the graphics in the online help file is to view the
folder using the Thumbnail view in the Windows Explorer. Using Thumbnail view, you can see
the logo graphics, such as mh_logo.png, which is the Avaya logo.
Deleting customizations
Prerequisites
Before you delete customizations or brandings, you must you must install and configure the
Web Portal virtual machine.
Prerequisites
Before you search for customizations or brandings, you must you must install and configure
the Web Portal virtual machine.
The purpose of this task is to search for a particular wholesaler, company or client branding
Example
If the company name contains any special characters, such as Company$a, the Web Portal
creates a branding alias called Companya. The branding alias is simply the company name
with any special characters removed.
• <message key='common.button.submit'>Login</message>
• <message key='common.button.back>Back</message>
• <message key='login.title'>Login Page</message>
• <message key='console.edit.participant.name'>Name</message>
• <message key='console.part.menu.mute'>Mute</message>
• <message key='console.part.menu.unmute'>Unmute</message>
• <message key='chat.text.allmod'>ALL MODERATORS</message>
• <message key='chat.text.allop>ALL OPERATORS</message>
• <message key='console.polling.question.prompt'>Put your question here</message>
• <message key='console.polling.answer.prompt'>Put your answer here</message>
To create a new resource bundle, copy the default resource bundle and modify the text
corresponding to the tag keys. For example, if you are creating an Italian resource bundle, you
may have the following entries:
• <message key='common.button.submit'>Inizio attività</message>
• <message key='common.button.back>Vada indietro</message>
• <message key='login.title'>Pagina Di Inizio attività</message>
• <message key='console.edit.participant.name'>Nome</message>
• <message key='console.part.menu.mute'>Muto</message>
• <message key='console.part.menu.unmute'>Onu-muto</message>
• <message key='chat.text.allmod'>Tutti i Moderatori</message>
• <message key='chat.text.allop>Tutti gli Operatori</message>
• <message key='console.polling.question.prompt'>Scriva la vostra domanda a macchina
qui</message>
• <message key='console.polling.answer.prompt'>Scriva la vostra risposta a macchina
qui</message>
Resource bundles can be updated at any time. Apache and Tomcat must be restarted to view
the updates. A Tomcat restart on the Web Portal is required if languages are configured on the
CRS. You can restart these services using the Conferencing Manager menu: Elements >
Conferencing > Services.
You can view the languages via Internet Explorer. To view languages, go to Tools > Internet
Options > Languages.
As a result of this mapping, if you configure CRS Client authentication settings, Web Portal
moderators must adhere to these settings.
Similarly, if you configure CRS administrator authentication settings, Web Portal administrators
must adhere to these settings.
Creation of Web Portal users
You must create an entry for each Web Portal user in the CRS database, BSRes2. When a
Web Portal user exists in the database, they can access the Web Portal. The database stores
all Web Portal moderators and administrators:
• Each Web Portal moderator must exist as a CRS client.
• Each Web Portal administrator must exist as a CRS administrator.
You can create users in the database using the following applications and methods:
• Client Registration Server (CRS)
The CRS Front End is the PC-based application, typically used by operators to create
companies, clients, and conferences and by administrators to configure resources,
bridges, cabinets, DDIs, telephones, timezones, and system parameters.
• Stored Procedure Interface to the CRS
Avaya provides the Stored Procedure Interface to the CRS as a software developer’s tool
kit. It allows application developers to create companies and clients in the CRS database
from within application programs.
• CRS Import Utility
The CRS Import Utility enables you to upload companies and clients in batch to the CRS
database. This utility is useful when the CRS is first brought into service and in cases
where periodic synchronization with external databases is required.
It is important to note that you can set an account inactivity threshold for CRS users, namely,
CRS administrators, CRS supervisors, and CRS operators. You can also set an account
inactivity threshold for CRS clients. As mentioned in the table above, an account inactivity
threshold for CRS clients impacts Web Portal moderators. Similarly, an account inactivity
threshold for CRS users impacts Web Portal administrators and Web Portal wholesalers.
With this functionality, if a Web Portal moderator or Web Portal administrator does not log in
to the Web Portal for a configurable period of time, the CRS disables their account. A CRS
operator can re-enable a Web Portal moderator by editing the corresponding CRS client
account. A CRS administrator can re-enable a Web Portal administrator by editing the
corresponding user account.
If the CRS disables all CRS and Web Portal administrator accounts due to account inactivity,
you must contact Avaya Support.
The configuration parameters for the account inactivity threshold are stored in the users, client,
and system parameters tables in the BSRes2 database.
Web Portal connection to the Web server
In a typical configuration, the Web server also requires a CRS log-in to connect to the CRS.
The important feature of this log-in is that it is at System level. System level log-ins are not
subject to the password expiry rules that you configure for Web Portal moderators,
administrators, and wholesalers.
You must configure the CRS connection information on the Web server. You must also
configure the Web server information on the CRS.
• Configuring the Web server connection on the CRS
In CRS, Avaya creates a Web server log-in on your behalf, by default. To activate the log-
in, you must access the System Administration section of the CRS Front End. In the
System Administration section of the CRS Front End, select the System option in the
View panel on the right side of the Logins tab and click the Create Default button. When
you click the Create Default button, the CRS Front End displays the default log-ins that
Avaya created. These log-ins are used for all systems that connect to the CRS, such as
the Notification Subsystem, the eXtended Message Server (XMS), the Web Portal, and
so on.
• Configuring the CRS connection on the Web server
You can configure the CRS connection in the Conferencing Manager interface: Navigate
to Elements > Conferencing > Web Applications. You can also set the log-in type using
the Conferencing Manager.
Configure the Period to password expiry field with the lifespan of the password
in days.
• To enable password expiry for Web Portal administrators and wholesalers:
Configure the Period to password expiry field with the lifespan of the password
in days and ensure that Authentication required at login=1.
Disabling password expiry
• To disable password expiry for Web Portal moderators:
Ensure that Period to password expiry field=0.
• To disable password expiry for Web Portal administrators and wholesalers:
Ensure that Period to password expiry field=0.
Note:
Avaya recommends that you disable password expiry for Web Portal moderators who use
log-in type 1 or 4.
Single sign on
The SSO feature only applies to Web Portal moderators. The SSO feature does not apply to
Web Portal administrators or Web Portal wholesalers.
In a similar way, the Login type field in the Conferencing Manager menu (Elements >
Conferencing > Web Applications) only applies to Web Portal moderators.
Single Sign On provides streamlined access to the Web Portal. SSO is beneficial to moderators
who are already logged on to/authenticated by the network as they do not have to log on a
second time. Also, if Conferencing is offered with other services, the moderator does not have
to log on to the conference separately.
SSO applies to installations where the Web Portal is deployed within a Service Provider or
Enterprise system. Normally, the moderator is authenticated by the Service Provider or
Enterprise portal. Therefore, it is not necessary for the moderator to enter further information
to access the Avaya Web Portal.
SSO does not support password expiry functionality because in an SSO implementation,
moderators are typically not familiar with their Web Portal password. If SSO is implemented in
your organization, Avaya recommends disabling the password expiry feature.
SSO may not function correctly when used with a reverse proxy server, or if authentication and
session management are not handled by Web Portal.
It is important to note that the SSO solution has a number of limitations. The SSO solution
cannot pick up the operating system username and password. It cannot use Simple and
Protected GSSAPI Negotiation Mechanism (SPNEGO). It cannot authenticate against a
Related topics:
Login type on page 249
DSCA parameters on page 356
Implementing single sign on on page 446
Note:
This example is in English.
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Content-Script-Type" content="text/javascript"/>
< meta http-equiv="Content-Style-Type" content="text/css"/>
<meta http-equiv="Expires" content="0"/>
<meta http-equiv="Pragma" content="no-cache"/>
<meta http-equiv="Cache-Control" content="-1"/>
/head> body>
</table>
</form>
<!-- Login Type 4 -->
<form target="" onSubmit="" action="http://localhost/webportal/do-login" method="GET"
id="login" name="login"/accept-charset=”UTF-8”>
<table width="100%" cellspacing="0" valign="top" cellpadding="0" border="0">
<tr valign="bottom">
<td>
<input onClick="" class="formButton" value="Login Type 4" type="submit" id="" name=""/>
<input value="-120" id="tzoff" name="tzoff" type="hidden"/>
<input value="default" id="companyname" name="companyname" type="hidden"/>
<input value="test" id="accountname" name="accountname" type="hidden"/>
<input value="4167340069" id="accountreference" name="accountreference" type="hidden"/
>
<input value="1" id="loginmode" name="loginmode" type="hidden"/>
<input value="fr" id="locale" name="locale" type="hidden"/>
</td>
< /tr>
</table>
</form>
</body>
</html>
</tr>
</table>
</form>
The user must exist in the directory server with user logon name=”test” and password =”Test1”.
On the active directory server Windows 2008 password must meet complexity requirements.
Directory context name is case sensitive.
The locale parameter is optional. The browsers default language is used if it is not present.
The “companyname” parameter is used to validate all log-in types and is not optional.
Self administration
The Self Administration feature enables non-Web Portal moderators to use the Web Portal
system. Non-Web Portal moderators can create their own Web Portal log-in and then create
their own conferences. In this way, non-Web Portal moderators can become Web Portal
moderators. Self Administration empowers Web Portal users and reduces your administration
workload.
As a Web Portal system administrator, you can configure the Self Administration feature. For
example, you may want to hide the feature completely or you may want to limit the number of
fields that are displayed to moderators.
If your deployment makes use of the Import Utility or the Directory Services Client Application
(DSCA) to import and create moderators, you should hide the Self Administration feature. The
self-administration feature is more suited to smaller, enterprise deployments where moderators
are not imported from an external source.
The Self Administration feature enables non-Web Portal moderators to create Web Portal
moderators. It is a powerful feature, which allows non-Web Portal moderators to be
independent and reduces their reliance on Wholesaler users or CRS operators.
When a non-Web Portal moderator creates a login and becomes a Web Portal moderator,
these new moderator’s details are synchronized with the CRS server. The CRS server adds a
new client to the CRS BSRes2 database to reflect the addition of the new Web Portal
moderator. You can locate a corresponding CRS client record on the CRS Front End for each
new Web Portal moderator.
The validation rules that apply when a CRS operator adds a new client on the CRS also apply to
the Self Administration functionality. For example, with regard to the Password field, you can
set both password length and password complexity on the CRS Front End System
Administration section. It is worth considering that Web Portal moderators will be subject to
these rules when you set up the validation limitations on the CRS. You can configure the CRS
password settings on Elements > Conferencing > Client Registration > General. Web Portal
adminstrators must rely on CRS administrators for this setting. When you enable Self
Administration for Web Portal moderators, you can configure the Web Portal to create an on-
demand conference for each new moderator. Similarly, you can configure the system not to
create an on-demand conference for each new moderator.
If you intend to deploy the Self Administration feature in your customer site, Avaya
recommends that you configure the User Login page to ensure that moderators can log in to
Web Portal by entering their username and password or their e-mail address and password.
The reason for this recommendation is that moderators who are created using the Self
Administration feature do not know their Account Reference. They will not be able to log in
to the Web Portal by entering an Account Reference as verification.
When CRS operators create new clients in the CRS Front End, they can enter an Account
Reference number for each new client. If operators do not enter a value in the Account
Reference field, the CRS server allocates an automatic Account Reference number to the
client.
You can specify the log in credentials for moderators in Conferencing Manager in Elements
> Conferencing > Web Applications.
Related topics:
Accessing the self administration configuration pages on page 450
Configuring the automatic creation of on-demand conference on page 450
Specifying the fields on the self administration page for moderators on page 451
Specifying self administration default values on page 452
Hiding self administration on page 457
The purpose of this task is to navigate to the self administration configuration pages.
Next steps
Now you can configure the automatic creation of an on-demand conference.
Prerequisites
Before you configure the automatic creation of on-demand conferences, you must access the
self administration configuration pages.
The purpose of this task is to set up the Self Administration feature so that it creates a new
on-demand conferences for each new moderator.
1. Navigate to the Default Values tab on the Self Administration configuration pages.
2. Select the Auto create demand conference for new clients checkbox.
3. Click Commit Changes.
The Web Portal Application will create a new on-demand conference for each new
moderator who is created using the Web Portal Self Administration feature. To
ensure that the conferencing server does not create a new on-demand conference,
ensure that the Auto create demand conference for new clients checkbox is not
selected.
Next steps
Now you can configure further options with regard to the Self Administration feature.
Prerequisites
Before you specify the displayed fields for the Self Administration feature, you must install and
configure the Web Portal virtual machine.
1. Navigate to the Form Fields tab on the Self Administration configuration pages.
2. Select a field to display it.
Field Description
Title The title of the new moderator. For example, enter a title
such as, Mrs., Mr., Dr., and so on.
Address The address of the new moderator. Many users enter the
company address.
Field Description
Second Phone A second telephone number of the new moderator. For
example, users can enter an assistant’s telephone
number.
Mobile Phone A mobile telephone number for the new moderator.
Fax Number A fax number for the new moderator.
Job Title The new moderator’s job title.
Comment This is a free text field. Moderators can enter some
additional information or a special note in relation to the
new moderator.
Timezone The default timezone for the new moderator.
Preferred The preferred language for e-mail notifications and audio
Language prompt sets.
External ID A numeric value to associate the new moderator with an
external database. For example, moderators can enter a
phrase which links the moderator with an external list of
sales targets.
External String A phrase which associates the new moderator with an
external database. For example, moderators can enter a
phrase which links the moderator with a list of resources
that exists outside of the CRS framework.
3. Alternatively, you can choose to hide a field by ensuring that it is not selected.
4. Click Commit Changes to apply your settings.
Next steps
Now you can configure further options with regard to the Self Administration feature.
new moderator through the Self Administration tool. When the newly created moderator logs
into the Web Portal and books a new conference, the regular system-wide settings apply to
that user and that conference. You can set Period until conference disabled in Conferencing
Manager in the Elements > Conferencing > Client Registration > General menu.
Prerequisites
Before you specify the default values for the Self Administration feature, you must install and
configure the Web Portal virtual machine.
The purpose of this task is specify default values for the Self Administration User page and for
the on-demand conference that is automatically created for new moderators.
1. Navigate to the Default Values tab on the Self Administration configuration pages.
2. You can set the default value for a number of client settings.
Field Description
Company You can specify which company name is displayed as the
Name default company name. You can use the Search button to
locate the default company name.
Prompt Set You can specify the language of the audio prompt set that is
displayed by default on the Self Administration User page.
Timezone You can specify the timezone that is displayed by default on
the Self Administration User page.
Block The Dial Out feature enables moderators to make external
Dialout calls during a conference. Moderators can bring new
participants into the conference using this feature.
As the Web Portal system administrator, you can set a default
value for Block Dialout for all moderators created using the
Self Administration feature on the Web Portal.
If you enable it, the Conferencing server prevents moderators
created using the Self Administration feature from dialling out
during a conference.
If you disable it, the Conferencing server permits users created
using the Self Administration feature to dial out during a
conference.
On the CRS Front End, operators can set the Block Dialout
feature at company, client, and conference level. The user/
client level setting overrides the company level setting.
Similarly, the conference level setting overrides the user/
client level setting.
On the Web Portal application, moderators cannot edit this
setting at their account level, which equates to user/client level
in the CRS Front End, or at conference level. So, it is important
to note that your choice for Block Dialout becomes a
moderator attribute which the moderator cannot change within
the Web Portal application. The Block Dialout attribute is
Field Description
hidden from moderators on their account details page and on
their conference booking page.
Disabled You can choose to allocate Disabled status to all moderators
created using the Self Administration feature. In this state, the
new moderators cannot create conferences. CRS system
administrators must enable them in the CRS Front End.
Disable Operator Recall enables participants to signal to operators that
Operator they require assistance during a conference. Participants
Recall signal to operators by entering a pre-configured DTMF key
sequence, such as *0, on their telephone keypad. When
participants require assistance, their name is displayed in the
Help Requests dialog in the BridgeTalk application.
As the Web Portal system administrator, you can set a default
value for Disable Operator Recall for all moderators created
using the Self Administration feature on the Web Portal.
If you enable it, the conferencing server sets Disable
Operator Recall as an attribute for all conferences booked by
moderators who were created using the Self Administration
feature.
If you disable it, the conferencing server sets Enable Operator
Recall as an attribute for all conferences booked by
moderators who were created using the Self Administration
feature.
On the CRS Front End, operators can set the Disable
Operator Recall as a feature at company, client, and
conference level. The user/client level setting overrides the
company level setting. Similarly, the conference level setting
overrides the user/client level setting.
On the Web Portal application, moderators cannot edit this
setting at their account level, which equates to user/client level
in the CRS Front End, or at conference level. So, it is important
to note that your choice for Disable Operator Recall becomes
a moderator attribute which the moderator cannot change
within the Web Portal application. The Disable Operator
Recall attribute is hidden from moderators on their account
details page and on their conference booking page.
3. You can set the default value for a number of on-demand conference settings.
Field Description
Number of You can specify the Number of Participants that will apply
Participants to the on-demand conference that is created for the new
moderator, using the Self Administration feature.
Data You can choose to enable or disable data conferencing in
Conference the on-demand conference that is created for the new
moderator, using the Self Administration feature. Data
Field Description
conferencing enables participants to share applications,
slide shows, and whiteboards.
Auto Extend You can choose to enable Auto Extend Ports by default.
Ports Auto Extend Ports means that the Conferencing server
automatically increases the number of ports allocated to a
particular conference if the number of participants exceeds
the number of booked participants.
Prompt Set You can also specify the language of the audio prompts in
the on-demand conference that is created for the new
moderator, using the Self Administration feature. For
example, if you select English, the English audio prompts
are used for the moderator’s on-demand conference.
Payment Type The available values for Self Administration are:
• Account Reference (AR): The moderator’s account
number.
• Dial number (DN): The telephone number of the caller.
• Calling line identifier (CLI): The redirecting number
information for the caller.
Enter Tone You can select a default value for the configuration of tones
Leaving Tone and messages as participants enter and exit the on-
demand conference that is created for the new moderator,
using the Self Administration feature.
The following options are available:
• Off: The feature is not active.
• System: The Conferencing server uses a pre-configured
default setting.
• Tone: The Conferencing server sounds a tone.
• Message: The Conferencing server plays a voice
message.
• Both: The Conferencing server sounds a tone and play a
voice message.
Field Description
From the Music Source drop-down list, you can select Off
to switch the music off. Alternatively, you can select a
source for the music. The numbers one to four represent
four file locations on the bridge. Music is stored in the .wav
format, but additional functionality is available to dial out to
an external music source.
Note:
It is important to note that if you select Off, moderators
cannot place their participants in an on hold state.
Moderator You can choose a default status for Moderator Hang up for
Hang up the on-demand conference that is created for the new
moderator, using the Self Administration feature. If you
enable Moderator Hang up, the on-demand conference
ends when the last moderator exits.
Secure Mode If Secure Mode is enabled, moderators can lock the on-
demand conference that is created for the new moderator,
using the Self Administration feature.
Name Record You can choose a default value for the Name Record
Playback Playback drop-down list for the on-demand conference
that is created for the new moderator, using the Self
Administration feature.
If you enable Name Record Playback (NRP), the
Conferencing server prompts all participants to call out their
name before they enter the conference. Moderators can
then play a audio roll call of attendees. There are number
of possible values:
• Off: The Name Record Playback option is not enabled.
• Individual: The system plays a recording only to the
individual.
• Conference: The system plays a recording to the
conference.
Next steps
Now you can configure further options with regard to the Self Administration feature.
Prerequisites
Before you hide the Self Administration feature, you must install and configure the Web Portal
virtual machine.
The purpose of this task is to hide the Self Administration feature from moderators.
1. Navigate to the Default Values tab on the Self Administration configuration pages.
2. Ensure that the Self Administration Feature Enabled checkbox is not selected.
3. Click Commit Changes.
Customization
Customization, or branding is a value-added service that Communication Service Providers
(CSPs) can offer customers. Enterprise customers can also brand the Audio Console for their
own internal use to ensure that the interface is consistent with their overall Web style.
Using branding functionality, you can integrate customer styles and logos into existing Audio
Console screens. You can customize Audio Console screens on a per client basis. Branding
presents a consistent look and feel across all conferences for a particular client.
Audio Console system administrators can customize the Audio Console screen for individual
clients, using a series of branding options in the Web Portal suite.
Cascading Style Sheet (CSS) is a simple mechanism for adding style (such as fonts, colors,
spacing, and so on) to Web documents. All Web pages reference the style sheet and you can
use the style sheet to change the look and feel of an entire site. CSS files simplify the
customization process because you can make changes in a single location.
A branding wizard guides you through the process:
You can customize the Audio Console toolbar and also the Audio Console participant states.
Toolbar
Participant states
The Audio Console displays each conference participant using an icon. These icons represent
the various participant states. For example, if a participant enters the Mute state, their
participant icon changes to an icon which represents the Mute state. Similarly, moderators are
distinguished from participants using specific iconography.
Audio Console system administrators can replace these default icons with new images. The
default icons are 24 pixels X 24 pixels in size. It is advisable to replace the default icons with
new images of an identical or very similar size.
It is important to note that if moderators access the Audio Console using a branded URL, the
Web Portal does not embed URLs in the Web page that refer to different CSS and image
locations. The Web Portal does substitute different strings so that the Web page appears
different to the browser cache. The consequence of this feature is that:
• If a user visits their branded URL for the first time, the Web page displays the branded
images successfully.
• If a user visits a different company or the default branding before they visit their branded
URL, they must clear the browser cache to display the correctly branded images
successfully. If the user simply refreshes the Web page, the correct images do not display.
They must clear the cache.
Icon Description
Conferee
Conferee talking
Conferee mute
Conferee hold
Moderator
Moderator talking
Moderator mute
Moderator hold
Subconference flag
Conferee interceptee
Moderator interceptee
Moderator interceptor
Dialing conferee
Dialing moderator
Note:
Avaya recommends that only one person customizes the Audio Console at a time. If there
are multiple simultaneous attempts to configure Audio Console settings, the Audio Console
may become unstable.
Supported browsers
Avaya recommends Microsoft Internet Explorer 8.0 and Mozilla Firefox 3.6 for use with the
Audio Console.
The purpose of this task is to access the administration pages of the Audio Console.
1. In a Web browser, enter the Web Portal administrator URL: http://Web Portal
virtual machine IP/ webportal/admin/login.
2. Enter an account name and a password and click Login.
3. Navigate to Branding > Web Portal Branding.
Next steps
Now you can customize the Audio Console toolbar and the Audio Console participant states.
The purpose of this task is to give the Audio Console a customized look and feel.
provided for any company branding to fit that space regardless of the size of the
image.
Next steps
Now you can customize further options with regard to the Audio Console application.
The purpose of this task is to activate or deactivate toolbar functions. This task is useful if you
want to customize moderator access to specific features.
Note:
You can configure most of these settings using the Conferencing Manager administrator
interface. It is unlikely that you should have to edit the manage-menu.xml file. These steps
are included for information only.
When you deploy the Audio Console, it locates a file called manager-menu.xml in the
docs/client directory. To activate and deactivate toolbar icons, you must edit this file.
To de-activate any feature, comment out the associated entity. Typically, Avaya
Support Engineers perform this level of customization.
Example
In this example, the Avaya Support Engineers have disabled dial list functionality:
<?xml version="1.0"?>
<!--
This is the Participant List Context-Sensitive Menu
-->
<menu xmlns:i18n="http://apache.org/cocoon/i18n/2.0">
<entity id="dial">
<description><i18n:text>console.conf.status.dialout.help</i18n:text></description>
<image>/console/images/btn_dial_enabled.gif</image>
<onclick>dialListDialog</onclick>
</entity>
<!-- DISABLE DIAL LIST
<entity id="dial-list">
<description><i18n:text>console.conf.status.diallist.help</i18n:text></description>
<image>/console/images/btn_list_enabled.gif</image>
<onclick>dialListDialog</onclick>
</entity>
-->
Prerequisites
Before you enable the sub conference functionality for the Audio Console, you must install and
configure the Web Portal virtual machine. You must also have an administrator account on the
CRS Front End.
The purpose of this task is to enable the sub conference feature for Audio Console.
• You can set it to Anyone. In this situation, any conferee can be transferred to a
sub conference in order to open the sub conference. The sub conference closes
when it is empty.
Next steps
Now you can customize further options with regard to the Audio Console application.
Properties file
The Conferencemanager.properties file contains the Audio Console configurable parameters.
The Conferencemanager.properties file is located in: <installation directory>/
webapps/console/WEB-INF
Parameter Description
LogConf The name of the file that contains the log4j
properties. Log4j is a 3rd party logging tool that is
configured for Audio Console debug output. The
log4j properties are things like the log file name
and location, the format of logged output etc.
Note:
All the Web products use log4j for logging.
BRIDGE_NAME The IP address or the hostname of the bridge.
If the Audio Console is setup to talk to a CRS, then
BRIDGE_NAME can be blank. Audio Console
takes the bridge name from CRS in this case.
UserName This parameter specifies the username, which is
the operator log in name that is used to log on to
Audio Console.
Parameter Description
PASSWORD This parameter specifies the password, which is
the operator log in password that is used to log on
to Audio Console.
CodrDBServer The IP address or hostname of the CODR
database server.
CodrDBUser The CODR database system administrator
username.
CodrDBPwd The CODR database system administrator
password.
ReportsChartBgColor These parameters are not used in the current
ReportsChartPlotBackgroundColor release of Conferencing. Web Portal compiles the
ReportsChartSeriesForegroundColor reports and uses the settings in
ReportsChartFont webportal.properties.
ReportsChartFontSize
ReportsChartFontStyle
LogonType LogonType detemines the fields that are
presented to the user on the Log On screen. This
Note: parameter is specified as a numeric value, as
On the Conferencing, LogonType is follows. Logon includes a name entry. When a
defined by ModApiLogonType. CRS is present a password is also required.
• 1 = Conference ID, Confirmation Number and
Moderator PIN - all three required
• 2 = Confirmation Number and Moderator PIN -
both required
• 3 = Conference ID and Moderator PIN - both
required
• 4 = Moderator PIN - only this is required (this
logon type does not work if Audio Console is
configured with a CRS)
Parameter Description
would close the connection if there was no activity
for a particular length of time. The PING
parameter configures the length of time in
seconds between pings to keep the firewall alive.
For example, PING=30.
Note:
In the case of a Web Portal and Self Registration installation:
- Set CRS_Name to the IP address or hostname of the CRS.
- Comment out Bridge_Name.
Avaya advises not to change the default configuration.
The Conference Scheduler plug-in for Microsoft Outlook has two installation options:
• You can run the client set-up for the Conference Scheduler plug-in for Microsoft Outlook
on each User’s computer. After set-up, the assemblies needed for the plug-in reside on
the User’s computer.
• You run a silent installation without the installer by extracting the client set-up and running
the .msi file only. This is a fast and efficient method.
If Microsoft Outlook is in offline mode, but is still connected to the network, then the plug-in
operates as normally. It retrieves the details of users’ on-demand conferences and it creates
new scheduled conferences for users. However, if Microsoft Outlook is in offline mode and is
not connected to the network, then the plug-in displays a network error if users try to retrieve
on-demand conference details or schedule new conferences.
Related topics:
Prerequisites on page 470
Prerequisites
The plug-in is based on Microsoft Visual Studio Tools for Office (VSTO) technology. As a result,
you must install the following pre-requisites on the client PC’s.
Note:
Avaya ships all prerequisites with the Conferencing software.
If you are using Microsoft Outlook 2003
• Microsoft .Net Framework 2.0
• Microsoft Visual Studio Tools for Office 2005 Runtime
• Microsoft Visual Studio Tools for Office 2005 Language Pack (optional)
• Microsoft Office 2003 Primary Interop Assemblies
If you are using Microsoft Outlook 2007
• Microsoft .Net Framework 2.0 and 3.5
• Microsoft Visual Studio Tools for Office 2005 Second Edition Runtime
• Microsoft Office 2007 Primary Interop Assemblies
If the clients, or target PCs, are using non-English locale settings, they must have an
appropriately localized version of the Microsoft .Net Framework 2.0 installed on their PC. This is
a requirement for both Microsoft Windows XP (Service Pack 2 or later), and Microsoft Windows
Vista platforms. It is your responsibility as the system administrator to ensure that the correctly
localized version of the Microsoft .Net Framework 2.0 is installed on the target PCs.
Related topics:
Microsoft adapter on page 471
OCS adapter on page 472
Microsoft adapter
Microsoft Adapter integrates Microsoft Office Communications Server R2 (OCS) and the Avaya
Conferencing application server (bridge) to provide protocol conversion between the Microsoft
Live Meeting client application and an Avaya Conferencing bridge.
Microsoft Adapter is deployed in a Conference Service Provider (CSP) or an Enterprise
environment to provide the following protocol conversions:
• Conversion of SIP events that are received from OCS, to commands that are specific to
the Avaya Conferencing bridge. The Conferencing bridge then initiates an audio
conference. The Conferencing bridge is also deployed in the environment of the CSP.
• Conversion of events that are specific to the Conferencing bridge, to SIP events. Microsoft
Adapter then sends these SIP events to OCS.
Related topics:
Microsoft adapter components on page 472
OCS adapter
Avaya has developed the Microsoft Office Communications Server Adapter, often called the
OCS Adapter, to act as an interface between Microsoft Office Communicator 2007 R2 and the
Conferencing server.
Related topics:
OCS adapter feature set on page 473
OCS adapter audit trail on page 473
OCS adapter operating environment on page 474
Note:
In the OCS Adapter environment, Name Record Playback (NRP) is not supported. Similarly,
entry and exit tones and announcements are not supported.
Timezones
The Avaya Conference Scheduler Plug-in for Microsoft Outlook uses timezone 1 UTC (System)
as the default timezone for booking conferences. This configuration is hardcoded. Do not edit
the timezone list in the Client Registration Server Front End. If you want to update the timezone,
make the change using the Conferencing Manager application (Elements > Conferencing >
Client Registration > Timezones menu).
Related topics:
Timezone settings on page 223
Stored procedures
The CRS Stored Procedure Interface (CSPI) is a series of SQL stored procedures that provide
developers with conference managing tools. CSPI is part of the BSRes2 Database. CSPI
enables third party developers call the procedures from their preferred programming language
or directly via SQL.
For more information on CSPI, see the Avaya CRS Stored Procedures Guide, which is
available from your Avaya Support Representative. For the successful operation of the
Conference Scheduler Plug-in for Microsoft Outlook application, you must install the
Conferencing CSPI component. For more information, contact your Avaya Support
Representative.
sets the .NET security policy to enable Microsoft Outlook to run the plug-in. It is a standalone
set-up, which is suited to a local installation scenario. The client set-up is located in the
Conferencing installation folder at:
• /Outlook2007/Setup.exe if you are running Microsoft Office Outlook 2007
• /Outlook2003/Setup.exe if you are running Microsoft Office Outlook 2003
The client set-up performs the following actions:
• Checks that the pre-requisites are installed.
• Prompts the user to accept license agreements for any of the pre-requisites which are
not installed.
• Installs any missing pre-requisites.
• Prompts the user to accept the Avaya license agreements.
• Prompts the user to enter the IP address of the Conferencing bridge.
• Prompts the user to e-mail address and password that matches their client account on
the CRS Front End. Each user of the Conference Scheduler plug-in for Microsoft
Outlook requires a client account on the CRS Front End.
• Provides a default installation folder; C\Program Files\Avaya\Outlook Conference
Scheduler\ and prompts the user to select an installation folder.
• Installs the Conference Scheduler plug-in for Microsoft Outlook.
The add-in loads when the user restarts Microsoft Outlook or when it is enabled in the
COM add-in menu.
• During an un-install, the client set-up:
a. Removes the contents of the installation folder.
b. Removes the security policy settings for OutlookConferenceScheduler.
c. Removes the registry entries for OutlookConferenceScheduler.
Note:
Users runs the un-install using the Add/Remove Programs feature in the
Windows Control Panel. The un-install does not remove the pre-requisites for
the Conference Scheduler plug-in for Microsoft Outlook.
Prerequisites
Before you can configure a silent installation of the Conference Scheduler for Microsoft Outlook
in your deployment, you must obtain the installation files from your Avaya Support
Representative. Avaya ship these files as an .ISO image.
The purpose of this task is to role out the Avaya plug in for Microsoft Outlook in your
organization.
1. The installation package as an .ISO image containing the following files and
directories:
• Administrator: The directory used by setup.exe to check for administrator
privileges. This file is not relevant for a silent installation.
• dotnetfx: Microsoft .Net Framework 2.0
• localisation: Localized Resource DLL’s
• Office200xPIA: Microsoft Office Outlook Primary Interop Assemblies
• VSTOR: Visual Studio Tools for Office (VSTO) or VSTO Second Edition for
Outlook 2007 version
• OutlookConferenceSchedulerClientSetup.msi or
Outlook2007ConferenceSchedulerClientSetup.msi: MSI install package
• setup.exe: Setup program
2. Install the relevant pre-requisites on the target computers.
3. Install the MSI Installation package on the target computers.
4. Run the command for installing the Avaya Conference Scheduler for Microsoft
Outlook. Here is an example of this command:
msiexec /quiet /package
OutlookConferenceSchedulerClientSetup2007.msi
5. Use the remote registry editor or another tool to roll out the following 3 registry
entries (strings) to each target computer:
[HKEY_LOCAL_MACHINE\Software\Classes\CLSID\{9B6591DB-66E8-4975-
BDB4-6E05BD1239BF}]
• hostname
• EmailAddress
• AccountPassword
The three entries are the IP address of the Conferencing server, the User’s e-mail
address, and the User’s password as set on their account on the Conferencing
server.
6. If your users are running Microsoft Outlook 2003:
Next steps
Now you can configure the Microsoft Outlook settings using the Conferencing Manager
administration interface.
Configurable settings
You can configure many of the properties of the Conference Scheduler for Microsoft Outlook
using the Conferencing Manager administrator interface.
For example, you can hide certain Conferencing options or you can configure certain options to
display on the GUI in an enabled state. You can also configure which features are displayed
for users on the Conference Call tab of the New Appointment dialog. Using this functionality,
you can customize the end user experience to exactly match your requirements.
Related topics:
Audio
Invitation header on page 219
Invitation body on page 219
Audio numbers on page 219
On demand on page 219
Schedule on page 219
Web conference on page 220
Join conference on page 220
Prerequisites
Before you configure the Conference Scheduler for Microsoft Outlook settings, ensure that you
install and configure Conferencing and install the Conference Scheduler for Microsoft Outlook.
Next steps
Restart Microsoft Outlook to verify that your configuration options are reflected in the
Conference Scheduler for Microsoft Outlook interface.
Related topics:
Ensuring that Conferencing notification e-mails are not classified as junk on page 480
Prerequisites
Before you ensure that notification e-mails are not classified as junk, you must install the Avaya
Aura™ Conferencing Plug-in for Microsoft Outlook.
The purpose of this task is to add the Conferencing details to the safe sender list in Microsoft
Outlook.
1. Make a note of the e-mail address that you entered in the Email Sender field in the
Conferencing Manager menu: Elements > Conferencing > Client Registration
Server > General settings > Notification settings.
2. Add this e-mail address to the Microsoft Outlook address book or add it to the Safe
Senders list.
Example
The E-mail Sender field can be a value such as conferencing@customername.com or
conferencing@noreply.com.
Next steps
Now it is a good idea to verify this configuration by sending a test e-mail to see if it is classified
as a junk e-mail. You can send a test e-mail by booking a test conference.
Related topics:
E-mail sender on page 211
Reinstalling
In the unlikely event that a user has to re-install the Conference Scheduler plug-in for Microsoft
Outlook, ensure that they uninstall the previous version of Conference Scheduler plug-in for
Microsoft Outlook prior to beginning the re-installation.
Related topics:
Installing JRE on page 482
Installing Microsoft adapter on page 483
Configuring BSmon on page 484
Installing JRE
The Microsoft adapter requires Java files in order to operate successfully. The Java files are
called the Java Runtime Environment (JRE).
Prerequisites
Before you configure the JRE environment, you must install and configure Conferencing. You
must also install and configure Microsoft Live Meeting.
The purpose of this task is to install and configure the Java prerequisites that are necessary
for the Microsoft adapter. The Microsoft adapter is a key component in the Conferencing plug-
in for Microsoft Live Meeting.
Example
An example of a JRE path is C:\Program Files\Java\jre1.5.0_07\bin\client.
Next steps
Now, you can install the Microsoft adapter.
Prerequisites
Before you install the Microsoft adapter, install and configure the JRE environment.
The purpose of this task is to install and configure a key component for the Conferencing Plug-
in for Microsoft Live Meeting.
1. Click setup.exe.
The system starts the InstallShield wizard for Microsoft Adapter and displays the
Welcome to the InstallShield Wizard screen.
2. Click Next.
The system displays the license agreement screen.
3. On the Customer Information screen, type your user name and your company
name. Click Next.
4. On the Choose Folder screen, select the folder in which to install the application.
Click Next to accept the default installation path C:\Program Files
\Microsoft Adapter or click Browse to choose another location. Select the
folder and then click OK to accept the changes.
The system displays the Select a Program Folder screen.
By default, the Avaya BSMon service is installed in C: \Program Files\
Microsoft Adapter. If you change the default installation path of Microsoft
Adapter, you must also change the BSMon registry manually and start the service
manually.
5. To create a shortcut for Microsoft Adapter, ensure that Microsoft Adapter is selected
in the Existing Folders area and click Next.
The system displays the Ready to Install the Program screen.
6. Click Next and then click Install to start the installation.
When the installation is finished, the system displays the Installation Complete
screen.
7. Click Finish.
If you set the default path to C:\Program Files\Microsoft Adapter, the
system installs and starts the BSMon service.
If you set the path to a location other than the default, you must configure the
BSMon.
Next steps
Now, you can configure BSMon if you did not install the Microsoft adapter at the default location.
Configuring BSmon
The Booking and Scheduling Monitor (BSMon) is a watchdog. A watchdog is a software timer
that triggers a system reset or other corrective action if the main program enters a faulty state. If
you install the Microsoft adapter in any location other than the default location (C:
\ProgramFiles\Microsoft Adapter), you must configure BSMon.
Prerequisites
Before you configure BSMon, you must install the Microsoft adapter.
The purpose of this task is to change the registry entry and start-up type for BSMon.
1. Click Start > Run. In the Open field, type regedit and click OK.
The system displays the Registry Editor screen.
2. Navigate to MY COMPUTER > HKEY_LOCAL_MACHINE > SYSTEM >
ControlSet001 > Services > Avaya BSmonitor.
3. In the left pane, click AvayaBsMonitor > Parameters > 0.
In the right pane, the system displays the default path C:\ProgramFiles
\Microsoft Adapter\bin.
4. Right-click Path and then click Modify.
The system displays the Edit String screen.
5. In the Value data field, enter the path where the Microsoft Adapter application is
installed and click OK to save.
6. Start the BSMon service.
7. Open the Microsoft Windows Services screen.
By default, the startup type for the Avaya BsMonitor service is Manual.
8. Right-click Avaya BsMonitor and click Properties.
The system displays the Avaya BsMonitor Properties screen.
Next steps
Now, you can configure Microsoft adapter.
Prerequisites
Before you uninstall Microsoft adapter, you must install it.
The purpose of this task is to remove the Microsoft adapter from your computer.
If you see this message, do not continue with this procedure. Instead, double-
click setup.exe to uninstall Microsoft Adapter.
4. Select Remove and click Next.
The system displays a confirmation box.
5. Click Yes.
The system stops the Avaya BSMonitor service and then displays the Uninstall
Progress screen. When the uninstallation is complete, the system displays the
Uninstall Complete screen.
6. Click Finish.
The application is removed from the target computer. The related entries that are
made during installation are also removed.
Related topics:
Configuring TLS on page 486
Microsoft adapter administrative interface on page 488
Configuring the gateway settings on page 490
Configuring the logs settings on page 491
Configuration of Microsoft Office Communications Server 2007 R2 for MSAdapter on
page 493
Configuring TLS
Microsoft Adapter starts only if a valid Transport Layer Security (TLS) certificate exists.
Prerequisites
Before you perform this task, you may purchase a security certificate from a trusted security
vendor, such as Verisign, or you can install a security certificate from your Active Directory
Certificate Services.
The purpose of this task is to configure security for the Conferencing Plug-in for Microsoft Live
Meeting. Microsoft Adapter starts only if a valid Transport Layer Security (TLS) certificate
exists. The first thing that Microsoft Adapter does is try to read the default certificate file
acp.cer from the default path \\MSAdapter\config\acp.cer. If Microsoft Adapter does
not find the certificate or finds an invalid certificate, you see an error message. Microsoft
Adapter then opens in the default mode, from which you can provide the valid certificate path.
1. To provide the valid certificate path, click Gateway Configuration > Gateway
Settings.
2. On the Gateway Settings screen, click Browse and select the valid certificate path.
3. Click Save.
Microsoft Adapter stops and then restarts automatically with the new path.
4. Add the certificate to Microsoft Management Console:
To add the certificate to Microsoft Management Console:
a. Click Start > Run. In the Run screen, type mmc and click OK.
b. On the Console screen File menu, click Add/Remove Snap-in.
c. On the Add/Remove Snap-in screen, click Add.
d. On the Add Standalone Snap-in screen, click Certificates and then click Add.
e. On the Certificates snap-in screen, select Computer account and click Next.
f. In the Select Computer screen, select Local computer and click Finish.
g. On the Add Standalone Snap-in screen, click Close.
h. On the Add/Remove Snap-in screen, click OK.
5. Export the TLS certificate.
To export the TLS certificate:
a. Click Start > Run. In the Run screen, type mmc and click OK.
b. In the left pane of the Console screen, expand Certificates (Local Computer)
> Personal.
c. In the right plane, double-click Certificates.
d. Right-click the issued certificate and then click All Tasks > Export.
e. Click Next.
f. On the Welcome screen, click Next.
The system displays the Export Private Key screen. By default, the option No,
do not export the private key is selected.
g. Click Next.
The system displays the Export File Format screen. By default, the option DER
encoded binary X.509 (.CER) is selected.
h. Click Next.
i. On the File to Export screen, in the File Name field, enter the name of the
certificate file or click Browse to select the Config folder where Microsoft
Adapter is installed. Export the certificate file to that folder.
j. Click Finish.
If you rename the TLS certificate or change the location of the certificate and
then try to start Microsoft Adapter or if Microsoft Adapter is already running, the
application displays an error message that asks for the correct TLS certificate
file. You must then provide the correct certificate file details and restart the
application.
Next steps
Now, you can explore the Microsoft adapter interface.
Start
Stop
• Help
About
Note:
See the notes in the next section.
Prerequisites
Before you configure logs, you must install and configure the Microsoft adapter and the
Conferencing server.
The purpose of this task is to configure the adapter connection settings to suit your deployment
requirements.
1. On the Microsoft Adapter main screen, click Gateway Configuration > Gateway
Settings.
2. On the Gateway Settings dialog, complete the following information:
Field Description
Local Port The port on which Microsoft Adapter listens to the OCS
events. The default is 5060 for TCP and 5061 for TLS
connections.
Field Description
Polling Interval After a successful connection, Microsoft Adapter
continues to poll the audio conferencing bridge every n
seconds, where n is a number that you can configure. The
default is 30 seconds.
Re-Connection If a connection failure occurs, Microsoft Adapter tries to
Attempts re-establish the connection n number of times, where n is
a number that you can configure. The default is five
attempts.
Re-Connection If a connection failure occurs, Microsoft Adapter tries to
Attempt Interval re-establish the connection every n seconds, where n is
a number that you can configure. The default is five
seconds.
TLS Live Communications Server sends the SIP traffic to the
audio bridges on the secured TLS layer over the Internet.
TLS Path The path where the TLS Certificate exists.
Next steps
Now, you can add the Conferencing application server (bridge) information to the Microsoft
adapter.
Prerequisites
Before you configure logs, you must install and configure the Microsoft adapter and the
Conferencing server.
The purpose of this task is to change the default log settings to suit your deployment
requirements.
1. On the Microsoft Adapter main screen, click Gateway Configuration > Log
Settings.
2. On the Gateway Settings screen, complete the following information:
Field Description
Log Level Microsoft adapter logs messages and events based on the log
level that you select.
Log Path The path where the log files are sent. By default, the logs are
sent to the Logs folder. This Logs folder resides in the folder
where the application is installed. For example, if the
application is installed in D:\ACPGateway, the logs are stored
is D:\APCApplication\Logs.
Log File Microsoft adapter logs messages into multiple log files. When
Size the size of the file reaches the value that you set here, a new
file is created. The maximum size that you can set is 10 MB.
The default value is 2 MB.
Log Storage Microsoft adapter stores log files for n days, where n is a
Duration number that you can configure. The default is 30 days. The
system deletes files that are older than n days.
Free This is the free memory threshold of the Microsoft adapter. If
Memory the application memory utilization crosses the threshold value,
Microsoft adapter displays a warning message on the GUI for
administrators. The threshold value ranges between 100 MB
and 500 MB. The default value is 1 GB.
Free Disk This is the free disk space threshold of the Microsoft adapter. If
Space the log size crosses the threshold value, Microsoft adapter
displays a warning message on the GUI for Administrators.
The threshold value ranges between 1 GB and 10 GB. The
default value is 1 GB.
Example
Example log levels:
The trace pane displays the messages and the events that Microsoft Adapter logs.
Microsoft Adapter supports the following four different modes to log messages and events:
Logs Description
(0) ERROR Logs the failed operations including failure to connect to a bridge.
(1) WARNING Logs all warnings that pertain to operations or events that can cause
errors, such as connection attempts and resource thresholds. By
default, the log level WARNING is selected when the application starts.
(2) INFO Logs all events and commands, such as SIP events, Bridge Control
API (BCAPI) commands and responses, BCAPI events, and
connection messages.
(3) DEBUG Logs all information-level items.
On the Log Settings screen, you can choose the option that you want.
ACP Server logs all messages and events into log files for debugging. The system stores
these log files in the path that you specify in the Log Settings screen. Microsoft Adapter
generates the following three types of log files:
File Description
CPPlogger.txt This log file contains the logs that are related to the
ACPBCAPIClient Interface module. This file describes the flow of
the commands and events between the ACPServer module and the
BCAPIClient module
BCAPImodule.txt This log file contains the commands as received from the ACP
Server module, and the events and responses received from the
Conferencingbridge.
MSAdapter.txt This log file contains all the messages that you see in the trace pane.
These logs are located in the Logs folder, which is automatically created when the Microsoft
Adapter application is started.
During the installation of the application, information about the installation process, such as,
errors and warnings are logged in the Installer log file Microsoft_Adapter_Logs.txt.
This log file is located in the Microsoft_Adapter_Logs folder. You should delete log files
in accordance with the parameters, Log File Size and Log Storage Duration.
Next steps
Now, you can configure Microsoft adapter with the Conferencing bridge.
Firstly, you must administer certificates. Conferencing and Microsoft Office Communication
Server communicate using Transport Layer Security (TLS). For communication to take place,
Conferencing and Microsoft Office Communications Server 2007 R2 must exchange signed
server certificates each time a TLS session is opened. For more information on this task, see:
• Microsoft Office Communications Server 2007 R2 Document: Standard Edition
Deployment Guide
• Microsoft Office Communications Server 2007 R2 Document: Integrating Telephony with
Office Communications Server 2007 R2
• Microsoft Office Communications Server 2007 R2 Document: Enterprise Edition
Deployment Guide
• Microsoft Office Communications Server 2007 R2 Document: Active Directory Guide
All documents are available from www.microsoft.com.
Secondly, you must perform some configuration steps on the Microsoft Office Communications
Server (OCS) 2007 R2 for Microsoft adapter. The last configuration stage involves using the
Conferencing Manager administrative interface to configure the settings for your user client
machines.
Related topics:
Configuring the Microsoft Office Communications Server (OCS) 2007 R2 for MSAdapter on
page 494
The purpose of this task is to configure the Microsoft Office Communications Server (OCS)
2007 R2 for OCS adapter.
1. Navigate to Start > Administrative Tools > Office Communications Server 2007
R2.
2. Stop all services.
3. Open Pool Front End Properties.
The system displays the Properties screen.
4. On the Host Authorization tab, click Add.
The system displays the Add Authorized Host screen.
5. In the Server area, select Network address and enter the fully qualified domain
name (FQDN). The FQDN is the name of the server on which OCS adapter is
installed.
6. In the Settings area, select Throttle as Server and Treat as Authenticated.
7. Click OK.
8. On the Routing tab, click Add.
The system displays the Add Static Route screen.
9. Complete the following fields:
• Domain. Enter the FQDN of the server.
• Network address. Select and enter the FQDN of the server on which the OCS
adapter is installed.
• Transport. Select TLS.
• Port. Enter 5061.
10. Select Replace host in request URI.
11. Click Select Certificate and select the appropriate certificate.
12. Click OK.
13. Click Apply.
14. To start Microsoft Office Communications Server, right-click the Microsoft Office
Communications Server name and click Start All Services.
Next steps
Now you can use the Conferencing Manager administrative interface to configure the settings
for your user client machines.
Field Description
Conferencing A logical name for the Conferencing bridge. This name can contain a
Bridge Name maximum of 64 alphanumeric characters.
Bridge Type The type of bridge. The default is S6200. The S6200 is the bridge type
that applies to the Standard Edition of Conferencing.
DNIS Number The DNIS number to map to the Conferencing bridge. The DNIS
number must be unique. You cannot use the same DNIS for different
bridges. You must use one DNIS per bridge. This number can contain
from 1 to 16 digits and can include the question mark (?) as a wildcard
character. However, if you use wildcard characters if a multiple bridge
environment, ensure that you do not submit an ambiguous entry that
could match several bridges.
Bridge IP The IP address of the Conferencing bridge. This address must be
unique for the configuration.
User Name The user name that is associated with the Conferencing bridge. This
name can contain a maximum of eight alphanumeric characters.
Password The password that is associated with the user name for the
Conferencing bridge. This password can contain a maximum of eight
alphanumeric characters.
Related topics:
Adding the application server on page 496
Editing the application server on page 497
Removing the application server on page 498
Starting and stopping the application server on page 498
Prerequisites
Before you add the application server to the Microsoft adapter, you must install and configure
the Microsoft adapter and the Conferencing server.
The purpose of this task is to make the Microsoft adapter aware of the Conferencing application
server.
Next steps
Now you can configure the Conferencing Plug-in for Microsoft Live Meeting for your users.
Prerequisites
Before you edit the application server on the Microsoft adapter interface, you must add it first.
The purpose of this task is to update the bridge details on the Microsoft adapter. You can edit a
bridge configuration only when the bridge connection is in the NOT CONNECTED state.
Next steps
Now you can configure the Conferencing Plug-in for Microsoft Live Meeting for your users.
Prerequisites
Before you remove the application server on the Microsoft adapter interface, you must add it
first.
The purpose of this task is to delete the bridge details on the Microsoft adapter.
1. Take a note of the bridge details and stop the bridge if it is running.
2. In the treeview pane, click the bridge node that you want to remove.
3. Perform one of the following actions:
• On the main menu, click Conference Bridge > Remove.
• Right-click on the bridge node. On the Context menu, click Remove.
4. On the Remove click OK to remove the bridge configuration.
Next steps
Now you can add a new Conferencing application server (bridge).
Prerequisites
Before start or stop the application server to the Microsoft adapter, you must add it.
The purpose of this task is to start or stop the application server on the Microsoft adapter.
• To start a bridge connection:
a. In the treeview pane, click the bridge node for which you want to start the
connection.
b. Perform one of the following actions:
- On the main menu, click Conference Bridge > Start.
- Right-click the bridge node. On the Context menu, click Start.
If the connection is successful, the bridge node turns green and the Start button is
disabled. If the connection is unsuccessful, the system displays an error message.
• To stop a bridge connection:
a. In the treeview pane, click the bridge node for which you want to start the
connection.
b. Perform one of the following actions:
- On the main menu, click Conference Bridge > Stop.
- Right-click the bridge node. On the Context menu, click Stop.
If you stop the bridge connection, the bridge node is no longer green and the Stop
button is disabled. If active conferences exist on the bridge, the Stop button is
disabled.
Tip:
If you would like your users to perform this task, you can extract these steps using the
Document > Extract Pages feature in Adobe Acrobat Professional.
Prerequisites
Before you configure the settings on each machine, you must install and configure the Microsoft
adapter. You must also set up an on-demand conference on the CRS Front End for each of
your users. For more information on booking these on-demand conferences for your users,
see Operating Avaya Aura™ Conferencing which is available from support.avaya.com. It is a
good idea to distribute the Using Avaya Aura™ Conferencing guide to your users. This guide
describes how to use the Conferencing Plug-in for Microsoft Live Meeting.
You must also have the Microsoft Office Communications Server 2007 R2 installed in the
customer site.
The purpose of this task is to enable the Conferencing Plug-in for Microsoft Live Meeting for
each user.
Next steps
Now it is a good idea to verify the Conferencing functionality in Microsoft Live Meeting.
Related topics:
Configuring JRE on page 502
Configuring .Net on page 503
Installing IIS on page 503
Installing OCS adapter on the server on page 504
Installing OCS adapter on the client on page 504
Configuring JRE
As with the Microsoft adapter, you must configure some Java settings for the successful
operation of the OCS adapter. The Java settings are called the Java Runtime Environment
(JRE).
Prerequisites
Before you configure JRE for the Conferencing Plug-in for Microsoft Office Communicator, you
must install and configure Conferencing and Microsoft Office Communicator.
The purpose of this task is to configure the JRE path for the Conferencing Plug-in for Microsoft
Office Communicator application.
Example
Example JRE path: C\Program Files\Java\Jre1.5.0\bin\client
Next steps
Now you can configure the .NET framework path.
Configuring .Net
You must configure a .NET framework path.
Prerequisites
Before you configure .NET for the Conferencing Plug-in for Microsoft Office Communicator,
you must install and configure Conferencing and Microsoft Office Communicator.
The purpose of this task is to configure the .NET path for the Conferencing Plug-in for Microsoft
Office Communicator application.
Example
Example .NET path: C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727
Next steps
Now you can install Internet information services (IIS).
Installing IIS
Internet Information Services (IIS) - formerly called Internet Information Server - is a web server
application and set of feature extension modules created by Microsoft for use with Microsoft
Windows. Please refer to the Microsoft documentation for information on how to install IIS. The
documentation is available here: http://technet.microsoft.com/en-us/library/ee692294%28WS.
10%29.aspx.
Prerequisites
Before you install IIS for the Conferencing Plug-in for Microsoft Office Communicator, you must
install and configure Conferencing and Microsoft Office Communicator.
The purpose of this task is to install IIS for the Conferencing Plug-in for Microsoft Office
Communicator application.
Next steps
Now you can install the OCS adapter.
Note:
To uninstall the OCS Adapter, use the Add/Remove Programs feature on the
Windows Control Panel.
Next steps
Now you can configure the OCS adapter or install the OCS adapter on each client machine.
to push the files to each of the users in your network. Alternatively, you can notify the users
and provide them with the instructions to install the adapter themselves. The installation steps
are not in the Using Avaya Aura™ Conferencing guide.
Tip:
If you would like your users to perform this task, you can extract these steps using the
Document > Extract Pages feature in Adobe Acrobat Professional.
You must install the OCS adapter on each client machine.
Prerequisites
Before you install the OCS adapter, you must install and configure Conferencing and Microsoft
Office Communicator R2.
The purpose of this task is to install OCS adapter on each end user client machine.
Next steps
You can now configure the OCS adapter.
Related topics:
Configuring OCS adapter on page 506
Configuring IIS on page 507
Setting Description
Next steps
When you complete these steps, you must configure Internet information server (IIS). You must
also configure the Conferencing Plug-in for Microsoft Office Communicator for your users.
Configuring IIS
Prerequisites
Before you configure Internet information services (IIS), you must install it.
1. On the server machine, navigate to Programs > Administrative Tools > Internet
Information Services (IIS) Manager.
2. On the main Internet Information Services (IIS) Manager screen, navigate to
<hostname> > Application Pools.
3. Right-click Application Pools and click Add Application Pool.
4. On the Add Application Pools dialog, enter OCSAdapterAppPool in the Name
field.
5. Select .Net Framework v2.050727 in the .Net Framework Version drop-down list.
6. Select Classic in the Managed Pipeline Mode drop-down list.
7. Click the Start Application Pool Immediately checkbox and click OK.
8. On the main Internet Information Services (IIS) Manager screen, navigate to
<hostname> > Application Pools.
9. Select OCSAdapterAppPool.
10. From the right panel window, select Advanced Settings.
11. Modify the settings as follows:
Options Description
Setting Recommended Value
Limit Interval (minutes) 1440
Identity NetworkService
Idle Time-out (minutes) 14400
Load User Profile False
Disable Recycling for Configuration Changes True
Regular Time Interval (minutes) 14400
12. Right-click Default Web Site and from the right-click menu, click New > Virtual
Directory.
13. On the Add Virtual Directory dialog, enter ocdadapterws in the Alias field, and
click browse to select the Avaya OCS Adapter folder where the OCS Adapter is
installed and click OK.
14. On the main Internet Information Services (IIS) Manager screen, navigate to
Internet Information Services > <hostname> > Sites > Default Web Site to
display the ocsadapterws properties.
15. Right-click on ocsadapterws and from the right-click menu, click Convert to
application to display the ocsadapterws properties.
16. Select OCSAdapterAppPool.
Next steps
When you complete these steps, you must configure the Conferencing Plug-in for Microsoft
Office Communicator for your users.
When operators are creating on-demand conferences for the users, using the CRS Front End,
ensure that they select Security in the General Conference Options dialog. For more
information on booking on-demand conferences for the users, see Operating Avaya Aura™
Related topics:
Attended originator dial out on page 115
Originator dial out on page 127
Moderator lecture mode on page 166
Self-mute on page 167
Accessing Conferencing Manager on page 510
Prerequisites
Before you configure the values in Conferencing Manager, you must install and configure the
other aspects of the OCS integration.
The purpose of this task is to update the default values that are displayed on the Conferencing
Manager administrative interface.
Next steps
Now it is a good idea to verify the operation of the plug-in.
Security considerations
As a system administrator, you should be aware of potential security issues surrounding the
use of passwords between Sametime servers and the Conferencing servers. Avaya
recommends taking a number of precautions to minimize any potential security risks.
Important:
BCAPI is the bridge control application programming interface. It is an object-
oriented, programming interface that is written in Java. Programmers use BCAPI to
write applications that communicate with Conferencing application servers and media
servers.
• If your deployment is entirely within a LAN and does not cross the Internet, there are a
number of safeguards that you can implement.
- Isolate non encrypted information about the LAN by creating a secured network
segment.
- Set up coresident Sametime servers and Conferencing application or media servers.
Related topics:
Encrypting operator passwords on page 515
Prerequisites
Before you encrypt operator passwords on the Sametime server, you must install and configure
the Conferencing Plug-in for IBM Lotus Sametime. Also, before you encrypt operator
passwords, you must configure and test the connectivity between the Sametime server and
the Conferencing application server with a plain text password.
The purpose of this task is to increase the level of security on the Sametime server.
Example
Here is an example of an encrypted password:
63:eb:3b:11:fd:48:8b:30:af:3e:cd:fe:96:98:72:3d:c:d9:fa:90:b3:be:17:38:f7:31:88:74.
It is important to note that repeated invocations of the bridgepassword command with the
same clear text password produces different encrypted forms.
Next steps
Now you can configure the remaining settings for the Conferencing Plug-in for IBM Lotus
Sametime.
Option Description
Status Select 'enabled'.
Mode Select 'on demand'.
Frequency Daily (or 24X7)
Weekend Set to yes.
Option Description
Conference name Provide a conference name.
Moderator code Include a moderator passcode for the conference.
Conferee code Include a conferee passcode for the conference. This code is the
only alphanumeric sequence that uniquely identifies a conference
scheduled on a bridge.
Block dialout The system blocks or allows moderator dial out.
Set to off, which allows the moderator to dial out.
PIN mode Select Conf PIN (conference PIN).
PIN list Use all capital letters to type in the name "ANYPIN."
Music When enabled, the system places the callers on hold and plays
music until an audio conference moderator enters the conference.
However, data-only participants can enter the Web conference
immediately. Set to off.
Start time and end time Set to 12:00 AM.
Security Set to on. This option must be enabled for the Lock Conference
feature to work.
Roll call Yes
Enter Tone & Leaving In the IBM Lotus Sametime environment, the enter and leaving
tones tones are not supported.
(Moderator) Hang up Optional. The settings are:
Off: Conferencing will extend the conference after the last audio
conference moderator hangs up. (Recommended)
On: Conferencing will end the meeting when the last audio
conference moderator hangs up.
Operator help Set to on.
Name record playback In the IBM Lotus Sametime environment, NRP is not supported.
(NRP)
Of all the on-demand conference properties, one property, in particular, is very important. This
is the PIN list property.
On-demand conference profiles must have a PIN list identified as ANYPIN for the Conferencing
system to use PIN codes to match application users with users that enter the conference
automatically.
The ANYPIN list provides the following functionality:
• A caller dials into the Conferencing application server or bridge. The bridge prompts the
caller to enter a passcode and to enter a PIN code.
• If callers enter any passcode along with the pound (#) sign or just the pound sign, the
system places the caller into the conference.
• IBM Lotus Sametime matches the PIN code the caller enters with the PIN codes displayed
in the Sametime interface. Also, IBM Lotus Sametime associates each caller line with a
data conference session. For example, a caller can enter passcode: 9876 and PIN: 5172.
• A moderator can create an association manually between the audio line and data session
of each caller. Specifically, a moderator can select one or more data users and one audio
participant, then right-click and select Associate Users from the submenu. Also, a
moderator can associate users by choosing the Tools > Audio > Associate Users
command from the menu bar.
So, in summary, you must set up your on-demand conferences to use an ANYPIN list. Using
ANYPIN, Conferencing can use PIN codes to match existing Web participants with audio
participants that dial directly into the audio conference server. Conferencing prompts users for
a PIN using the ANYPIN stored procedure and accepts whatever the user enters into the IBM
Lotus Sametime application. Specifically, Conferencing prompts a participant to enter a PIN
into IBM Lotus Sametime. The Conferencing plug-in forwards the PIN to Sametime, which
validates the entry against a list of predefined PINs. If there is a match, Sametime identifies
the phone line as a Sametime login. Conferencing accepts any PIN that callers enter along
with the pound (#) sign or no PIN at all and just the pound sign. Note that no validation occurs on
the audio conference server. Conferencing always places the callers into the conference.
Related topics:
Understanding some terms on page 337
PIN functionality on page 338
Option Description
Status Select 'enabled'.
Mode In the default profile for scheduled conferences, the mode is Unattended.
In an unattended conference, callers dial into the bridge and enter a
passcode to join the conference that is managed by a Moderator. This
mode differs from the Attended mode. In an attended conference, an
operator places callers into the conference and remains available to
conferees and moderators for the duration of the conference.
Conference This is the title of the conference and is an alphanumeric string of less
name than 12 characters.
Moderator code Include a Moderator code for the conference. The user can specify this
code or, if they leave the Moderator Code field blank, Conferencing auto-
generates the code.
Conferee code Include a conferee code for the conference. The user can specify this
code or, if they leave the Conferee Code field blank, Conferencing auto-
generates the code.
Block dialout Conferencing blocks or allows moderator dial out. In the default
conference profile for scheduled conferences, it is set to off, which allows
the moderator to dial out.
PIN mode In the default conference profile for scheduled conferences, it is set to off.
If it is set to System PIN or Conference PIN, participants must enter a
PIN as well as a passcode before joining the conference. System PINs
are stored in a system-wide PIN code database. Conference PINs are
PIN codes from a specified PIN list.
PIN list This field is not enabled in the default conference profile for scheduled
conferences. PIN list stores the name of the Conference PIN file if
Conference PIN is selected from the PIN Mode field. If PIN Mode is set to
on and PIN list is idenfied as ANYPIN, Conferencing can use Sametime
PIN codes to match existing Web participants with audio participants who
dial directly into the audio Conferencing server.
Music The music is set to on. The music source is set to M1. When enabled,
Conferencing places the callers on hold and plays music until a moderator
enters the conference.
Security Set to Off in the default conference profile for scheduled conferences. The
feature, when enabled (On), allows a leader to add a second passcode
using DTMF commands prior to conference start. This feature must also
be enabled for the LOCK CONFERENCE feature to work.
Roll call Set to Off in the default conference profile for scheduled conferences. The
rollcall feature plays annunciator messages that prompt callers to record
their names and other relevant information when dialing into an
unattended or on-demand conference. There are a number of rollcall
settings such as INDVL, CONF, OPER, which correspond to playing the
rollcall to an individual, a conference, or the operator.
Option Description
Enter Tone & Set to Tone for scheduled conferences. Other values include:
Leaving tones Off: Omit tones or voice messages.
System: Use the pre-configured default setting.
Message: Play a voice message.
Tone & Message: Sound a tone and play a voice message.
(Moderator) Set to On for scheduled conferences. This means that Conferencing will
Hang up end the meeting when the last moderator hangs up.
If it is set to Off, Conferencing will extend the conference after the last
moderator hangs up.
Operator help Set to On for scheduled conferences. The Operator Help feature allows
or blocks help requests on a per conference basis.
If it is set to Off, Conferencing plays a user-defined annunciator message,
such as “Operator Assistance is not available” when Moderators or
Participants press *0 or 0.
Auto extend Auto Extend Duration is always set to On for IBM Lotus Sametime users.
duration
For more information on booking scheduled conferences, see Using Avaya Aura™
Conferencing, and Operating Avaya Aura™ Conferencing which are available from
support.avaya.com. It is a good idea to distribute these guides to your users.
Note:
The Avaya e-mail template, which contains all the features for the Conferencing Plug in for
IBM Lotus Notes, is referred to as the Avaya template. The IBM Lotus Notes e-mail template
that your organization currently uses is referred to as your template. Engineers often refer to
the process of adding the Avaya customizations to your template as the merge process.
• The Avaya features are contained in the Avaya template. You must copy the Avaya
template to the IBM Lotus Domino server. You can then use the IBM Lotus Domino
Designer to open the Avaya template. Using IBM Lotus Domino Designer, you can also
open your template. Always open your template from the Domino\Data directory. Avaya
recommends that you save a back-up copy of your template before you begin.
• Every installation of IBM Lotus Notes is different. Depending on how you have configured
the security settings on your network, IBM Lotus Notes may display some security
information dialogs during the merge process. If this is the case, click Yes on these
information dialogs to progress to the next step.
• Many of the steps in the merge process involve copying sections of code from the Avaya
template and pasting them into your template. The relevant Avaya code is always
indicated as follows:
---START AVAYA CODE
<code appears here>
---END AVAYA CODE
In cases where you must copy multiple sections of code, the number of sections is
indicated as follows:
---START AVAYA CODE (Section 1 of 2)
<code appears here>
---END AVAYA CODE (Section 1 of 2)
...
...
...
---START AVAYA CODE (Section 2 of 2)
<code appears here>
---END AVAYA CODE (Section 2 of 2)
• If your template has no customizations, you can simply copy the Avaya template. If you
copy the Avaya template, you can skip many of configuration tasks but you must perform
the following:
- Configure the Click to Call feature
- Enable encryption between the SOAP server and the Notes client
Tip:
Select the option which best fits your deployment and keep the letter (A, B, C, or D) in mind as
you read the configuration steps that follow.
Prerequisites
Before you configure script libraries, you must obtain a copy of the Conferencing Plug in for
IBM Lotus Notes software.
The purpose of this task is twofold. This task involves copying the Avaya script libraries and
making some changes to a number of existing libraries.
As you paste the script libraries, IBM Lotus Notes may display some information
dialogs.
5. Click Yes on any information dialogs.
6. Open the Avaya template and your template.
7. In the Avaya template, navigate to the Shared Code or Code folder and expand
the Script Libraries folder.
8. Using the table as a guide, open each of the script libraries and copy the Avaya
code sections to the currently active mail template. In all cases, the Avaya code is
indicated
Script Library Section
Common [options]
CSExtAppDocSave functions
CSCalendarEntry [declarations] > CalendarEntry class
There is a single block of Avaya code in the onChange
method within the class.
CSUIViewClass viewDragPasteHandler
There are two sub-sections of Avaya code.
CSEventNotes [Options]
There is one section of Avaya code.
[DraftSpecificWork]
There is one section of Avaya code.
[Declarations] > CSEventNotes class
There are blocks of code in each of the following two
methods: The Function
OpenChangeRepeatDialog(nNoCancelOp As
Integar) As Integar method and also the Sub
QueryClose(bContinue As Variant) method.
CSEventsClass [Options]
There is one section of Avaya code.
[Declarations] > CsEvent class
There is a single block of Avaya code in the Sub
CSDocSave (vContinue As Variant) method within the
class.
Next steps
Now, configure the sub forms.
Prerequisites
Before you configure the sub forms, it is a good idea to configure the script libraries.
The purpose of this task is to copy some sub forms from the Avaya template and paste them
into your template.
Next steps
Now, configure the calendar entry form.
Prerequisites
Before you configure the sub forms, it is a good idea to configure the sub forms.
The purpose of this task is to copy some items, such as tabs and buttons from the Avaya
template and paste them into your template.
Tip:
Navigate to this code on the _Calendar Entry form, rather than in the
Programmer’s Pane. It is easier to find in the _Calendar Entry form.
e. Save your template.
5. Copy the action bar and menu.
Once you install the plug-in, the users in your organization will be able to access an
About dialog, a help URL, and their conference log-in details from the Action
toolbar and the Action menu. The following steps enable these menus.
a. Expand the Action bar entries on the right panel by selecting the View menu
and ensuring that the Action Pane item is selected.
b. Select the entry, Conference Call Options.
c. Copy and paste Conference Call Options entry into the Action bar entries
section your template.
d. Save all your changes.
e. Archive/compile your NFT file. At this point, users have access to a limited set of
Conferencing features.
Next steps
Now, configure the database scripts.
Prerequisites
Before you configure the database scripts, it is a good idea to configure the calendar entry form.
The purpose of this task is to copy some database scripts from the Avaya template and paste
them into your template.
Next steps
Now, configure the Click to call feature.
The purpose of this task is to configure the Click to call feature. You must configure the Click
to call feature using the Conferencing Manager interface.
Next steps
Now, enable encryption between the SOAP server and the IBM Lotus Notes client.
Related topics:
Attended originator dial out on page 115
Prerequisites
Before you configure the sub forms, it is a good idea to configure the other aspects of the
solution, such as the Click to call feature.
The purpose of this task is to ensure that SOAP messages between the IBM Lotus Notes client
and the Conferencing application server or bridge are encrypted
SOAP message encryption is now enabled between the IBM Lotus Notes client and
the Conferencing application server.
Next steps
Now, configure logging.
Configuring logging
Note:
Perform this task on the IBM Lotus Domino server. It is required for options A, B, C, and D.
If you are running the IBM Lotus Domino 8.5 server with IBM Lotus Notes 8.5, you must perform
an extra step to ensure that the logging feature operates successfully in your deployment. This
step is not required for deployments that consist of IBM Lotus Domino 8.0.2 with IBM Lotus
Notes 8.0.2.
Prerequisites
Before you configure logging, it is a good idea to configure the other aspects of the solution,
such as enabling encryption between the SOAP server and the IBM Lotus Notes client.
The purpose of this task is to enable an audit trail or log for IBM Lotus 8.5 deployments.
Next steps
Now, update your template for IBM Lotus Notes.
The setup application obtains the Lotus Notes installation path from the System Registry. The
setup application also adds the JavaUserClasses property along with the classpaths of the
jar files to the notes.ini file.
The setup application adds the JavaUserClasses property along with the classpaths because
IBM Lotus Notes does not use the system classpath. Instead it uses the JavaUserClasses
property as a classpath.
You must install these jar files because the SOAP client uses these files and they are not
accessible from within the IBM Lotus Notes database.
Jar file list
The jar files which you need to install are as follows:
• axis.jar
• commons-discovery-0.2.jar
• commons-logging-1.0.4.jar
• jaxrpc.jar
• saaj.jar
• wsdl4j-1.5.1.jar
Initialization file modification
You must also add the following line to the end of the ini file:
JavaUserClasses=<NotesSchedulerPath>/
axis.jar;<NotesSchedulerPath>/
commons-discovery-0.2.jar;<NotesSchedulerPath>/
commons-logging-1.0.4.jar;<NotesSchedulerPath>/
jaxrpc.jar;<NotesSchedulerPath>/
saaj.jar;<NotesSchedulerPath>/
wsdl4j-1.5.1.jar
Note:
<NotesSchedulerPath> represents the path location where the jar files are copied. This task
must be performed manually. The system does not automatically apply these changes.
Prerequisites
Before you use the Avaya e-mail template, you must perform all of the other configuration tasks
that are required for options C and D.
The purpose of this task is to make the Avaya e-mail template available for your client users.
The Avaya e-mail template will replace your existing template. For this reason, ensure that
your existing template has no customizations.
Next steps
Now it is a good idea to verify that the Avaya template features are available for your clients.
The purpose of this task is to make the specific Conferencing features from the Avaya e-mail
template available in your e-mail template. The automatic deployment of the Conferencing
Plug-in for IBM Lotus Notes is only successful if you install it in the default location on the C
drive (C:\Notes_ST). If you install it on the client machines in any other folder location, you
must update the script and set libpath to reference the folder location.
Next steps
For successful roll out, this automatic deployment feature requires permissions, including:
• Profile document access
• Access to the file system
Setting Description
PINs You must enable the PIN code functionality for on-demand
conferences.
Then when you are creating a default on-demand conference for all
of your IBM Lotus Sametime users, ensure that you select
Conference PIN as your PIN Mode and enter the phrase
ANYPIN in the PIN list field.
FLEX DAPI You must ensure that you have a Flexible Digital Auxiliary Port
resources Interface (FDAPI) for each IBM Lotus Sametime server connection.
Operator log ins You must ensure that you have a log in, at operator level, for each
IBM Lotus Sametime server connection.
Lecture You must enable Moderator Lecture Mode.
Setting Description
Self Mute You must enable Self Mute.
Early start minutes You must enable Early Start Minutes.
On demand You must allocate a certain percentage of ports to provide support
conferences for on-demand conferences by setting the On demand percentage
parameter.
Tip:
To identify the current build of the Conferencing Plug-in for IBM Lotus Sametime, open a
browser and enter the following: http://<Host name of IBM Lotus Sametime
server>/sametime/avaya-plugin-version.txt.
To identify the current build of IBM Lotus Sametime, open a browser and enter the following:
http://<Host name of IBM Lotus Sametime server>/sametime/
buildinfo.txt.
To uninstall the Conferencing Plug-in for IBM Lotus Sametime, use the Add/Remove
Programs feature on the Windows operating system.
Related topics:
Sign in users on page 118
Configuring sign ins on page 120
Early start minutes on page 124
On demand percentage on page 128
Flex DAPI configuration on page 148
Moderator lecture mode on page 166
Self-mute on page 167
PIN functionality on page 338
On demand conference considerations on page 516
PIN enablement on page 540
PIN enablement
If you wish to install the Conferencing Plug-in for IBM Lotus Sametime, you must enable PINs.
PINs are identification numbers that are unique to each participant.
You can enable PINs in your deployment, using the Conferencing Manager administration
interface. On the Conferencing Manager interface, navigate to Elements > Conferencing >
Audio Conferencing > Bridge Features > Scheduling and select Pin Code.
Related topics:
Understanding some terms on page 337
Prerequisites
Before you create log ins for IBM Lotus Sametime, you must ensure that you have reserved a
Flex DAPI port for the IBM Lotus Sametime connection.
The purpose of this task is to enable the IBM Lotus Sametime server to connect to the
Conferencing server.
1. Reserve a Flex DAPI port using the Conferencing Manager interface by navigating
to the Elements > Conferencing > Audio Conferencing > System Config >
Miscellaneous > Flex DAPI configuration menu.
2. Create an operator sign in to represent the IBM Lotus Sametime connection to the
Conferencing server using the Conferencing Manager interface by navigating to the
Elements > Conferencing > Audio Conferencing > Bridge Features > Sign In
Users menu.
3. Add the operator log in's to the conference-adapter-configuration.xml file.
Next steps
Now you can enable strong encryption.
Related topics:
Sign in users on page 118
Configuring sign ins on page 120
Flex DAPI configuration on page 148
Operators on page 148
Configuring conference-adapter-configuration.xml on page 544
Prerequisites
Before you enable strong encryption, you must have an operational IBM Lotus Domino server.
The purpose of this task is to enable ACP API to communicate with IBM Lotus Sametime.
Next steps
Now you can make a configuration change on the IBM Lotus Sametime server to increase the
memory to the amount required by the ACP API.
Prerequisites
Before you prepare the IBM Lotus Sametime server, you must have an operational IBM Lotus
Domino server and Sametime server.
The purpose of this task is to increase the memory allocation to enable ACP API to
communicate with IBM Lotus Sametime.
1. On the IBM Lotus Sametime server, click Start > Runand type regedit in the
Open field on the Run dialog.
2. Navigate to My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Lotus
\Sametime\MeetingServer\Services\.
3. In the right hand panel, right-click on the variable VMArguments.
4. From the right-click menu, select Modify.
5. On the Edit String dialog, edit the Value data field as follows:
Change -Xmx128m to -Xmx256m.
-Xmx128m appears at the start of the Value data string.
6. Click OK.
7. Restart the server.
Next steps
Now it is a good idea to take a look at some of the configuration options. Many of the
configuration options are stored in the conference-adapter-configuration.xml file, which is on
the IBM Lotus Domino server in the IBM/Domino/Home/Telephony_ext/MX/Lib folder.
Note:
The Standard Edition of Conferencing does not
support multiple bridges.
dial-plan.xml The dialing plan rules on mapping telephone
numbers dialed by participants to numbers that the
audio server can readily dial.
SametimeDiagnostics_Telephony. The IBM Lotus Sametime telephony logs
properties generated by the Conferencing plug-in.
log4j.properties The BCAPI log verbosity generated by the BCAPI.
Configuring conference-adapter-configuration.xml
Typically, the IBM Lotus Domino server and the IBM Lotus Sametime server are co-resident
on the same machine. The conference-adapter-configuration.xml is located on this machine.
Prerequisites
Before you configure conference-adapter-configuration.xml, you must install the Conferencing
Plug-in for IBM Lotus Sametime.
The purpose of this task is to customize the features and functionality of the Conferencing
Plug-in for IBM Lotus Sametime to match the requirements of your deployment site.
Note:
The default value is 20002 and must rarely be
changed, if ever.
jndi-service- <jndi-service-location>
location The JNDI is used by BCAPI to get a session object to
connect to a conference server. Specifically, this string
contains an IP address and the port number of a server
as shown. Example: jnp://123.45.67.123:1099. This
entry is ignored by other servers.
Client events port <client-events-port>
Entry Value
The IP port on which the IBM Lotus Sametime plug-in
receives bridge events. Example: 5020. The default is
5020 for the first configured bridge. For subsequent
bridges, add one to this number, such as 5021, 5022,
5023.
Note:
The Standard Edition of Conferencing does not
support multiple bridges.
Client state port <client-state-port>
The IP port on which the IBM Lotus Sametime plug-in
receives bridge state updates. Example: 5040. The
default is 5040 for the first configured bridge. For
subsequent bridges, add one to this number, such as
5041, 5042, 5043.
Note:
The Standard Edition of Conferencing does not
support multiple bridges.
SIP support <sip-supported>
A flag for SIP support. Do not change this value. Use:
false
Verify that this value is set to false for this release.
Maximum number <max-conferences>
of supported The maximum number of conferences that the IBM
conferences Lotus Sametime plug-in is allowed to start on the bridge.
This value can be set to any number less than or equal
to the maximum number of conferences that the bridge
can support. Example: 500.
Auxiliary dial-in <auxilliary-dial-in-number>
number An auxiliary dial-in number for the bridge that is used
only for display purposes only. IBM Lotus Sametime
plug-in software never dials the number. There might be
more than one of these numbers for each bridge. This
number must be in an easily readable form. Example:
(123) 555-1212.
Toll dial-in <toll-dial-in-number>
number A toll dial-in number for the bridge that is used only for
display purposes only. IBM Lotus Sametime plug-in
software never dials the number. There might be more
than one of these numbers for each bridge. This number
must be in an easily readable form. Example: (123)
555-1212 or NONE.
Toll-free dial-in <toll-free-dial-in-number>
number A toll-free dial-in number for the bridge that is used only
for display purposes only. IBM Lotus Sametime plug-in
Entry Value
software never dials the number. There might be more
than one of these numbers for each bridge. This number
must be in an easily readable form. Example: (800)
555-1212 or NONE.
Announcement <announcement-mapping>
mapping A mapping of the location of an IBM Lotus Sametime
data user to a recorded bridge announcement. There
might be more than one announcement for each bridge.
Each announcement mapping has the following sub
fields:
<language>: a two-letter ISO code for the language of
the location Example: en for English
<country>: a two-letter ISO code for the country of the
location, for example: Example: US for the United
States
<announcement-number>: the index of the recorded
announcement for the location on the bridge Example:
242
The defaults are listed but the values can be changed
if desired.
The announcement indices must be valid and match the
audio server configuration.
3. Create operator log ins (sign ins) as described in the following table.
The log ins that you create here must be identical to the operator log ins that you
created on the Conferencing application server using the Conferencing Manager
administrator interface.
Entry Description
Operator <operator-login>
login name The operator login name for the plug-in, which must not be
used for any other purpose. Operator names and passwords
must be identical to those defined on the bridge. Example:
gpwr1 or gpwr2.
Operator <operator-password>
password This value can be set to the clear text operator password. The
password can later be encrypted with a command-line utility.
Example: 63:eb:3b:11:fd:48:8b:30:af:3e:cd:fe:
96:98:72:3d:c:d9:fa:90:b3:be:17:38:f7:31:88:74.
The encrypted values display as hexadecimal-encoded
numbers.
Operator <operator-number>
number A number that specifies the channel the plug-in uses to log in
to the bridge. Set this value to:
• A maintenance channel to dedicate the channel for use only
with the plug-in. For example, enter a number between one
Entry Description
Next steps
Now it is a good idea to open the Client Registration Server (CRS) Front End application to
create a CRS client for the IBM Lotus Sametime server and clients for each IBM Lotus
Sametime user.
Related topics:
Sign in users on page 118
Creating log ins for IBM Lotus Sametime on page 541
Entry Description
adaptor-user- When you create a CRS Client for the IBM Lotus Sametime server, you
name must ensure that the E-mail field associated with the CRS Client is identical
to the adaptor-user-name field in the conference-adapter-
configuration.xml file for the IBM Lotus Sametime server.
adaptor- When you create a CRS Client for the IBM Lotus Sametime server, you
password must ensure that the Password field associated with the CRS Client is
identical to the adaptor-password field in the conference-adapter-
configuration.xml file for the IBM Lotus Sametime server.
When you are creating the CRS client for each IBM Lotus Sametime user in your deployment,
the values in the conference-adapter-configuration.xml file are not significant. However, the
name of the CRS client must match the name on the IBM Lotus Sametime account for each
user. For example, if the name on the IBM Lotus Sametime account is John Smith, you must
create a CRS client with the name, John Smith.
When you finish creating the clients on the CRS Front End, restart the IBM Lotus Domino/
Sametime server.
For more information on creating, editing, and deleting clients, see the Operating Avaya Aura™
Conferencing Guide, which is available from support.avaya.com.
Now, it is a good idea to configure the dialing plan.
Acronym Definition
AC Area Code
CC Country Code
IDP International Dialing Prefix
LP Local Prefix
Acronym Definition
LTP Leading Trunk Prefix
NDC National Destination Code
NSN National Significant Number
PBX Private Branch Exchange
PSTN Public Switched Telephone Network
SN Subscriber Number
TAP Trunk Access Prefix
TP Trunk Prefix
The following sections describe specific E.164 conversion cases and provide accompanying
examples. If converting to the E.164 format, administrators must configure IBM Lotus
Sametime and all connecting bridges to interpret and dial incoming E.164 numbers correctly.
The conversion of a dialed number to E.164 format is a two-step process. The IBM Lotus
Sametime dialing plan mechanism must:
• Match an incoming number against a sequence of patterns to determine the originating
location and intended destination of the caller.
• Modify the outgoing-string digits so that the number is fully qualified but does not contain
any dialing prefixes like TP, IDP, or TAP.
The IBM Lotus Sametime installation utility installs a default dial-plan.xml file. The dial-
plan.xml file defines a set of rules for mapping input digit strings to output digit strings. dial-
plan.xml also contains commented-out examples of how to use each mapping rule to achieve
the desired results. In addition, this XML file implements a pass-through policy, for example,
an input number can be returned unchanged.
Note:
The Standard Edition of Conferencing does not support multiple bridges.
Related topics:
Dialing plan mapping rules on page 551
Configuring the dialing plan for campus sites on page 552
Configuring the dialing plan for local cities on page 553
Configuring the dialing plan for local countries on page 554
Configuring the dialing plan for international sites on page 556
Configuring the dialing plan for residential sites on page 556
Mapping incoming dialed numbers to defined bridge numbers on page 557
Mapping Description
Rule
Fixed length Basic format example:
<mapping match="91303XXXXXXX" replace="1303XXXXXXX"/>
This format takes an input string that starts with 91303 and is exactly 12 digits
long. The format produces an output string that starts with 1303 and reduces
the string to 11 digits. In the basic format example, the mapping process
removes the leading number, 9.
Variable Basic format example:
length <mapping match="9011*" replace="*"/>
This format takes an input string that starts with any length <n> that starts
with 9011. The format produces an output string that starts with a string length
of N-4 and removes the leading 9011 digits. In the basic format example, the
mapping process removes the leading number, 9
The dialing plan mechanism processes a sequence of rules for each input number in the dial-
plan.xml. The processing of the rule sequence is in order, from top to bottom, until a match is
found. Once a match is found, the rule output is returned immediately with no further processing
of any subsequent rules.
The rules file in the default dialing plan defines a single rule that matches any input number
and returns the number unchanged. However, the single rule immediately stops further
processing of the dialing plan. To use the single rule, place the rule at the end of the rules file to
terminate processing of dialing plan. Administrators can remove the single rule, if desired. If
the rule is removed, the system sends a failure notification to the caller if no other rules match
the input number.
Technical support representatives can modify the dial-plan.xml file to suit the following
scenarios: Configuring the dialing plan for local campus sites, local cities, local countries,
international sites, and residential sites.
Prerequisites
Before you configure dial-plan.xml, it is a good idea to configure conference-adapter-
configuration.xml.
This example identifies a campus in Lincroft, NJ, USA, with 7-digit abbreviated
dialing.
• CC="353", NDC="1", "SN=207XXXX"
This example identifies a campus in Dublin, Ireland, with 7-digit abbreviated
dialing.
These examples specify the dialing campus locations for Example B, above.
Abbreviated dialing schemes similar to the previous example are often not
coordinated across sites. Therefore, non coordinated sites are likely to trigger
ambiguities if the same IBM Lotus Sametime instance serves multiple sites. The
only solution is to force callers to use longer numbers like 9720444XXXX instead
of XXXX as shown in the previous example.
The local campus switching system must recognize a longer form for local numbers.
If the switching system does not, there is no solution that allows IBM Lotus
Sametime to dial the numbers. As a work around, use another external mechanism,
such as the bridge TUI, which requires the caller to know the dialing plan of the
bridge.
4. Save and close the file.
The changes take effect after the IBM Lotus Sametime server is restarted. The next
number dialed uses the updated mappings.
Prerequisites
Before you configure dial-plan.xml, it is a good idea to configure conference-adapter-
configuration.xml.
Example
Note that these rules are modifiable and, therefore, easily broken. For example, adding
another city with an eight-digit local number starting with 1, 8, or 9 can cause ambiguity in
the rule set. A possible solution is to add more digits but do not overlap the numbering
schemes. For example, the IBM Lotus Sametime dialing plan cannot resolve numbers when
a local number in two different cities are exactly the same.
Prerequisites
Before you configure dial-plan.xml, it is a good idea to configure conference-adapter-
configuration.xml.
Prerequisites
Before you configure dial-plan.xml, it is a good idea to configure conference-adapter-
configuration.xml.
Related topics:
Telephony diagnostic log on page 558
Setting Description
SEVERE (highest value)
WARNING
INFO Default
CONFIG
FINE
FINER Granular
FINEST (lowest value) Very granular, includes log pings. The log verbosity increases.
Related topics:
Setting up the telephony diagnostics logs on page 559
The purpose of this task is to change the log level to match your requirements.
Note:
The default log level for the IBM Lotus Sametime plug-in is INFO.
2. Change the value, INFO, on these two lines to one of the lower log levels, such as
FINEST, and save the file. Within five minutes, the verbosity of the logs increases.
To return the reduce the log levels, return values to INFO and wait another five
minutes. For more information, see http://java.sun.com/j2se/1.4.2/docs/guide/util/
logging/overview.html.
3. Save and close the file.
When the file is saved, the changes take effect within a few minutes.
Next steps
Now, it is a good idea to configure the BCAPI logs.
BCAPI log
The log4j.properties file stores the BCAPI logs for IBM Lotus Sametime. You can configure the
following BCAPI logging settings:
• Standard output
• File output
• JDK 1.4 logging adapter
This table compares the logging levels in the log4j.properties file with the Java logging levels.
The BCAPI log messages are forwarded to the IBM Lotus Sametime plug-in logging utility.
Since the SametimeDiagnostics_Telephony.properties file controls the IBM Lotus Sametime
plug-in logging utility, set the same verbosity levels in both files for the messages to appear in
the logs. For example, the DEBUG-level messages from BCAPI do not appear in the logs if
you set the logging level to DEBUG in log4j.properties and INFO in
SametimeDiagnostics_Telephony.properties.
For more information, see http://logging.apache.org/.
Note:
For more information on the reports that are available for moderators, see the Using Avaya
Aura™ Conferencing Guide, which is available from support.avaya.com. The Web Portal
moderator URL is: http://Web Portal virtual machine IP/webportal/login.
Related topics:
Generating reports on page 562
Generating reports
Prerequisites
In order to produce a meaningful report, you must ensure that some activity takes place on the
Web Portal application.
1. Click Reports.
2. To generate a booking or moderator console report:
a. Click Admin Reports.
b. Select what type of report you want to generate.
c. Select the date that you want the report generation to start from the Start Day
drop down list.
d. Select the date that you want the report generation to end from the End Day
drop down list.
e. Select the chart type.
3. To generate a session load or user session report:
a. Click Session Reports.
b. Select User Sessions for a User Sessions report.
c. Enter the date range for the reports.
d. Select your preferred graph type.
4. Click Generate Report.
Next steps
If you like, you can view the report details in a Microsoft Excel™ spreadsheet. To view the report
in a Microsoft Excel™ spreadsheet, Click Report CSV File, followed by OK and Save.
Section Description
CDR Loader Displays details regarding:
main fields Bridge Name: Displays the name of the bridge.
IPAddress: Displays the bridge’s IP address.
Model: Displays the bridge type. The S70, S700_20, S700_21, S700_31
are currently supported. S700_31 is used by default if no value is displayed.
Enabled: It is recommended that ‘1’ is used.
CDR LastImportDate: Displays the last CDR import date. The loader
recommences from this date.
Bridge IP Address: Displays the IP address of the bridge.
LastBytePos: Displays the last byte position in CDR file on the bridge. This
is used by incremental download and is always 0 on start.
CDR_LocalStore: Displays the name of the CDR Files local directory
storage location.
CDR_RemoteStore: Displays the full path on the bridge where FTP can
find the CDR Files.
Section Description
CODR_LastImportDate: Displays the last CODR import date. The loader
recommences from this date.
CODR_LastBytePos: Displays the last byte position in CODR file on the
bridge. This is used by incremental download and is always 0 on start.
CODR_LocalStore: Displays the name of the CODR Files local directory
storage location.
CODR_RemoteStore: Displays the full path on the bridge where FTP can
find the CODR Files.
CabinetRef: Displays the cabinet reference number.
SynchInterval: Displays the time interval between each download. This
value is in seconds and is configurable.
Main Area Displays the progress details of CDR file creation. Alerts the user to any
fault in connection to the bridge.
Red Text: Displays an alert.
Green Text: Displays a success message.
Blue Text: Displays normal information
Bridge Area Enables the user to set the interval time to check for new information. New
CDR files are created if there is new information available.
Patcher Enables the user to create process files for manually downloaded
Started Area information.
Open Active Enables the user to open a note pad file which displays the log details of
Log the created CDR Files.
Exit Button Enables the user to exit the CDR Loader.
You can start the CDR loader using silent mode. Silent mode starts all the services, for
example, update db process and automatic download process for all specified bridge(s).
CoDR fields
Conferee table
Conference table
Note:
Data conferencing is provided by an application
called Avaya Web Conferencing (AWC).
Conference Viewer tinyint 1/0 – Indicates whether Conference Viewer was
enabled for the conference. (0= Conference Viewer was
not enabled, 1= Conference Viewer was enabled).
Initialization file
The CDR Loader initialization file is called CDRLoader.ini. It contains a number of system
parameters that control CDR Loader functionality. Using CDRLoader.ini, you can configure the
settings that manage:
• The deletion of old data files
• The limitations on the range of communication ports
• The secure file transfer protocol
Related topics:
File management on page 567
Limitations on communciations ports on page 569
Secure file transfer protocol on page 569
File management
Old files, consisting of CDR and CODR information transferred from an application server
(bridge), are deleted automatically so that the folder size does not exceed the available storage
space. Automatic deletion of old files also ensures that system performance never deteriorates
due to the exhaustion of storage space.
You can choose to enable automatic deletion or you can choose not to enable it.
If you do not enable it, you must manually delete old files.
If you enable automatic deletion, the automatic deletion task is triggered every 60 minutes.
The automatic deletion task inspects the contents of each bridge’s local CDR and CODR
directories and deletes all files that are older than a predefined threshold. The automatic
deletion task makes an exception for files with an .imp file extension. These files are considered
to be not yet processed. Usually, the CDR and CODR files loose the .imp extension as they
are imported into the CDRs database but a file may still retain the .imp extension in exceptional
circumstances.
The CDR Loader calculates the age of the file according to the most recent time it was either
created, modified, or “accessed”. "Accessing" means opening a file for reading. So if a file was
opened within the age threshold, the CDR Loader will not delete it, even if it was created or
modified beyond the age threshold.
The CDR Loader Logging screen shows detailed information about the automatic deletion
process.
Related topics:
Managing automatic deletion on page 568
The purpose of this task is to ensure that the CDR and CoDR file sizes do not grow too large.
• To enable automatic deletion:
a. Ensure that PurgeOldFile=1 parameter in the [LocalStore] section of
CDRLoader.ini.
b. Enter a value for DaysToKeepFilesBeforePurge.
DaysToKeepFilesBeforePurge refers to an age threshold in days. If a file is
older than this value, the automatic deletion task deletes it.
• To disable automatic deletion:
Ensure that PurgeOldFile=0 parameter in the [LocalStore] section of
CDRLoader.ini.
Example
For example, if DaysToKeepFilesBeforePurge=30, the CDR Loader automatically
deletes the file if it is older than 30 days.
Next steps
Now you can limit the range of communication ports.
At CDR Loader startup, the CDR Loader performs a SFTP test connection. It attempts to
connect to each bridge using the bridge username and password. If the test is successful, the
CDR Loader uses SFTP for all communication with that bridge. If the test is not successful,
the CDR Loader assumes that the bridge does not support SFTP. In this case, the CDR Loader
uses FTP, without performing an FTP test connection.
If SFTP support is enabled on a bridge while the CDR Loader is running, you must restart the
CDR Loader to enable SFTP because the CDR Loader only performs the SFTP test connection
at CDR Loader startup.
Related topics:
Enabling SFTP on page 570
Enabling SFTP
Prerequisites
Before you enable secure file transfer protocol, it is a good idea to configure CDR and CoDR file
management.
The purpose of this task is to ensure that CoDR and CDR file transfers are secure. By default
SFTP is enabled.
To enter the fully qualified path: Enter the fully qualified path to PSFTP.exe in the
PuttySftpPath parameter in the [LocalStore] section of CDRLoader.ini.
Introduction to upgrading
You can upgrade to the General Availability (GA) version of Avaya Aura™ Conferencing 6.0
Standard Edition from:
• Avaya Meeting Exchange Express version 2.0, Service Pack 1
• The beta version of Avaya Aura™ Conferencing 6.0 Standard Edition
These upgrade paths preserve customer data such as:
• Companies
• Clients (accounts)
• Reservations
• Conferences
If you are a beta customer and require an upgrade from the beta version of Avaya Aura™
Conferencing 6.0 Standard Edition, contact an Avaya Support Representative.
Prerequisites
Before you upgrade to Avaya Aura™ Conferencing, you must have a clean instance of Avaya
Aura™ Conferencing and an instance of Meeting Exchange Express. You also require an
understanding of the functionality and features of Microsoft SQL Server Management Studio™.
The purpose of this task is to move to Avaya Aura™ Conferencing from an instance of Meeting
Exchange Express is version 2.0, Service Pack 1.
1. Access the CRS virtual machine. You can use the remote desktop feature to access
the virtual machine.
a. Click Start > Run.
b. Enter mstsc /console in the Run dialog.
c. In the Computer field, enter the CRS virtual machine IP address.
d. Enter a password.
The password is Avaya123.
2. Create an Open Database Connectivity Data Source Name (ODBC DSN) to access
the Meeting Exchange Express database from the CRS virtual machine.
a. Navigate to Start > Programs > Administrative Tools > Data Sources
(ODBC).
b. On the ODBC Data Source Administrator dialog, click Add.
c. From the list of database types, select PostgreSQL Unicode.
You must select Unicode, rather than ANSI because Conferencing supports
multiple languages.
d. On the PostgreSQL Unicode ODBC Driver (psqlODBC) dialog, enter the
information as follows:
Field Value
Data Source crystaldb
Database crystal
Server <IP address of Meeting Exchange Express server>
User Name postgres
Description <any descriptive information>
SSL Mode disable
Port 5432
Password postgres
Option One: Run a single script Option Two: Run three separate scripts
exec ImportCrystalData 'import' exec ImportCrystalData 'copy'
exec ImportCrystalData 'insert'
exec ImportCrystalData 'reload'
Next steps
Now you can check that the Meeting Exchange Express companies, clients, reservations, and
conferences exist on the Conferencing instance. The easiest way to do this is to open the CRS
Front End and navigate to the Customer Bookings section.
Company fields
ID Field Type Definition
75 Company Ref 9(8) The company reference of this company.
76 Company Name* X(50) The name of this company.
77 Address Line 1 X(50) Company address
78 Address Line 2 X(50) Company address
79 Address Line 3 X(50) Company address
80 Address Line 4 X(50) Company address
81 Phone X(40) Company phone number
Although a phone is required, it is possible to
assign the telephone number in the Import
Profile. If it is not present in the import record or
supplied in the import profile, it defaults to 123.
82 Fax X(40) Company fax number
83 E-mail X(50) Company email address
84 Contact Name X(50) The contact name for this company
85 External ID 9(10) An external id for the company.
87 Import ID* X(50) Uniquely identify the imported record.
88 Disabled 9(1) Disabled field
89/90 ContactFirstName X(50) The ContactFirstName and ContactLastName
ContactLastName fields are combined, with a space in between, to
form a single field, called,
Company.ContactName. Their combined length
is a maximum of 50. There is only one
ContactName field in the Company record, so
the Import Utility allows a choice of entering:
Contact Name (field 84)
ContactFirstName<space>ContactLastName
(fields 89 and 90)
Client fields
ID Field Type Definition
100 Client Ref 9(8) The client reference of this client.
Although a phone is required, it is possible to
assign the telephone number in the Import
Profile. If it is not present in the import record
or supplied in the import profile, it defaults to
123.
101 Company Import ID* 9(8) The company reference of this client. This is a
cross reference to the Company’s Import ID.
For more information, see the previous table.
102 Name* X(50) The name of this client
103 Address 1 X(50) Address line 1
104 Address 2 X(50) Address line 2
105 Address 3 X(50) Address line 3
106 Address 4 X(50) Address line 4
107 Main Phone X(24) Client’s main phone number
108 Main Fax X(24) Client’s main fax number
109 Main Icc X(24) Client’s main credit card number
110 External Id 9(10) Client’s external ID. (foreign database link)
111 Client Main Email X(50) Client’s main contact email
112 Contact Name X(50) Contacts name for the client
113 Contact Address Line 1 X(50) Contacts address
114 Contact Address Line 2 X(50) Contacts address
115 Contact Address Line 3 X(50) Contacts address
116 Contact Address Line 4 X(50) Contacts address
117 Contact Phone X(40) Contacts phone number
118 Contact Fax X(40) Contacts fax number
119 Contact E-Mail X(50) Contacts email address
Conference fields
Related topics:
Conferencing installation on page 39
Configuration of your network in preparation for AWC on page 233
Customizing/Configuring your model on page 406
Audio Console provides moderators with real-time control during conferences, using icons
representing each participant and intuitive buttons for tasks such as mute, inbound call
intercept, dial out, sub conferencing, and recording/playback controls. In the Standard Edition
of Conferencing, the Web Portal cannot reside in a DMZ (as all components of the system
reside on a single server) so it’s recommended for internal use only.
Avaya Web Conferencing
Avaya Web Conferencing enables Web conferencing features that include white boarding,
PowerPoint presentations, video steaming of moderators, and application sharing functionality
using a Web browser. In the Standard Edition of Conferencing, the AWC cannot reside in a
DMZ (as all components of the system reside on a single server) so it’s recommended for
internal use only.
Audio Codes Mediant 2000
This is a TDM to SIP gateway. It is used to integrate Conferencing into a legacy TDM telephony
environment. It supports T1, T1 ISDN, E1 ISDN.
Virtualization
In the Standard Edition of Conferencing, the applications above run as Virtual Machines (VM)
on a single server. Collectively the VMs are known as the Conferencing template.
• You must install System Platform on the server before the template can be applied.
System Platform consists of two components, system domain & console domain.
• As well as CRS, Bridge, Webportal and AWC, there is a virtual machine called
Conferencing Manager which provides a single interface to configure the Conferencing
applications. Consequently, seven sets of networking data (IP address, hostname,
gateway, DNS, NTP) are required for the Conferencing installation. All IPs must be on the
same subnet. Avaya has created the Conferencing Manager virtual machine for use in
deployments where there is no System Manager installed. Avaya has created
Conferencing Manager to manage one and only one Avaya Aura™ Conferencing 6.0
Standard Edition server. Customers who have multiple servers require Avaya Aura™
System Manager 6.0 server to manage multiple Avaya Aura™ products.
Architecture overview
This diagram shows the relationships between the components of Avaya Aura™.
Remote access
This worksheet lists the information that you need to configure remote access for Conferencing.
Remote access is required for all remote Conferencing implementations. This access must be
tested & confirmed as operational by Avaya prior to the start of the system implementation.
# Task Description
# Task Description
# Task Description
Port usage
The following ports are used with the different Avaya products. Depending on your selection,
these ports need to be open as required.
All ports are bi-directional.
Note:
The Standard Edition of Conferencing does not support Bridge Talk.
For remote support use
Miscellaneous notes
For a complete list of the server environmental specifications for your Conferencing
deployment, see the Avaya Aura™ Conferencing Release Notes, which are available from
support.avaya.com.
CRS: Client imports
The application server (bridge), CRS, and Web Portal have the capability to accept scheduling
and user account data through input utilities and tools. This allows customers to export from
an existing system, such as an Avaya 70 or 700 schedules, or from a Human Resources
database. The input requirements vary according to the system to be installed, but a comma
separated value (CSV) file is preferred. Please review the requirements with your Avaya
Support Representative.