Professional Documents
Culture Documents
Issue 3.1.0.1
Abstract
This document provides the configuration details and steps for connecting to and obtaining
more information about your AvayaLive Collaboratory.
Table of Contents
1 Introduction ............................................................................................................................. 5
1.1 Your Welcome Package ................................................................................................... 5
1.2 Getting Support ................................................................................................................ 5
1.3 Reference Configuration .................................................................................................. 6
1.4 Lab Components .............................................................................................................. 8
1.5 Lab Access ....................................................................................................................... 8
2 Configure OpenVPN Client .................................................................................................... 9
2.1 Configure Microsoft Windows Client .............................................................................. 9
2.2 Configure MacOS Client ................................................................................................ 13
2.3 Configure Linux Client .................................................................................................. 18
2.4 Configure iPad Client ..................................................................................................... 23
3 Installing the SMGR CA Certificate ..................................................................................... 34
3.1 Installing the SMGR CA Certificate in Windows .......................................................... 34
3.2 Installing the SMGR CA Certificate in iOS ................................................................... 41
3.3 Installing the SMGR CA Certificate in Mac OS ............................................................ 41
3.4 Installing the SMGR CA Certificate in Android ............................................................ 42
3.5 Installing the SMGR CA Certificate in Firefox ............................................................. 43
4 Install and Configure Avaya Clients ..................................................................................... 44
4.1 Install and Configure Avaya one-X® Communicator for Windows ............................. 45
4.1.1 Install Avaya one-X® Communicator for Windows .............................................. 45
4.1.2 Configure Avaya one-X® Communicator for Windows ........................................ 49
4.2 Install and Configure Avaya one-X® Mobile for iOS ................................................... 58
4.3 Install and Configure Avaya Communicator® for Windows ........................................ 69
4.4 Install and Configure Avaya Communicator® for iOS ................................................. 73
4.5 Install and Configure Avaya Communicator® for Android .......................................... 77
5 Configuring 96x1 SIP Deskphone ........................................................................................ 82
6 Dial plan for Collaboratory ................................................................................................... 85
7 Emergency Services and PSTN Calls ................................................................................... 86
7.1 Emergency Services ....................................................................................................... 86
7.2 Outbound Calls............................................................................................................... 86
7.3 Inbound Calls ................................................................................................................. 86
8 Developing inside the Collaboratory .................................................................................... 92
Page 2
8.1 Getting Started with SDK .............................................................................................. 92
8.2 Configuring Host Names On Your Development Environment PC .............................. 92
8.3 Deploying and Running EDP Services .......................................................................... 92
8.4 Clickatell Connector ....................................................................................................... 93
8.5 Email Connector............................................................................................................. 94
8.6 Scopia Connector ........................................................................................................... 95
8.7 AAMS and Media Control API...................................................................................... 96
8.8 Engagement Designer Access ........................................................................................ 97
8.8.1 SMS Broadcast WFD .............................................................................................. 98
8.8.1 Email Broadcast WFD ............................................................................................ 99
8.8.2 Dynamic Team Formation WFD .......................................................................... 100
8.8.3 Basic Inbound Call WFD ...................................................................................... 101
8.8.4 Basic Inbound Call with Relaxed Attributes WFD............................................... 102
8.8.5 Retrieve Context WFD ......................................................................................... 103
8.8.6 Save Context WFD ............................................................................................... 104
8.8.7 Request and Conference Knowledge Worker Based on Speech Search WFD ..... 105
8.9 Make a WebRTC Call .................................................................................................. 107
8.10 Real-Time Speech..................................................................................................... 110
8.11 Context Store ............................................................................................................ 110
8.12 Engagement Call Control ......................................................................................... 110
8.13 Work Assignment ..................................................................................................... 110
8.14 Presence Snap-in....................................................................................................... 110
9 Avaya Scopia video conferencing ...................................................................................... 111
9.1 Schedule a Meeting ...................................................................................................... 111
9.2 Join a Meeting .............................................................................................................. 116
9.2.1 No Client (audio only) .......................................................................................... 116
9.2.2 Scopia Conference Client ..................................................................................... 116
9.2.3 Scopia Mobile App ............................................................................................... 121
10 Troubleshooting .................................................................................................................. 131
10.1 Verifying data replication ......................................................................................... 131
10.2 Tracing SIP calls ....................................................................................................... 131
11 Additional References ......................................................................................................... 132
Page 3
Page 4
1 Introduction
This document provides the configuration details and steps for connecting to and using the
AvayaLive Collaboratory.
Collaboratory provides an environment where application developers can learn about Avaya
Aura® Engagement Development Platform and the services it provides, and develop applications
using those services. While Collaboratory provides all the services available in Engagement
Development Platform, it does not allow application developers to test performance, scalability
and the full range of redundancy capabilities of the Avaya Aura® infrastructure.
You can use OpenVPN to access your lab and get full access to its local subnet. If your lab has
ASBCE installed, you may also access it from the public internet, but with slightly less
functionality.
Your welcome email from AvayaLive will point you to a customized Welcome Page from which
you can download this document and a CustomerAccess.csv file giving you:
1. The OpenVPN username and password you can use to connect into your Collaboratory. The
steps to do this are described in Section 2 below.
2. A link to Customer User Documentation under the Documentation page on the AvayaLive or a
URL containing this documentation. This page includes information and software you need for
using and configuring your Collaboratory. The URL is in one of the following forms:
http://CMIPaddr:8400 for access from the VPN
http://devNNN.collaboratory.avaya.com if your lab has ASBCE configured for direct
access from the intern (where NNN is your lab number including any leading zeros)
Page 5
f. Search for the product: AvayaLive Collaboratory. Your account will have AvayaLive
Collaboratory associated with it based upon your approved purchase through the
AvayaLive portal.
g. Complete the rest of the request.
We encourage you to refer to this document and ensure that you have correctly configured your
systems for access to Collaboratory before submitting technical support tickets for connectivity
issues.
It is assumed that the user is familiar with the Avaya Aura® infrastructure and Engagement
Development Environment. More detailed information about the Avaya Aura® infrastructure can
be found in Section 11. The various servers in the lab are:
System Manager (SMGR) – This server is the provisioning and configuration system for
the lab. You use it to install, configure and deploy applications you develop for
Engagement Development Platform. The majority of the configuration of the lab is
already done you, but you will need SMGR to configure any custom EDP snap-ins you
develop.
Engagement Development Platform (CE-1, CE-2, aka EDPa and EDPb) – Two EDP
instances are provided to support creation of Engagement Development Platform clusters.
CE1/EDPa is preconfigured with typical UC applications. CE2/EDPb is preconfigured
with typical CC applications.
Session Manager (SM) – This SIP proxy is responsible for SIP registrations and operates
as a SIP proxy between various components.
Communication Manager (CM) – Provides H.323, and SIP endpoints sequenced with
CM.
Page 6
Avaya Media Server (AMS) – Shared instance for Engagement Development Platform
and CM.
Avaya Development Server – Contains information and software you need for using and
configuring your Collaboratory
There are also some shared (common) servers in the environment that are used by all of the
Collaboratory labs hosted in the environment. This common equipment supports PSTN calling,
email, and Scopia video services.
Collaboratory Stack
Avaya One-X
WebRTC Avaya Collaboration Communicator, SIP & H.323
Access CE SDK JavaScript Designer Desk Phones
Subscriber
Environment
.
VCenter and
Hypervisors
Networks, Servers,
Firewalls, Physical
Environment
Figure 1: Collaboratory
Page 7
1.4 Lab Components
Login information and IP addresses for Collaboratory access are located in the spreadsheet
(CustomerAccess.csv) located on the website for your lab. The welcome email has the URL for
your lab, where you can get everything you need during your time on Collaboratory.
Note: SSH:, WEB: etc. is not part of the login credentials, rather they describe the connection
methodology.
Each lab may be accessed through up to 10 individual SSL VPN tunnels. A tunnel may be
established for each server, PC or telephone used in the lab. Once the tunnel is established, you
will have access to various Avaya Aura® components in the lab through SSH or HTTP access.
Additionally 10 more IPSec Tunnels are allowed for supporting H.323 using the Avaya 9600
Series Desk phones.
Depending on configuration, you may also access your lab directly from the internet, or from
your internal network through your firewall to the internet. Direct lab access is provided by an
Avaya Session Border Controller for Enterprise (ASBCE), if this was requested when your
Collaboratory access was purchased. ASBCE is configured to support SIP-TLS, RTPS, HTTPS,
and XMPP. It does not support H.323.
When ASBCE is used, you must install the Avaya SMGR CA certificate in the trust store for
various clients and browsers, as described in section 3.
Customers wishing to test with H.323 based clients must use VPN access.
Page 8
2 Configure OpenVPN Client
If you wish to use a VPN client to access your Collaboratory lab, or if your lab is not configured
with Avaya Session Border Controller for Enterprise (ASBCE), you must install and configure
OpenVPN or equivalent for your operating system.
Even if your Collaboratory lab is configured with ASBCE access, you may still use a VPN to
access the lab. You may wish to do so in order to test H.323 client access to your application,
which is not supported in the Collaboratory ASBCE configuration.
This section describes the configuration for the OpenVPN Client for various operating systems.
Please be sure to use the section for the operating system you are using.
1. Go to https://openvpn.net/index.php/open-source/downloads.html.
2. Select appropriate link to download the Windows Installer.
3. Install the OpenVPN client. Select all defaults. (If prompted to install tap driver for
windows, accept and allow the driver to be installed.)
Page 9
4. After the installation is complete, uncheck Show Readme, check Start OpenVPN GUI
and click Finish. The OpenVPN GUI client will be loaded in the system tray.
Page
10
5. When starting the OpenVPN client after the initial install make sure to do so with the
“Run as Administrator” option.
6. Copy the labNNN_vpn.ovpn file from AvayaLive/Collaboratory Download page (link
available in Welcome email) to C:\Program Files\OpenVPN\config directory -
Screenshot not shown.
7. From the System Tray right-click the OpenVPN GUI Icon and click Connect.
Page
11
8. Enter Use name and Password to gain access to Collaboratory.
Page
12
9. From System tray verify OpenVPN GUI Icon is green and mouse over icon to verify
configuration.
10.
Page
13
4. When the Tunnelblick window opens double-click the Tunnelblick icon. If prompted
select Open to allow the installation to begin (not shown). If prompted enter the
administrator’s credentials (not shown) and the installation should begin.
Page
14
7. From the “Which Type of Configuration Do You Have?” window, click OpenVPN
Configuration(s).
Page
15
8. “An Empty Tunnelblick VPN Configuration Has Been Created” window should be
displayed. Follow the instructions given in this window. Once completed, click Done.
Page
16
12. Click OK to complete the installation.
13. In order to connect the VPN tunnel. Click the Tunnelblick icon located at the top right of
the screen (not shown). From the menu click the desired VPN.
15. Verify connection by mousing over the Tunnelblick icon at the top right of the screen.
Page
17
2.3 Configure Linux Client
1. Verify OpenVPN version. This configuration was tested with OpenVPN 2.2.1.
Page
18
2. Create directory to store labNNN_vpn.ovpn file which is on AvayaLive/Collaboratory Download
page; link is in the welcome email.
Page
19
3. Change directories to the newly created directory.
4. Start the OpenVPN client and log in using the VPN credentials.
Page
20
Page
21
5. The VPN client connection window must remain open. Use Ctrl-c to end the VPN
session.
Page
22
2.4 Configure iPad Client
Page
23
2. Click Install APP.
Page
24
4. The ovpn file should now be visible in the folder.
Page
25
5. Connect the iPad to the PC for use with iTunes.
Page
26
6. From iTunes, go to Apps then highlight the OpenVPN app. Click the Add button to
upload the VPN files to the iPad.
Page
27
7. Click the Add button, browse to the VPN files and select the ovpn file to upload to the
iPad.
Page
28
8. Click the Sync button to upload the files.
Page
29
9. From the iPad select OpenVPN to start the session. One new OpenVPN profile should be
available for import. Select the green plus sign to import the profile.
Page
30
10. Provide the VPN credentials and select the Connection button to login.
Page
31
11. Select Yes to allow the connection.
Page
32
12. Status should now show connected.
Page
33
3 Installing the SMGR CA Certificate
This section is applicable only if your Collaboratory lab is configured for direct access from the
Internet via Avaya SBC for Enterprise. If you only use VPN access to Collaboratory, you may
skip this entire section.
In order to access the Avaya servers in your Collaboratory lab over secure connections, your
clients and browsers must trust the identity certificates provided for each server. These
certificates are signed by the Avaya System Manager Certificate Authority (SMGR CA) installed
in your lab. You must configure your clients and browsers to trust the SMGR CA. This is done
by installing the SMGR CA certificate in the trust store of any OS you are using. If using Firefox
to connect to SMGR or any other web server, you must also install the same certificate
separately in Firefox’s trust store.
In Collaboratory, all secure connections to a given server use the same server identity certificate.
This is different from a typical Avaya system in which an Avaya client may require trusting
many different CAs – for example, an Avaya root CA cert, and SIP cert and a Presence cert. In
Collaboratory, only a single CA certificate is required.
The SMGR CA certificate is installed by accessing your Collaboratory DEV server as described
below.
To install the certificate on a Windows device, follow these instructions using Internet Explorer
or Google Chrome. Do not use Firefox.
This will install the certificate for browser access (except Firefox), and Avaya Windows client
access.
Note: In the following steps, screenshots show use of Internet Explorer on Windows. Similar
operations in other browsers may be used instead.
Click the certificate install link for Windows. You will be presented with a dialog to select Open
or Save:
Click Open
Page
34
You will be presented with the “Certificate” dialog, showing the certificate details:
Page
35
This displays the Certificate Import Wizard.
Page
36
You will need to select a location to Store the Certificate.
Click on “Place all certificates in the following store” and click “Browse”
Click OK
Page
37
Confirmation window showing your selection:
Page
38
Click Finish
Page
39
You will receive a warning about an unverified thumbprint. This is expected as Windows has
never seen this CA certificate before:
Page
40
3.2 Installing the SMGR CA Certificate in iOS
To install the certificate on an iOS device, follow these instructions using Safari. Do not use
Firefox.
This will install the certificate for browser access (except Firefox), and Avaya iOS client access.
This will bring up the iOS “Install Profile” app to install the certificate. Steps:
Tap Install
If prompted, enter your passcode – This is the passcode used to open your iPhone when locked
Tap Install again in the subsequent popups if prompted: You may get a Root Certificate warning
and an Unverified Profile warning.
The certificate is now trusted. Click Done on the Profile Installed screen.
You will automatically be brought back to the dev website where you can now access the secure
page without any certificate warnings.
To install the certificate on a Mac, follow these instructions using Google Chrome. Do not use
Firefox.
This will install the certificate for browser access (except Firefox), and Avaya Mac client access.
Keychain Access will open. If it doesn’t, locate the smgrca.crt file in the Chrome downloads
folder, and click on it.
Steps:
Keychain Access asks whether or not you want the computer to trust certificates from this CA in
the future. Expand the Trust section and choose "Always Trust" for both "X.509 Basic Policy" and
the "When using this certificate" pull-down.
Finally, click the "Always Trust" button. Provide the administrator password and the System
keychain will be updated.
Page
41
3.4 Installing the SMGR CA Certificate in Android
To install the certificate on an Android device, follow these instructions using Google Chrome.
Do not use Firefox.
This will install the certificate for browser access (except Firefox), and Avaya Android client
access.
This will bring up the Android app to install the certificate. Steps:
Enter the certificate name: “Collaboratory SMGR CA” and press OK.
If prompted for credential use, select “VPN and apps”.
Click OK.
You will automatically be brought back to the website
Page
42
3.5 Installing the SMGR CA Certificate in Firefox
Click the certificate install link for Firefox. You will be presented with the following dialog:
Page
43
4 Install and Configure Avaya Clients
You can use Avaya one-X® Communicator or Avaya Communicator as an endpoint for the
purposes of testing with this lab. If you have an Avaya SSO login to the www.avaya.com/support
portal and entitlements to download Avaya one-X® Communicator, the application can be
downloaded from that portal. The download is also available on your lab’s website. See chapter
2 for more information on where to find the URL for your lab.
To access the software from the www.avaya.com/support portal, click the DOWNLOADS &
DOCUMENTS link at the top. Under Enter Your Product Here, enter “Avaya one-X
Communicator”. From the Choose Release drop down select the top choice which is the latest
release. Select the Downloads option and click Enter. Click the link for the latest Avaya one-
X® Communicator or Avaya Communicator release. At the bottom of that page click on the zip
file for the version you want to download.
Or you can also download the client s/w load from your lab wiki site. Your lab wiki is available
at either http://CMIPaddr:8400 OR http://devNNN.collaboratory.avaya.com, depending on
whether your lab has ASBCE installed or not. From there, access the Secure Site, then select
Resources, Documents and Software / Client/Softphone Software. NNN is your lab number
(e.g. if you are assigned lab005 then NNN is 005)
Extensions have been setup for you on System Manager. Please see Chapter 5 for more
information on the dial plan. The IP address of Session Manager and Communication Manager is
located in the CustomerAccess spreadsheet located on your labs website. Log your chosen
endpoint into the extensions setup on the system (H.323 2100-2109, or SIP 2300-2309),
password 123456.
The PCs running the Avaya one-X® Communicator or Avaya Communicator will need to have
either the OpenVPN software installed and running, or your lab’s SMGR CA certificate installed
before Avaya one-X® Communicator or Avaya Communicator can connect to the Session
Manager or Communication Manager during a Collaboratory session. To install and configure
OpenVPN, see Section 2. To install the SMGR CA certificate, see section 3.
Page
44
4.1 Install and Configure Avaya one-X® Communicator for Windows
Once Avaya one-X Communicator software executable has been downloaded and unzipped use
the following steps to install.
Once Avaya one-X Communicator has been downloaded and unzipped use the following steps to
install:
Page
45
3. Select Setup Type Complete and click next.
4. Select the destination folder and click on install. It will prompt you to close the outlook if it’s
running.
Page
46
5. If installation is successful then click on finish.
Page
47
Page
48
4.1.2 Configure Avaya one-X® Communicator for Windows
Make sure Avaya one-X® Communicator has been installed. See Section 4.1.1 for instructions
on installing.
Page
49
3. Once SIP is selected and Avaya one-X® Communicator has been restarted (if needed),
enter an extension that is setup in System Manager (2300-2309). Also, enter the password
of 123456. The domain should be set to collaboratory.avaya.com. Check Enable Video
Calls if desired.
Page
50
4. Next, click the Add button under the Server List text box. This is where you enter the Session
Manager address. If you access Collaboratory from OpenVPN, use the Session Manager SM
Secure IP address shown in the LabNNN_UserAccess.csv file available from your AvayaLive
account. If you access Collaboratory via ASBCE, use the following address, replacing NNN with
your lab number: “smNNN.collaboratory.avaya.com”. Set the Transport Type of TLS. Set the
Port to 5061 and click OK.
Page
51
5. Click on “IM and Presence” under General Settings / Accounts. Check the "Enable
Instant Messaging and Presence" box. Configure the Server field as follows
a. If using OpenVPN access, put the CE1 internal IP address
b. If using ASBCE, put “edpaNNN.collaboratory.avaya.com”, and substitute NNN
with your lab number including leading zeros.
Set the Domain field to “presence.collaboratory.avaya.com”.
For example, the screenshot below shows the configuration required for IM & Presence
in Lab013 when using ASBCE access:
Page
52
6. Now, back at the main Settings form click OK at the bottom. This should take you to the
Login screen with the Extension and Password already populated.
8. Once logged in, you should see the Avaya one-X® Communicator reflects the SIP URI
on the extension you just logged in. You should also see your Presence icon.
Repeat the above steps to register multiple endpoints. You must use a different PC with an
connection to login another Avaya one-X Communicator endpoint.
Tip: if you want to test with more than one client on a single PC, use Avaya Communicator and
Avaya one-X Communicator. Ensure Avaya Communicator is started before Avaya one-X
Communicator. See the next section for instructions on installing and configuring Avaya
Communicator for Windows.
Page
53
4.1.2.2 Configure Avaya one-X® Communicator for H.323
Tip: H.323 is supported in Collaboratory only through Open VPN access. It is not possible at this
time to configure Avaya one-X Communicator for H.323 access over ASBCE in Collaboratory.
Make sure Avaya one-X Communicator has been installed. See Section 4.1.1 for instructions on
installing.
Page
54
11. Once H.323 is selected and one-X Communicator has been restarted (if needed), enter an
extension that is provisioned in Communication Manager (2100-2109). Also, enter the
password of 123456. Check Enable Video Calls if desired.
12. Next, click the Add button under the Server List text box. This is where you enter the CM
IP. Refer to the spreadsheet attached to your welcome email, Click OK.
Page
55
13. Click on “IM and Presence” under General Settings / Accounts. Check the "Enable
Instant Messaging and Presence" box. Configure the Server field with the CE1 internal IP
address. Set the Domain field to “presence.collaboratory.avaya.com”. Ensure the button
“Manually specify my IM login information” is selected, then put your extension in the
“IM username” field. Put password 123456 in the IM password field.
Page
56
14. Now, back at the main Settings form click OK at the bottom. This should take you to the
Login screen with the extension and password already populated.
Repeat the above steps to register multiple endpoints. You must use a different PC with an
OpenVPN connection to login another endpoint.
Tip: if you want to test with more than one client on a single PC, use Avaya Communicator and
Avaya one-X Communicator. Ensure Avaya Communicator is started before Avaya one-X
Communicator. See the next section for instructions on installing and configuring Avaya
Communicator for Windows.
Page
57
4.2 Install and Configure Avaya one-X® Mobile for iOS
Follow these steps to install and configure Avaya one-X® Mobile SIP 6.2 for iPad:
1. From iPad go to the App Store and locate Avaya one-X® Mobile SIP 6.2. Select iPhone
Apps after searching.
Page
58
2. Install Avaya one-X® Mobile SIP 6.2. This step will require an apple id to login to the
App Store.
Page
59
3. In order to configure it, Launch Avaya one-X® Mobile SIP 6.2. Select OK or Don’t
Allow to continue.
Page
60
4. Read and accept the license agreement.
Page
61
5. Select Enter SIP Setup.
Page
62
6. Enter Extension and Password. Select Next to continue.
Page
63
7. Enter Domain and Session Manager’s IP Address. Select Next to continue.
Page
64
8. Select Next to continue.
Page
65
9. Select Finish Setup.
Page
66
10. Review the settings and select done.
Page
67
11. Once the verification is complete the Avaya one-X® Mobile SIP should launch a dial pad
with the extension displayed in the top left corner.
Page
68
4.3 Install and Configure Avaya Communicator® for Windows
1. Download the Avaya Communicator® for Windows, and then Click on Next.
3. Choose the folder where the Avaya Communicator needs to be installed, and then click on
Next.
4. Click Install
Page
69
5. Click on Finish. Installation is complete.
Page
70
3. Select Other Settings
Page
71
For example, here is the configuration for Lab013 for access using ASBCE:
5 Click on “Not Logged In” Then Enter the extension number and password (123456).
Page
72
Click the right arrow to log in.
You are now logged in and should see your Presence icon.
1. Download and install latest Avaya Communicator® for iOS from AppStore
Page
73
3. Choose I will manually configure Communicator
Page
74
5. Now enter the Phone Server Address (SM IP address if using VPN access, SM FQDN in the form
smNNN.collaboratory.avaya.com if using ASBCE access), port number (5061), Domain name
(collaboratory.avaya.com), extension number (2300-2309, not shown as such in screen shot
below) and the password (123456). Then click done.
6 Once logged in you should see the Communicator reflect the extension you just logged in.
Page
75
Page
76
4.5 Install and Configure Avaya Communicator® for Android
1. Download and install the latest Avaya Communicator® for Android software from Google Play store
Page
77
3. Click OK
Page
78
4. Click on Configure manually
Page
79
6. Click VoIP Account Information
Page
80
7. Enter the Extension number (2300-2309, not shown as such in screen shot below), password
(123456), Domain (collaboratory.avaya.com), Server (SM IP address if using VPN access, SM FQDN
in the form smNNN.collaboratory.avaya.com if using ASBCE access) , and port (5061)
Select the Secure Connection checkbox, and then click on login
Page
81
5 Configuring 96x1 SIP Deskphone
1) Clear the phone setting by pressing MUTE C R A F T # (2 7 2 3 8 #) and go to CLEAR
settings. The phone will restart after this.
2) Once phone reboots enter MUTE C R A F T # (2 7 2 3 8 #) and select addr from menu.
3) Check if you have DHCP option and if you do then set DHCP to yes, else enter the IP,
Router and mask values.
Page
82
5) Select Group and set it to 0.
Page
83
Now the Phone will pull the required settings file from HTTP file server and will add the SIP
settings in it.
7) Enter the username (2300 to 2309) and password (123456). This will register the station to
SM in lab.
Page
84
6 Dial plan for Collaboratory
The Collaboratory Lab is configured with 10 SIP endpoints (2300-2309), which sequence in
Avaya Aura® Communication Manager. There are also 10 H.323 stations (2100-2109)
provisioned on Communication Manager. Calls can be placed between these extensions by
dialing the four digit extensions from any registered phone. However, this is not a supported call
flow for sequencing Collaboration Environment services.
For using these extensions with Collaboration Environment applications see Section 8.
Page
85
7 Emergency Services and PSTN Calls
7.1 Emergency Services
While Collaboratory enables specific whitelisted test calls to be passed to the Public Switched
Telephone Network (PSTN), Collaboratory blocks accessing emergency access services such as
911, 311, etc.
Do not attempt to utilize Collaboratory connected endpoints or trunks to initiate such calls.
Users who are encountering medical emergencies requiring accurate, timely response from
public safety officials must use standard corporate or private communication facilities.
Furthermore, applications that require or utilize such services should not consider Collaboratory
to be sufficient for development or prototyping usage.
Note, when dialing a PSTN number, you must dial “9” first, followed by the country code and
the complete number.
Your lab supports up to two (2) simultaneous PSTN calls (inbound and/or outbound). Calling
patterns are monitored for misuse. Calls may be blocked if they are deemed excessive in
duration, or frequency. The facilities are intended to be used for short duration test calls.
The following steps may be taken to change the extension mapped to a DID number. Use the
CustomerAccess spreadsheet located on the labs information website (location in welcome
email) whenever credentials are needed.
Page
86
Click on Routing.
Page
87
Click on Adaptations, and then DID.
Page
88
Under “Digit Conversion for Incoming Calls to SM”, enter an extension number that is
administered locally on the system (e.g. 2100-2109 for H.323, 2300-2309 for SIP) for
Insert Digits. Under “Digit Conversion for Outgoing Calls from SM”, enter the same
number for Matching Pattern (note, this step is not needed for the Scopia auto-attendant
extension since the auto-attendant will not be used to place outbound calls). Click
Commit.
Page
89
Page
90
Page
91
8 Developing inside the Collaboratory
8.1 Getting Started with SDK
Now that you have access to Collaboratory, you are ready to begin developing services on
Engagement Development Platform. To develop EDP services, you should have some
knowledge of Java. As a pre-requisite, the following tools should be downloaded and installed
onto your development environment PC:
The /etc/hosts file is found in different places on the different operating systems:
Windows: C:\Windows\System32\drivers\etc\hosts
MAC OS X: /etc/hosts
Linux: /etc/hosts
This file is normally writeable only by an Administrator or root account, so you will want to run
the editor (notepad for Windows or vi for MAC OS X and Linux from a terminal window) as the
proper user. Add lines of the following pattern to the /etc/hosts file:
10.130.xxx.aaa smgr1.collaboratoryNNN.avaya.com
10.130.xxx.aaa ce1sec.collaboratoryNNN.avaya.com
10.130.xxx.aaa ce2sec.collaboratoryNNN.avaya.com
Where NNN is the Collaboratory Number given to you in your welcome package and xxx.aaa is
the respective IP address in the server IP address spreadsheet provided.
Page
92
1. System Manager – Logon to System Manager web console for your Collaboratory then navigate
to Engagement Development Platform Service Management Select Load and specify your
service Select your service and Install.
2. Another method is to copy the service .svar file onto each Engagement Development Platform
server instances and execute
deploy_service <service-name>
NOTE: If you make changes to properties.xml file contained within svar, the service must be
deployed via System Manager.
The instructions specified above are general instructions. Once service has been installed, a
Service Profile needs to be associated and assigned to a user. Please see How to Install,
Configure and Test an Avaya Aura® Engagement Development Platform Service video
tutorials and documentation located on DevConnect Portal.
Page
93
8.5 Email Connector
The Email Connector on Engagement Development Platform provides a proxy API which can
communicate with an Email Server of your choice. Once the Email Connector has been
configured, the APIs from Engagement Development Platform SDK can be invoked to send
emails. The Email Connector can be configured from attribute settings. Click Configuration on
left menu and select Attributes. From the dropdown select EmailConnector service. Here we
see a list of attributes whose default can be overridden by checking ‘Override Default’ and
specifying a value. You may use Email server settings provided by Collaboratory or you may use
your own Email Server settings.
If you choose to use the Email server settings provided by Collaboratory, please note that, ALL
outbound emails from Collaboratory is by whitelist only. You must request a list of specific
email addresses or domains to be allowed. You must request and receive permission from these
parties to receive Collaboratory email. All other email destinations will be blocked. To have
outbound email services configured for your environment, please submit a DevConnect
Technical Support request with the desired email addresses and/or domains that you wish to use
for testing. See the Support Section 1.2 for information on how to submit DevConnect Technical
Support requests.
You should also note that while using the Email services provided by Collaboratory, you will be
able to send emails to a maximum of 15 recipients in 5 minutes duration at any point. Once the
limit is reached, any additional emails will be rejected by the Email server and will not be
queued for processing for 5 minutes.
Page
94
8.6 Scopia Connector
The Scopia Connector on Engagement Development Platform provides a proxy API which can
communicate with a Scopia Server. Once the Scopia Connector has been configured, the APIs
from Engagement Development Platform SDK can be invoked to schedule Scopia conferences.
The Scopia Connector can be configured from attribute settings. Click Configuration on the left
menu and select Attributes. From the dropdown select ScopiaConnector service. Here we see
the list of attributes whose default can be overridden by checking ‘Override Default’ and
specifying a value. You may use Scopia server settings provided by Collaboratory or you may
use your own Scopia server settings.
Page
95
8.7 AAMS and Media Control API
The Engagement Development Platform SDK API provides methods for Media Control
capability. Before the Media Control API can be invoked, Avaya Aura Media Server (AAMS)
must be setup and configured. For your Collaboratory, an AAMS instance has been already setup
and configured with Engagement Development Platform. Please refer to Lab Equipment Details
for information on AAMS.
If you would like to use your own .wav file(s) for use with Media API, you will need to upload
the audio file using one of these methods
Upload via AAMS Element Manager: Navigate to AAMS Element Manager link provided
in Lab Equipment Details and login using provided credentials. From left menu bar,
navigate to Tools Media Management. Here you may choose to create a new Context
Store / Namespace or use existing and upload wav file. When you call on Media API, you
will need to formulate URI as follows:
cstore://<wav-file-name>?ns=<namespace>&cg=<content-group>
Upload via AAMS SCP: Using SCP tool such as WinSCP, connect to AAMS server using
SSH credentials provided in Lab Equipment Details. Once connected, you may place wav
file on AAMS server and reference the path when invoking Media API.
Page
96
8.8 Engagement Designer Access
Collaboratory comes with Engagement Designer pre-installed. To learn more about this
powerful service and workflow design and execution tool go here:
http://www.devconnectprogram.com/site/global/products_resources/engagement_development_p
latform/avaya_snap_ins/engagement_designer/overview/index.gsp
Page
97
Your Collaboratory comes with some canned sample Work Flow Definitions that you can use to
build your own work flow definitions.
You can access them by clicking on ‘Open Workflow’ in the top menu bar.
Page
98
8.8.1 Email Broadcast WFD
Page
99
8.8.2 Dynamic Team Formation WFD
DB tasks are used to simulate the Context Store and Work Assignment tasks.
Page
100
8.8.3 Basic Inbound Call WFD
Snapshot:
Page
101
8.8.4 Basic Inbound Call with Relaxed Attributes WFD
Snapshot:
Page
102
8.8.5 Retrieve Context WFD
The main process consists of Create Process task and Email task. The Create process task calls
for the sub process task which is a Read From DB task, that fetches the value of recipient to be
emailed from the table in the database on the basis of ID entered in the payload. As soon as the
recipient value is fetched, the email task is being executed and the email is being sent to the
recipient.
Snapshots
Main Process:
Page
103
Child Process:
In this WFD, the context data i.e. id and name value is passed through the payload which is then
saved using UpdateDB task.
Snapshot:
Page
104
8.8.7 Request and Conference Knowledge Worker Based on Speech Search
WFD
Page
105
Page
106
8.9 Make a WebRTC Call
Collaboratory comes with the WebRTC interface Snap-in and a sample WebRTC “phone”
application pre-installed. To learn more about this interface go here:
https://www.devconnectprogram.com/site/global/products_resources/engagement_development_
platform/avaya_snap_ins/webrtc/overview/index.gsp
Page
107
b. for ASBCE access – by visiting the WebRTC interface snap-in at
https://edpaNNN.collaboratory.avaya.com/services/WebRTCSampleApplication /
(the certificate will automatically be accepted provided you have installed the SMGR CA
certificate as described in section 3)
6. finally be presented with the “phone” interface:
7. Then a call can be made to a previously logged in one-X Communicator or to one of the allowed
outdial numbers for this lab. The use of the microphone must be allowed before the call will
begin:
Page
108
Page
109
8.10 Real-Time Speech
Collaboratory comes with the Real-Time Speech Snap-in pre-installed. To learn more about this
powerful tool for speech analytics go here:
https://www.devconnectprogram.com/site/global/products_resources/engagement_development
_platform/avaya_snap_ins/real_time_speech/overview/index.gsp
https://www.devconnectprogram.com/site/global/products_resources/engagement_development
_platform/avaya_snap_ins/context_store/overview/index.gsp
http://www.devconnectprogram.com/site/global/products_resources/engagement_development_p
latform/avaya_snap_ins/engagement_call_control/overview/index.gsp
http://www.devconnectprogram.com/site/global/products_resources/engagement_development_p
latform/avaya_snap_ins/work_assignment/overview/index.gsp
http://www.devconnectprogram.com/site/global/products_resources/engagement_development_p
latform/avaya_snap_ins/presence_services/interfaces/index.gsp
Page
110
9 Avaya Scopia video conferencing
This section describes how to use the Avaya Scopia Video Conferencing Infrastructure to
schedule and join a meeting. Refer to the previous section for integrating Engagement
Development Platform with Scopia.
Within the Collaboratory lab, only 1 active meeting at any particular time is supported, with up
to 3 parties.
Page
111
After logging into the user portal, you can schedule and manage your conferences. The example
screen below shows that there are currently no active or future meetings scheduled. Click the
“Schedule” button to schedule a meeting and send out an invitation email.
Page
112
Enter the following information on the screen below:
To: Email addresses for recipients of the meeting invite.
Subject: Meeting subject (mandatory).
Start Time: Start time of the meeting.
Duration (minutes): Enter the desired duration of the meeting.
Where: This field will default to your virtual room. If you would prefer to set a Meeting ID,
click the three dots ( ) to open a new window to set the meeting location.
Optional text may be entered for the body of the email under the “Message” tab.
Page
113
If you clicked the three dots ( ) in the Where field above, you’ll see a screen similar to the
one shown below. The Meeting Type and Meeting ID will automatically be populated. Click
OK to return to the previous screen and then click the Send button.
Page
114
After clicking the Send button, your meeting is now scheduled.
Page
115
9.2 Join a Meeting
9.2.1 No Client (audio only)
If you are not using the Scopia Conference Client or Scopia Mobile app to join a meeting, you
may dial the Meeting ID from a local endpoint. If calling from the PSTN, ensure one of your
DIDs is mapped to the auto-attendant extension from your welcome packet. The auto-attendant
will prompt you to enter a Meeting ID and Pin. Refer to Section 7.3 for mapping a DID to an
extension.
Page
116
Check the box for the “Conference Client” and click the “Install” button.
Page
117
The Conference Client will be downloaded and installed. Click the “Close” button to return to
the Scopia Desktop home page.
Page
118
Enter your name and Meeting ID (if the Virtual Room was scheduled, enter the Virtual Room
number provided from your welcome packet as the Meeting ID, as shown below).
Page
119
Enter the Meeting Pin provided in your welcome packet. Click “OK” to join the meeting.
Page
120
9.2.3 Scopia Mobile App
9.2.3.1 Android
Download and install the Scopia Mobile app from Google play. Click OPEN.
Page
121
Click the settings icon.
Page
122
For Server Address, enter https://135.11.115.136/scopia/mt/<org>, where <org> is the
Organization provided in your welcome packet (e.g. org1). Exit out of settings.
Page
123
Enter your meeting ID and click Connect.
Page
124
Enter your meeting access PIN and click Continue.
Page
125
9.2.3.2 IOS
Download and install the Scopia Mobile app from the App Store. Click OPEN.
Page
126
Click the settings icon.
Page
127
For Scopia Desktop Server, enter https://135.11.115.136/scopia/mt/<org>, where <org> is the
Organization provided in your welcome packet (e.g. org1). Click Done.
Page
128
Enter your meeting ID and click Connect.
Page
129
Enter your meeting PIN and click OK.
Page
130
10Troubleshooting
10.1 Verifying data replication
For configuration changes to be successful in the Collaboratory, the System Manager and
Session Manger must be synchronized. The Engagement Development Platform must also be
synchronized with System Manager.
Procedure:
1. On the System Manager Web console, click Services > Replication.
2. Select the Session Manager instance and click View Replica Nodes.
3. Confirm that target Session Manager is synchronized.
4. Confirm that Engagement Development Platform is synchronized.
If either instance will not repair, please open a DevConnect support ticket and explain
what is happening. Be sure to put the IP address of System Manager in the ticket.
If you are experiencing problems with SIP calls use SIP tracing to find a more specific reason for
the problem. Chapter 16 of the Maintaining and troubleshooting Avaya Aura® Session Manager
Release 6.3 document has more information on using Session Manager SIP Tracing.
Page
131
11 Additional References
Avaya product documentation, including the following, is available at http://support.avaya.com
[1] Administering Avaya Aura® Session Manager, Release 7.0 August 2015 available at
https://downloads.avaya.com/css/P8/documents/101013827
[2] Maintaining Avaya Aura® Session Manager, Release 7.0 August 2015 available at
https://downloads.avaya.com/css/P8/documents/101014038
[3] Troubleshooting Avaya Aura® Session Manager, Release 7.0 August 2015 available at
https://downloads.avaya.com/css/P8/documents/101014040
[4] Administering Avaya Aura® System Manager, Release 7.0 August 2015 available at
https://downloads.avaya.com/css/P8/documents/101014185
[5] Troubleshooting Avaya Aura® System Manager, Release 7.0 August 2015 available at
https://downloads.avaya.com/css/P8/documents/101013941
[6] Implementing Avaya one-X® Communicator, Release 6.2, April 2015 available at
https://downloads.avaya.com/css/P8/documents/100177364
[7] Using Avaya one-X® Communicator, Release 6.2, April 2015 available at
https://downloads.avaya.com/css/P8/documents/100177365
[8] Avaya Communicator Overview and Specification for Android, iPad, iPhone, and Windows
Release 2.1, Oct 2015 available at
https://downloads.avaya.com/css/P8/documents/101004714
[9] Using Avaya Communicator for Windows Release 2.1, Oct 2015 available at
https://downloads.avaya.com/css/P8/documents/101004734
[10] Using Avaya Communicator for Android Release 2.1, Oct 2015 available at
https://downloads.avaya.com/css/P8/documents/101004711
[11] Using Avaya Communicator for iPhone Release 2.1, Oct 2015 available at
https://downloads.avaya.com/css/P8/documents/101010021
[12] Using Avaya Communicator for iPad Release 2.1, Oct 2015 available at
https://downloads.avaya.com/css/P8/documents/100182081
Page
132
©2015 Avaya Inc. All Rights Reserved.
Avaya and the Avaya Logo are trademarks of Avaya Inc. All trademarks identified by ® and
™ are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks
are the property of their respective owners. The information provided in this document is
subject to change without notice. The configurations, technical data, and recommendations
provided in this document are believed to be accurate and dependable, but are presented
without express or implied warranty. Users are responsible for their application of any
products specified in this document.
Page
133