Related Manuals for Avaya 16-300272
Summary of Contents for Avaya 16-300272
- Page 1 Broadcast Server User Guide Release 2.1 (Service Pack) 16-300272 Issue 2.1 April 2006...
- Page 2 However, information is subject to change. Warranty Avaya Inc. provides a limited warranty on this product. 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 through the following Web site: http://www.avaya.com/support.
-
Page 3: Table Of Contents
Related Documentation Introduction to Broadcast Server C H A P T E R Broadcast Server Overview Opening and Using the Broadcast Server Interface Configuring Broadcast Server Application Gateway and Broadcast Server Operation C H A P T E R System Management... - Page 4 The Distribution List Membership Page The Distribution List User Permissions Page Media Management C H A P T E R The Media List Quick FAQ Broadcast Server User Guide User information Password Shared distribution list access General user permissions Alert access...
- Page 5 A P P E N D I X Preparing the Application Gateway and an Application to Use the Push XML API Push XML API Operation Uploading a media file Supported graphic formats Supported audio formats Emergency alerts Normal alerts Background alerts Broadcast Server User Guide Contents...
- Page 6 Contents Push XML Reference Sample ASP Pages Broadcast Server User Guide PushMessage Request Recipient Subject, Body, Image, Audio, Button Schedule DistributionList Request Member ServerRegistration Response Subscribers Response PushMessageResponse Response Character Set and Character Entities XML Declaration ManagePushMessage ManageDistributionLists ServerRegistration Subscribers PushMessageResponse distribution_list.asp...
-
Page 7: Preface
Preface This preface describes who should read the Broadcast Server User Guide, how it is organized, and its document conventions. 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 Server, refer to the Phone Applications Suite Configuration Guide, Chapter 3, “Broadcast... - Page 8 Related Documentation viii Broadcast Server User Guide...
-
Page 9: Chapter 1 Introduction To Broadcast Server
Introduction to Broadcast Server With Broadcast Server you can create alerts for display on the 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’... -
Page 10: Broadcast Server Overview
Broadcast Server administrator and the individual alert creators. Broadcast Server users are individuals with an account on Broadcast Server. Subscribers are Avaya IP telephones. Broadcast Server requires the Application Gateway for operation. While Broadcast Server provides an interface for creating and scheduling alert delivery, the Application Gateway manages alerts and transforms alerts for delivery to IP telephones. -
Page 11: Users
The documents that you can download from the Application Gateway Note includes a document, Sending Alerts to Avaya IP Phones from a PC, that you can change as needed and distribute to Broadcast Server users. The document explains how to perform the options available by default to Broadcast Server users. -
Page 12: Alerts
For more information on distribution lists, see Management” on page Alerts An alert is the basic content item in the Broadcast Server and represents the information to be pushed to a phone. Alerts are delivered to the subscriber without requiring the subscriber to request outstanding alerts. -
Page 13: Sending Alerts
Sending Alerts Creating and sending an alert is easy 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 text and/or a graphic, audio, and soft keys. -
Page 14: Opening And Using The Broadcast Server Interface
The home page for the Broadcast Server administrator provides access to all tasks. The home page for a Broadcast Server user provides access to a subset of tasks. Many pages in the Broadcast Server interface contain icons that you can mouse over to view helpful information as well as click to make changes. -
Page 15: Initial Configuration
Suite Configuration Guide, Chapter 2, “LDAP/CSV Directory Configuration.” Create user accounts To enable a user to log in to Broadcast Server and work with alerts, you must create an account for the user. The user privileges are described in Define the items that should be available to users when they compose alerts: “General user permissions,”... -
Page 16: Broadcast Server Maintenance
IP telephones. Users can provide IP phone users access to external services by adding a soft key to a broadcast alert. To enable Broadcast Server users to include a soft key link to an external service in an alert, you must specify the service URL, as described in “External Service Management”... -
Page 17: Chapter 2 Application Gateway And Broadcast Server Operation
Application Gateway and Broadcast Server, you specify in the Application Gateway Administration Tool the base URL where Broadcast Server is running. That is the only information that the Application Gateway needs to register with Broadcast Server. Broadcast Server User Guide... - Page 18 Application Gateway also uses the phone extension to locate the associated department name in the directory. The Application Gateway sends the department information to Broadcast Server where it is used to update the distribution list. Any time that a particular telephone is updated, the Application Gateway collects the updated extension, user name, and department and sends that information to Broadcast Server.
-
Page 19: Chapter 3 System Management
System Management The System Management page is a single location for defining all Broadcast Server control parameters and for performing system-level tasks such as temporarily disabling the system. Component Versions This section lists the versions of the various components used by Broadcast Server and its supporting software. -
Page 20: Server Configuration
Click this button to temporarily disable the Broadcast Server messaging functionality. Only use this feature if you believe that the Broadcast Server is causing a problem on your network or Communication Manager system. Click this button to re-run the Configuration Wizard at any time. -
Page 21: Home Page Tips
Home page tips Item Description Tip 1 The text to display in the first blue tip box on the Broadcast Server home page. Tip 2 The text to display in the second blue tip box on the Broadcast Server home page. - Page 22 Chapter 3 System Management Home page tips Broadcast Server User Guide...
-
Page 23: Chapter 4 System Messages
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 the Broadcast Server as the administrator, the system will check the messages list for any critical error messages. Each Broadcast Server page will display a red note indicating if you have critical messages waiting. - Page 24 Chapter 4 System Messages Quick FAQ Broadcast Server User Guide...
-
Page 25: Chapter 5 User Management
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 individuals. Privileges dictate to which distribution lists a user may send alerts, which portions of an alert that users may modify, and so on. -
Page 26: Quick Faq
Then, click the Delete Selected button. Note that Broadcast Server will not allow you to delete the Administrator user. Edit the user record, uncheck the Active checkbox and save your changes. -
Page 27: Broadcast Server User Guide
User information The Active checkbox indicates whether the user record is active in Broadcast Server – that is, whether the user may log in to the system. At minimum, a Broadcast Server user must have a user ID and a name defined. -
Page 28: Shared Distribution List Access
Broadcast Server to ignore subscriber-specific settings such as Do-Not-Disturb and whether the subscriber wishes to receive priority alerts or not. Most ordinary Broadcast Server users should not have this privilege assigned to them. If checked, allows the user to send alerts to every subscriber in Broadcast Server. -
Page 29: Alert Access
If this option is checked, a user will be able to add subscribers to their private distribution lists. Most non-administrative Broadcast Server users should not have this privilege assigned to them. Instead, the system administrator should create distribution lists and share them among selected users. - Page 30 Chapter 5 User Management The User Page Broadcast Server User Guide...
-
Page 31: Chapter 6 Subscriber Management
Subscriber Management Subscribers are IP telephones that can receive content posted by Broadcast Server users. A subscriber entry is created when Broadcast Server receives subscriber information from the Application Gateway when an IP telephone comes online. The Subscriber Management List The subscriber management page presents the list of subscriber records that fulfill your current filter criteria. -
Page 32: Quick Faq
Chapter 6 Subscriber Management Quick FAQ Broadcast Server will display the name of the user who is currently logged Note into a device. Quick FAQ How do I … Change my filter criteria Delete one or more subscribers See which distribution lists a... -
Page 33: 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 alerts posted by Broadcast Server users. The IP Address field contains the network address for the subscriber (IP telephone). -
Page 34: Subscriber Settings
Emergency alerts are not subject to this setting. If set, prevents alert delivery for the period specified. Emergency alerts are not subject to this setting. If checked, allows Broadcast Server to play an audio alert associated with priority alerts on the device. -
Page 35: Chapter 7 Distribution List Management
The Application Gateway sends the department information to Broadcast Server where it is used to update the distribution list. For information on configuring connections to LDAP and CSV directory sources, refer to the Phone Applications Suite Configuration Guide, Chapter 2, “LDAP/CSV Directory Configuration.”... -
Page 36: Automatically Created Distribution Lists
Automatically created distribution lists If you have configured the Application Gateway to obtain department information from a directory source (LDAP or CSV), Broadcast Server will automatically create and update distribution lists based on the department corresponding to each IP telephone extension. The distribution list is updated each time that the Application Gateway detects a new or changed IP telephone. -
Page 37: Sharing Distribution Lists
Sharing distribution lists Sharing distribution lists is a way to standardize on a set of distribution lists across the organization and is easy to do in the Broadcast Server. Only the system administrator can perform this function. Users can share only the lists that are owned by the Administrator user. -
Page 38: The Distribution List Page
Broadcast Server. A distribution list must be named; comments are optional. Unless you are creating a new distribution list, Broadcast Server displays a link titled Edit recipients next to the list’s name. Clicking this link will take you to the Distribution List Membership page where you can select the subscribers that are members of the list. -
Page 39: The Distribution List Membership Page
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. -
Page 40: Adding And Removing Distribution List Members
US lists. You could do the same for locations in other cites in other countries, or any combination or configuration that suits your needs. Like other screens in Broadcast Server, the records displayed on this page contain icons that show the status of an item. -
Page 41: Granting Users Permission To Send To The List
Distribution Lists page if ownership of the list has been shared, as described in This page contains two columns showing on the left side Broadcast Server users that can send alerts to the list and, on the right, those that cannot. - Page 42 Chapter 7 Distribution List Management The Distribution List User Permissions Page Broadcast Server User Guide...
-
Page 43: Chapter 8 Media Management
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 individual Broadcast Server users. Not all phones support the display of images. -
Page 44: System Media
While all sections are visible to the Administrator user, regular Broadcast Note Server users are restricted to Shared Images and My Images only. In addition, only the administrator can see the Owner column. Icon System media Broadcast Server is installed with some system media items, including an audio clip used for notifying subscribers of priority alerts. -
Page 45: Media Ownership
Broadcast Server users. Sharing media items is a way to conserve disk space usage on Broadcast Server and to standardize on a set of media across the organization. Media linkage Media items are linked to alerts instead of being embedded in them. This... -
Page 46: The Media Page
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 a graphic, Broadcast Server displays a thumbnail of the original graphic below the current file name. -
Page 47: Supported Audio Formats
IP phone screen. Supported audio formats File Type Broadcast Server is capable or converting most wave files into a format Note compatible with IP phones. For best results use a wave file in G.711 or PCM format, 8 KHz sampling rate, with 8 or 16 bits per sample. - Page 48 Chapter 8 Media Management The Media Page Broadcast Server User Guide...
-
Page 49: Chapter 9 External Service Management
External Service Management External Services are network-based applications that can be launched from IP telephones. Broadcast Server allows users to link their alerts to such services in order to provide content and functionality beyond the scope of the Broadcast Server system. Such applications may include third-party products, solutions from other vendors, or applications developed internally by your IT staff. -
Page 50: 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 minimum, an External Service definition must have a name, description, and URL. You must provide this information before you can save the record. - Page 51 URL will return information that the IP phone can display. Be sure to verify that the URL does display information correctly on the phone. Chapter 9 External Service Management The External Service Page Broadcast Server User Guide...
- Page 52 Chapter 9 External Service Management The External Service Page Broadcast Server User Guide...
-
Page 53: Chapter 10 Broadcast Alert Management
The alert list page shows the alerts available to the currently logged-in user. Broadcast Server will display an alert to a user if a) The user is the current owner of the alert, or b) The user can send alerts to a distribution list that the alert has been sent to. -
Page 54: Column Descriptions
Column Descriptions Column Title Main Page Extended Information Recipients Broadcast Server User Guide 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. -
Page 55: Alert Types
Alerts automatically “rotate” for their display duration. This means that if multiple alerts are sent to a phone; Broadcast Server will display each alert for the display period set for that alert and then move on to the next alert. -
Page 56: Quick Faq
Change the delivery schedule for an alert Add or remove buttons on an alert Broadcast Server User Guide Description Click the Add Priority alert button at the top of the list to create an alert. This will open the alert Page. -
Page 57: The Alert Page
(from the current time) that an alert should be sent to subscribers). The default is 10 minutes but you can choose a custom delivery schedule by selecting Set a custom delivery schedule. Broadcast Server User Guide Broadcast Alert Management The Alert Page... - Page 58 Extended Alert: Alert graphic Extended Alert: Alert Text Button definitions Broadcast Server User Guide 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.
- Page 59 Broadcast Alert Management The Alert Page Use audio alert If checked, indicates to Broadcast Server that an audio alert must be played on the phone when the alert is pushed to the device. The current System Audio clip in the Media Library is used for all alert audio notifications.
- Page 60 Chapter 10 Broadcast Alert Management The Alert Page Broadcast Server User Guide...
-
Page 61: Chapter 11 My Preferences
The alert list has numerous options for display including a feature that divides the entire alert list into manageable pages. This setting allows you to indicate to Broadcast Server how many alert records you want displayed on a single page. - Page 62 Chapter 11 My Preferences Setting the maximum list entries to display Broadcast Server User Guide...
-
Page 63: Chapter 12 Troubleshooting
Priority alerts typically take about 5 seconds to propagate to phones. This procedure may take longer to a particular phone if Broadcast Server had encountered errors with that phone in the last 2 minutes. Broadcast Server transmits audio in ITU G.711 ULaw format in 30ms frames. - Page 64 Chapter 12 Troubleshooting Common problems Broadcast Server User Guide...
-
Page 65: Appendix
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 phones. For example, you might wish to send call center statistics, sales updates, or automated IT alerts. -
Page 66: Xml Api
To enable the Push XML API on the Application Gateway: Upload a Broadcast Server license to the Application Gateway. The Broadcast Server license opens a port on the Application Gateway for communication with a third-party application. Enter the URL of the application in the Application Gateway Administration Tool on the Operation >... -
Page 67: Push Xml Api Operation
Immediately and take control of the audio. Priority = emergency. • When the phone is idle. Priority = normal. • Only to the alert history item in the Voice Office menu. Priority = • background. Appendix A Push XML API Push XML API Operation Broadcast Server User Guide... -
Page 68: Recipient
URL to display. (OK and Exit soft keys are automatically added to an alert. OK returns to the alert list; Exit returns to the Voice Office menu.) Broadcast Server User Guide for a detailed explanation of the... -
Page 69: Schedule
(if applicable) and also to the phones. To change the Application Gateway time zone, date or time, go to the Administration > Date page of the Application Gateway Administration Tool. Appendix A Push XML API Push XML API Operation Broadcast Server User Guide... -
Page 70: Distributionlist Request
One or more Member elements can be included in a DistributionListRequest element. The Member element has one attribute that specifies the device ID (that is, the MAC address of the phone). Broadcast Server User Guide 63. You can then use your application to for a detailed explanation of the... -
Page 71: Serverregistration Response
The department associated with the phone or user (obtained from the • Application Gateway connection to your LDAP server). The device ID (MAC address). • The extension associated with the phone or user (obtained from •... -
Page 72: Push Xml Reference
XML reference documentation. XML Declaration The Push XML string should begin with the following XML declaration: <?xml version="1.0" encoding="utf-8"?> The XML declaration must not be preceded by comments, whitespace, or processing instructions. Broadcast Server User Guide Character Entity & ' > <... -
Page 73: Managepushmessage
<PushMessage priority="1" message_id="3" action="schedule" reloaded="{true | false}“ <Recipient id="MainFloor" type="distribution"/> <Subject>Server Maintenance this Week</Subject> <Body>Servers will be taken off-line this week, as follows. </Body> <Audio>http://mysite.com/alerts/alert.wav</Audio> <Button index="1" type="url" caption="Server Usage"> http://mysite.com/it/info/matrix.html</Button> <Button index="2" type="dial" caption="Help Desk">2323</Button2> <Schedule> <BeginDate>10:03:2005</BeginDate> <EndDate>10:07:2005</EndDate> <Days sunday="0" monday="0" tuesday="1" wednesday="1" thursday="0" friday="1"... - Page 74 Subject PushMessage Body PushMessage Image PushMessage Audio PushMessage Broadcast Server User Guide Attributes Enumeration Description 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.
- Page 75 The time to start and stop the push, formatted as hh:mm:ss AM | PM. For example, noon is 12:00:00 PM. The time is based on the Application Gateway time. Broadcast Server User Guide Push XML API Push XML Reference...
-
Page 76: Managedistributionlists
Element Parent Element ManageDistributionLists none DistributionList ManageDistributionLists Member DistributionList Broadcast Server User Guide Attributes Enumeration Description none Parent element of one or more DistributionList elements. Parent element of zero or more Member elements. A numeric value that uniquely identifies the distribution list. -
Page 77: Serverregistration
Application Gateway and can be named as alert recipients or distribution list members. name Either the user name associated (in an LDAP directory) with the device or the phone model. Broadcast Server User Guide Push XML API Push XML Reference... -
Page 78: Pushmessageresponse
The extension associated with the device, obtained from an LDAP or CSV directory source. class The device model, such as avaya 4620. Currently not used. action The device is a new subscriber. update The device is an existing subscriber and might have updated data. -
Page 79: Sample Asp Pages
Sample ASP Pages You can use the script language of your choice 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 one file to create an alert. - Page 80 Appendix A Push XML API Sample ASP Pages '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 (defined below) set NewDoc = xmlSend (sURL, SendDoc)'xmlString)
- Page 81 = xmlString & " </Schedule>" & vbcrlf xmlString = xmlString & "</PushMessage>" xmlString = xmlString & "</ManagePushMessage>" '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/"...
- Page 82 'response.write "<b>XML DOC Received back: </b>" 'response.write (NewDoc.Xml) response.write "<br><a href='schedule_message.asp'>Send Schedule</a></body>" response.write "<br><a href='push_message.asp'>Send Push </a></body>" private function xmlsend(url, docSubmit) Set poster = Server.CreateObject("MSXML2.ServerXMLHTTP") poster.open "POST", url, false poster.setRequestHeader "CONTENT_TYPE", "text/xml" poster.send docSubmit Set NewDoc = server.createobject("Microsoft.XMLDOM") newDoc.ValidateOnParse= True newDoc.LoadXML(poster.responseTEXT)