Using SAL Hosted Concentrator for Business Partners

Transcription

1 Using SAL Hosted Concentrator for Business Partners Release Issue 1 December 2017

2 2017, Avaya Inc. All Rights Reserved. Notice While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes. Documentation disclaimer Documentation means information published in varying mediums which may include product information, operating instructions and performance specifications that are generally made available to users of products. Documentation does not include marketing materials. Avaya shall not be responsible for any modifications, additions, or deletions to the original published version of Documentation unless such modifications, additions, or deletions were performed by or on the express behalf of Avaya. End User agrees to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation, to the extent made by End User. Link disclaimer Avaya is not responsible for the contents or reliability of any linked websites referenced within this site or Documentation provided by Avaya. Avaya is not responsible for the accuracy of any information, statement or content provided on these sites and does not necessarily endorse the products, services, or information described or offered within them. Avaya does not guarantee that these links will work all the time and has no control over the availability of the linked pages. Warranty Avaya provides a limited warranty on Avaya hardware and software. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya s standard warranty language, as well as information regarding support for this product while under warranty is available to Avaya customers and other parties through the Avaya Support website: getgenericdetails?detailid=c under the link Warranty & Product Lifecycle or such successor site as designated by Avaya. Please note that if You acquired the product(s) from an authorized Avaya Channel Partner outside of the United States and Canada, the warranty is provided to You by said Avaya Channel Partner and not by Avaya. Licenses THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA WEBSITE, UNDER THE LINK AVAYA SOFTWARE LICENSE TERMS (Avaya Products) OR SUCH SUCCESSOR SITE AS DESIGNATED BY AVAYA, ARE APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC., ANY AVAYA AFFILIATE, OR AN AVAYA CHANNEL PARTNER (AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYA OR AN AVAYA CHANNEL PARTNER. UNLESS OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR AN AVAYA CHANNEL PARTNER; AVAYA RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING, DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER REFERRED TO INTERCHANGEABLY AS YOU AND END USER ), AGREE TO THESE TERMS AND CONDITIONS AND CREATE A BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE APPLICABLE AVAYA AFFILIATE ( AVAYA ). Avaya grants You a license within the scope of the license types described below, with the exception of Heritage Nortel Software, for which the scope of the license is detailed below. Where the order documentation does not expressly identify a license type, the applicable license will be a Designated System License as set forth below in the Designated System(s) License (DS) section as applicable. The applicable number of licenses and units of capacity for which the license is granted will be one (1), unless a different number of licenses or units of capacity is specified in the documentation or other materials available to You. Software means computer programs in object code, provided by Avaya or an Avaya Channel Partner, whether as stand-alone products, pre-installed on hardware products, and any upgrades, updates, patches, bug fixes, or modified versions thereto. Designated Processor means a single stand-alone computing device. Server means a set of Designated Processors that hosts (physically or virtually) a software application to be accessed by multiple users. Instance means a single copy of the Software executing at a particular time: (i) on one physical machine; or (ii) on one deployed software virtual machine ( VM ) or similar deployment. License types Designated System(s) License (DS). End User may install and use each copy or an Instance of the Software only: 1) on a number of Designated Processors up to the number indicated in the order; or 2) up to the number of Instances of the Software as indicated in the order, Documentation, or as authorized by Avaya in writing. Avaya may require the Designated Processor(s) to be identified in the order by type, serial number, feature key, Instance, location or other specific designation, or to be provided by End User to Avaya through electronic means established by Avaya specifically for this purpose. Concurrent User License (CU). End User may install and use the Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the Software at any given time. A Unit means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an or voice mail account in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Software that permits one user to interface with the Software. Units may be linked to a specific, identified Server or an Instance of the Software. Cluster License (CL). End User may install and use each copy or an Instance of the Software only up to the number of Clusters as indicated on the order with a default of one (1) Cluster if not stated. Cluster means a group of Servers and other resources that act as a single system. Enterprise License (EN). End User may install and use each copy or an Instance of the Software only for enterprise-wide use of an unlimited number of Instances of the Software as indicated on the order or as authorized by Avaya in writing. Named User License (NU). You may: (i) install and use each copy or Instance of the Software on a single Designated Processor or Server per authorized Named User (defined below); or (ii) install and use each copy or Instance of the Software on a Server so long as only authorized Named Users access and use the Software. Named User, means a user or device that has been expressly authorized by Avaya to access and use the Software. At Avaya s sole discretion, a Named User may be, without limitation, designated by name, corporate function (e.g., webmaster or helpdesk), an or voice mail account in the name of a person or corporate function, or a directory entry in the administrative database utilized by the Software that permits one user to interface with the Software. Shrinkwrap License (SR). You may install and use the Software in accordance with the terms and conditions of the applicable license agreements, such as shrinkwrap or clickthrough license accompanying or applicable to the Software ( Shrinkwrap License ). Support tools AVAYA SUPPORT TOOLS MEAN THOSE SUPPORT TOOLS PROVIDED TO PARTNERS OR CUSTOMERS IN CONNECTION WITH MAINTENANCE SUPPORT OF AVAYA EQUYIPMENT (E.G., SAL, SLA MON, AVAYA DIAGNOISTIC SERVER, ETC.) AVAYA SUPPORT TOOLS ARE INTENDED TO BE USED FOR LAWFUL DIAGNOSTIC AND NETWORK INTEGRITY PURPOSES ONLY. The customer is responsible for understanding and complying with applicable legal requirements with regard to its network. The Tools may contain diagnostic capabilities that allow Avaya, authorized Avaya partners, and authorized customer administrators to capture

