Avaya 16-300272 manual

Broadcast Server User Guide Release 2.1 (Service Pack) 16-300272 Issue 2.1 April 2006[...]

Copyright 2004-20 06, Avaya Inc. All Rights Reserved Notice Every effort was made to ensure that the information in this document was complete and accurate at the time of printing. However , information is subject to change. Warranty Avaya Inc. provides a li mited warranty on this pr oduct. Refer to your sales agreement to establish the terms of th[...]

iii Broadcast Server User Guide Contents Preface vii Audience vii Related Documentation vii CHAPTER 1 Introduction to Broadcast Server 1 Broadcast Server Overview 2 Users 3 Subscribers and Di stribution Lists 3 Alerts 4 Sending Alerts 5 BCS Interaction with Phones 5 Opening and Using the Broadcast Server Inter face 6 Configuring Broadcast Server 6 [...]

Contents Broadcast Server User Guide iv The User Page 19 User information 19 Password 19 Shared distribution l ist access 20 General user permissions 20 Alert access 21 CHAPTER 6 Subscriber Management 23 The Subscriber Management List 23 Quick FAQ 24 The Subscriber Page 25 Subscriber information 25 Subscriber settings 26 Distribution list membershi[...]

v Broadcast Server User Guide Contents The Media Page 38 Uploading a media file 38 Supported graphic formats 38 Supported audio formats 39 CHAPTER 9 External Service Management 41 The External Services Management List 41 Quick FAQ 42 The External Service Page 42 CHAPTER 10 Broadcast Alert Management 45 The Alert List 45 Column Descriptions 46 Alert[...]

Contents Broadcast Server User Guide vi PushMessage Request 59 Recipient 60 Subject, Body, Image, Audio, Button 60 Schedule 61 DistributionList Request 62 Member 62 ServerRegistration Response 63 Subscribers Response 63 PushMessageResponse Response 63 Push XML Reference 64 Character Set and Character Entities 64 XML Declaration 64 ManagePushMessage[...]

vii Broadcast Server User Guide Preface This preface describes who should read the Broa dcast Server User Guide , how it is organized, and its document conven tions. Audience This user guide is intended for administrators who will configure and use the Broadcast Server. Related Documentation For deployment and installation information for Broadcast[...]

Related Documentatio n viii Broadcast Server Us er Guide[...]

1 Broadcast Server User Guide Chapter 1 Introduction to Broadcast Server With Broadcast Server you can create alerts for display on th e screens of your Avaya IP telephones. You direct alerts to distribution lists. The phones to receive alerts might be in reception areas and conference rooms, guest rooms, staff members’ offices, factory floors, w[...]

Chapter 1 Introduction to Broad cast Server Broadcast Server Overview 2 Broadcast Server Us er Guide Broadcast Server Overview Broadcast Server, a server-based application, manages alerts created by Broadcast Server users and sent to subscr ibers , according to rules and schedules defined by the Broadcas t Server administrator and the individual al[...]

Broadcast Server User Guide Chapter 1 Introduction to Broadcast Server Broadcast Server Overview 3 Users Broadcast Server has one administr ative user (Administrator) with full access to all Broadcast Server contr ols. The Broa dcast Serv er Administrator can create accounts for other users who will compose and send alerts in Broadcast Server. User[...]

Chapter 1 Introduction to Broad cast Server Broadcast Server Overview 4 Broadcast Server Us er Guide The Broadcast Server administrator ca n see all distribution lists while individual users can only see those lists they own and those that have been shared with them by the administrator. By default, the distribution lists created automatically from[...]

Broadcast Server User Guide Chapter 1 Introduction to Broadcast Server Broadcast Server Overview 5 Sending Alerts Creating and sending an alert is ea sy through the Broadcast Server. You use a Web-based interface to configure the alert, a delivery schedule, and the distribution list(s) to receive the alert. An alert can consist of plain t ext and/o[...]

Chapter 1 Introduction to Broad cast Server Opening and Using the Broadcast Server Interface 6 Broadcast Server Us er Guide Opening and Using the Broadcast Server Interface All administrative and user tasks are performed through a web-based interface. To open the interface, enter the following URL in a web browser: http:// ipAddress /BCS where ipAd[...]

Broadcast Server User Guide Chapter 1 Introduction to Broadcast Server Configuring Broadcast Server 7 Initial Configuration In typical usage, the Broadcast Server administrator enables a select group of users to broadcast alerts to distribution lists obtained from th e Application Gateway (which is synchr onized with LDAP or CSV directory sources).[...]

