User Tools

Site Tools


clab_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

clab_guide [2019-07-23 20:28] (current)
Line 1: Line 1:
 +<WRAP round box centeralign 70%>
 +__**Avaya Collaboratory User Guide\\ ​
 +Issue 4.0**__
 +</​WRAP>​
 +
 +<WRAP centeralign 70%>
 +__**Abstract**__
 +</​WRAP>​
 +
 +This document provides the configuration details and steps for connecting to and obtaining more information about your Avaya Collaboratory.  ​
 +
 +====== Introduction ======
 +
 +This document provides the configuration details and steps for connecting to and using the Avaya Collaboratory. ​
 +
 +Collaboratory provides an environment where application developers can learn about Avaya Breeze™ ​ and the services it provides, and develop applications using those services. While Collaboratory provides all the services available inBreeze™,​ it does not allow application developers to test performance,​ scalability and the full range of redundancy capabilities of the Avaya Aura® infrastructure. ​
 +
 +***Important NOTE**: //You do not require OpenVPN (and can skip its installation) to access the lab unless you plan to use H.323 clients or One-X Agent. For all other scenarios you can directly access the lab links provided in 'Your Lab's Information'//​
 +
 +===== Your Welcome Package =====
 +
 +Your welcome email from Avaya will point you to a customized Welcome Page from which you can download this document and a CustomerAccess.csv file giving you:
 +
 +  - The OpenVPN username and password you can use to connect into your Collaboratory. ​ The steps to do this are described in Section 2 below.  ​
 +  - A link to Customer User Documentation under the Documentation page on the Avaya or a URL containing this documentation. This page includes information and software you need for using and configuring your Collaboratory. ​ The URL is:
 +    * http://​dev-NNN.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)
 +   
 +===== Getting Support =====
 +
 +If you have problems connecting to or using your Collaboratory,​ please:
 +
 +  - Carefully re-read this document.
 +  - If you still have issues you send an email to collaboratory@avaya.com
 +  - Or post a question on the forum https://​support.avaya.com/​forums/​Collaboratory_EDP forum
 +  - Or open a support request at support.avaya.com,​ as follows:
 +    - Log in at http://​support.avaya.com.  ​
 +    - Click on Service Requests link at the top right center of the toolbar.
 +    - Select “I need to fix my product” for issues with your lab environment
 +    - Select “I need implementation assistance” for questions regarding API/SDK help.
 +    - Enter your provided Sold To id
 +    - Search for the product: ​ Avaya Collaboratory. ​ Your account will have Avaya Collaboratory associated with it based upon your approved purchase through the Avaya portal.
 +    - 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.  ​
 +
 +===== Reference Configuration =====
 +
 +It is assumed that the user is familiar with the Avaya Aura® infrastructure and Avaya Breeze environment. More detailed information about the Avaya Aura® infrastructure can be found in Section 10. 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 forBreeze™. The majority of the configuration of the lab is already done you, but you will need SMGR to configure any custom Avaya Breeze™ snap-ins you develop.
 +  * Breeze™(Breeze1,​ Breeze2) ​ – Two instances are provided to support creation of Avaya Breeze™clusters. Breeze1is preconfigured with Avaya  snap-ins. Breeze2 is preconfigured with Avaya connectors and will be available for you to install any customized snap-ins, workflows .
 +  * 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.
 +  * Avaya Media Server (AMS) – Shared instance for Breeze™and CM.
 +  * Avaya Development Server – 
 +
 +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, Scopia video services and Avaya Mobile Video.
 +
 +<WRAP centeralign>​ **Collaboratory Lab** </​WRAP>​
 +
 +
 +{{ clab_user_guide:​figure_1_collaboratory.png?​600 |**Figure 1: Collaboratory **}}
 +
 + 
 +===== 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.//​
 +
 +The following components are provided in the sample configuration:​
 +
 +  * **Access mechanisms:​**
 +    * Avaya Session Border Controller for Enterprise
 +    * OpenVPN Client for Windows, Linux, Mac, and iOS 
 +  * **Lab Servers**
 +    * Avaya Aura® System Manager
 +    * Avaya Breeze<​sup>​TM ​ </​sup>​
 +    * Avaya Aura® Session Manager
 +    * Avaya Aura® Communication Manager
 +    * Avaya Aura® Media Server
 +    * Collaboratory Development Server
 +    * Avaya Aura® Messaging
 +    * Avaya Aura® Application Enablement Services
 +  * **Avaya Cluster on Breeze1 instance:** \\ Contains the following pre-installed Avaya snap-ins:
 +    * Context Store
 +    * Real Time Speech
 +    * Work Assignment
 +    * Presence
 +    * Engagement Call Control
 +    * Speech (TTS and ASR)
 +    * WebRTC Audio
 +    * Co-browsing
 +    * Avaya Message Recorder
 +    * Hello World
 +  * **Customer Cluster on Breeze2 instance:​**\\ This is the cluster where you can install your custom built snap-ins and workflows. It has the following pre-installed :
 +    * Engagement Designer
 +    * Email Connector
 +    * SMS Connector\\ There are two SMS connectors currently loaded on SMGR: WebText and ClickaTell. The customer can decide which one to use and accordingly install that.
 +    * Scopia Connector
 +    * Presence Services Connector
 +
 +pre-canned Engagement Designer Workflows that can be modified to build your own customized workflows.
 +
 +**Phones/​Softphones supported:​**
 +
 +The following Softphone software can be downloaded by the Collaboratory customers using the Client SoftPhone software link on the wiki.
 +
 +  * Avaya one-X® Communicator
 +  * Avaya Communicator
 +  * Avaya one-X® Agent
 +  * Media Client for Avaya one-X® Agent (for video)
 +  * VDI client is pre-loaded on the Collaboratory Development server.
 +  * Avaya 9600 Series desk phones (SIP)
 +
 +===== Lab Access =====
 +
 +You can access your lab directly from the internet, or from your internal network through your firewall to the internet. ​ Lab access is provided via two mechanisms: ​
 +
 +**Direct lab access via Avaya Session Border Controller for Enterprise (ASBCE): **
 +
 +This is the recommended mechanism for access to the Collaboratory. 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. Other than the installation of SMGR CA certificate there is no additional installation required. ​
 +
 +SMGR, ED plus other links as mentioned on the wiki under Your Lab Information can be directly accessed using the External Links. ​
 +
 +ASBCE is configured to support SIP-TLS, RTPS, HTTPS, and XMPP. While ASBCE does not support H.323 so you will not be able register H.323 clients from outside the Collaboratory,​ but you can use the VDI client on your Development Server which provides similar capability as the one-X Agent (H.323). The only limitation is that it does not support video.
 +
 +**OpenVPN access:**
 +
 +This should be used only if you need to use Avaya one-X Agent (H.323) with Media Client for video or  Avaya one-X Communicator (H.323).  ​
 +
 +Each lab may be accessed through up to 2 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. ​
 +
 +
 +====== Configure OpenVPN Client ======
 +
 +If you wish to use a VPN client to access your Collaboratory lab you must install and configure OpenVPN or equivalent for your operating system.
 +
 +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.
 +
 +===== Configure Microsoft Windows Client =====
 +
 +  - Go to https://​openvpn.net/​index.php/​open-source/​downloads.html
 +  - Select appropriate link to download the Windows Installer.
 +  - Install the OpenVPN client. Select all defaults. (If prompted to install tap driver for windows, accept and allow the driver to be installed.) \\ {{ clab_user_guide:​openvpn_setupstart.png?​500 |}}\\ 
 +  - 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.\\ {{ clab_user_guide:​openvpn_setupend.png?​500 |}}\\ 
 +  - When starting the OpenVPN client after the initial install **__make sure to do so with the “Run as Administrator” option__**.
 +  - Copy the labNNN_vpn.ovpn file from Avaya/​Collaboratory Download page (link available in Welcome email) to C:\Program Files\OpenVPN\config directory -Screenshot not shown.
 +  - From the System Tray right-click the OpenVPN GUI Icon and click Connect. \\ {{ clab_user_guide:​openvpn_connect.png?​300 |}}\\ 
 +  - Enter Use name and Password to gain access to Collaboratory.\\ {{clab_user_guide:​using_openvpn_log_in.png?​500 |}}\\ 
 +  - From System tray verify OpenVPN GUI Icon is green and mouse over icon to verify configuration.\\ {{ clab_user_guide:​using_openvpn_mouse_over_to_check.png?​200 |}}
 +  - 
 +
 +  
 +===== Configure MacOS Client =====
 +
 +  - Create directory to store labNNN_vpn.ovpn file which is on Avaya/​Collaboratory Download page; link is in the welcome email.
 +  - Go to https://​openvpn.net/​index.php/​access-server/​download-openvpn-as-sw/​357.html (Tunnelblick 3.3 stable was used in this example).
 +  - After downloading .dmg file double-lick Tunnelblick.dmg file in the Downloads folder.\\ {{ clab_user_guide:​tunnelblick_in_folder.png?​500 |}}\\ 
 +  - 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.\\ {{ clab_user_guide:​starting_to_open_tunnelblick.png?​400 |}}\\ 
 +  - Once the installation is completed click the Launch button.\\ {{ clab_user_guide:​launch_tunnelblick.png?​400 |}}\\ 
 +  - A “Welcome to Tunnelblick” window should be displayed. Click the **I have configuration files button**.\\ {{ clab_user_guide:​tunnelblick_do_you_have_config_files.png?​600 |}}\\ 
 +  - From the “Which Type of Configuration Do You Have?” window, click **OpenVPN Configuration(s)**.\\ {{ clab_user_guide:​tunnelblick_type_of_config_files.png?​500 |}}\\ 
 +  - “An Empty Tunnelblick VPN Configuration Has Been Created” window should be displayed. ​ Follow the instructions given in this window. Once completed, click **Done**.\\ {{ clab_user_guide:​empty_tunnelblick.png?​500 |}}\\ 
 +  - If prompted to ‘check ip address’, select your desired choice.
 +  - If prompted to ‘check for updates automatically’,​ select your desired choice.
 +  - When prompted to “Install Configuration For All Users”, select your desired choice. ​ Then enter administrator’s credentials (not shown) to complete the installation.\\ {{ clab_user_guide:​tunnelblick_all_users.png?​400 |}}\\ 
 +  - Click **OK** to complete the installation.\\ {{ clab_user_guide:​tunnelblick_installed.png?​300 |}}\\ 
 +  - 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.\\ {{ clab_user_guide:​connect_tunnelblick.png?​250 |}}\\ 
 +  - Enter VPN credentials and click OK.\\ {{ clab_user_guide:​logging_in_using_tunnelblick.png?​400 |}}\\ 
 +  - Verify connection by mousing over the Tunnelblick icon at the top right of the screen.
 + 
 +===== Configure Linux Client =====
 +
 +  - Verify OpenVPN version. ​ This configuration was tested with OpenVPN 2.2.1.\\ {{ clab_user_guide:​linux_verify_openvpn.png?​500 |}}\\ 
 +  - Create directory to store labNNN_vpn.ovpn file which is on Avaya/​Collaboratory Download page; link is in the welcome email.\\ {{ clab_user_guide:​linux_make_openvpn_dir.png?​500 |}}\\ 
 +  - Change directories to the newly created directory.\\ {{ clab_user_guide:​linux_cd_to_openvpn_dir.png?​500 |}}\\  ​
 +  - Start the OpenVPN client and log in using the VPN credentials.\\ {{ clab_user_guide:​linux_run_openvpn.png?​700 |}}\\ 
 +  - The VPN client connection window must remain open. Use Ctrl-c to end the VPN session.\\ {{ clab_user_guide:​linux_ctrl_c_to_end_openvpn.png?​500 |}}
 +
 +
 +===== Configure iPad Client =====
 +
 +  - Download **OpenVPN Connect** from the App Store.\\ {{ clab_user_guide:​ipad_download_openvpn.png?​500 |}} \\ 
 +  - Click **Install APP**.\\ {{ clab_user_guide:​ipad_install_openvpn.png?​500 |}}\\ 
 +  - Create a directory on the PC and copy labNNN_vpn.ovpn file which is on Avaya/​Collaboratory Download page; link is in the welcome email.\\ <​code>​ the file included in welcome email.</​code>​\\ ​
 +  - The ovpn file should now be visible in the folder.\\ {{ clab_user_guide:​ipad_can_find_ovpn.png?​500 |}}\\ 
 +  - Connect the iPad to the PC for use with iTunes.\\ {{ clab_user_guide:​ipad_connect_to_pc_for_itunes.png?​600 |}}\\ 
 +  - From iTunes, go to **Apps** then highlight the **OpenVPN** app. Click the **Add** button to upload the VPN files to the iPad.\\ {{ clab_user_guide:​ipad_add_openvpn_app.png?​600 |}}\\ 
 +  - Click the **Add** button, browse to the VPN files and select the ovpn file to upload to the iPad.\\ {{ clab_user_guide:​ipad_can_find_ovpn.png?​600 |}}\\ 
 +  - Click the **Sync** button to upload the files.\\ {{ clab_user_guide:​ipad_sync_apps.png?​600 |}}\\ 
 +  - 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.\\ {{ clab_user_guide:​ipad_opening_the_openvpn_first_time.png?​500 |}}\\ 
 +  - Provide the VPN credentials and select the **Connection** button to login.\\ {{ clab_user_guide:​ipad_openvpn_credentials.png?​500 |}}\\ 
 +  - Select **Yes** to allow the connection.\\ {{ clab_user_guide:​ipad_openvpn_allow_connection.png?​500 |}}\\ 
 +  - Status should now show connected.\\ {{ clab_user_guide:​ipad_now_connected.png?​500 |}}
 +
 + 
 +
 +====== Installing the SMGR CA Certificate ======
 +
 +This section is applicable only if you are directly accessing your Collaboratory lab from the Internet via Avaya SBC for Enterprise (no VPN connection). 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.  ​
 +
 +===== Installing the SMGR CA Certificate in Windows =====
 +
 +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.
 +
 +Use a browser to connect to http://​dev-NNN.collaboratory.avaya.com,​ after substituting NNN with your lab number including any leading zeros.
 +
 +Click the certificate install link for Windows. You will be presented with a dialog to select Open or Save:\\ {{ clab_user_guide:​smgr_c3_1_f1.png?​400 |}}
 +
 +Click Open 
 +
 +You will be presented with the “Certificate” dialog, showing the certificate details:\\ {{ clab_user_guide:​smgr_c3_1_f2.png?​500 |}}
 +
 +Click the Install Certificate…
 +
 +This displays the Certificate Import Wizard.\\ {{ clab_user_guide:​smgr_c3_1_f3.png?​500 |}}  ​
 +
 +Click Next >
 +
 +You will need to select a location to Store the Certificate. \\ {{ clab_user_guide:​smgr_c3_1_f4.png?​500 |}}  ​
 +
 +Click on “Place all certificates in the following store” and click “Browse”
 +
 +An auxiliary window will open up, allowing you to select the desired option. ​ Select the Trusted Root Certification Authorities. \\ {{ clab_user_guide:​smgr_c3_1_f5.png?​400 |}}  ​
 +
 +Click OK
 +
 +Confirmation window showing your selection:​\\ {{ clab_user_guide:​smgr_c3_1_f6.png?​500 |}}  ​
 +
 +Click Next >\\ {{ clab_user_guide:​smgr_c3_1_f7.png?​500 |}}  ​
 +
 +Click Finish
 +
 +You will receive a warning about an unverified thumbprint. This is expected as Windows has never seen this CA certificate before:\\ {{ clab_user_guide:​smgr_c3_1_f8.png?​500 |}}  ​
 +
 +Click Yes to confirm the Certificate Installation. The results are displayed:​\\ {{ clab_user_guide:​smgr_c3_1_f9.png?​300 |}}  ​
 +
 +Click OK when Completed
 +
 +
 +===== 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.
 +
 +Use a browser to connect to  http://​dev-NNN.collaboratory.avaya.com,​ after substituting NNN with your lab number including any leading zeros.
 +
 +Click the certificate install link for iOS.
 +
 +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 development website where you can now access the secure page without any certificate warnings.
 +
 +===== Installing the SMGR CA Certificate in Mac OS =====
 +
 +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.
 +
 +Use a browser to connect to  http://​dev-NNN.collaboratory.avaya.com,​ after substituting NNN with your lab number including any leading zeros.
 +
 +Click the certificate install link for Mac OS.
 +
 +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.
 +
 +===== 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.
 +
 +Use a browser to connect to  http://​dev-NNN.collaboratory.avaya.com,​ after substituting NNN with your lab number including any leading zeros.
 +
 +Click the certificate install link for Android.
 +
 +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
 +
 +
 +===== Installing the SMGR CA Certificate in Firefox =====
 +
 +Use Firefox to connect to  http://​dev-NNN.collaboratory.avaya.com,​ after substituting NNN with your lab number including any leading zeros.
 +
 +Click the certificate install link for Firefox. You will be presented with the following dialog:\\ {{ clab_user_guide:​smgr_c3_5_f1.png?​500 |}}
 + 
 +
 +Select “Trust this CA to identify websites.”
 +
 +Click OK
 +
 +
 +
 +====== 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 http://​dev-NNN.collaboratory.avaya.com. 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 Your lab’s Information link  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.
 +
 + 
 +===== 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.
 +
 +==== Install Avaya one-X® Communicator for Windows ====
 +
 +Once Avaya one-X Communicator has been downloaded and unzipped use the following steps to install:
 +
 +  - Double click **Setup.exe** and select the language. Click next.\\ \\ {{ clab_user_guide:​install_clients_c4_1_f1.png?​400 |}}\\ \\ 
 +  - Accept the license and click next.\\ \\ {{ clab_user_guide:​install_clients_c4_1_f2.png?​400 |}}\\ \\ 
 +  - Select Setup Type **Complete** and click next.\\ \\ {{ clab_user_guide:​install_clients_c4_1_f3.png?​400 |}}\\ \\ 
 +  - Select the destination folder and click on install. It will prompt you to close the outlook if it’s running.\\ \\ {{ clab_user_guide:​install_clients_c4_1_f4.png?​400 |}} {{ clab_user_guide:​install_clients_c4_1_f4a.png?​400 |}}\\ \\ 
 +  - If installation is successful then click on finish.\\ \\ {{ clab_user_guide:​install_clients_c4_1_f5.png?​400 |}}
 +
 +==== Configure Avaya one-X® Communicator for Windows ====
 +
 +=== Configure Avaya one-X® Communicator for SIP ===
 +
 +Make sure Avaya one-X® Communicator has been installed. See Section 4.1.1 for instructions on installing.
 +
 +Follow these steps to configure Avaya one-X® Communicator for SIP:
 +
 +  - Launch Avaya one-X® Communicator.
 +  - The “General Settings” form will be presented with the **Telephony** settings showing. Make sure the **SIP** radio button is selected. If it is not, select it and restart Avaya one-X® Communicator.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_1_f1.png?​500 |}}\\ \\ 
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_2_f1.png?​500 |}}\\ \\ 
 +  - 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 Lab-NNN_UserAccess.csv file available from your Avaya account. ​ If you access Collaboratory via ASBCE, use the following address, replacing NNN with your lab number: “sm-NNN.collaboratory.avaya.com”. ​ Set the Transport Type of **TLS**. Set the Port to **5061** and click **OK**.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_1_f3.png?​300 |}} {{ clab_user_guide:​install_clients_c4_1_2_1_f3a.png?​300 |}}\\ \\ 
 +  - Click on “IM and Presence” under General Settings / Accounts. ​  Check the "​Enable Instant Messaging and Presence"​ box. Configure the Server field as follows:​\\ ​  * If using OpenVPN access, put the Breeze1 internal IP address. \\    * If using ASBCE, put “breeze1-NNN.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:\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_1_f4.png?​500 |}}\\ \\ Ensure the button “Automatically discover my IM login information” is selected, and click OK.
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_1_f5.png?​400 |}}\\ \\ 
 +  - Click **Log On**.
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_1_f6.png?​500 |}}\\ \\ 
 +
 +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.
 +
 +=== Configure Avaya one-X® Communicator for H.323 ===
 +
 +Tip: Avaya one-X Communicator for 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.
 +
 +(You also have the option to use the VDI client on the Development server as an H.323 client.)
 +
 +Make sure Avaya one-X Communicator has been installed. See Section 4.1.1 for instructions on installing.
 +
 +Follow these steps to configure Avaya one-X Communicator:​
 +
 +  - Launch Avaya one-X Communicator
 +  - The Settings form will be presented with the Telephony settings showing. Make sure the **H.323** radio button is selected. If it is not, select it and restart one-X Communicator.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_2_f1.png?​500 |}}\\ \\ 
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_2_f2.png?​500 |}}\\ \\ 
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_2_f3.png?​200 |}}\\ \\ 
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_2_f4.png?​500 |}}\\ \\ When done, click OK.
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_2_f5.png?​350 |}}\\ \\ 
 +  - Click **Log On**.
 +  - Once logged in you should see the one-X Communicator reflect the extension you just logged in. You should also see your Presence icon.\\ \\ {{ clab_user_guide:​install_clients_c4_1_2_2_f6.png?​400 |}}\\ \\ 
 +
 +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.
 +
 +===== 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:
 +
 +  - From iPad go to the App Store and locate **Avaya one-X® Mobile SIP 6.2**. Select **iPhone Apps** after searching.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f1.png?​600 |}}\\ \\ 
 +  - Install **Avaya one-X® Mobile SIP 6.2**. This step will require an apple id to login to the App Store.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f2.png?​600 |}}\\ \\ 
 +  - In order to configure it, launch **Avaya one-X® Mobile SIP 6.2**. Select **OK** or **Don’t Allow** to continue.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f3.png?​600 |}}\\ \\ 
 +  - Read and accept the license agreement.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f4.png?​600 |}}\\ \\ 
 +  - Select **Enter SIP Setup**.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f5.png?​600 |}}\\ \\ 
 +  - Enter **Extension** and **Password**. Select **Next** to continue.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f6.png?​600 |}}\\ \\ 
 +  - Enter **Domain** and Session Manager’s IP Address. Select **Next** to continue. \\ \\ {{ clab_user_guide:​install_clients_c4_2_f7.png?​600 |}}\\ \\ 
 +  - Select Next to continue.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f8.png?​600 |}}\\ \\ 
 +  - Select **Finish Setup**.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f9.png?​600 |}}\\ \\ 
 +  - Review the settings and select **Done**. \\ \\ {{ clab_user_guide:​install_clients_c4_2_f10.png?​600 |}}\\ \\ 
 +  - 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.\\ \\ {{ clab_user_guide:​install_clients_c4_2_f11.png?​600 |}}\\ \\ 
 +
 +===== Install and Configure Avaya Communicator® for Windows =====
 +
 +Follow these steps to install Avaya Communicator for Windows:
 +
 +  - Download the Avaya Communicator® for Windows, and then Click on Next.
 +  - Read the license and accept it and click on **Next**.\\ \\ {{ clab_user_guide:​install_clients_c4_3_f1.png?​400 |}}\\ \\ 
 +  - Choose the folder where the Avaya Communicator needs to be installed, and then click on **Next**.\\ \\ {{ clab_user_guide:​install_clients_c4_3_f2.png?​400 |}}\\ \\ 
 +  - Click **Install**.\\ \\ {{ clab_user_guide:​install_clients_c4_3_f3.png?​400 |}}\\ \\ 
 +  - Click on **Finish**. Installation is complete.
 +
 +Follow these steps to configure Avaya Communicator for Windows:
 +  - Launch the Avaya Communicator ​
 +  - Go to options and setting \\ \\ {{ clab_user_guide:​install_clients_c4_3_f4.png?​400 |}}\\ {{ clab_user_guide:​install_clients_c4_3_f5.png?​300 |}}\\ \\ 
 +  - Select Other Settings \\ \\ {{ clab_user_guide:​install_clients_c4_3_f6.png?​300 |}}\\ \\ 
 +  - For Server address, enter one of the following:​\\ ​   a. For Open VPN access, enter the SM IP in Server address. \\    b. For access via ASBCE, enter the SM FQDN, in the form “sm-NNN.collaboratory.avaya.com”.\\ ​     Replace NNN with your lab number including any leading zeros.\\ Select TLS and port 5061  \\ \\ {{ clab_user_guide:​install_clients_c4_3_f7.png?​300 |}} {{ clab_user_guide:​install_clients_c4_3_f7a.png?​300 |}}\\ \\ Enter “collaboratory.avaya.com” in the Domain field. ​
 +  - For Presence server address, enter one of the following:​\\ ​ a. For Open VPN access, enter the internal CE1 IP in Server address. \\ b. For access via ASBCE, enter the Breeze1 FQDN, in the form “breeze1-NNN.collaboratory.avaya.com”.\\ Replace NNN with your lab number.\\ For example, here is the configuration for Lab013 for access using ASBCE:\\ \\ {{ clab_user_guide:​install_clients_c4_3_f8.png?​500 |}}\\ \\ When done, click OK\\ \\ {{ clab_user_guide:​install_clients_c4_3_f9.png?​300 |}}\\ \\ 
 +  - Click on “Not Logged In” Then Enter the extension number and password (**123456**).\\ \\ {{ clab_user_guide:​install_clients_c4_3_f10.png?​300 |}}\\ \\ Click the right arrow to log in.\\ \\ {{ clab_user_guide:​install_clients_c4_3_f11.png?​300 |}}\\ \\ 
 +
 +
 +You are now logged in and should see your Presence icon.
 +
 +
 +===== Install and Configure Avaya Communicator® for iOS =====
 +
 +  - Download and install latest Avaya Communicator® for iOS from AppStore.\\ \\ {{ clab_user_guide:​install_clients_c4_4_f1.png?​400 |}}\\ \\ 
 +  - Read the License Agreement and accept it.\\ \\ {{ clab_user_guide:​install_clients_c4_4_f2.png?​400 |}}\\ \\ 
 +  - Choose "I will manually configure Communicator"​.\\ \\ {{ clab_user_guide:​install_clients_c4_4_f3.png?​400 |}}\\ \\ 
 +  - Select Phone Service.\\ \\ {{ clab_user_guide:​install_clients_c4_4_f4.png?​400 |}}\\ \\  ​
 +  - Now enter the Phone Server Address (SM IP address if using VPN access, SM FQDN in the form sm-NNN.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. \\ \\ {{ clab_user_guide:​install_clients_c4_4_f5.png?​400 |}}\\ \\ 
 +  - Once logged in you should see the Communicator reflect the extension you just logged in.\\ \\ {{ clab_user_guide:​install_clients_c4_4_f6.png?​400 |}}\\ \\ 
 +
 +===== Install and Configure Avaya Communicator® for Android =====
 +
 +  - Download and install the latest Avaya Communicator® for Android software from Google Play store.\\ \\ {{ clab_user_guide:​install_clients_c4_5_f1.png?​400 |}}\\ \\ 
 +  - Read the License Agreement and Accept or Decline.\\ \\ {{ clab_user_guide:​install_clients_c4_5_f2.png?​400 |}}\\ \\ 
 +  - Click OK.\\ \\ {{ clab_user_guide:​install_clients_c4_5_f3.png?​400 |}}\\ \\ 
 +  - Click on Configure manually.\\ \\ {{ clab_user_guide:​install_clients_c4_5_f4.png?​400 |}}\\ \\ 
 +  - Click on Accounts and Services.\\ \\ {{ clab_user_guide:​install_clients_c4_5_f5.png?​400 |}}\\ \\ 
 +  - Click VoIP Account Information.\\ \\ {{ clab_user_guide:​install_clients_c4_5_f6.png?​400 |}}\\ \\ 
 +  - 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 sm-NNN.collaboratory.avaya.com if using ASBCE access) , and port (5061) \\ Select the Secure Connection checkbox, and then click on login.\\ \\ {{ clab_user_guide:​install_clients_c4_5_f7.png?​400 |}}\\ \\ 
 +
 +
 +====== 5 Install and Configure Avaya one-X® Agent with Media Client ======
 +
 +===== 5.1 Installing Avaya one-X® Agent =====
 +
 +Before you begin:
 +
 +  * You must install Avaya one-X Agent on a Windows computer that is connected to Collaboratory via OpenVPN.
 +  * Avaya one-X Agent and Avaya Media Client must be installed on the same Windows computer.
 +
 +**__Steps__**:​
 +
 +  - Unpack the zip file and run OneXAgentSetup.exe. ​
 +  - If Windows ask you if you want to allow this app from an unknown publisher to make changes to your PC, Click Yes.
 +  - On the Welcome screen, click Next.\\ \\ {{ clab_user_guide:​one_x_c5_1_f1.png?​500 |}}\\ 
 +  - Accept the license agreement and click Next.\\ \\ {{ clab_user_guide:​one_x_c5_1_f2.png?​500 |}}\\ 
 +  - Fill in your customer details and click Next.\\ \\ {{ clab_user_guide:​one_x_c5_1_f3.png?​500 |}}\\ 
 +  - Select installation location and click Next.\\ \\ {{ clab_user_guide:​one_x_c5_1_f4.png?​500 |}}\\ 
 +  - Ensure central storage is not selected and click Next.\\ \\ {{ clab_user_guide:​one_x_c5_1_f5.png?​500 |}}\\ 
 +  - Skip language pack selection by clicking Next.\\ \\ {{ clab_user_guide:​one_x_c5_1_f6.png?​500 |}}\\ 
 +  - Skip optional feature enablement by clicking Next.\\ \\ {{ clab_user_guide:​one_x_c5_1_f7.png?​500 |}}\\ 
 +  - Click Next on the Video Information screen.\\ \\ {{ clab_user_guide:​one_x_c5_1_f8.png?​500 |}}\\ 
 +  - Click Next on the TTY Information screen.\\ \\ {{ clab_user_guide:​one_x_c5_1_f9.png?​500 |}}\\ 
 +  - Ready to install. Click Install.\\ \\ {{ clab_user_guide:​one_x_c5_1_f10.png?​500 |}}\\ 
 +  - Wait for the installer to complete.\\ \\ {{ clab_user_guide:​one_x_c5_1_f11.png?​500 |}}\\ 
 +  - Select Launch one-X Agent when setup exits, and click Finish.\\ \\ {{ clab_user_guide:​one_x_c5_1_f12.png?​500 |}}\\ 
 + 
 +
 +
 +===== 5.2 Installing Avaya Media Client =====
 +
 +Before you begin:
 +
 +  * You must install Avaya Media Client on a Windows computer that is connected to Collaboratory via OpenVPN.
 +
 +**__Steps__**:​
 +
 +  - Unpack the zip file and run MediaClient1.0.00000.442.exe. Click Next.\\ \\ {{ clab_user_guide:​media_client_c5_2_f1.png?​500 |}}\\ 
 +  - Accept the license agreement and click Next.\\ \\ {{ clab_user_guide:​media_client_c5_2_f2.png?​500 |}}\\ 
 +  - Set the destination folder and click Next.\\ \\ {{ clab_user_guide:​media_client_c5_2_f3.png?​500 |}}\\ 
 +  - Select all installable items, and click Next.\\ \\ {{ clab_user_guide:​media_client_c5_2_f4.png?​500 |}}\\ 
 +  - Click Install to confirm and start the installation.\\ \\ {{ clab_user_guide:​media_client_c5_2_f5.png?​500 |}}\\ 
 +  - If Windows asks if you want to allow this app to install software on your PC, click Yes.
 +  - Wait for the installation to complete.\\ \\ {{ clab_user_guide:​media_client_c5_2_f6.png?​500 |}}\\ 
 +  - Click Finish to close the installer.\\ \\ {{ clab_user_guide:​media_client_c5_2_f7.png?​500 |}}\\ 
 + 
 +
 +===== 5.3 Configuring Avaya one-X® Agent =====
 +
 +Before you begin:
 +
 +  * You will need to install your lab’s System Manager CA root certificate in your local OS trust store before you can log into the system with one-X Agent. \\ Instructions for doing this are in located here: <fc #​ff0000>​**XXXXXXX (insert document cross-reference or wiki hyper-link here)**</​fc>​
 +  * You will need the following information:​
 +    * An Agent ID. In the Collaboratory,​ agents have IDs in the range 2200-2209.
 +    * An H.323 telephony extension. In the Collaboratory,​ H.323 extensions are in the range 2100-2109. You must use the same extension in Avaya Media Client in Avaya one-X® Agent.
 +
 +When you’re done:
 +
 +  * You must be connected to Collaboratory via OpenVPN before you can login and test your one-X Agent configuration.
 +  * Avaya Media Client must be installed, configured, running and logged in before you can log in and receive voice or video calls with Avaya one-X Agent.
 +
 +**__Steps__**:​
 +
 +  - Start the one-X Agent client. ​ Click the “Change Login Settings” button:\\ \\ {{ clab_user_guide:​one_x_c5_3_f1.png?​300 |}}\\ 
 +  - Configure the Agent tab as shown:\\ \\ {{ clab_user_guide:​one_x_c5_3_f2.png?​400 |}}\\ 
 +    - Select “Enable ACD Login”
 +    - Select “Automatically sign into the ACD server”
 +    - In the Agent field, enter the agent ID
 +    - In the Password field, enter 123456
 +    - In the “Default Agent state upon ACD connection” dropdown, select Ready.\\ \\ 
 +  - Configure the Telephony tab as shown:\\ \\ {{ clab_user_guide:​one_x_c5_3_f3.png?​400 |}}\\ 
 +    - Select “Enable automatic connection to Communication Manager”
 +    - In the Extension field, enter the H.323 extension that you wish to assign to the agent.
 +    - In the Password field, enter 123456
 +    - In the Server Address field, enter the internal address of the Communication Manager, which is 10.0.0.13
 +    - In the User Type dropdown, select Agent
 +    - In the “Place and receive calls using” drop down, select Desk Phone.\\ **__Note:​__** Avaya Media Client takes the role of the agent’s Desk Phone, and is used for both audio and video calls.\\ \\ 
 +  - Configure the IM tab as shown:\\ \\ {{ clab_user_guide:​one_x_c5_3_f4.png?​400 |}}\\ 
 +    - Select “Enable IM Login”
 +    - Select “Enable automatic connection to IM server”
 +    - In the User Name field, enter the same H.323 extension that was configured in the Telephony tab
 +    - In the Password field, enter 123456
 +    - In the Domain field, enter “presence.collaboratory.avaya.com”
 +    - In the Server Address field, enter the internal address of the Breeze1 server, which is 10.0.0.8\\ \\ 
 +  - Configure to enable auto in for One-X agent:\\ \\ {{ clab_user_guide:​one_x_c5_3_f5.png?​400 |}}\\
 +    - In One-X agent go to System Settings > Work Handling > Advanced
 +    - Communication Manager Ready Mode > set to Auto-In\\ \\
 +
 +  - Click Save Settings & Log in
 +
 +===== 5.4 Configuring Avaya Media Client =====
 +
 +Before you begin:
 +
 +  * You will need the following information:​
 +    * An H.323 telephony extension. In the Collaboratory,​ H.323 extensions are in the range 2100-2109. ​ You must use the same extension in Avaya Media Client in Avaya one-X® Agent.
 +
 +When you’re done:
 +
 +  * You must be connected to Collaboratory via OpenVPN before you can login and test your Media Client configuration.
 +
 +**__Steps__**:​
 +
 +  - Start the Media Client and click OK.\\ \\ {{ clab_user_guide:​media_client_c5_4_f1.png?​400 |}}\\ 
 +  - Click “Show Hidden Icons” in the Windows System Tray
 +  - Right-click on Avaya Media Client and select Settings
 +  - Configure Login Settings as shown:\\ \\ {{ clab_user_guide:​media_client_c5_4_f2.png?​500 |}}\\ 
 +    - Select “Enable Automatic Connection to CM”
 +    - For Extension, use the same value as configured in Avaya one-X® Agent.
 +    - For Password, use 123456
 +    - For Server Address, use the internal IP address of the Communication Manager server, which is 10.0.0.13\\ \\ 
 +  - Configure Video Settings, Basic tab as shown:\\ \\ {{ clab_user_guide:​media_client_c5_4_f3.png?​500 |}}\\ 
 +    - In the Preferred Camera dropdown, select your video device.
 +    - Select “Send your video image automatically when you answer a video call”
 +    - Select “Open video window automatically on login with video capabilities”\\ \\ 
 +  - Configure Video Settings, Advanced tab as shown:\\ \\ {{ clab_user_guide:​media_client_c5_4_f4.png?​500 |}}\\ 
 +    - In Codec Preferences,​ deselect “Enable H.263” and “Enable H.263-1998”.
 +    - In Codec Preferences,​ select “Enable H.264”
 +    - Ignore the warning that Disabling H.263 is not supported in CM environment.\\ \\ 
 +  - Click OK to save all the Media Client changes.
 +
 +
 +====== 6 Configure 96x1 SIP Deskphone ======
 + 
 +  - 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.\\ \\ {{ clab_user_guide:​96x1_config_c6_f1.png?​300 |}}\\ 
 +  - Once phone reboots enter MUTE C R A F T # (2 7 2 3 8 #) and select addr from menu.\\ \\ {{ clab_user_guide:​96x1_config_c6_f2.png?​300 |}}\\ 
 +  - Check if you have DHCP option and if you do then set DHCP to yes, else enter the IP, Router and mask values.\\ \\ {{ clab_user_guide:​96x1_config_c6_f3.png?​300 |}}\\ 
 +  - Set HTTP server IP to Dev IP in Collabotory lab.\\ \\ {{ clab_user_guide:​96x1_config_c6_f4.png?​300 |}}\\ 
 +  - Select Group and set it to 0.\\ \\ {{ clab_user_guide:​96x1_config_c6_f5.png?​300 |}}\\ {{ clab_user_guide:​96x1_config_c6_f5a.png?​300 |}}\\ 
 +  - Select SIG, set it to SIP and Select save and restart.\\ \\ {{ clab_user_guide:​96x1_config_c6_f6.png?​300 |}}\\ {{ clab_user_guide:​96x1_config_c6_f6a.png?​300 |}}\\ \\ Now the Phone will pull the required settings file from HTTP file server and will add the SIP settings in it.\\ 
 +  - Enter the username (2300 to 2309) and password (123456). This will register the station to SM in lab.
 +\\ {{ clab_user_guide:​96x1_config_c6_f7.png?​300 |}}\\ 
 + 
 +
 +
 +
 +
 +
 +====== 7 Making Phone Calls (the Dial Plan) ======
 +
 +===== 7.1 Stations =====
 +
 +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. Avaya Breeze will be sequenced in on all calls to and from SIP stations, and all calls to and from H.323 stations that come from or go to the PSTN. There are other extensions provisioned within the Communication Manager to provide other functions (e.g. Remote Access, Voice Mail, VDNs). ​ You are free to modify Communication Manager provisioning in any way you desire (e.g. to add other stations or enable other features).
 +
 +===== 7.2 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. ​
 +
 +===== 7.3 Outbound Calls to PSTN =====
 +
 +ALL outbound PSTN calling from Collaboratory is by whitelist only. You must provide a list of specific numbers to be allowed. All other numbers will be blocked, you must secure approval from all parties that they are willing to be called from your lab.  To have outbound PSTN services configured for your environment,​ send an email request to collaborator@avaya.com as described in section 1.2 above  with the desired PSTN numbers (up to 10) that you wish to use for testing.
 +
 +By default, the dial plan allows direct dial of  the whitelisted 11 digit North American numbers (e.g. 12005551212) from registered stations. ​ From within Breeze applications,​ E.164 numbers should be used (e.g. +12005551212)—in fact, the numbers dialed by stations have a plus prepended to them as the route to the Session Manager. This is specified in the Communication Manager Dialplan Analysis, AAR Analysis, and Routing Pattern tables. ​ In Session Manager the Dial Pattern table specifies the final route. ​  ​Communication Manager Automatic Route Selection is not used, so there is no reason to dial an outgoing access code (e.g. 9)—just dial the number. ​ You are free to modify these tables in any way you see fit (e.g. to use ARS or to add other country codes), but the need to put numbers on a whitelist cannot be avoided.
 +
 +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.**
 +
 +===== 7.4 Inbound Calls from PSTN =====
 +
 +Two Direct Inward Dial (DID) numbers are provided in the welcome email. ​ By default, the first DID number will ring a Remote Access feature wihin the Communication Manager in the Collaboratory lab.  This feature answers the call and immediately begins to play dialtone. ​ You may then dial any digits that you can dial from a station registered within the lab.  In this way, a single DID number can be used to get to any station or application in the lab.  The second DID number is routed to the Scopia auto-attendant extension. Your lab supports up to two (2) simultaneous PSTN calls (inbound and/or outbound). ​ Note: local and long distance toll charges may apply for the calling party.  ​
 +
 +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.
 +
 +Login to the System Manager Web console provided in your Collaboratory.
 +
 +{{ clab_user_guide:​making_calls_c7_4_f1.png?​600 |}}
 +
 +Click on **Routing**.
 +
 +{{ clab_user_guide:​making_calls_c7_4_f2.png?​600 |}}
 +
 +Click on **Adaptations**,​ and then **DID**.
 +
 +{{ clab_user_guide:​making_calls_c7_4_f3a.png?​600 |}}
 +{{ clab_user_guide:​making_calls_c7_4_f3b.png?​600 |}}
 +
 +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**.
 +
 +{{ clab_user_guide:​making_calls_c7_4_f4.png?​600 |}}
 +
 +{{ clab_user_guide:​making_calls_c7_4_f5.png?​600 |}}
 +
 +
 +====== 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 onBreeze™. To develop Breeze™ services, you should have some knowledge of Java. As a prerequisite,​ the following tools should be downloaded and installed onto your development environment PC:
 +
 +  * Java JDK – We recommend Oracle SE 1.6.x
 +  * Eclipse IDE (e.g. Juno)
 +  * Apache Maven 
 +
 +For further instructions on environment installation/​setup and Breeze™ SDK, please refer to //**Getting Started with the Breeze™**//​ and //**Create Your First Service**// video tutorials and documentation located on the [[http://​www.avaya.com/​cedeveloper|DevConnect Portal]]. Follow //**Avaya Breeze™ Release 3.1.1 Contents**//​ for documentation and SDK download.
 +
 +
 +===== 8.2 Deploying and Running Avaya Breeze™Services =====
 +
 +Once a service has been created (svar file), it must be deployed onto Avaya Breeze™ instance(s). There are two methods of deploying a service. ​
 +
 +  - System Manager – Logon to System Manager web console for your Collaboratory then navigate to  Avaya Breeze™ **→** Service Management **→** Select **Load** and specify your service **→** Select your service and **Install**.
 +  - Another method is to copy the service .svar file onto each  Avaya Breeze™server instances and execute:
 +
 +<​code> ​    ​deploy_service <​service-name>​ </​code>​
 +
 +//**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 Breeze™**//​ video tutorials and documentation located on the [[http://​www.avaya.com/​cedeveloper|DevConnect Portal]]. ​
 +
 +===== 8.3 Call Connector ​  =====
 +
 +By default, Breeze intercepts, accepts, and makes calls through an Avaya Aura included in your Collaboratory.
 +  * Call accept happens when the application/​Snap-in owns or is the telephone number. ​ An IVR is a good example.
 +  * Call make happens when the application makes the telephone call.  An outbound dialer is an example.
 +  * Call intercept requires an IMS infrastructure (like Avaya Aura) to sequence the call through an application server like Breeze. ​ A call is from any caller (person or call making application) and is to any called party (person or accepting application).
 +Breeze provides APIs for handling each of these types of calling.
 +A basic platform function, Breeze uses SIP to connect to Avaya Aura Session Manager, not requiring any add-on Connector Snap-In.
 +
 +Zang.io Call Connector:
 +
 +Beginning with version 3.3, Breeze supports connections to remote systems which can perform calling operations,
 +and the first such connector allows calls through the Zang Communication Platform as a Service (CPaaS) to be accepted and made.
 +Call intercept is not available with Zang.
 +Breeze supports simultaenous use of Zang and Aura for call accept, but one or the other must be chosen for call make.
 +
 +Use of Zang CPaaS requires the installation and configuration of the ZangCallConnector Snap-in.
 +You must obtain an account and one or more numbers from Zang.io.
 +The Account SID (service ID) and authorization token must be configured as a ZangCallConnector attribute.
 +All the information required can be found in the guide:
 +[[https://​www.devconnectprogram.com/​site/​global/​products_resources/​avaya_breeze/​releases/​3_3/​docs/​deploying_zang_enabled_3_3_1/​index.html|Deploying Zang-enabled Avaya Breeze]].
 +
 +===== 8.4 SMS Connector ​  =====
 +
 +The Collaboratory provides the option of choosing between three  SMS connectors: Zang, WebText and Clickatell, which are supported with Avaya Breeze™. These connectors are pre-loaded on the Collaboratory SMGR and provide simplified API’s which can be used to send SMS messages. You will need to install your SMS connector of choice on the Avaya Breeze™ ​
 +
 +Before getting started with the any Connector, you must have an  account created with appropriate vendor and obtain appropriate API credentials. **NOTE:** //Avaya does not offer SMS accounts nor is Avaya responsible for supporting direct SMS API/​Services//​. ​
 +
 +Zang SMS Connector special instructions:​
 +
 +See [[https://​www.devconnectprogram.com/​fileMedia/​download/​6834371e-82cb-4484-a71d-c6f1e5d3624d|Zang SMS Connector Snap-in]].
 +
 +WebText SMS Connector special instructions:​
 +
 +To configure your Webtext Connector for your account, Click **Configuration** on left menu and select **Attributes**. From dropdown select **WebtextConnector** service. ​
 +
 +{{ clab_user_guide:​developing_8_3_f2_webtext.png?​700 |}}
 +
 +Clickatell SMS Connector special instructions:​
 +
 +To configure your Clickatell Connector for your account, Click **Configuration** on left menu and select **Attributes**. From dropdown select **ClickatellSmsConnector** service. ​
 +
 +{{ clab_user_guide:​developing_8_3_f1.png?​700 |}}
 +===== 8.5 Email Connector =====
 +
 +The Email Connector on Avaya Breeze™ provides a proxy API which can communicate with an Email Server of your choice. Once the Email Connector has been configured, the APIs from Avaya Breeze™ 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 send a request to collaboratory@avaya.com with the desired email addresses and/or domains that you wish to use for testing.
 +
 +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.
 +
 +{{ clab_user_guide:​developing_8_4_f1.png?​700 |}}
 +===== 8.6 Scopia Connector =====
 +
 +The Scopia Connector on Avaya Breeze™ provides a proxy API which can communicate with a Scopia Server. Once the Scopia Connector has been configured, the APIs from Avaya Breeze™ 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.
 +
 +{{ clab_user_guide:​developing_8_5_f1.png?​700 |}}
 +===== 8.7 AAMS and Media Control API =====
 +
 +The Avaya Breeze™ 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 Avaya Breeze™. 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 (also called Namespace) or use existing and upload wav file. When you call on Media API, you will need to formulate URI as follows:\\ <​code>​cstore://<​wav-file-name>?​ns=<​namespace>&​cg=<​content-group></​code>​
 +  * **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. 
 +
 +===== 8.8 Engagement Designer Access =====
 +
 +Avaya Engagement Designer is an Avaya Breeze™ snap-in that enables Business Analysts and other non-developers to create Workflow Definitions that describe and execute business processes. A Workflow Definition comprises a series of connected events and tasks. <fs larger>​Collaboratory comes with Engagement Designer pre-installed. ​ To learn more about this powerful service and workflow design and execution tool go here:</​fs>​
 +
 +http://​www.devconnectprogram.com/​site/​global/​products_resources/​engagement_development_platform/​avaya_snap_ins/​engagement_designer/​overview/​index.gsp
 +
 +To start using Engagement Designer:
 +  - If your lab is not configured with ASBCE, then to start using Engagement Designer, **first make certain** the /etc/hosts file on your PC has had the proper entries added (described in section Configuring Host Names On Your Development Environment PC in Section 7.2 above).  ​
 +  - Login to System Manager and navigate to the Avaya Breeze™ Element Manager:\\ {{ clab_user_guide:​developing_8_7_f1.png?​700 |}}\\ 
 +  - Go to Cluster Administration under Avaya Breeze™.
 +  - Select Designer console URL under Service URL column from the cluster where Engagement Designer is installed.\\ {{ clab_user_guide:​developing_8_7_f2.png?​700 |}}\\ 
 +  - An extra window or tab should pop up in your browser:\\ {{ clab_user_guide:​developing_8_7_f3.png?​700 |}}\\ 
 +
 +
 +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.
 +==== 8.8.1 SMS Broadcast WFD  ====
 +
 +  * A workflow is started because of an external event.
 +  * One or more resource attributes are passed to the workflow.
 +  * Using the resource attributes, all resources are located that match the attributes.
 +  * For the list of resources returned, each is sent a hardcoded SMS. 
 +
 +{{ clab_user_guide:​developing_8_7_1_f1.png?​700 |}}
 +==== 8.8.2 Email Broadcast WFD ====
 +
 +  * A workflow is started because of an external event.
 +  * One or more resource attributes are passed to the workflow.
 +  * Using the resource attributes, all resources are located that match the attributes.
 +  * For the list of resources returned, each is sent a hardcoded email.  ​
 +
 +{{ clab_user_guide:​developing_8_7_2_f1.png?​700 |}}
 +
 +==== 8.8.3 Dynamic Team Formation WFD ====
 +
 +  * A workflow is started because of an external event, e.g. a customer reports a problem of an Avaya product online, or system generates a critical alarm, a customer filled a product query form online, etc.
 +  * Customer and product information is passed to the workflow.
 +  * Customer info is saved into customer database.
 +  * Based and product type, find one person from sales/​account team and one person from the support team with the matched skill sets and notify them by email and SMS with Scopia meeting info.
 +  * Team is formed to follow up the customer'​s issue/​query.
 +
 +DB tasks are used to simulate the Context Store and Work Assignment tasks.
 +
 +{{ clab_user_guide:​developing_8_7_3_f1.png?​700 |}}
 +
 +==== 8.8.4 Basic Inbound Call WFD ====
 +
 +  * A workflow is started because of an inbound call intercept.
 +  * A calling and called number are passed to the workflow.
 +  * A customer record is retrieved from an external database based on the calling number.
 +  * A single resource is retrieved based on the attributes from the caller record.
 +  * When the resource becomes available, the caller is connected to the resource.
 +  * Until the resource becomes available, the called is played an announcement every 30 seconds. ​ At all other times, music is played. ​
 +
 +__**Snapshot:​**__ ​
 +
 +{{ clab_user_guide:​developing_8_7_4_f1.png?​700 |}}
 +==== 8.8.5 Basic Inbound Call with Relaxed Attributes WFD ====
 +
 +  * A workflow is started because of an inbound call intercept.
 +  * A calling and called number are passed to the workflow.
 +  * A customer record is retrieved from an external database based on the calling number.
 +  * A single resource is retrieved based on the attributes from the caller record.
 +  * When the resource becomes available, the caller is connected to the resource.
 +  * Until the resource becomes available, the called is played an announcement every 30 seconds. ​ At all other times, music is played.
 +  * If a resource is not available within 2 minutes, the resource attributes are relaxed so that the pool of potential resources for the call is expanded. (This would be similar to queuing for a second agent group if the call cannot be handled by the first agent group within 2 minutes).
 +
 +__**Snapshot:​**__
 +
 +{{ clab_user_guide:​developing_8_7_5_f1.png?​700 |}}
 + 
 +==== 8.8.6 Retrieve Context WFD ====
 +
 +  * A workflow is started because of an external event.
 +  * A customer ID is passed to the workflow.
 +  * All context data associated with the customer ID is retrieved and passed back to the calling process.
 +
 +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**:​\\ {{ clab_user_guide:​developing_8_7_6_f1.png?​700 |}}
 +
 +**Child Process**:​\\ {{ clab_user_guide:​developing_8_7_6_f2.png?​700 |}}
 +==== 8.8.7 Save Context WFD ====
 +
 +  * A workflow is started because of an external event.
 +  * Context data is passed to the workflow.
 +  * Each piece of context data is identified by a customer ID.
 +  * The context is saved.
 + 
 +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:​__**
 +
 +{{ clab_user_guide:​developing_8_7_7_f1.png?​700 |}}
 +==== 8.8.8 Request and Conference Knowledge Worker Based on Speech Search WFD ====
 +
 +  * A workflow is started because of an external event.
 +  * Active call ID is passed to the workflow, as well as a list of attributes for requesting a knowledge worker.
 +  * Speech search is attached to the call, and 3 canned speech search queries are associated with the call.
 +  * Any time a caller speech search query is detected, a path is taken in the workflow.
 +  * A single resource is retrieved based on the attributes from the caller record. ​ This request should **__NOT__** queue if a resource is not immediately available. (Instead of this, a database entry is made for the match)
 +  * The allocated resource is conferenced into the active call.
 +  * The name of the allocated resource is returned to the process that executed the workflow. ​ If no resource is available, an error is returned to the process.
 +  * Once a speech search query is satisfied with a resource, the speech search is cancelled and the workflow is terminated.
 +
 +{{ clab_user_guide:​developing_8_7_8_f1.png?​700 |}}
 +===== 8.9 Make a WebRTC Call =====
 +
 +Avaya WebRTC is an Avaya Breeze™ ​ snap-in that enables end users to make secure voice calls from their Web browser. The call destination can be any endpoint to which Avaya Aura® Session Manager is able to route calls. For example, a customer can initiate a call directly into the contact center from a Web page on a company'​s public Web site. <fs larger>​Collaboratory comes with the WebRTC interface Snap-in and a sample WebRTC “phone” application pre-installed.</​fs>​
 +
 +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
 +
 +To start using the WebRTC “phone” (named WebRTCSampleApplication):​
 +
 +  - If your lab is not configured with ASBCE, **first make certain** the /etc/hosts file on your PC has had the proper entries added (described in section Configuring Host Names On Your Development Environment PC in Section 7.2 above), ​
 +  - then make certain a WebRTC capable browser is being used. You must use a later version of Firefox or Chrome, but not Internet Explorer. ​ WebRTC is not supported in any browser on iPhones or iPads.
 +  - then make certain the proper certificate is loaded, replacing NNN with your lab number in the following steps:
 +    - for VPN access, by visiting the WebRTC interface snap-in at:  https://​10.0.0.8/​services/​WebRTC/​WebRtcServlet and accept the certificate:​\\ {{ clab_user_guide:​developing_8_8_f1.png?​600 |}}\\ 
 +    - for ASBCE access – by visiting the WebRTC interface snap-in at https://​breeze1-NNN.collaboratory.avaya.com/​services/​WebRTCSampleApplication /
 +    - (the certificate will automatically be accepted provided you have installed the SMGR CA certificate as described in section 3)
 +  - finally be presented with the “phone” interface: ​ \\ {{ clab_user_guide:​developing_8_8_f2.png?​600 |}}\\ 
 +  - 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:\\ {{ clab_user_guide:​developing_8_8_f3.png?​600 |}}
 +
 +
 +
 +===== 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 ​
 +
 +===== 8.11 Context Store =====
 +
 +Collaboratory comes with a small version of the Context Store Snap-in pre-installed. ​ To learn more about this powerful data grid and customer journey storage tool go here:
 +
 +https://​www.devconnectprogram.com/​site/​global/​products_resources/​engagement_development_platform/​avaya_snap_ins/​context_store/​overview/​index.gsp ​
 +
 +===== 8.12 Engagement Call Control =====
 +
 +Collaboratory comes with the Engagement Call Control Snap-in pre-installed. To learn about this third party call control Snapin go here:
 +
 +http://​www.devconnectprogram.com/​site/​global/​products_resources/​engagement_development_platform/​avaya_snap_ins/​engagement_call_control/​overview/​index.gsp
 +
 +===== 8.13 Work Assignment ​ =====
 +
 +Collaboratory comes with the Work Assignment Snap-in pre-installed. To learn about this Snapin go here:
 +
 +http://​www.devconnectprogram.com/​site/​global/​products_resources/​engagement_development_platform/​avaya_snap_ins/​work_assignment/​overview/​index.gsp
 +
 +===== 8.14 Presence Services Snap-in =====
 +
 +Avaya Aura® Presence Services Snap-in provides a scalable, high performance presence aggregation service. Avaya Aura Presence Services collects and disseminates rich presence from Avaya and third party sources across a diverse set of business environments. The presence information allows users to locate colleagues and experts to address customer inquiries, handle service issues, and solve critical problems in real time. It helps to expand contact center capabilities by leveraging resources and expertise across the entire enterprise to serve customers better.To learn about this Snapin go here:
 +
 +http://​www.devconnectprogram.com/​site/​global/​products_resources/​engagement_development_platform/​avaya_snap_ins/​presence_services/​interfaces/​index.gsp
 +
 +===== 8.15 Avaya Mobile Video =====
 +
 +Avaya Mobile Video enables an enterprise'​s customers to initiate and conduct a two-way video or audio-only call with a contact center agent from their mobile device. The enterprise'​s contact center infrastructure is based on Avaya Aura® Contact Center Elite. Agents receive and control calls using the Avaya Media Client and Avaya one-X™ Agent.
 +
 +Details on its API  can be found on:
 +http://​www.devconnectprogram.com/​site/​global/​products_resources/​mobile_video/​overview/​index.gsp
 +
 +
 +
 +
 +====== 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 Avaya Breeze with Scopia.
 +
 +Within the Collaboratory lab, only 1 active meeting at any particular time is supported, with up to 3 parties.
 +
 +===== 9.1 Schedule a Meeting =====
 +
 +Access the Scopia User Portal in a browser at http://​iview.collaboratory.avaya.com/​userportal/​views/​main.jsf. Log in using the **Username**,​ **Password**,​ and **Organization** provided in your welcome packet.
 +
 +{{ clab_user_guide:​scopia_c9_1_f1.png?​600 |}}
 +
 +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.
 +
 +{{ clab_user_guide:​scopia_c9_1_f2.png?​600 |}}
 +
 +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 ({{ clab_user_guide:​scopia_c9_1_f6_dots.png?​20|}}) 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.
 +
 +{{ clab_user_guide:​scopia_c9_1_f3.png?​600 |}}
 +
 +
 +If you clicked the three dots ({{ clab_user_guide:​scopia_c9_1_f6_dots.png?​20|}}) 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.
 +
 +{{ clab_user_guide:​scopia_c9_1_f4.png?​600 |}}
 +
 +After clicking the Send button, your meeting is now scheduled.
 +
 +{{ clab_user_guide:​scopia_c9_1_f5.png?​600 |}}
 +
 +===== 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 6.3** for mapping a DID to an extension.
 +
 +==== 9.2.2 Scopia Conference Client ====
 +
 +Access Scopia Desktop in a browser at https://​scopia.collaboratory.avaya.com/​scopia/​mt/<//​org//>,​ where <//​org//>​ is the Organization provided in your welcome packet (e.g. //​org1//​). ​ If this is the first time accessing Scopia Desktop from your system, click the link shown on the screen below to display the list of updates available.
 +
 +{{ clab_user_guide:​scopia_c9_2_2_f1.png?​600 |}}
 +
 +Check the box for the “Conference Client” and click the “Install” button.
 +
 +{{ clab_user_guide:​scopia_c9_2_2_f2.png?​500 |}}
 +
 +The Conference Client will be downloaded and installed. ​ Click the “Close” button to return to the Scopia Desktop home page.
 +
 +{{ clab_user_guide:​scopia_c9_2_2_f3.png?​500 |}}
 +
 +
 +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).
 +
 +{{ clab_user_guide:​scopia_c9_2_2_f4.png?​600 |}}
 +
 +
 +Enter the Meeting Pin provided in your welcome packet. ​ Click “OK” to join the meeting.
 +
 +{{ clab_user_guide:​scopia_c9_2_2_f5.png?​400 |}}
 +
 +
 +==== 9.2.3 Scopia Mobile App ====
 +
 +=== 9.2.3.1 Android ===
 +
 +Download and install the **Scopia Mobile** app from Google play.  Click **OPEN**.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_f1.png?​200 |}}
 +
 +Click the settings icon.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_f2.png?​200 |}}
 +
 +For **Server Address**, enter https://​scopia.collaboratory.avaya.com/​scopia/​mt/<​org>,​ where <org> is the Organization provided in your welcome packet (e.g. org1). ​ Exit out of settings.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_f3.png?​200 |}}
 +
 +Enter your meeting ID and click **Connect**. ​
 +
 +{{ clab_user_guide:​scopia_c9_2_3_f4.png?​200 |}}
 +
 +Enter your meeting access PIN and click Continue.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_f5.png?​200 |}}
 +
 +You should now be in your meeting.
 +
 +
 +=== 9.2.3.2 IOS ===
 +
 +Download and install the **Scopia Mobile** app from the App Store. ​ Click **OPEN**.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_2_f1.png?​200 |}}
 +
 +Click the settings icon.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_2_f2.png?​200 |}}
 +
 +For **Scopia Desktop Server**, enter https://​scopia.collaboratory.avaya.com/​scopia/​mt/<​org>,​ where <org> is the Organization provided in your welcome packet (e.g. org1). ​ Click **Done**.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_2_f3.png?​200 |}}
 +
 +Enter your meeting ID and click **Connect**. ​
 +
 +{{ clab_user_guide:​scopia_c9_2_3_2_f4.png?​200 |}}
 +
 +Enter your meeting PIN and click OK.
 +
 +{{ clab_user_guide:​scopia_c9_2_3_2_f5.png?​200 |}}
 +
 +You should now be in your meeting.
 +
 +====== 10 Troubleshooting ======
 +
 +===== 10.1 Verifying data replication =====
 +
 +For configuration changes to be successful in the Collaboratory,​ the System Manager and Session Manger must be synchronized. The Avaya Breeze must also be synchronized with System Manager.
 +
 +**Procedure**:​
 +  - On the System Manager Web console, click Services > Replication.
 +  - Select the Session Manager instance and click View Replica Nodes.
 +  - Confirm that target Session Manager is synchronized.
 +  - Confirm that Avaya Breeze ​  is synchronized.\\ \\ Note: Synchronization Status should be green.\\ \\ 
 +  - If the Session Manager and/or Avaya Breeze are not synchronized,​ select the problem instance and click Repair. Use the refresh button to track the status. Be patient as it may take several minutes for System Manager to start the repair.\\ \\ If either instance will not repair, please send email to collaboratory@avaya.com and explain what is happening. Be sure to put the IP address of System Manager in the ticket.
 +
 +===== 10.2 Tracing SIP calls =====
 +
 +If you are experiencing problems with SIP calls use SIP tracing to find a more specific reason for the problem. Chapter 16 of the [[http://​downloads.avaya.com/​css/​P8/​documents/​100168156|Maintaining and troubleshooting Avaya Aura® Session Manager Release 6.3]] document has more information on using Session Manager SIP Tracing.
 +====== 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.1  May 2016 available at https://​downloads.avaya.com/​css/​P8/​documents/​101013827 |
 +|[2] | |
 +|[3] | //​Maintaining Avaya Aura® Session Manager//, Release 7.0.1  May 2016  available at https://​downloads.avaya.com/​css/​P8/​documents/​101014038 |
 +|[4] | //​Troubleshooting Avaya Aura® Session Manager//, Release 7.0.1  May 2016  available at https://​downloads.avaya.com/​css/​P8/​documents/​101014040 |
 +|[5] | //​Administering Avaya Aura® System Manager//, Release 7.0.1  May 2016   ​available at https://​downloads.avaya.com/​css/​P8/​documents/​101014185 |
 +|[6] | //​Troubleshooting Avaya Aura® System Manager//, Release 7.0.1  May 2016   ​available at https://​downloads.avaya.com/​css/​P8/​documents/​101013941 |
 +|[7] | //​Implementing ​ Avaya one-X® Communicator//, ​ Release 6.2, November 2015 available at https://​downloads.avaya.com/​css/​P8/​documents/​100177364 |
 +|[8] | //Using Avaya one-X® Communicator//,​ Release ​ 6.2, November 2015 available at https://​downloads.avaya.com/​css/​P8/​documents/​100177365 |
 +|[9] | //Avaya Communicator Overview and Specification for Android, iPad, iPhone, and Windows// Release 2.1 v3, Oct  2015 available at https://​downloads.avaya.com/​css/​P8/​documents/​101004714 |
 +|[10] | //Using Avaya Communicator for Windows// ​ Release 2.1 v3, Oct  2015 available at https://​downloads.avaya.com/​css/​P8/​documents/​101004734 |
 +|[11] | //Using Avaya Communicator for Android// ​ Release 2.1 v3, Oct  2015 available at https://​downloads.avaya.com/​css/​P8/​documents/​101004711 ​ | 
 +|[12] | //Using Avaya Communicator for iPhone// Release 2.1 v3, Oct  2015 available at https://​downloads.avaya.com/​css/​P8/​documents/​101010021 |
 +|[13] | //Using Avaya Communicator for iPad// Release 2.1 v3, Oct  2015 available at https://​downloads.avaya.com/​css/​P8/​documents/​100182081 |
 +
 +
 +**©2016 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.
  
clab_guide.txt · Last modified: 2019-07-23 20:28 (external edit)