Nortel Networks Broadcast Server warranty Schedule

Page 69

Appendix A Push XML API

Push XML API Operation

Schedule

The Schedule element is optional. If the Schedule element is not provided, the alert is pushed immediately.

The Schedule element requires the following child elements:

•begin_date, end_date, begin_time, and end_time: These elements specify when the Application Gateway is to start and stop sending the alert. The dates and times are based on the Application Gateway server time.

Note To change the Application Gateway time zone, go to the

Administration > 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 that day.

When the Application Gateway comes online it does the following:

•Sends the ServerRegistration file to the broadcasting application.

•Registers with the broadcasting application.

•Receives from the broadcasting application the ManagePushMessages file. The broadcasting application can also send a ManageDistributionLists file.

•Pushes the alerts that have a reloaded attribute of true only to the alert list (if applicable). Pushes the alerts that have a reloaded attribute of false to the alert list (if applicable) and also to the phones.

Broadcast Server User Guide

61

Image 69

Contents Broadcast Server User Guide Page Contents A P T E R 6 Subscriber Management A P T E R 9 External Service Management Vi Broadcast Server User Guide Preface AudienceOrganization Related Documentation Introduction to Broadcast Server ChapterBroadcast Server Overview Subscribers and Distribution Lists UsersAlerts BCS Interaction with Phones Sending AlertsOpening and Using the Broadcast Server Interface Initial Configuration Configuring Broadcast ServerBroadcast Server Maintenance Application Gateway and Broadcast Server Operation Application Gateway and Broadcast Server Operation Component Versions System ManagementSupport items Server configurationHome page tips System Management Home page tips Broadcast Server User Guide System Messages Quick FAQSystem Messages Quick FAQ Broadcast Server User Guide User Management List User ManagementAdministrator user Password UserUser information General user permissions Shared distribution list accessAlert access User Management The User Broadcast Server User Guide Subscriber Management List Subscriber ManagementGo to the Distribution List Management page, select Subscriber settings SubscriberSubscriber information Distribution list membership Emergency alerts are not subject to this settingDistribution List Distribution List ManagementList ownership Automatically created distribution listsSharing distribution lists Distribution List Management Distribution List Management Distribution List Membership Adding and removing distribution list members Distribution List User PermissionsRevoking users’ permission to send to the list Granting users permission to send to the listBroadcast Server User Guide Media List Media ManagementSystem media Media linkage Media ownershipMedia Uploading a media fileSupported graphic formats WAV Supported audio formatsMedia Management The Media Broadcast Server User Guide External Services Management List External Service ManagementExternal Service External Service Management Page Alert List Broadcast Alert ManagementColumn Descriptions Emergency alerts Alert TypesNormal alerts Background alertsBroadcast Alert Management Quick FAQ Title AlertSend to the following Use audio alert Page Setting the maximum list entries to display Changing your passwordMy Preferences Set the number of alerts perPage Common problems TroubleshootingTroubleshooting Common problems Broadcast Server User Guide Push XML API Appendix aTo enable the Push XML API on the Application Gateway PushMessage Request Push XML API OperationRecipient Schedule Member DistributionList RequestServerRegistration Response Subscribers ResponsePushMessageResponse Response Push XML Reference Character Set and Character EntitiesXML Declaration Element Parent Element Attributes Enumeration Description ManagePushMessageMessageid Appendix a Push XML API DistributionList ManageDistributionListsSubscribers ServerRegistrationPushMessageResponse Distributionlist.asp Sample ASP PagesLoad the XML into an Xmldom object Schedulemessage.asp Appendix a Push XML API Sample ASP Pages Page Broadcast Server User Guide Configuration and Operation