Avaya 16-300272 User Manual Download

Page: 79 / 82

Broadcast Server User Guide

Appendix A

Push XML API

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.
The following topics include sample script for writing, sending, and

receiving a response to a distribution list or scheduled alert:

•

distribution_list.asp, page 71

•

schedule_message.asp, page 73

distribution_list.asp

The following sample code shows how to write the XML required to create

and add members to a distribution list, send the list to the Application

Gateway, and then send report status to the application from the

Application Gateway. You must send a distribution list to the Application

Gateway before you can begin sending alerts.
The IP addresses and device IDs in distribution_list.asp are examples.

Note

Device IDs are listed in the Application Gateway License Monitor.

To open the License Monitor, go to the Administration Tool

Operation > Advanced page.

<%@ Language=VBScript %>

<HTML>

<HEAD>

</HEAD>

'Put together some XML to post off

xmlString = "<?xml version=""1.0""?>" & vbcrlf

xmlString = xmlString & "<BCSDistributionList id='123' name='Jon Test'>" & vbcrlf

xmlString = xmlString & " <Member device_id='000E8349D6ED'/>" & vbcrlf

xmlString = xmlString & " <Member device_id='0009B7F3FA1D'/>" & vbcrlf

xmlString = xmlString & " <Member device_id='000821381711'/>" & vbcrlf

xmlString = xmlString & "</BCSDistributionList>"

Summary of Contents for 16-300272

Page 1: ...Broadcast Server User Guide Release 2 1 Service Pack 16 300272 Issue 2 1 April 2006...

Page 2: ...s a malicious party is anyone including someone who may be otherwise authorized who accesses your telecommunications equipment with either malicious or mischievous intent Such intrusions may be either...

Page 3: ...th Phones 5 Opening and Using the Broadcast Server Interface 6 Configuring Broadcast Server 6 Initial Configuration 7 Broadcast Server Maintenance 8 C H A P T E R 2 Application Gateway and Broadcast S...

Page 4: ...A P T E R 7 Distribution List Management 27 The Distribution List Page 27 Automatically created distribution lists 28 List ownership 28 Sharing distribution lists 29 Quick FAQ 29 The Distribution Lis...

Page 5: ...t Management 45 The Alert List 45 Column Descriptions 46 Alert Types 47 Emergency alerts 47 Normal alerts 47 Background alerts 47 Quick FAQ 48 The Alert Page 49 C H A P T E R 11 My Preferences 53 Chan...

Page 6: ...mber 62 ServerRegistration Response 63 Subscribers Response 63 PushMessageResponse Response 63 Push XML Reference 64 Character Set and Character Entities 64 XML Declaration 64 ManagePushMessage 65 Man...

Page 7: ...anized 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 inform...

Page 9: ...want to share Broadcast Server includes the following features Pushed priority alerts with audio notifications Flexible subscriber distribution lists Automatically generated and updated distribution...

Page 10: ...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 trans...

Page 11: ...ustomized as described in General user permissions page 20 Subscribers and Distribution Lists Subscribers IP telephones are added to Broadcast Server automatically You configure the Application Gatewa...

Page 12: ...ng the subscriber to request outstanding alerts An alert might consist of a meeting reminder that is scheduled for delivery at a particular date and time or an Emergency announcement that takes preced...

Page 13: ...ert is delivered to the phone regardless of phone state an in progress phone call is put on hold For Normal alerts Alert is delivered to the phone if the phone is idle whether on or off hook Alert is...

Page 14: ...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 inte...

Page 15: ...te Configuration Guide Chapter 2 LDAP CSV Directory Configuration 2 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...

Page 16: ...rvices External services are network based applications that can be launched from IP telephones Users can provide IP phone users access to external services by adding a soft key to a broadcast alert T...

Page 17: ...e in the appropriate format for display and delivery to IP telephones Note Sites using a cluster of Application Gateways should configure all Application Gateways in the cluster with the same Broadcas...

Page 18: ...st Server where the information is used to update the subscriber list The Application Gateway also uses the phone extension to locate the associated department name in the directory The Application Ga...

Page 19: ...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...

Page 20: ...Configuration Wizard at any time Purge alerts after The period that inactive alerts will be retained in the Broadcast Server database before being automatically deleted Item Description Administrative...

Page 21: ...splay 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 Tip 3 The text to display in the third blue tip...

Page 22: ...Chapter 3 System Management Home page tips 14 Broadcast Server User Guide...

