Schema for .NET Alerts service Copyright (c) 2001 Microsoft Corporation. All rights reserved. An argot is a domain-specific blob of data qualified by a name and ID. The contents are free. Argots are opaque to Microsoft® .NET My services. This URI uniquely identifies the type of argot and points to a location containing the XSD for this argot. An argot list is a container of argots. An alert has contents: "from" (sender) data, optional "to" (receiver) data, and optional "routing" data. The contents are a set of argots (domain-specific blobs). The sender and receiver must understand and agree on the argots that are transmitted in the alert. In the .NET Alerts service, both streams and connections usually choose which alerts they process based on the argots contained within the alerts. This tag contains all data from the sender, including sender authentication as well as preferences and requests from the sender. This tag contains all data pertaining to the receiver. This data can be set by the sender or by any processing/routing agent between the sender and the receiver. This element contains the problem domain-specific data to be conveyed to the receiver. Each child element of the contents element is an argot, a problem domain-specific strongly typed XML blob. Streams and connections query against the element names of these blobs when selecting alerts they will process. This tag contains any routing data inserted by the .NET Alerts routing process. This element defines the original receiver of the alert. A routing agent may change (forward or fan out) an alert to other receivers. If so, it should add this element to the alert. This element contains the timestamp of when the alert was received by the .NET Alerts service. This element defines the actors that have processed the alert to date. This data can be used by .NET Alerts to recognize and stop infinite loops. myAlerts is the user content document for alert routing. It contains streams, connections, and preferences (general provisioning). The document does not contain a list of alerts. Alerts are transitory. Use the notifyRequest, route, and PollRequest to send and receive alerts. A stream is an internal object that processes alerts before they are routed to connections. Streams can buffer or reroute. Defines what kind of stream. Lifetime of a connection in absolute time (GMT). This can be used to clean up the content document. BUGBUG - we really should use a date type not string for the type attribute! Defines where the stream fits into the streamFork processing. The stream's query against incoming alerts. The query specifies the argot name(s) that enable selection (a logical OR of the named argots). This is optional based on the streamClass (a stream may do its own selection processing instead of or in addition to the standard stream alert query). See the available stream classes. If not present, the query defaults to all alert argots ("*"). An optional provisioning argot for the stream. This is dependent on the stream class. See the available stream classes. Abbreviations: CXN (Connection): The vonnection exists inside of the .NET Alerts service. UA (UserAgent): The userAgent exists outside of the .NET Alerts service. There are two primary types of connections: Push: Alerts are pushed by CXN to UA. Pull: Alerts are downloaded by the UA by issuing a request to CXN. The response contains the alerts. A CXN is created (added to the .NET Alerts content document) either by the UA directly or by some entity acting on behalf of the UA. In order to transfer the alerts, a session, either persistent or transient, is established between CXN and UA. In cases in which sessions are transient, the CXN persists. Establishment of a session can be initiated by either CXN or UA, either when the CXN is created or based on, say, a timer or some signaling mechanism between CXN and UA. The session can be closed by either entity after a period of time (including 0). The following are different models of UA-CXN interaction: 1) UA establishes a session with a CXN and pulls alerts from CXN. 2) UA establishes a session with a CXN and the CXN pushes alerts to the UA. 3) CXN establishes a session with a UA and the UA pulls alerts. 4) CXN establishes a session with a UA and pushes alerts to UA. 5) UA polls the CXN periodically on a timer and UA will initiate process #1 or #2. 6) CXN polls the UA when alerts arrive or periodically on a timer. When there are pending alerts in the queue, UA will initiate process #1 or #2. This element specifies the class of a connection (for example, Push over Soap-RP or Pull over Soap-RP). Flags indicating the current status of the connection. Can be used by the Stream modules to do traffic management, buffering, generate nondelivery and delayed delivery reports for the sender. Information about the nature of the connection, used mainly by the Stream modules. Reliable can mean it supports ACKs; unreliable means it is fire-and-forget. Type of polling used (Connection vs. UserAgent). Lifetime of a connection in absolute time (GMT). This can be used to clean up the content document. BUGBUG - we really should use a date type not string for the type attribute! The connection's query against incoming alerts. The query specifies the argot name(s) that enable selection (a logical OR of the named argots). An optional provisioning argot for the connection. This is dependent on the connection class. For more information, see the available connection classes. This element is an argot specifying the read and write parameters for a bufferStream stream. For the current implementation of .NET My Services, the bufferStream takes no input parameters; it returns the current set of buffered alerts through this argot. A query on a bufferStream is a transient, read-only operation. Zero or more alerts in the buffer of the streamBuffer stream. This element is an argot specifying the read and write parameters for a connectionPush connection. The push connection will issue notifyRequest packets to this target URL. This element is an argot used to convey human readable information in an alert. The receiver of a human readable alert should be able, at a minimum, to display the text element data to a human in either textual or speech form. The base URL to which all other URLs are relative. This is a URL that links to an action page from the sender. This URL can be relative to the baseURL element. This is a URL that links to the sender's page that allows the receiver to view and change the way the alert was sent. This URL can be relative to the baseURL element. This element contains text specific to a language. You can include as many language elements as you like to convey the same information in different languages. The element contains the text to be conveyed to the human. This text must be in the language specified by the xml:lang attribute. This required attribute is used to specify an ISO 639 language code or an ISO 3166 country code as described in RFC 1766. The value of this attribute indicates the language type of the content within this element. This attribute contains an optional URL from the sender for an icon in a Portable Network Graphics (PNG) file that can be used when the userAgent displays the content to the user. This method attempts to send the enclosed alerts using standard routing by .NET Alerts. There can be one or more notification elements specified. If none is specified, the notify request should be interpreted as a query about whether the receiver is willing to accept alerts from this sender. An alert to be delivered. This method can be invoked on a connection. If there is a new alert in the buffer stream, it will be returned in the pollResponse message. The pollRequest will immediately return a response about whether there is a pending alert. However, if the optional parkInterval element is specified, then the response can take up to parkInterval milliseconds before returning when there are no new alerts in the buffer stream. The unit of time specified for the parkInterval is milliseconds. The response contains zero or one new alerts in the buffer stream. A new alert contained in the buffer stream. The contentProvider element is the Microsoft .NET Alerts version 4.5 service authentication element. It replaces the expected .NET Services kerberos element. This attribute contains the content provider ID as assigned to the content provider by the .NET Alerts service provisioning. The ID must be a valid decimal or hexadecimal string. This attribute is optional and contains the sending user's Passport User ID (PUID). The sending content provider is required to ensure the authenticity of this PUID.