Chapter 1 Introduction to Broad cast Server Configuring Broadcast Server 8 Broadcast Server Us er Guide b. Media Files Media files consist of alert tones and images files. (Image files are not supported on all phones.) The system media files provided with Broadcast Server are available to all users. To make additional media files ava ilable to all [...]

9 Broadcast Server User Guide Chapter 2 Application Gateway and Broadcast Server Operation As shown in the following illustrati on, Broadcast Serv er communicates only with the Application Gateway. The Application Gateway provides Broadcast Server with device inform ation and manages all communication with other servers and IP telephone s. The Appl[...]

Chapter 2 Application Gateway and Broad cast Server Operation 10 Broadcast Server Us er Guide You can also configure connection inform ation for one or more LDAP servers or CSV-formatted directory files, enabling the Application Gateway to automatically supply Broadcas t Server with distribution l ists. When the Application Gateway detect s that an[...]

11 Broadcast Server User Guide Chapter 3 System Management The System Management page is a single location for defining all Broadcast Server control parameters and for performing system-le vel tasks such as temporarily disabling the system. Component Versions This section lists the versions of the various components used by Broadcast Server and its[...]

Chapter 3 System Management Server configuration 12 Broadcast Server Us er Guide Server configuration Support items Item Descrip tion Suspend BCS button Click this button to temporarily di sable the Broadcast Server messaging functionality. Only use this feature if you believe that the Broadcast Server is causing a problem on your network or Commun[...]

Broadcast Server User Guide Chapter 3 System Management Home page tips 13 Home page tips Item Descr iption Tip 1 The text to display in the first blue ti p box on the Broadcast Ser ver home page. Tip 2 The text to display in the second blue tip box on the Broadcast Server home page. Tip 3 The text to display in the third blue tip box on the Broadca[...]

Chapter 3 System Management Home page tips 14 Broadcast Server Us er Guide[...]

15 Broadcast Server User Guide Chapter 4 System Messages System messages are status messages th at the Broadcast Server places in the database when it detects system errors. Note that these messages are not sent to subscribers or distribution lists – they are reserved for the Broadcast Server system administrator only. When you are logged into th[...]

Chapter 4 System Messages Quick FAQ 16 Broadcast Server Us er Guide[...]

17 Broadcast Server User Guide Chapter 5 User Management Broadcast Server users are individuals who can log in to Broadcast Server to create and manage content. The administrator’s task is to define users and assign privileges to those indivi duals. Privileges dictate to which distribution lists a user m ay send alerts, which portion s of an aler[...]

Chapter 5 User Management Quick FAQ 18 Broadcast Server Us er Guide Quick FAQ Icon Description The user record has been deactivated. The user will not be allowed to login to Broadcast Server. The user does not have a password assigned. How do I … Description Change my filter criteria Select the filter ing type from the dro p-down list and enter a[...]

Broadcast Server User Guide Chapter 5 User Management The User Page 19 The User Page User information The Active checkbox indicates whether the user record is active in Broadcast Server – that is, whether the user may lo g in to the system . At minimum, a Broadcast Server user must have a u ser ID and a name defined. You can also provide a depa r[...]

Chapter 5 User Management The User Page 20 Broadcast Server Us er Guide Shared distribut ion list access This section allows you to select the shared distribution lists to which the user may send alerts. Note that these are not all the distribution lists in the system – only those shared among users at the discretion of the system administrator. [...]

Broadcast Server User Guide Chapter 5 User Management The User Page 21 Alert access This section allows you to specify the kinds of alert s a user may acces s and what operations they may carry out on those types of alerts. Allow user to add subscribers to distribution lists If this option is checked, a user will be able to add subscribers to their[...]

Chapter 5 User Management The User Page 22 Broadcast Server Us er Guide[...]

23 Broadcast Server User Guide Chapter 6 Subscriber Management Subscribers are IP telephones that ca n receive conte nt posted by Broadcast Server users. A subscriber entry is created when Broadcast Server receives subscriber information from the Application Gateway when an IP telephone co mes online . The Subscriber Management List The subscriber [...]

Chapter 6 Subscriber Manageme nt Quick FAQ 24 Broadcast Server Us er Guide Note Broadcast Server will display the name of the user who is currently logged into a device. Quick FAQ The subscriber is not a member of any distribution lists. The subscriber’s information was changed during the last synchronization. Edit the record to view the ch anges[...]

Broadcast Server User Guide Chapter 6 Subscriber Management The Subscriber Page 25 The Subscriber Page Subscriber information The Active checkbox indicates whether the subscriber record is active in Broadcast Server – that is, whether the subscriber will receive al erts posted by Broadcast Server users. The IP Address field contains the network a[...]