Page 23: ...FAQ Icon Description The message is informational only The message is a critical error The message has not been viewed How do I Description View message details Click the message in the record you wan...

Page 24: ...Chapter 4 System Messages Quick FAQ 16 Broadcast Server User Guide...

Page 25: ...of an alert that users may modify and so on You create and manage login IDs user names and passwords within Broadcast Server The User Management List The user management page presents the list of Bro...

Page 26: ...n at the top of the list This will open the User Page Edit a user Click the user ID in the record you want to modify This will open the User Page Delete one or more users Check the box next to each re...

Page 27: ...ID and a name defined You can also provide a department name or number but this information is not required for the user to be considered valid within Broadcast Server Password The password section o...

Page 28: ...ce over all other types of alerts and cause Broadcast Server to ignore subscriber specific settings such as Do Not Disturb and whether the subscriber wishes to receive priority alerts or not Most ordi...

Page 29: ...r 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...

Page 30: ...Chapter 5 User Management The User Page 22 Broadcast Server User Guide...

Page 31: ...ist The subscriber management page presents the list of subscriber records that fulfill your current filter criteria Individual entries are displayed with helpful icons to the left of each entry where...

Page 32: ...box in the list s title to select all records displayed Then click the Delete Selected button See which distribution lists a subscriber belongs to Edit the subscriber record The Distribution list mem...

Page 33: ...the subscriber will receive alerts posted by Broadcast Server users The IP Address field contains the network address for the subscriber IP telephone The value of this field is especially important t...

Page 34: ...on list to edit the membership for that list Setting Description Types of alerts to receive Dictates the types of alerts that can be delivered to the subscriber Emergency alerts are not subject to thi...

Page 35: ...eway uses the phone extension to locate the associated department name in the directories The Application Gateway sends the department information to Broadcast Server where it is used to update the di...

Page 36: ...Note Automatically created distribution lists cannot be renamed or have their recipients changed Broadcast Server updates this information By default an automatically created distribution list is priv...

Page 37: ...dcast Server users who will be able to send alerts to the distribution list To unshare a list simply change the ownership to Administrator Private and assign ownership to another Broadcast Server user...

Page 38: ...st s title to select all records displayed Then click the Delete Selected button Note that the Broadcast Server re instates created distribution lists during its next synchronization if these are dele...

Page 39: ...ions if any even if you are not the owner of the list You will not however be able to change information of a list you do not own The Distribution List Membership Page This page contains two columns s...

Page 40: ...t members To add members check the boxes in the right side column next to the items you want to add and click the Add Selected button To remove members check the boxes in the left side column next to...

Page 41: ...want to add and click the Add Selected button To select all users click the box in the column heading to the left of Name Users who have been granted rights to send to the lists can select the list as...

Page 42: ...Chapter 7 Distribution List Management The Distribution List User Permissions Page 34 Broadcast Server User Guide...

Page 43: ...libraries maintained by the system administrator and or individual Broadcast Server users Not all phones support the display of images Both image and audio files stored in the media library can be sel...

Page 44: ...clips used internally by Broadcast Server available to the system administrator only Note While all sections are visible to the Administrator user regular Broadcast Server users are restricted to Shar...

Page 45: ...mmediately reflected throughout the system in all alerts as soon as the media item is changed Quick FAQ How do I Description Add a new media item Click the Add Media button at the top of the list This...

Page 46: ...rent file name Uploading a media file If you want to replace the existing media item if any you need only enter the name of a file on your computer or click the Browse button to open a selection box O...

Page 47: ...depth of the picture For best results use a file with a resolution and color model appropriate for the IP phone screen Supported audio formats Note Broadcast Server is capable or converting most wave...

Page 48: ...Chapter 8 Media Management The Media Page 40 Broadcast Server User Guide...

Page 49: ...cast Server system administrator must first define the service using the External Service Management functionality of Broadcast Server before a user can link to an external service Available services...

Page 50: ...oadcast Server users when they create alerts How do I Description Add a new External Service Click the Add Service button at the top of the list This will open the External Service Page Edit an Extern...

Page 51: ...phones must be capable of accessing the URL exactly as typed For instance If your IP phones cannot use DNS to resolve a URL you must enter an IP address instead of a host name in the URL In addition t...

Page 52: ...Chapter 9 External Service Management The External Service Page 44 Broadcast Server User Guide...

Page 53: ...e 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 h...