3 packets, run diagnostics, capture key strokes and information from endpoints including contact lists, and remotely control and monitor end-user devices. The customer is responsible for enabling these diagnostic capabilities, for ensuring users are aware of activities or potential activities and for compliance with any legal requirements with respect to use of the Tools and diagnostic capabilities on its network, including, without limitation, compliance with laws regarding notifications regarding capture of personal data and call recording. Avaya Support Tools are provided as an entitlement of Avaya Support Coverage (e.g., maintenance) and the entitlements are established by Avaya. The scope of the license for each Tool is described in its License terms and/or the applicable service description document. Copyright Except where expressly stated otherwise, no use should be made of materials on this site, the Documentation, Software, Hosted Service, or hardware provided by Avaya. All content on this site, the documentation, Hosted Service, and the product provided by Avaya including the selection, arrangement and design of the content is owned either by Avaya or its licensors and is protected by copyright and other intellectual property laws including the sui generis rights relating to the protection of databases. You may not modify, copy, reproduce, republish, upload, post, transmit or distribute in any way any content, in whole or in part, including any code and software unless expressly authorized by Avaya. Unauthorized reproduction, transmission, dissemination, storage, and or use without the express written consent of Avaya can be a criminal, as well as a civil offense under the applicable law. Third Party Components Third Party Components mean certain software programs or portions thereof included in the Software or Hosted Service may contain software (including open source software) distributed under third party agreements ( Third Party Components ), which contain terms regarding the rights to use certain portions of the Software ( Third Party Terms ). As required, information regarding distributed Linux OS source code (for those products that have distributed Linux OS source code) and identifying the copyright holders of the Third Party Components and the Third Party Terms that apply is available in the products, Documentation or on Avaya s website at: support.avaya.com/copyright or such successor site as designated by Avaya. The open source software license terms provided as Third Party Terms are consistent with the license rights granted in these Software License Terms, and may contain additional rights benefiting You, such as modification and distribution of the open source software. The Third Party Terms shall take precedence over these Software License Terms, solely with respect to the applicable Third Party Components to the extent that these Software License Terms impose greater restrictions on You than the applicable Third Party Terms. Service Provider THE FOLLOWING APPLIES TO AVAYA CHANNEL PARTNER S HOSTING OF AVAYA PRODUCTS OR SERVICES. THE PRODUCT OR HOSTED SERVICE MAY USE THIRD PARTY COMPONENTS SUBJECT TO THIRD PARTY TERMS AND REQUIRE A SERVICE PROVIDER TO BE INDEPENDENTLY LICENSED DIRECTLY FROM THE THIRD PARTY SUPPLIER. AN AVAYA CHANNEL PARTNER S HOSTING OF AVAYA PRODUCTS MUST BE AUTHORIZED IN WRITING BY AVAYA AND IF THOSE HOSTED PRODUCTS USE OR EMBED CERTAIN THIRD PARTY SOFTWARE, INCLUDING BUT NOT LIMITED TO MICROSOFT SOFTWARE OR CODECS, THE AVAYA CHANNEL PARTNER IS REQUIRED TO INDEPENDENTLY OBTAIN ANY APPLICABLE LICENSE AGREEMENTS, AT THE AVAYA CHANNEL PARTNER S EXPENSE, DIRECTLY FROM THE APPLICABLE THIRD PARTY SUPPLIER. WITH RESPECT TO CODECS, IF THE AVAYA CHANNEL PARTNER IS HOSTING ANY PRODUCTS THAT USE OR EMBED THE G.729 CODEC, H.264 CODEC, OR H.265 CODEC, THE AVAYA CHANNEL PARTNER ACKNOWLEDGES AND AGREES THE AVAYA CHANNEL PARTNER IS RESPONSIBLE FOR ANY AND ALL RELATED FEES AND/OR ROYALTIES. THE G.729 CODEC IS LICENSED BY SIPRO LAB TELECOM INC. SEE THE H.264 (AVC) CODEC IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR THE PERSONAL USE OF A CONSUMER OR OTHER USES IN WHICH IT DOES NOT RECEIVE REMUNERATION TO: (I) ENCODE VIDEO IN COMPLIANCE WITH THE AVC STANDARD ( AVC VIDEO ) AND/OR (II) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A PERSONAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL INFORMATION FOR H.264 (AVC) AND H.265 (HEVC) CODECS MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE Compliance with Laws You acknowledge and agree that it is Your responsibility for complying with any applicable laws and regulations, including, but not limited to laws and regulations related to call recording, data privacy, intellectual property, trade secret, fraud, and music performance rights, in the country or territory where the Avaya product is used. Preventing Toll Fraud Toll Fraud is the unauthorized use of your telecommunications system by an unauthorized party (for example, a person who is not a corporate employee, agent, subcontractor, or is not working on your company's behalf). Be aware that there can be a risk of Toll Fraud associated with your system and that, if Toll Fraud occurs, it can result in substantial additional charges for your telecommunications services. Avaya Toll Fraud intervention If You suspect that You are being victimized by Toll Fraud and You need technical assistance or support, call Technical Service Center Toll Fraud Intervention Hotline at for the United States and Canada. For additional support telephone numbers, see the Avaya Support website: or such successor site as designated by Avaya. Security Vulnerabilities Information about Avaya s security support policies can be found in the Security Policies and Support section of support.avaya.com/security. Suspected Avaya product security vulnerabilities are handled per the Avaya Product Security Support Flow ( support.avaya.com/css/p8/documents/ ). Downloading Documentation For the most current versions of Documentation, see the Avaya Support website: or such successor site as designated by Avaya. Contact Avaya Support See the Avaya Support website: for product or Hosted Service notices and articles, or to report a problem with your Avaya product or Hosted Service. For a list of support telephone numbers and contact addresses, go to the Avaya Support website: (or such successor site as designated by Avaya), scroll to the bottom of the page, and select Contact Avaya Support. Trademarks The trademarks, logos and service marks ( Marks ) displayed in this site, the Documentation, Hosted Service(s), and product(s) provided by Avaya are the registered or unregistered Marks of Avaya, its affiliates, its licensors, its suppliers, or other third parties. Users are not permitted to use such Marks without prior written consent from Avaya or such third party which may own the Mark. Nothing contained in this site, the Documentation, Hosted Service(s) and product(s) should be construed as granting, by implication, estoppel, or otherwise, any license or right in and to the Marks without the express written permission of Avaya or the applicable third party. Avaya is a registered trademark of Avaya Inc. All non-avaya trademarks are the property of their respective owners. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

4 Contents Chapter 1: Introduction... 6 Purpose of the document... 6 Chapter 2: Interface of SAL Hosted Concentrator... 7 Browser requirement for SAL Hosted Concentrator web interface... 7 Java Requirement... 7 Adding Java security exception... 7 SAL Hosted Concentrator Login... 8 Logging on to the SAL Hosted Concentrator... 8 Logging out of the SAL Hosted Concentrator... 9 SAL Hosted Concentrator web interface... 9 BP user UI Administrator UI Chapter 2: SAL Gateway Redundancy Chapter 3: Home Page List of Recent Devices List of My Active Connections Quick Actions Gaining remote access of a device Viewing device details Chapter 4: Devices Page Devices page field description Searching a device Exporting searched device list Viewing and exporting the invalid devices list Chapter 5: Device Dashboard Page Dashboard page field descriptions Muting and unmuting a device Viewing and exporting relationship table Synchronizing devices with Gateway Viewing data record details SAL Gateway Redundancy Chapter 6: Package Deployment Page Package Deployment Creating a package by uploading archived file Creating a package without uploading an archived file Searching a package Publishing a Package field descriptions Publishing a Package Viewing Package Deployment Status December 2017 Using SAL Hosted Concentrator for Business Partners 4

5 Contents Extracting files from gateway Searching and viewing the extracted file Viewing data records Chapter 7: Administration Page Domain configurations Searching a user Id Domain management Searching a BusinessPartner Merging BP domains Splitting a BP domains Chapter 8: Resources Documentation Finding documents on the Avaya Support website Viewing Avaya Mentor videos Support Using the Avaya InSite Knowledge Base December 2017 Using SAL Hosted Concentrator for Business Partners 5

6 Chapter 1: Introduction Purpose of the document This document explains how to use the SAL Hosted Concentrator user interface (UI). You can use this UI to monitor and establish end-to-end connections with Avaya devices that are deployed at a customer site. This document is intended for support engineers from authorized BusinessPartners (BP), to monitor, troubleshoot, and remotely service the Avaya devices. Note: 2.x gateways and their devices cannot be accessed by using this SAL Hosted Concentrator for Business Partners. Existing Avaya hosted concentrator 2.x should be used for these devices. December 2017 Using SAL Hosted Concentrator for Business Partners 6

7 Chapter 2: Interface of SAL Hosted Concentrator Browser requirement for SAL Hosted Concentrator web interface Internet Explorer 11 and later Mozilla Firefox 40.0 and later Java Requirement To access and use the SAL Hosted Concentrator web UI, the required java version installed on your system must be either one of the following: The latest Java (JRE) 8 Java (JRE) 7 Update 80 Adding Java security exception About this task Security exception must be added in the Java control panel to allow Java Webstart to run. This is required for running the SAL Hosted Concentrator applet on your machine. Before you begin Ensure the Browser requirement and Java requirement are met. 1. On your machine, click Start > Control Panel. 2. Search Java from the Control Panel to open the Java Control Panel. 3. Go to the Security tab on the Java Control Panel. December 2017 Using SAL Hosted Concentrator for Business Partners 7

8 Interface of SAL Hosted Concentrator 4. To add a security exception in the Exception Site List, click Edit Site List. 5. Click Add. 6. Enter the URL in the Location field. 7. Click OK to save the URL. 8. A Security Warning dialog box is displayed, click Continue. SAL Hosted Concentrator Login To access SAL Remote Access Hosted Concentrator you can login as: BusinessPartner User BusinessPartner Administrator Avaya Administrator Logging on to the SAL Hosted Concentrator Before you begin Ensure that you have the following: The Avaya Single Sign On (SSO) login details that is added to the SAL Hosted Concentrator for BusinessPartner account you belong to. The customer location, SAL Gateway, and devices that needs to be accessed by the SSO login must already be associated with the respective BusinessPartner account. Note: For the configuration of the BusinessPartner account details, including the addition of SSO logins, download the SAL Hosted Concentrator request form from the Partner portal at and send the filled form to BPHostedSAL@avaya.com. The login credentials will be different for different user type. However, the login procedure is the same. SAL Hosted Concentrator server URL: A computer with a web browser and access to the internet. Access to the network where the SAL Hosted Concentrator server is installed. Note: If you are using Internet Explorer to access SAL Hosted Concentrator server, use the URL: to avoid session time out error. December 2017 Using SAL Hosted Concentrator for Business Partners 8

9 Logging out of the SAL Hosted Concentrator Result 1. Open a supported browser from a computer on your network, and navigate to the SAL Hosted Concentrator URL: 2. On the login page, enter your Avaya SSO credentials, and click Submit. 3. On End Users License Agreement page, click Accept. The system displays the default home page of SAL Hosted Concentrator. Logging out of the SAL Hosted Concentrator 1. Hover the cursor over the profile icon on the upper-right corner of the UI. 2. Click Logout from the drop-down list. SAL Hosted Concentrator web interface To login to SAL Hosted Concentrator, three separate login access are provided on basis of the type of the user. The different types of users are: BP User BP Administrator Avaya Administrator The access rights or privileges are not the same for all the users. December 2017 Using SAL Hosted Concentrator for Business Partners 9

10 Interface of SAL Hosted Concentrator The Home page is the landing page of the SAL Hosted Concentrator web interface. The following is the Home page for an Administrator. No. Name Description 1 Title bar Displays the following information: User ID of the person who has logged in. The Log Out link. Version details 2 Navigation tabs Provides tab options to access the tools of SAL Hosted Concentrator. For a BusinessPartner (BP) user account, the Administration tab is not available. 3 Work area Displays the page that you select from the navigation tabs. Related links BP user UI on page 11 Administrator UI on page 12 When you log on to the web UI, the system displays the Home page as default in the work area. December 2017 Using SAL Hosted Concentrator for Business Partners 10

11 SAL Hosted Concentrator web interface BP user UI If you login to SAL Hosted Concentrator with BP user credentials, you will land on the following page. The BP User home page do not have the Administration tab Related links SAL Hosted Concentrator web interface on page 9 December 2017 Using SAL Hosted Concentrator for Business Partners 11

12 Interface of SAL Hosted Concentrator Administrator UI The Administrator user account has an additional Administration tab apart from the other Navigation tabs. Both the BP Administrator and Avaya Administrator has the Administration tab, but the menu options for both are different. BP Administrator For BP Administrator, the Administration tab consists of the following menu: Domain Configuration User Domain Management December 2017 Using SAL Hosted Concentrator for Business Partners 12

13 SAL Hosted Concentrator web interface Avaya Administrator For Avaya Administrator, the Administration tab consists of the following menu: User BP Administration Related links SAL Hosted Concentrator web interface on page 9 December 2017 Using SAL Hosted Concentrator for Business Partners 13

14 Chapter 2: SAL Gateway Redundancy Avaya Hosted Concentrator controls SAL Gateway Redundancy. SAL Gateway connected to BP concentrator cannot operate as redundant pair. With SAL 2.x technology, only SAL Gateways connected to the Avaya Hosted concentrator can operate as a redundant pair. With SAL 3.x technology, the individual BP concentrator are replaced with the Avaya Hosted Concentrator for Business Partners. SAL Gateway 3.0 connects to both the Avaya Hosted concentrator and to the BP concentrator by administering a BP link ID in the gateway. In this environment, SAL Gateway can operate as a redundant pair if: Both SAL Gateways are release 3.0 with SP2 (3.0.2) or later. Both SAL Gateways are administered with the same BP link ID. The redundancy will be broken if: If release 2.x SAL Gateways are operating as a redundant pair, but after upgrade to they are administered with different BP link ID. If release 3.x SAL Gateways are operating as a redundant pair, but later they are administered with different BP link ID. December 2017 Using SAL Hosted Concentrator for Business Partners 14

15 Chapter 3: Home Page List of Recent Devices The Recent Devices section on the Home Page displays the list of all the devices which the logged in user had recently made a remote access connection to. The table also displays: The SEID of the device. A status icon that indicates Gateway and device connectivity. The Protocols supported by the device to gain remote access. If you hover the cursor over a device SEID, the following information is displayed: Considered Gateway: The Gateway SEID considered for status information. Reason for Status which explains the status icon. A status icon of all the Gateways linked to the device. SEID of all the Gateways linked to the device. Click the device SEID link to go to the device Dashboard page. Note: The considered gateway is as per the current status. While gaining the remote connection, another gateway might be picked up that suits best at the time of connection. List of My Active Connections The My Active Connections section on the Home Page displays the list of all the Remote Access connections currently active for the logged in User. The table also displays: The SEID of the device. A status icon that indicates Gateway and device connectivity. The Protocol allowed by the device to gain remote access. December 2017 Using SAL Hosted Concentrator for Business Partners 15

16 Home Page A Disconnect link to disconnect the remote session. If you hover the cursor over a device SEID, the following information is displayed: Considered Gateway: The Gateway SEID considered for status information. Reason for Status which explains the status icon. A status icon of all the Gateways linked to the device. SEID of all the Gateways linked to the device. Click the device SEID link to go to the device Dashboard page. Note: The considered gateway is as per the current status. While gaining the remote connection, another gateway might be picked up that suits best at the time of connection. Quick Actions The Quick Actions section contain options to perform either one of the following: Connect to : Connects to the device that has the entered SEID. View Details Of : Views the device details of the entered SEID. To gain remote connection or view device details, the user must know the full or partial SEID of the device. Related links Gaining remote access of a device on page 16 Viewing device details on page 17 Gaining remote access of a device Before you begin To request a remote connection to the device, ensure you have the device or gateway SEID. Partial SEID is also sufficient to execute the device search. 1. Login to the SAL Hosted Concentrator for Business Partners using the Avaya SSO credentials. 2. On the Home page, navigate to the Quick Actions section. 3. Select Connect to. 4. Enter the device SEID in the search field. December 2017 Using SAL Hosted Concentrator for Business Partners 16

17 Quick Actions 5. A list of devices that matches your search criteria is displayed. The list displays: Account Reference Status icon SEID of the device Node type 6. Select the desired SEID and click Go. 7. Connect to device dialog box is displayed. 8. Select the connection type for initiating the remote connection. 9. Remote Access Request Details dialog box is displayed. 10. Click Connect. A jnlp file is downloaded to your desktop. 11. Open the jnlp file. 12. Click Continue, if the system shows a security warning dialog box. 13. Enter the SAL Hosted Concentrator login credentials. If you enter incorrect login credentials in the first attempt, followed by the correct credentials in the second attempt, an Unable to launch the application error is encountered. To resolve this, close the login window, run the same jnlp file and log in with correct credentials within 3 minutes. If 3 minutes have elapsed, request a new Remote connection and follow step 7 through Click Run. Result A Remote Session Ready message is displayed, remote session begins and the device is listed in the My Active Connections section. Related links Quick Actions on page 16 Viewing device details Before you begin To view device details, ensure you have the device or gateway SEID. Partial SEID is also sufficient to execute the device search. 1. Login to the SAL Hosted Concentrator for Business Partners using the Avaya SSO credentials. 2. On the Home page, navigate to the Quick Actions section. December 2017 Using SAL Hosted Concentrator for Business Partners 17

18 Home Page 3. Select View details of. 4. Enter the device SEID in the search field. 5. A list of devices that matches your search criteria is displayed. The list displays: Result Account Reference Status icon SEID of the device Node type 6. Select the desired device SEID and click Go. You are directed to the Device Dashboard page. Related links Quick Actions on page 16 December 2017 Using SAL Hosted Concentrator for Business Partners 18

19 Chapter 4: Devices Page Devices page field description This page has two section: Search filter section: Includes the search criteria to search a device on this page Search result section: Views the status icon information and list of devices that matches the provided search criteria. The Search filter section includes the below search criteria: Name Account Ref Location Ref Node Type Alarm ID SEID Model Name IP Address Description A 10-character Account number assigned to a customer. Functional location number of the customer, whom the device is sold to. The type of Node applicable to your device that you want to search. The options are: All CoreServer Gateway Device A unique 10-character Product ID assigned to a device. The Product ID is included in the alarms that are sent to alarm receivers from the managed device. The unique identifier assigned to the device when the device is registered with Avaya. The ID is in the (nnn)nnn-nnnn format, where n is a digit in the range 0 through 9. SAL Gateway uses the Solution Element ID value to uniquely identify the managed device for providing the remote access facility. The SAL Model configured on the SAL gateway to the device that you want to search. The IP address of the device that you want to search. Table continues December 2017 Using SAL Hosted Concentrator for Business Partners 19

20 Devices Page Data Record contains: BP Names Include Unverified: Additional gateway specific properties for the gateway SEID that you want to search. This option is only applicable if you want to search for Gateway. The value of the Data Record field that you want to search. The name of the Avaya authorised Business Partner associated to the device that you want to search. Check box to include Unverified devices in the device search. Unverified devices are the devices that are not registered with Avaya or are registered with incorrect information for one of the following field: Model Name SEID Alarm ID For BP and Avaya Administrator login, the below additional search fields are available. Name Remote Access Filter Show Only Muted: Button Search Reset Description The status of the device that you want to search. The status option are: Active: List of active devices that has one or more than one valid policy applicable to it. Without Policy: List of active devices that do not have any policies applicable to it. Maintenance: List of all the devices that are under maintenance Inactive: List of all inactive devices. Disabled/Unauthorized: List of all the disabled or unauthorized devices. Any: List of all the devices. Check box to view only the muted devices in the device search result. Muted devices are devices that do not allow any communication. Description Initiates the search for devices that matches the search criteria. Erases all the data from the search fields. Table continues December 2017 Using SAL Hosted Concentrator for Business Partners 20

21 Devices page field description Invalid Devices Views the list of all the invalid devices for your domain. Invalid devices are the devices that are not registered with Avaya or are registered with incorrect information for one of the following field: Model Name SEID Alarm ID The search results are displayed in the search result section. It includes the below additional information: Name Link Ids RA Description The unique identifier assigned to all the authorised Avaya Partners. The Remote access status of the device. The status options are: Active Without Policy Maintenance Inactive Disabled/Unauthorized Muted Derived Muted Not Applicable Note: Deployment Device remote access status is derived from the gateway remote access status which is managing this device. The type or method of deployment used. The options are: SFTW : Software Only OVA : ADS OVA SAL_AVP : Small SAL OVA SVM : Services VM ION-H : ION-Appliance ION-V : ION-OVA FIPS : FIPS (SW only version supported) Table continues December 2017 Using SAL Hosted Concentrator for Business Partners 21

22 Devices Page Verified ION-H32 : ION-H32 Confirms if the device has been registered with Avaya based on the following fields: Model Name SEID Alarm ID Searching a device About this task Some of the search filters on the Devices page are only available for Administrators. Remote Access Filter search criteria and Show Only Muted check box is not available for BP users. 1. Navigate to the Devices page. 2. Enter values in one or more of the following fields by which you want to search for a device: Account Ref Location Ref Node Type Alarm ID SEID Model Name IP Address Data Record and contains: BP Names 3. (Optional) You can also select one of the options in the Remote Access Filter field to search for a device: Active Without Policy Maintenance Inactive Disabled/Unauthorized Any December 2017 Using SAL Hosted Concentrator for Business Partners 22

23 Exporting searched device list 4. Select the Include Unverified check box to include the unverified devices in the search result. 5. Select the Show Only Muted check box to view only the muted device in the search result. 6. Click Search. A list of devices that matches the selected search criteria is displayed. Exporting searched device list Result 1. Navigate to the Devices page. 2. Use any of the provided search filter to search for a device. The search results will be displayed in a tabular format. 3. Click the Export Devices button located above the search result table. The device list will open in an excel sheet after you select the Save/Open option. Viewing and exporting the invalid devices list 1. Navigate to the Devices page. 2. Click the Invalid Devices button. The search results will be displayed in a new window and displays the following fields: Device SEID: The SEID assigned to the device when the device is registered with Avaya. Gateway SEID: The SEID assigned to the Gateway when it is registered with Avaya. Error Code: The Error code displayed if the device is not registered with Avaya. The options are: - ASSET_NOT_FOUND - ALARMID_MISMATCH - MODEL_MISMATCH Original Value: The Alarm ID or Model entered on SAL Gateway while adding the device as Managed Element. This field will be populated if the error code is: ALARMID_MISMATCH or MODEL_MISMATCH. December 2017 Using SAL Hosted Concentrator for Business Partners 23

24 Devices Page Result Expected Value: The Alarm ID or Model assigned to the Device or Gateway during registration with Avaya. This field will be populated if the error code is: ALARMID_MISMATCH or MODEL_MISMATCH. Description: Description or reason of the error for the device. 3. You can view the search results in a new window. 4. To export the device list, click the Export button. The device list will open in an excel sheet after you select the Save/Open option. December 2017 Using SAL Hosted Concentrator for Business Partners 24

25 Chapter 5: Device Dashboard Page Dashboard page field descriptions If you select a device on the Home page or from device list on Devices page, you will be taken to the Dashboard page of the selected device. The Dashboard page gives detailed information about the selected device. The Dashboard page is divided into the below sections: Device/Gateway (SEID): Details of the selected device or gateway. Status: Status details of the selected device. Quick Actions: Synchronizes the devices linked to the selected Gateway Relationships: Relationship of the devices with the other linked devices or gateway. Remote Access: Protocol used to gain remote access. Data: Details of the data record or the Name-Value pairs providing system information about SAL Gateway Files: Details of the file pulled from the gateway. Remote Access Audit: Details of all the Remote access sessions. Packages: Details of the linked packages and its deployment status. Device/Gateway (nnn)nnn-nnnn While viewing a device Dashboard, the following information will be displayed in section gives the below device information. Name Device SEID Muted Description The unique identifier assigned to the device when the device is registered with Avaya. The ID is in the (nnn)nnn-nnnn format, where n is a digit in the range 0 through 9. SAL Gateway uses the Solution Element ID value to uniquely identify the managed device for providing the remote access facility. Confirms if the device allows remote access. If muted, the device cannot be communicated. There is a Mute/Unmute link that can be used to Mute/Unmute the device communication. Table continues December 2017 Using SAL Hosted Concentrator for Business Partners 25

26 Device Dashboard Page Alarm ID Model Name Model Version Account Ref Account Name Location Ref Location Name BP Link Ids BP Names Status Name Remote Access Status Last Ping Status A unique 10-character Product ID assigned to a device.the Product ID is included in alarms that are sent to alarm receivers from the managed device. The SAL model associated with the device, which indicates the product family of the selected device. The version number of the SAL model associated with the device. A 10-character Account number assigned to a customer. The account name of the customer whom the device is sold to. Functional location number of the customer, whom the device is sold to. The functional location name of the customer, whom the device is sold to. The unique identifier assigned to all the authorised Avaya Partners. Contact Avaya or your Avaya authorised Partner to obtain this Link ID. The BP name is auto populated by the Avaya hosted server, after verifying the BP name assigned to the Link ID. If the Link ID is invalid or not configured with SAL Gateway, this field will be set to the default value and SAL Gateway will not be accessible by the BP. Description The Remote access status of the device. The status option are: Active Without Policy Maintenance Inactive Disabled/Unauthorized Muted Derived muted Not Applicable Shows the date and time of the last connection made with the device. Table continues December 2017 Using SAL Hosted Concentrator for Business Partners 26

27 Dashboard page field descriptions Verified City Address Confirms if the device has been registered with Avaya based on the following fields: Model Name SEID Alarm ID The city where the device is located. Address of the user whom the device was sold to. Quick Actions If the displayed device is SAL Gateway, the Quick Actions section is enabled. You can use this section to Synchronize Devices linked to the gateway and are displayed in the Relationships section, on this page. Quick Actions section is enabled for users with Administrator privileges. This section is not displayed for BP user. Relationships This table views the list of all the devices linked to the searched device. Name Relation Account Ref Remote SEID Model Name Verified Export Devices Description The relationship of the device with the initially searched device. the relationships could be: Manages Managed By partof A 10-character Account number assigned to a customer. The Remote access status of the device. Device SEID The SAL model associated with the device, which indicates the product family of the selected device. Confirms if the device has been registered with Avaya based on the following fields: Model Name SEID Alarm ID You can use Export button to Export the device list. Remote Access The Remote Access section lists the top three remote access methods available for you to connect to the selected product. The available methods are determined by the SAL Model selected when the device was added as a Managed Element to the customer SAL Gateway. December 2017 Using SAL Hosted Concentrator for Business Partners 27

28 Device Dashboard Page Data Data Records are Name-Value pairs providing system information about SAL Gateway. It provided information such as OS name, OS Architecture, and Core server details, and updating the Core Server. Files The Files section lists the files that are pulled from the Gateway and the time when it was pulled. This section can be viewed only when the dashboard belongs to a Gateway. Remote Access Audit Name Timestamp Status User SR Number Reason Description Time and date of the remote session. Status of the remote session. User ID of the user who initiated the remote session. The Solution Element ID (SEID) of the device. Reason for remote access request. In case Packages Name Package Name Status Last Updated Description Name of the package that was deployed. Status of package deployment. Whether successful or failed. Time and date of the when the deployment was executed. Muting and unmuting a device 1. Search the desired device from the Home page or Device page. 2. Select the device and you will be navigated to the device Dashboard page. 3. In the Device section, on the Dashboard page, click Mute to mute the device communication. 4. If the device is already muted, an Unmute link will be displayed instead. 5. Click Unmute to restore the device communication. December 2017 Using SAL Hosted Concentrator for Business Partners 28

29 Viewing and exporting relationship table Viewing and exporting relationship table 1. Navigate to the Dashboard page of a device. 2. You can view the relationship table in Relationships section of the device dashboard. 3. Click the Export Devices button to export the table. The device list will open in an excel sheet after you select the Save/Open option. Synchronizing devices with Gateway About this task To update the list of all the devices linked to the Gateway that can be viewed in the Relationships table, a Synchronize Devices button is available The Synchronize Devices button is enabled only if the device dashboard belongs to a Gateway. 1. Search and select a Gateway on the Home page or Device page. You will be navigated to the Device Dashboard page. 2. Click the Synchronize Devices button and a full device synchronization request will be sent to the Gateway..The Relationships table will be refreshed and any new devices added to the Gateway will be updated in the list. Viewing data record details About this task To view more information about the selected Gateway s properties and values view the Data Record details of the device on the Dashboard page.. 1. Navigate to the Device Dashboard page. 2. You can view the device data in the Data section of the Dashboard page. 3. Click the Details link to view the complete details. December 2017 Using SAL Hosted Concentrator for Business Partners 29

30 Device Dashboard Page In a new window, the following Data Records will be displayed: Created Date: The date on which the first data record was created/collected by executing Data Record Package. Updated Date: The Data Record package can be executed multiple times on SAL Gateway provided by frequency during package creation. If the package is executed more than once, Updated Date for the respective Name (property/key) will be updated. Name: The name of the property, for example, JAVA_HOME. Value: The value of the property. SAL Gateway Redundancy Avaya Hosted Concentrator controls SAL Gateway Redundancy. SAL Gateway connected to BP concentrator cannot operate as redundant pair. With SAL 2.x technology, only SAL Gateways connected to the Avaya Hosted concentrator can operate as a redundant pair. With SAL 3.x technology, the individual BP concentrator are replaced with the Avaya Hosted Concentrator for Business Partners. SAL Gateway 3.0 connects to both the Avaya Hosted concentrator and to the BP concentrator by administering a BP link ID in the gateway. In this environment, SAL Gateway can operate as a redundant pair if: Both SAL Gateways are release 3.0 with SP2 (3.0.2) or later. Both SAL Gateways are administered with the same BP link ID. The redundancy will be broken if: If release 2.x SAL Gateways are operating as a redundant pair, but after upgrade to they are administered with different BP link ID. If release 3.x SAL Gateways are operating as a redundant pair, but later they are administered with different BP link ID. December 2017 Using SAL Hosted Concentrator for Business Partners 30

31 Chapter 6: Package Deployment Page Package Deployment On this page you can create and deploy remote packages and use other functionalities related to packages on the Core Server UI. A remote package is a tar.gz archive file that contains scripts or files that need to be downloaded on the client SAL Gateway. The package name and location on the Core Server are stored in the database along with instructions on how to execute the package on the SAL Gateway, what files have to be uploaded back from the SAL Gateway to core, etc. These instructions can be specified as part of an optional metadata.xml file, which can be added as part of the package. The methods for creating a new package are: Creating a new package by uploading an archived file. Creating a new package without uploading an archived file. Creating a new package by uploading an archived file You can create a package using a metadata.xml file that may include package instructions and bundle it in an archive file The supported archive file format is tar.gz. This archive file data will get auto updated in pre-configured fields. These fields are editable. Creating a new package without uploading an archived file If the archive file (tar.gz) does not contain the metadata.xml file, all the details must be added manually. Once the user saves the package, the metadata.xml file will be automatically generated in the uploaded archive file and the package can be downloaded. The Create package screen can be used for generating the metadata.xml into the package. This new archive can then be passed on so that the next time it is uploaded on the Create package screen (eg. In production), the instructions now present in it will pre-populate the screen. Creating a package by uploading archived file About this task You can create a package using a metadata.xml file that may include package instructions and bundle it in an archive file The supported archive file format is tar.gz. This archive file data will get auto updated in pre-configured fields. These fields are editable. December 2017 Using SAL Hosted Concentrator for Business Partners 31

32 Package Deployment Page 1. Navigate to Package Deployment page and select the Create Package option. 2. In the Do you want to upload package archive file? field, select Yes. 3. Click the Upload button to upload the package instructions metadata file (tar.gz). 4. Click Browse and then choose the file you want to upload. 5. Select the file and then click Open. 6. Click Upload. The desired tar.gz file will be uploaded and some of field will be auto updated. 7. Edit the required fields, and click Save. 8. If the uploaded file is not correct, select Reset button. Creating a package without uploading an archived file About this task If you are not using the existing metadata.xml file to create a new package, add the required field details manually.. 1. Navigate to Package Deployment page and select the Create Package option. 2. In the Do you want to upload package archive file? field, select No. 3. Enter the required details in the following field: Name :This field uniquely identifies the package. It is a mandatory field. Type :It describes the type of package. Currently supported types are: - Generic Package - Data Record Description :This text field provides more information about the package. It is an optional field. Maximum Retry Attempts :This field indicates the number of times retry should be triggered if upload/download activity fails. The default value is 5 and the retry range is from 0 to 99. Do you want to provide PreRequisite Script? :This field is to provide the name and path of the prerequisite script file. Do you want to provide Package Execution Script? :This is an optional script file and it should be selected as Yes if there is a script file for package execution. December 2017 Using SAL Hosted Concentrator for Business Partners 32