Chapter 6 Subscriber Manageme nt Subscriber settings 26 Broadcast Server Us er Guide Subscriber settings Subscriber settings are options set for a particular sub scriber. Distribution list membership This section lists the distribution li sts the subscriber belongs to. Click a distribution list to edit th e membership for that list. Setting Descrip[...]

27 Broadcast Server User Guide Chapter 7 Distribution List Management Distribution lists enable you to grou p subscribers together as recipients for alerts. These lists can be created and maintained by the system administrator. You can also configure the Application G ateway to add entries to the distribution list when an IP telephone comes online.[...]

Chapter 7 Distribution List Manag ement The Distribution List Page 28 Broadcast Server Us er Guide Automatically created distribution lists If you have configured the Applicat ion Gateway to obtain department information from a directory source (LDAP or CSV), Broadcast Server will automatically create and update distribu tion lists based on the dep[...]

Broadcast Server User Guide Chapter 7 Distribution List Management Quick FAQ 29 Sharing distribution lists Sharing distribution lists is a way to standardize on a set of distribution lists across the organization an d is easy to do in the Broadcast Server. Only the system administr ator can perfo rm this function. Users can share onl y the lists th[...]

Chapter 7 Distribution List Manag ement The Distribution List Page 30 Broadcast Server Us er Guide The Distribution List Page The Act ive checkbox indicates whether the di stribution list is active– that is, whether the recipients on the list will receive alerts from Br oadcast Server. A distribution list must be named; comm ents are optional. Un[...]

Broadcast Server User Guide Chapter 7 Distribution List Management The Distribution List Membership Page 31 A shared distribution list will also have a link titled Edit user permissions – allowing you to link to the Distribution List User Permissions page where you can select the Broadcast Server users who can send alerts to the distribution list[...]

Chapter 7 Distribution List Manag ement The Distribution List User Permissions Pag e 32 Broadcast Server Us er Guide distribution list into one named United States along with oth er regional US lists. You could do the same for locations in other cites in other countries, or any combination or co nfiguration that suits your needs. Like other screens[...]

Broadcast Server User Guide Chapter 7 Distribution List Management The Distribution List User Permissions Page 33 This page is available from the Edit User Permissions link on the Manage Distribution Lists page if ownership of the list has been shared, as described in “Sharing distribution lists,” page 29 . This page contains two columns showin[...]

Chapter 7 Distribution List Manag ement The Distribution List User Permissions Pag e 34 Broadcast Server Us er Guide[...]

35 Broadcast Server User Guide Chapter 8 Media Management Media in Broadcast Server consists of image and audio files stored on the Broadcast Server. These files are stored in media libraries maintained by the system administrator and/or indi vidual Broadcast Server users. Not all phones support the display of images. Both image and audio files sto[...]

Chapter 8 Media Management The Media List 36 Broadcast Server Us er Guide The media list includes these sections: • System Images – graphics used internally by Broadcast Server (available to the system administrator only) • Shared Images – graphics available to Broadcast Server users • My Images – graphics that are owned by the curr ent[...]

Broadcast Server User Guide Chapter 8 Media Management Quick FAQ 37 Media ownership The Owner column (available to the system administrator only) contains the name of the user who currently owns the me dia item. The administrator can change ownership of audio items, assigning th em to another user, or sharin g them among all other Broadcast Serve r[...]

Chapter 8 Media Management The Media Page 38 Broadcast Server Us er Guide The Media Page The Active checkbox indicates whether the media item is active– th at is, whether the item can be used by users when creating alerts. All media items must have a name and a short description, as well as a file containing the actual media. If the media item is[...]

Broadcast Server User Guide Chapter 8 Media Management The Media Page 39 Note Graphics converted to a format that can be displayed on IP phones may suffer degradation depending on the si ze, aspect ratio, and color-depth of the picture. For best results use a file with a resolution and color model appropriate for the IP phone screen. Supported audi[...]

Chapter 8 Media Management The Media Page 40 Broadcast Server Us er Guide[...]

41 Broadcast Server User Guide Chapter 9 External Service Management External Services are network-based applications that can be launched from IP telephones. Broadcast Server allows users to link th eir alerts to such services in order to provide content and func tion ality beyond the scope of the Broadcast Server syst em. Such applications may in[...]

Chapter 9 External Service Manageme nt Quick FAQ 42 Broadcast Server Us er Guide Quick FAQ The External Service Page The Active checkbox indicates whether the External Service record is active in Broadcast Server – that is , whether the service is available to Broadcast Server users when they create alerts. At mi nimum, an External Service defi n[...]