Page 54: ...been delivered The alert is owned by the currently logged in user Click this icon to change ownerships of the alert Only available to the system administrator Click this icon to contract or expand th...

Page 55: ...barge priority 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 th...

Page 56: ...from the popup list Send an alert containing a graphic Edit the alert record check the alert graphic option and select a graphic from the media library using the Select a Graphic button Then save your...

Page 57: ...e checkbox Indicates whether the alert is active Inactive alerts are not delivered to subscribers Title The title of the alert This text displays in the title are of a phone s screen A title can be a...

Page 58: ...this page An alert can be a maximum of 1000 characters Button definitions This section allows you to define buttons displayed on each page of an alert Subscribers reading the alert can press the butto...

Page 59: ...ement The Alert Page 51 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...

Page 60: ...Chapter 10 Broadcast Alert Management The Alert Page 52 Broadcast Server User Guide...

Page 61: ...chosen to allow blank passwords and you have a password defined Set the number of alerts per page The alert list has numerous options for display including a feature that divides the entire alert list...

Page 62: ...Chapter 11 My Preferences Setting the maximum list entries to display 54 Broadcast Server User Guide...

Page 63: ...in 30ms frames Verify that your network devices are optimized for this framing size or contact Support for assistance in changing these parameters Host not found is displayed on the phone s screen The...

Page 64: ...Chapter 12 Troubleshooting Common problems 56 Broadcast Server User Guide...

Page 65: ...Application Gateway then sends a response back to your application containing alert status and error information The response returned to your application is an XML string sent over HTTP The XML that...

Page 66: ...on Voice Office IP Phone page The Application Gateway needs the application URL so that it can send the application the IP address and push port to use when sending XML to the Application Gateway To p...

Page 67: ...at are deleted or expired Notifies the application about the status of the pushed alerts The following topics provide a general description of the XML elements used in those operations PushMessage Req...

Page 68: ...ML Recipient One or more Recipient elements can be included in a PushMessage element Recipient element attributes specify the destination phone s and or distribution list s of the alert Subject Body I...

Page 69: ...ration Date page of the Application Gateway Administration Tool days The days element contains an attribute for each day of the week For each day you specify whether or not the alert is to be sent on...

Page 70: ...ateway uses the DistributionListRequest element to maintain the distribution lists specified with PushMessage To send more than one DistributionListRequest you wrap the elements in a ManageDistributio...

Page 71: ...with the Application Gateway The Subscribers element attributes define the following The device which is either the user name associated in an LDAP directory with the device or the phone model The dep...

Page 72: ...Character Entities The Push XML API supports the UNICODE character set Use character entity references to escape the following special characters For more information on character references and char...

Page 73: ...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...

Page 74: ...e schedule and alert list reloaded true false Alert has been pushed to the phone Alert has not been pushed to the phone Push it according to the schedule Recipient PushMessage id A numeric value that...

Page 75: ...ers Schedule PushMessage none Parent element of the Schedule elements begin_date end_date Schedule none The date to start and stop the push formatted as mm dd yyyy For example January 15 2006 is 01 15...

Page 76: ...istributionLists The following table describes the ManageDistributionLists element and its child elements Element Parent Element Attributes Enumeration Description ManageDistributionLists none none Pa...

Page 77: ...s the application with the subscribers which you can specify as individual alert recipients and or members of a distribution list Sample XML for Subscribers and its child elements follows Subscribers...

Page 78: ...sageResponse id 123 200 PushMessageResponse dept The department associated with the device obtained from an LDAP or CSV directory source device_id The MAC address of the device extn The extension asso...

Page 79: ...and add members to a distribution list send the list to the Application Gateway and then send report status to the application from the Application Gateway You must send a distribution list to the App...

Page 80: ...er XML DOM object Tell the user what happened response Write b XML DOC posted off b br response write SendDoc XML br response write b Target URL b sURL br response write b XML DOC Received back b br r...

Page 81: ...ungry Body vbcrlf xmlString xmlString Image http 192 168 1 16 push_image png Image vbcrlf xmlString xmlString Audio http 192 168 1 16 moo wav Audio vbcrlf xmlString xmlString Schedule vbcrlf xmlString...

Page 82: ...wDoc 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 CreateOb...

Search results

Summary of Contents for 16-300272

Reviews:

Related manuals for 16-300272

Brands by name

Popular brands

Avaya 16-300272, User Manual

Search results

Summary of Contents for 16-300272

Reviews:

Related manuals for 16-300272

Brands by name

Popular brands