Broadcast Server User Guide Chapter 9 External Service Management The External Service Page 43 The URL field contains the URL that will be passed to devices that allows them to access the service. Note Be aware that your IP phones must be capable of accessing th e URL exactly as typed. For instance: If your IP phones cannot use DNS to resolve a URL[...]

Chapter 9 External Service Manageme nt The External Service Page 44 Broadcast Server Us er Guide[...]

45 Broadcast Server User Guide Chapter 10 Broadcast Alert Management Alerts can be created and updated by Broadcast Server users and posted to distribution lists. This section de scribes alert creation, modification and management. The Alert List The alert list page shows the alerts available to the currently logged-in user. Broadcast Server will d[...]

Chapter 10 Broadcast Alert Management Column Descriptions 46 Broadcast Server Us er Guide Column Descriptions Icon Description The alert has been disabled and will not be sent to subscribers. The alert’s delivery schedule dictates that the alert should be delivered at the current time. The alert’s delivery schedule di ctates that the alert will[...]

Broadcast Server User Guide Chapter 10 Broadcast Alert Management Alert Types 47 Alert Types Broadcast Server allows users to send three types of alerts – emergency, normal, and background alerts. Emergency alerts Emergency alerts are pushed immediately, override other alerts, and are sent with barge priority. Alerts automatically “rotate” fo[...]

Chapter 10 Broadcast Alert Management Quick FAQ 48 Broadcast Server Us er Guide Quick FAQ How do I … Description Add a new alert Click the Add Priority alert button at the top of the list to create an alert. This w ill open the alert Page. Edit an alert Click the title of the re cord you want to modify. This will open the alert Page. Delete one o[...]

Broadcast Server User Guide Chapter 10 Broadcast Alert Management The Alert Page 49 The Alert Page The alert page allows you to manage the conten t of alerts. This page is divided into sections – some may not be available depending on the privileges assigned by the system administrator. Item Descrip tion Alert active checkbox Indicates whether th[...]

Chapter 10 Broadcast Alert Management The Alert Page 50 Broadcast Server Us er Guide Priority Informs Broadcast Server how it should treat the alert. Emergency alerts take precedence over Normal alerts and are not subject to subscriber settings that would prevent barge-ins. Send to the following distribution list(s) This section contains all the di[...]

Broadcast Server User Guide Chapter 10 Broadcast Alert Management The Alert Page 51 Use audio alert If checked, indicates to Broa dcast Server that an audio alert must be played on the phone whe n the alert is pushed to the device. The current System Audio clip in the Media Library is used for all alert audio notifications.[...]

Chapter 10 Broadcast Alert Management The Alert Page 52 Broadcast Server Us er Guide[...]

53 Broadcast Server User Guide Chapter 11 My Preferences The Preferences page allows you to ch ange your password as well to set preferences for how informat ion should be displayed. Changing your password Fill out both fields and click the Save button to save your password. You can also clear your existing passw ord if the system administrator has[...]

Chapter 11 My Preferences Setting the maximum list en tries to display 54 Broadcast Server Us er Guide[...]

55 Broadcast Server User Guide Chapter 12 Troubleshooting This section discusses common problems and possible resolutions. Common problems Issue Description/Resolution Priority alerts are not being displayed on phones as soon as they are sent Priority alerts typically take about 5 seconds to propagate to phones. This procedure may take longer to a [...]

Chapter 12 Troubleshooting Common pro blems 56 Broadcast Server Us er Guide[...]

Appendix Broadcast Server User Guide 57 A Push XML API Broadcast Server communicates with the Application Gateway through the Push XML API. You can use that same interface to send alerts from other applications to IP phon es. For ex ample, you might wish to send call center statistics, sales update s, or automated IT alerts. To use the Push XML API[...]

Appendix A Push XML AP I Preparing the Application Gat eway and an Applic ation to Use the Push XML AP I Broadcast Server Us er Guide 58 Preparing the Application Gateway and an Application to Use the Push XML API To send alerts from a third-party ap plication to IP phones through the Push XML API, you must enable th e Push XML API on the Applicati[...]

Broadcast Server User Guide Appendix A Push XML API Push XML API Operation 59 Push XML API Operation Once the Application Gateway is awar e of a third-party application, it performs th e following oper ations: • Listens for XML data from the applic ation, including distribution lists to track for the ap plication and alerts to be p ushed. • Sen[...]

Appendix A Push XML AP I Push XML API Operation Broadcast Server Us er Guide 60 Alert action specifies how the Applicati on Gateway is to handle the alert: • If the alert is active, schedu le and pu sh it to the phone and also save it in the alert history lis t. Action = schedule. • If the alert is active, schedu le and push it to the pho ne bu[...]

Broadcast Server User Guide Appendix A Push XML API Push XML API Operation 61 Schedule The Schedule element is optional. If the Schedule element is not provided, the alert is pushed immediately. The Schedule element requires th e following child elements: • begin_date , end_date , begin_time , and end_time : These elements specify when the Applic[...]

Appendix A Push XML AP I Push XML API Operation Broadcast Server Us er Guide 62 DistributionList Request The Push XML API enables yo u to push an a lert to specific devices and/or distribution lists. A distribution list is composed of subscribers, which are IP phones that have registered with the Application Gateway. When an IP phone registers with[...]

Broadcast Server User Guide Appendix A Push XML API Push XML API Operation 63 ServerRegistration Response The ServerRegistration element is a response sent from the Application Gateway to the application after you submit the application’s URL through the Application Gatewa y Administrati on Tool. T he ServerRegistration element content consists o[...]

Appendix A Push XML AP I Push XML Reference Broadcast Server Us er Guide 64 Push XML Reference The following topics provide a deta iled descrip tion of the Push X ML: • Character Set and Character Entities, page 64 • XML Declaration, p age 64 • ManagePushMessage, page 65 • ManageDistributionLists, page 68 • ServerRegistration, page 69 •[...]

Broadcast Server User Guide Appendix A Push XML API Push XML Reference 65 ManagePushMessage The following sample XML for ManagePushMessage and its child elements illustrates scheduling a normal alert to a distribution list named “MainFloor”. The alert incl udes audio and two soft keys. <ManagePushMessage> <PushMessage priority="1&[...]

Appendix A Push XML AP I Push XML Reference Broadcast Server Us er Guide 66 PushMessage ManagePushMessage Parent of the elements that define the content, recipient, and schedule of an alert. Multiple PushMessage elements can be sent in the same HTML string. message_id A numeric value that uniquely identifies the alert and is used to track status. p[...]

Broadcast Server User Guide Appendix A Push XML API Push XML Reference 67 Button PushMessage index 1 2 Identifies the first soft key . Identifies the second soft key . type dial url The content of the Button element is a telephone number . The content of the Button element is a Web URL. caption The text that appears with the soft key , up to 32 cha[...]

Appendix A Push XML AP I Push XML Reference Broadcast Server Us er Guide 68 ManageDistributionLists The following sample XML for ManageDistributionLists and its child elements illustrates creating the dist ribution list named “accounting” and adding several devices to that list. <ManageDistributionLists> <DistributionList id="2&qu[...]

Broadcast Server User Guide Appendix A Push XML API Push XML Reference 69 ServerRegistration ServerRegistration is sent from the Application Gateway to the application URL specified in the Operat ion > Voice Office > IP Phone page of the Application Gateway Administration Tool. The ServerRegistration element provides your application with the[...]

Appendix A Push XML AP I Push XML Reference Broadcast Server Us er Guide 70 PushMessageResponse PushMessageResponse , sent from the Application Gateway to your application, provides the application with error response codes wh ich describe the status of the response and can assist in troubleshooting. The XML for PushMessageResponse follows: <Pus[...]

Broadcast Server User Guide Appendix A Push XML API Sample ASP Pag es 71 Sample ASP Pages You can use the script language of your c hoice to generate XML code. We have provided sample Microsoft Active Server Pages ( ASP) scripts to help you get started. Your application will need to generate two ASP files: One file to create a distribution list and[...]

Appendix A Push XML AP I Sample ASP Pages Broadcast Server Us er Guide 72 'Load the XML into an XMLDOM object Set SendDoc = server.createobject("Microsoft.XMLDOM") SendDoc.ValidateOnParse= True SendDoc.LoadXML(xmlString) 'Set the URL of the receiver sURL = "http://192.168.1.201:9998/" 'Call the XML Send function ([...]

Broadcast Server User Guide Appendix A Push XML API Sample ASP Pag es 73 schedule_message.asp The following sample code shows how to write the XML required to create and schedule an alert, send the alert to the Application Gateway, and then send report status to the applicat ion from the Application Gateway. The image paths and IP addresses in sche[...]

Appendix A Push XML AP I Sample ASP Pages Broadcast Server Us er Guide 74 'Tell the user what happened response.Write "<body><b>XML DOC posted off:</b><br><code>" 'response.write SendDoc.XML & "</code><br>" response.write "<b>Target URL:</b> " & sU[...]