[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: EDXL DE xsd and Sample xml and latest draft
EMTC, I'm a bit delayed on sending the full draft due to schema validation issues. I think they are resolved in the files sent. Dave did a great job putting the schema together. I still had issues with the <group> element followed by a <choice> in three validation tools. By removing the <group> as a wrapper, it 'seems' to have resolved the issue. I am no expert on xml schema 'model groups', 'partitions' or the like. We're likely to get (hopefully constructive) comments on the schema format during review. In the Specification Draft, Section 3.2: Data Dictionary, Appendix A: Examples and Appendix B: Schema still need replacing. I'll do that after a sleep break. Best Regards, Michelle
<?xml version='1.0' ?> <ed:EDXLDistribution xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ed="urn:oasis:names:tc:emergency:EDXL:DE:1.0" xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:DE:1.0 file://C:\home\users\mraymond\organizations\OASIS\EmergencyManagementTC\docs\EDXL\Specifications\EDXLDistribution.xsd" xmlns:cap="urn:oasis:names:tc:emergency:cap:1.1"> <ed:distributionID>schoolEvac050214160000</ed:distributionID > <ed:senderID>em@centralhigh.centerville.edu</ed:senderID> <ed:dateTimeSent>2005-02-14T16:00:00-05:00</ed:dateTimeSent> <ed:distributionStatus>Actual</ed:distributionStatus> <ed:distributionType>Update</ed:distributionType> <ed:senderRole> <ed:valueListUrn>centerville.edu.senderRole.schoolEmergencyManager</ed:valueListUrn> <ed:value>Principal</ed:value> </ed:senderRole> <ed:recipientRole> <ed:valueListUrn>centerville.edu.recipientRole.centralhigh.allSchool</ed:valueListUrn> <ed:value>Parents</ed:value> </ed:recipientRole> <ed:recipientRole> <ed:valueListUrn>centerville.edu.recipientRole.centralhigh.support</ed:valueListUrn> <ed:value>Transportation</ed:value> </ed:recipientRole> <ed:keyword> <ed:valueListUrn>centerville.edu.keyword.incident.phase</ed:valueListUrn> <ed:value>Bus Release</ed:value> </ed:keyword> <ed:explicitAddress>studentGuardians@centralhigh.metropolis.edu</ed:explicitAddress> <ed:distributionReference>schoolEmergency050214112019:em@centralhigh.edu:2005-02-14T11:20:19-05:00</ed:distributionReference> <ed:contentObject> <ed:contentKeyword> <ed:valueListUrn>centerville.edu.keyword.incident.phase</ed:valueListUrn> <ed:value>Bus Release</ed:value> </ed:contentKeyword> <ed:originatorRole> <ed:valueListUrn>centerville.edu.senderRole.schoolEmergencyManager</ed:valueListUrn> <ed:value>Principal</ed:value> </ed:originatorRole> <ed:consumerRole> <ed:valueListUrn>goBus:school:centerville:staff</ed:valueListUrn> <ed:value>Bus Coordinator</ed:value> </ed:consumerRole> <ed:description>Message to release buses.</ed:description> <ed:mimeType>text/xml</ed:mimeType> <ed:digest>The buses have been released</ed:digest> <ed:namespacedXMLContent xmlns:cap="urn:oasis:names:tc:emergency:cap:1.1"> <cap:alert xmlns:cap="urn:oasis:names:tc:emergency:cap:1.1"> <cap:identifier>em@centralhigh.centerville.edu2005-02-14T16:00:00-05:00</cap:identifier> <cap:sender>em@centralhigh.centerville.edu</cap:sender> <cap:sent>2005-02-14T16:00:00-05:00</cap:sent> <cap:status>Actual</cap:status> <cap:scope>Public</cap:scope> <cap:msgType>Update</cap:msgType> <cap:references>em@centralhigh.centerville.edu,em@centralhigh.centerville.edu2005-02-14T15:30:00-05:00,2005-02-14T15:30:00-05:00</cap:references> <cap:info> <cap:event>Bus Release</cap:event> <cap:urgency>Immediate</cap:urgency> <cap:severity>Unknown</cap:severity> <cap:certainty>Observed</cap:certainty> <cap:category>Transport</cap:category> <cap:language>En-US</cap:language> <cap:audience>Bus Coordinator</cap:audience> <cap:headline>Load and release buses</cap:headline> <cap:description>It is clear to load and release the buses at Centerville High.</cap:description> <cap:instruction>Release buses</cap:instruction> <cap:contact>Principal Jones, 555-555-1234</cap:contact> </cap:info> </cap:alert> </ed:namespacedXMLContent> </ed:contentObject> <ed:contentObject> <ed:contentKeyword> <ed:valueListUrn>centerville.edu.keyword.incident.phase</ed:valueListUrn> <ed:value>Bus Release</ed:value> </ed:contentKeyword> <ed:originatorRole> <ed:valueListUrn>centerville.edu.senderRole.schoolEmergencyManager</ed:valueListUrn> <ed:value>Principal</ed:value> </ed:originatorRole> <ed:consumerRole> <ed:valueListUrn>centerville.edu.recipientRole.centralhigh.allSchool</ed:valueListUrn> <ed:value>Parents</ed:value> </ed:consumerRole> <ed:description>Message to notify parents buses have left Centerville High</ed:description> <ed:mimeType>application/vnd.hw_sms</ed:mimeType> <ed:digest>The buses have been released and are running 2 hours late.</ed:digest> <ed:uri>centerville:edu:message:schoolEvac050214155900</ed:uri> </ed:contentObject> </ed:EDXLDistribution>
<?xml version="1.0" encoding="UTF-8"?> <schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ed="urn:oasis:names:tc:emergency:EDXL:DE:1.0" targetNamespace="urn:oasis:names:tc:emergency:EDXL:DE:1.0" elementFormDefault="qualified" attributeFormDefault="unqualified"> <element name="EDXLDistribution"> <annotation> <documentation>The container element for the distribution element. MAY include <targetArea> and <messageElement> blocks. </documentation> </annotation> <complexType> <sequence> <element name="distributionID" type="xsd:string"> <annotation> <documentation>An identifier string for this message, assigned by the sender to be unique for that sender. </documentation> </annotation> </element> <element name="senderID" type="xsd:string"> <annotation> <documentation>A unique idejntifier for the sender in the form actor@domain-name, with uniqueness of the domain-name guaranteed through use of the Internet Domain Name System, and uniqueness of the actor name enforced by the domain owner. </documentation> </annotation> </element> <element name="dateTimeSent" type="xsd:dateTime"> <annotation> <documentation>The date and time the message was sent, in the ISO-8601 format for the XML DateTime data type </documentation> <documentation>The Date Time combination must include the +/- offset time for time zone. </documentation> </annotation> </element> <element name="distributionStatus"> <annotation> <documentation> The actionability of the distribution of the message. Value must be one of: Actual - "Real-world" information for action Exercise - Simulated information for exercise participants System - Messages regarding or supporting network functions Test - Discardable messages for technical testing only </documentation> </annotation> <simpleType> <restriction base="xsd:string"> <enumeration value="Actual"/> <enumeration value="Exercise"/> <enumeration value="System"/> <enumeration value="Test"/> </restriction> </simpleType> </element> <element name="distributionType"> <annotation> <documentation> The function of the distribution message. Value must be one of: Report - New information regarding an incident or activity Update - Updated information superceding a previous message Cancel - A cancellation or revocation of a previous message Request - A request for resources, information or action Response - A response to a previous request Dispatch - A commitment of resources or assistance Ack - Acknowledgement of receipt of an earlier message Error - Rejection of an earlier message (for technical reasons) </documentation> </annotation> <simpleType> <restriction base="xsd:string"> <enumeration value="Ack"/> <enumeration value="Cancel"/> <enumeration value="Dispatch"/> <enumeration value="Error"/> <enumeration value="Report"/> <enumeration value="Request"/> <enumeration value="Response"/> <enumeration value="Update"/> </restriction> </simpleType> </element> <element name="senderRole"> <annotation> <documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the sender, in the form: <senderRole> <valueListUrn>valueListUrn</valueListUrn> <value>value<value> </senderrolegt; 2. Multiple instance of <value> MAY occur within a single <senderRole> structure. 3. Multiple instances of <senderRole> MAY occur within a single <messageElement> block. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn"> <annotation> <documentation>where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </documentation> </annotation> </element> <element ref="ed:value"> <annotation> <documentation>The content of "value" is a string (which may represent a number) denoting the value itself</documentation> </annotation> </element> </sequence> </complexType> </element> <element name="recipientRole" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the recipient, in the form: where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions, and the content of "value" is a string (which may represent a number) denoting the value itself 2. Multiple instance of <value> MAY occur within a single <recipientRole> structure. 3. Multiple instances or <recipientRole> MAY occur within a single <messageElement> block. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn"> <annotation> <documentation>where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions</documentation> </annotation> </element> <element ref="ed:value"> <annotation> <documentation>the content of "value" is a string (which may represent a number) denoting the value itself</documentation> </annotation> </element> </sequence> </complexType> </element> <element name="keyword" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> 1. Any value from a discrete managed list, used to inform message routing decisions, in the form: <keyword> <valueListUrn>valueListUrn</valueListURN> <value>value</value> </keyword> where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions, and the content of "value" is a string (which may represent a number) denoting the value itself 2. Examples of things <keyword> might be used to describe include event type, event etiology, incident ID and response type. 3. Multiple instance of <value> MAY occur within a single <keyword> structure. 4. Multiple instances of <keyword> MAY occur within a single <messageElement> block. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn"> <annotation> <documentation> where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions</documentation> </annotation> </element> <element ref="ed:value"> <annotation> <documentation>the content of "value" is a string (which may represent a number) denoting the value itself</documentation> </annotation> </element> </sequence> </complexType> </element> <element name="explicitAddress" type="xsd:string"> <annotation> <documentation> A unique identifier for the recipient in the form actor@domain-name, with uniqueness of the domain-name guaranteed through use of the Internet Domain Name System, and uniqueness of the actor name enforced by the domain owner. </documentation> </annotation> </element> <element name="distributionReference" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The messageID and senderID and dateTimeSent of the referenced previous message, concatenated with a ":" delimiter (should appear at least once in any message which updates, cancels or otherwise refers to another message.)</documentation> </annotation> </element> <element name="explicitAddress" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <element name="combinedConfidentiality" type="xsd:string" minOccurs="0"> <annotation> <documentation>Special requirements regarding confidentiality of the content of this <messageElement>.</documentation> </annotation> </element> <element name="targetArea" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The container element for geospatial or political-area targeting of the message. Contains elements as described in Table 2, below. Multiple <targetArea> blocks may appear in a single <distribution> element, in which case the target area for the current message is the union of all areas described in the various <targetArea> structures.</documentation> <documentation>TargetArea is a container for location information</documentation> </annotation> <complexType> <sequence> <element name="circle" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> An enclosed area within a given radius around a geographic point, represented in the form "latitude,longitude radius". The central point is represented per the specification for <site>, while the space-separated radius value is expressed in kilometers</documentation> </annotation> </element> <element name="polygon" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> An enclosed geographic area within a simple closed polygon defined by an ordered set of vertices. Represented by a space-delimited series of latitude,longitude pairs, with the last pair identical to the first.</documentation> </annotation> </element> <element name="country" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation>The two-character ISO 3166 alpha-2 Country Code for the country concerned.</documentation> </annotation> </element> <element name="subdivision" type="xsd:string" minOccurs="0"> <annotation> <documentation> The ISO 3166-2 designator for the administrative subdivision concerned. The first two characters, before the hyphen, is the ISO 3166 alpha-2 Country Code for the country within which the designated subdivision is located. The following one-to-three characters following the hyphen designate the particular subdivision.</documentation> </annotation> </element> <element name="location" type="xsd:string" minOccurs="0"> <annotation> <documentation> The UN/LOCODE designator for the location concerned. The two first digits are the ISO 3166 alpha-2 Country Code for the country in which the place is located. The following three characters are the UN/LOCODE designator for the particular location within that country. No spaces or punctuation are used within this designator.</documentation> </annotation> </element> </sequence> </complexType> </element> <element name="contentObject" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> 1. The container element for message content. 2. This element MUST assert an explicit namespace for any included XML content used in <keyXmlContent> and/or <contentObject>. </documentation> </annotation> <complexType> <sequence> <element name="contentKeyword" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation>??</documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn"> <annotation> <documentation> the content of "value" is a string (which may represent a number) denoting the value itself </documentation> </annotation> </element> <element ref="ed:value"> <annotation> <documentation> the content of "value" is a string (which may represent a number) denoting the value itself </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="keyXMLContent" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> 1. A container element for collected fragments of a valid XML document contained within an <xmlContent> element within the current <messageElement> block. 2. All content within this element MUST be explicitly namepaced as defined in the enclosing <messageElement> tag. </documentation> </annotation> <complexType> <sequence> <any namespace="##other" processContents="lax" maxOccurs="unbounded"/> </sequence> <anyAttribute namespace="##other" processContents="lax"/> </complexType> </element> <element name="originatorRole"> <annotation> <documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the sender, in the form: <messageSenderRole> <valueListUrn>valueListUrn</valueListUrn> <value>value</value> </messageSenderRole> </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn"> <annotation> <documentation> the content of "value" is a string (which may represent a number) denoting the value itself </documentation> </annotation> </element> <element ref="ed:value"> <annotation> <documentation> the content of "value" is a string (which may represent a number) denoting the value itself </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="consumerRole" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the recipient, in the form: <messageRcipientRole> <valueListUrn>valueListUrn</valueListURN> <value>value</value> </messageRecipientRole> where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions, and the content of "value" is a string (which may represent a number) denoting the value itself (e.g., valueListUrn = "http://www.dhs.gov/NiemRoleType" and value = "ICS Operations Branch".) 2. Multiple instance of <value> MAY occur within a single <messageRecipientRole> structure. 3. Multiple instances or <messageRecipientRole> MAY occur within a single <messageElement> block. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn"> <annotation> <documentation> the content of "value" is a string (which may represent a number) denoting the value itself </documentation> </annotation> </element> <element ref="ed:value"> <annotation> <documentation> the content of "value" is a string (which may represent a number) denoting the value itself </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="confidentiality" type="xsd:string" minOccurs="0"> <annotation> <documentation> Special requirements regarding confidentiality of the content of this <messageElement>. </documentation> </annotation> </element> <element name="description" type="xsd:string" minOccurs="0"/> <element name="mimeType" type="xsd:string"> <annotation> <documentation>MIME content type and sub-type as described in [RFC 2046].</documentation> </annotation> </element> <element name="size" type="xsd:integer" minOccurs="0"> <annotation> <documentation>Approximate size of the content item (in its un-encoded form) in bytes.</documentation> </annotation> </element> <element name="digest" type="xsd:string" minOccurs="0"> <annotation> <documentation>The digital digest ("hash") of the content item calculated using the Secure Hash Algorithm (SHA-1) per [FIPS 180-2]</documentation> </annotation> </element> <choice id="contentContainer" maxOccurs="1"> <element name="uri" type="xsd:anyURI" minOccurs="0"> <annotation> <documentation>Either a full absolute URI, typically a Uniform Resource Locator, that can be used to retrieve the resource over the Internet, or a relative URI naming the file represented in the <derefUri>.</documentation> </annotation> </element> <element name="derefUri" type="xsd:string" minOccurs="0"> <annotation> <documentation>The base-64 encoded data content. MAY be used either with or instead of the <uri> element in contexts where retrieval of a resource via a URI is not feasible.</documentation> </annotation> </element> <element name="namespacedXMLContent" maxOccurs="1"> <annotation> <documentation> 1. Container element for the actual content. That content MAY be either a separately-namespaced XML document or some item of non-XML content as described in Table 4, below. 2. If the enclosed content is XML it MUST be explicitly namepaced as defined in the enclosing <namespacedXMLContent> tag. Enclosed XML content may be encrypted and/or signed within this element. 3. This element MUST be present unless the Distribution Element is used in a query to, or a response from, a directory service. </documentation> </annotation> <complexType> <sequence> <any namespace="##other" processContents="lax" maxOccurs="unbounded"/> </sequence> <anyAttribute namespace="##other" processContents="lax"/> </complexType> </element> </choice> </sequence> </complexType> </element> </sequence> </complexType> </element> <element name="value" type="xsd:string"> <annotation> <documentation> A Value from a certified list maintained by the Community of Interest (COI) for the referenced element. </documentation> </annotation> </element> <element name="valueListUrn" type="xsd:string"> <annotation> <documentation> The name of the certified list maintained by the Community of Interest (COI) for the value referenced. </documentation> </annotation> </element> </schema>Title: Emergency Data Exchange Language (EDXL) Distribution Element
Emergency Data Exchange Language (EDXL) Distribution Element, v. 1.0
Committee Draft, 16, August 2005
Document Identifier:
[Document Identifier as per OASIS Artifact Naming Guidelines]
OASIS Identifier:
[OASIS Document Number]
Location:
This Version:http://docs.oasis-open.org/emergency/EDXL_DE/V1.0
Technical Committee:
OASIS Emergency Management TC
Chair(s):
Elysa Jones, Warning Systems, Inc
Editor(s):
Michelle Raymond, Honeywell ACS Labs
Sylvia Webb, GEFEG
Subject / Keywords:
[Comma-separated keyword listing]
OASIS Conceptual Topic Model Area:
[Please refer to (link) for appropriate topic area]]
Related Work:
This specification replaces or supercedes:
This specification is related to:
Abstract:
This Distribution Element specification describes a standard message distribution framework for data sharing among emergency information systems using the XML-based Emergency Data Exchange Language (EDXL). This format may be used over any data transmission system, including but not limited to the SOAP HTTP binding.
Status:
This document was last revised or approved by the Emergency Management Technical Committee on the above date. The level of approval is also listed above. Check the current location noted above for possible later revisions of this document. This document is updated periodically on no particular schedule.
Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at www.oasis-open.org/committees/emergency.
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page ( www.oasis-open.org/committees/emergency/ipr.php.
The non-normative errata page for this specification is located at www.oasis-open.org/committees/[specific location].
Notices
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification, can be obtained from the OASIS President.
OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS President.
Copyright © OASIS Open 2004. All Rights Reserved.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself does not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document must be followed, or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an “AS IS” basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Table of Contents
1.1 Purpose
1.2 History
1.3 Structure of the EDXL Distribution Element
1.3.1 <EDXLDistribution>
1.3.2 <targetArea>
1.3.3 <contentObject>
1.4 Application of the EDXL Distribution Element
1.5 Terminology
2 Design Principles and Concepts (non-normative)
3 EDXLDistribution Element Structure (normative)
3.2 Data Dictionary
3.2.1 EDXLDistribution Element and Sub-elements
3.2.2 targetArea Element and Sub-elements
3.2.3 contentObject Element and Sub-elements
3.2.4 Content Access Elements
3.2.4.1 derefUri Element
3.2.4.2 uri Element
3.2.4.3 namespacedXMLContent Element
A. Examples of Distribution Element XML Documents
A.1 Example 1: Sentry Alert Distribution
A.2 Example 2: School Alert Distribution
B. XML Schema for the EDXLDistribution Element
The Distribution Element may be thought of as a "container" which facilitates the "routing" of message sets (any properly formatted XML emergency message) to recipients. The Distribution Element carries and routes "payload" message sets (such as Alerts or Resource Messages), by specifying key routing information such as distribution type, geography, incident, and sender/recipient ID’s.
The goal of the EDXL project is to facilitate emergency information sharing and data exchange across the local, state, tribal, national and non-governmental organizations of different professions that provide emergency response and management services. EDXL will accomplish this goal by focusing on the standardization of specific messages (messaging interfaces) to facilitate emergency communication and coordination particularly when more than one profession is involved. It is not just an "emergency management" domain exercise. Once standardized, any technology vendor or organization can easily develop their XML-based messaging interface enabling them to send messages to each other regardless of platform.
[Need some more input]
1.3 Structure of the EDXL Distribution Element
The EDXL Distribution Element (DE) comprises an <EDXLDistribution> element as described hereafter, optional <targetArea> elements describing geospatial or political target area for message delivery, and a set of <contentObject> elements each containing specific information regarding a particular item of content. The included content may be any XML or other file or document.
The <EDXLDistribution> block may be used without content to form the body of a routing query to, or response from, a directory service.
The <EDXLDistribution> element asserts the originator"s intent as to the dissemination of that particular message or set of messages.
Note that use of the <EDXLDistribution> element does not guarantee that all network links and nodes will implement the asserted dissemination policy or that unintended disclosure will not occur. Where sensitive information is transmitted over untrusted networks, it should be encrypted in accordance with the Web Services Security (WSS) standard http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf with any updates and errata published by the OASIS Web Services Security Technical Committee http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wss), or some other suitable encryption scheme.
[basic targetArea description goes here]
[basic contentObject description goes here]
1.4 Applications of the EDXL Distribution Element
The primary use of the EDXL Distribution Element is to identify and provide information to enable the routing of encapsulated payloads, called as ContentObjects. It is used to provide a common mechanism to encapsulate content information.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” are to be interpreted as described in [RFC2119].
N. Freed, Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types, http://www.ietf.org/rfc/rfc2046.txt, IETF RFC 2046, November 1996.
S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
[XML 1.0]
T. Bray, Extensible Markup Language (XML) 1.0 (Third Edition), http://www.w3.org/TR/REC-xml/, W3C REC-XML-20040204, February 2004.
[namespaces]
T. Bray, Namespaces in XML, http://www.w3.org/TR/REC-xml-names/, W3C REC-xml-names-19990114, January 1999.
[dateTime]
N. Freed, XML Schema Part 2: Datatypes Second Edition, http://www.w3.org/TR/xmlschema-2/#dateTime, W3C REC-xmlschema-2, October 2004.
EDXL General Functional Requirements
EDXL General Functional Requirements, http://www.oasis-open.org/apps/org/workgroup/emergency/documents.php?expand_folder_id=720#folder_720, November 2004
2. Design Principles and Concepts (non-normative)
Below are some of the guiding principles of the Distribution Element:
The Distribution Element specification should:
3. EDXLDistribution Element Structure (normative)
Bold indicates required element.
* indicates multiple instances allowed
3.2.1 EDXLDistribution Element and Sub-elements
Element | EDXLDistribution |
---|---|
Definition |
The container element for all content necessary to the originator's intent as to the dissemination of that particular message or set of messages. (REQUIRED) |
Notes |
|
Sub-elements |
Element | distributionID |
---|---|
Type | xsd:string |
Definition |
An identifier string for this message, assigned by the sender to be unique for that sender. (REQUIRED) |
Used In | EDXLDistribution |
Element | senderID |
---|---|
Type | xsd:string |
Definition |
A unique identifier for the sender in the form actor@domain-name. (REQUIRED) |
Notes | Uniqueness of the domain-name is guaranteed through use of the Internet Domain Name System, and uniqueness of the actor name enforced by the domain owner. |
Used In | EDXLDistribution |
Element | dateTimeSent |
---|---|
Type | xsd:dateTime |
Definition |
The date and time the message was sent, in the ISO-8601 format for the XML DateTime data type. (REQUIRED) |
Notes | Example: 2004-08-01T16:49:00-07:00 |
Used In | EDXLDistribution |
Element | distributionStatus |
---|---|
Type | restricted xsd:string value to: Actual, Exercise, System or Test |
Definition |
The actionability of the message. (REQUIRED) |
Notes |
Value must be one of:
|
Used In | EDXLDistribution |
Element | distributionType |
---|---|
Type | restricted xsd:string value to: Ack, Cancel, Dispatch, Error, Report, Request, Response or Update |
Definition |
The function of the message. (REQUIRED) |
Notes |
Value must be one of:
|
Used In | EDXLDistribution |
Element | senderRole |
---|---|
Type | value list pair |
Definition |
Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the sender. (MAY have multiple) |
Notes |
|
Used In | EDXLDistribution |
Element | recipientRole |
---|---|
Type | value list pair |
Definition |
Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the recipient. (MAY have multiple) |
Notes |
|
Used In | EDXLDistribution |
Element | keyword |
---|---|
Type | value list pair |
Definition |
Any value from a discrete managed list, used to inform message routing or processing decisions. (MAY have multiple) |
Notes |
|
Used In | EDXLDistribution |
Element | distributionReference |
---|---|
Type | xsd:string |
Definition |
The <distributionID> and <senderID> and <dateTimeSent> of the referenced previous message, concatenated with a ":" delimiter. (MAY have multiple) |
Notes |
|
Used In | EDXLDistribution |
Element | explicitAddress |
---|---|
Type | xsd:string |
Definition |
(MAY have multiple) |
Notes | |
Used In | EDXLDistribution |
Element | combindedConfidentiality |
---|---|
Type | xsd:string |
Definition |
Special requirements regarding confidentiality of the content of this <EDXLDistribution> element. (Only one MAY be provide) |
Notes | The <combindedConfidentiality> indicates the confidentiality of the combined <messageElement> sub-elements. Generally the combined confidentiality is the most restrictive of the <confidentiality> elements in the container <messageElement> element, but it can be more restrictive than any of the individual <confidentiality> elements. |
Used In | EDXLDistribution |
3.2.2 targetArea Element and Sub-elements
Element | targetArea |
---|---|
Definition |
The container element for location information. (MAY have multiple) |
Notes |
|
Sub-elements | |
Used In | EDXLDistribution |
Element | circle |
---|---|
Type | xsd:string |
Definition |
An enclosed area within a given radius around a geographic point. (MAY have multiple) |
Notes |
NOTE: What <site> element is this referencing? The exact spec. should be noted. |
Used In | targetArea |
Element | polygon |
---|---|
Type | xsd:string |
Definition |
An enclosed geographic area within a simple closed polygon defined by an ordered set of vertices. (MAY have multiple) |
Notes |
|
Used In | targetArea |
Element | country |
---|---|
Type | xsd:string |
Definition |
The two-character ISO 3166 alpha-2 Country Code for the country concerned. (MAY have multiple) |
Used In | targetArea |
Element | subdivision |
---|---|
Type | xsd:string |
Definition |
The ISO 3166-2 designator for the administrative subdivision concerned. (MAY have multiple) |
Notes |
|
Used In | targetArea |
Element | location |
---|---|
Type | xsd:string |
Definition |
The UN/LOCODE designator for the location concerned. (MAY have multiple) |
Notes |
|
Used In | targetArea |
3.2.3 messageElement Element and Sub-elements
Element | messageElement |
Definition |
The container element for message content. (MAY have multiple) |
Notes |
|
Sub-elements | |
Used In | EDXLDistribution |
contentKeyword | contentKeyword |
Type | value list pair |
Definition |
Any value from a discrete managed list, used to inform message routing or processing decisions. (MAY have multiple) |
Notes |
|
Used In | messageElement |
Element | keyXMLContent |
Definition |
A container element for collected fragments of a valid XML document contained within an <xmlContent> element within the current <messageElement> block. (MAY have only one) |
Notes | All content within this element MUST be explicitly namespaced as defined in the enclosing <messageElement> tag. |
Used In | messageElement |
Element | messageSenderRole |
Type | value list pair |
Definition |
Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the sender. (MAY have multiple) |
Notes |
|
Used In | messageElement |
Element | messageRecipientRole |
Type | value list pair |
Definition |
Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the recipient. (MAY have multiple) |
Notes |
|
Used In | messageElement |
Element | confidentiality |
Type | xsd:string |
Definition |
Special requirements regarding confidentiality of the content of this <messageElement>
(MAY have only one) |
Used In | messageElement |
Element | contentObject |
Definition |
Container element for the actual message content. (MUST have only one) |
Notes |
|
Used In | messageElement |
3.2.4.1 contentObject Sub-elements: Option 1
Element | contentDescription |
Type | xsd:string |
Definition |
(MAY have only one) |
Notes | |
Used In | contentObject |
Element | mimeType |
Type | xsd:string |
Definition |
MIME content type and sub-type as described in [RFC 2046]. (MAY have only one) |
Used In | contentObject |
Element | size |
Type | xsd:integer |
Definition |
Approximate size of the content item (in its un-encoded form) in bytes. (MAY have only one) |
Used In | contentObject |
Element | uri |
Type | xsd:anyURI |
Definition |
Either a full absolute URI, typically a Uniform Resource Locator, that can be used to retrieve the resource over the Internet, or a relative URI naming the file represented in the <derefUri>. (MAY have only one) |
Used In | contentObject |
Element | derefUri |
Type | xsd:string |
Definition |
The base-64 encoded data content. MAY be used either with or instead of the <uri> element in contexts where retrieval of a resource via a URI is not feasible. (MAY have only one) |
Used In | contentObject |
Element | digest |
Type | xsd:string |
Definition |
The digital digest ("hash") of the content item calculated using the Secure Hash Algorithm (SHA-1) per [FIPS 180-2] (MAY have only one) |
Used In | contentObject |
3.2.4.2 contentObject XML Content: Option 2
Element | xmlContent |
Type | valid xml |
Definition |
(MAY have only one) |
Notes | |
Used In | contentObject |
The value list pair of valueListUrn and value is generally contained within another element in the form:
<containerElement>
<valueListUrn>valueListUrn</valueListURN>
<value>value</value>
</containerElement>
Element | valueListUrn |
---|---|
Type | xsd:string |
Definition |
The content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions (REQUIRED) |
Notes | Example: http://www.dhs.govNiemAgencyType |
Used In |
Element | value |
---|---|
Type | xsd:string |
Definition |
The content of <value> is a string (which may represent a number) denoting the value itself. (REQUIRED) |
Notes | Example: Fire Department |
Used In |
Appendix A. Examples of EDXLDistribution Element XML Documents
Example 1: Sentry Alert Distribution
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <EDXLDistribution xmlns="http://www.incident.com/EDXLDistribution/1.0" > <distributionID>12345</distributionID > <senderID>dellis@sandia.gov</senderID> <dateTimeSent>2005-05-01T18:00:00-06:00</dateTimeSent> <distributionStatus>Actual</distributionStatus> <distributionType>Report</distributionType> <distributionReference></distributionReference> <recipentAddress></recipentAddress> <lowestConfidentiallity>FOUO</lowestConfidentiallity> <targetArea> <location>USSUU</location> </targetArea> <messageElement> <keyword> <valueListUrn>a</valueListUrn> <value>b</value> </keyword> <senderRole> <valueListUrn>c</valueListUrn> <value>d</value> </senderRole> <recipentRole> <valueListUrn>e</valueListUrn> <value>f</value> </recipentRole> <responseType> <valueListUrn>g</valueListUrn> <value>h</value> </responseType> <confidentiality>FOUO</confidentiality> <keyXmlContent xmlns:cap="http://www.incident.com/CAP/1.0" > <cap:category>other</cap:category> <cap:event>chemical</cap:event> </keyXmlContent> <contentOject> <Payload xmlns:cap="http://www.incident.com/CAP/1.0" > <cap:identifier>SENTRY_01</cap:identifier> <cap:sender>SENTRY</cap:sender> <cap:sent>2005-05-01T18:08:00-06:00</cap:sent> <cap:status>Test</cap:status> <cap:msgType>Alert</cap:msgType> <cap:scope>Public</cap:scope> <cap:note>This comment is Extraordinarily tremendous!!</cap:note> <cap:incidents>MWM-13407</cap:incidents> <cap:info> <cap:category>Other</cap:category> <cap:event>chemical</cap:event> <cap:urgency>Immediate</cap:urgency> <cap:severity>Unknown</cap:severity> <cap:certainty>Unknown</cap:certainty> <cap:senderName>SENTRY</cap:senderName> <cap:headline>LV 2 CWA Low Blister</cap:headline> <cap:description>SENTRY has detected a(n) chemical event: MWM-13407 from Site: Tiedown. Its Primary Source is: LV 2 CWA Low Blister, it has a priority of 4, and is located at -77.099953,38.800035 Comment: This comment is Extraordinarily tremendous!!</cap:description> <cap:resource> <cap:resourceDesc>Video clip from Sensor: CWDET-01, Site: Tiedown, having a Detection class of CWDET. Video specs: Length: 23 Type: mpeg Channel Band: Channel A</cap:resourceDesc> <cap:uri>http://sentry/videoClip1</cap:uri> </cap:resource> <cap:resource> <cap:resourceDesc>Photo image from Sensor: CWDET-01, Site: Tiedown, having a Detection class of CWDET. Photo specs: Type: jpeg Channel Band: Channel B</cap:resourceDesc> <cap:uri>http://sentry/photoCapture</cap:uri> </cap:resource> </cap:info> </Payload> </contentOject> </messageElement> </EDXLDistribution>
Example 2: School Alert Distribution
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <EDXLDistribution xmlns="http://www.incident.com/EDXLDistribution/1.0" > <distributionID>schoolEvac050214130000</distributionID > <senderID>em@centralhigh.centerville.edu</senderID> <dateTimeSent>2005-02-14T13:00:00-05:00</dateTimeSent> <distributionStatus>Actual</distributionStatus> <distributionType>Update</distributionType> <senderRole> <valueListURN>centerville.edu.senderRole.schoolEmergencyManager</valueListURN> <value>Principal</value> </senderRole> <recipientRole> <valueListURN>centerville.edu.recipientRole.centralhigh.allSchool</valueListURN> <value>Parents</value> </recipientRole> <recipientRole> <valueListURN>centerville.edu.recipientRole.centralhigh.support</valueListURN> <value>Busing</value> </recipientRole> <keyword> <valueListURN>centerville.edu.keyword.incident.phase</valueListURN> <value>BusRelease</value> </keyword> <distributionReference>schoolEmergency050214112019:em@centralhigh.edu:2005-02-14T11:20:19-05:00</distributionReference> <recipentAddress>centralhigh.metropolis.edu/studentGuardians</recipentAddress> <messageElement> <keyword> <valueListUrn>district.metropolis.edu.pickupLoc</valueListUrn> <value>Metropolis Community Center</value> </keyword> <keyword> <valueListUrn>district.metropolis.edu/busSched</valueListUrn> <value>Variable</value> </keyword> <distributionFormat> </distributionFormat> <senderRole> <valueListUrn>centralhigh.metropolis.edu/facultyStaff</valueListUrn> <value>Principal</value> </senderRole> <recipentRole> <valueListUrn>centralhigh.metropolis.edu/studentGuardians</valueListUrn> <value>guardiansAll</value> </recipentRole> </EDXLDistribution>
Appendix B. XML Schema for the EDXLDistribution Element
<?xml version="1.0" encoding="UTF-8"?> <xsd:schema xmln:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.incident.com/EDXLDistribution/1.0" targetNamespace="http://www.incident.com/EDXLDistribution/1.0" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xsd:element name="EDXLDistribution"> <xsd:annotation> <xsd:documentation> The container element for the distribution element. May include <targetArea> and <messageElement> blocks. </xsd:documentation> <xsd:documentation> EDXL Distribution Message (version 0.5) </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element name="distributionID" type="xsd:string"> <xsd:annotation> <xsd:documentation> An identifier string for this message, assigned by the sender to be unique for that sender. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="senderID" type="xsd:string"> <xsd:annotation> <xsd:documentation> A unique identifier for the sender in the form actor@domain-name, with uniqueness of the domain-name guaranteed through use of the Internet Domain Name System, and uniqueness of the actor name enforced by the domain owner. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="dateTimeSent" type="xsd:dateTime"> <xsd:annotation> <xsd:documentation> The date and time the message was sent, in the ISO-8601 format for the XML DateTime data type. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="distributionStatus" type="xsd:string"> <xsd:annotation> <xsd:documentation> The actionability of the message. Value must be one of: Actual - "Real-world" information for action Exercise - Simulated information for exercise participants System - Messages regarding or supporting network functions Test - Discardable messages for technical testing only </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="distributionType"> <xsd:annotation> <xsd:documentation> The function of the message. Value must be one of: Report - New information regarding an incident or activity Update - Updated information superceding a previous message Cancel - A cancellation or revocation of a previous message Request - A request for resources, information or action Response - A response to a previous request Dispatch - A commitment of resources or assistance Ack - Acknowledgement of receipt of an earlier message Error - Rejection of an earlier message (for technical reasons) </xsd:documentation> </xsd:annotation> <xsd:simpleType> <xsd:restriction base="xsd:string"> <xsd:enumeration value="Ack"/> <xsd:enumeration value="Cancel"/> <xsd:enumeration value="Dispatch"/> <xsd:enumeration value="Error"/> <xsd:enumeration value="Report"/> <xsd:enumeration value="Request"/> <xsd:enumeration value="Response"/> <xsd:enumeration value="Update"/> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="senderRole" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the sender, in the form of <valueListUrn>, <value> pairs. 2. Multiple instance of the <valueListUrn>, <value> pairs MAY occur within a single <senderRole> structure. 3. Multiple instances of <senderRole> MAY occur within a single <messageElement> block. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element ref="valueListUrn"> <xsd:annotation> <xsd:documentation> The content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="value"> <xsd:annotation> <xsd:documentation> The content of "value" is a string (which may represent a number) denoting the value itself. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="recipentRole" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the recipient, in the form: where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions, and the content of "value" is a string (which may represent a number) denoting the value itself. 2. Multiple instance of <value> MAY occur within a single <recipientRole> structure. 3. Multiple instances or <recipientRole> MAY occur within a single <messageElement> block. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element ref="valueListUrn"> <xsd:annotation> <xsd:documentation> The content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="value"> <xsd:annotation> <xsd:documentation> The content of "value" is a string (which may represent a number) denoting the value itself. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="keyword" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> 1. Any value from a discrete managed list, used to inform message routing decisions, in the form: <keyword> <valueListUrn>valueListUrn</valueListURN> <value>value</value> </keyword> where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions, and the content of "value" is a string (which may represent a number) denoting the value itself 2. Examples of things <keyword> might be used to describe include event type, event etiology, incident ID and response type. 3. Multiple instance of <value> MAY occur within a single <keyword> structure. 4. Multiple instances of <keyword> MAY occur within a single <messageElement> block. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element ref="valueListUrn"> <xsd:annotation> <xsd:documentation> The content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="value"> <xsd:annotation> <xsd:documentation> The content of "value" is a string (which may represent a number) denoting the value itself. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="distributionReference" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> The distributionID and senderID and dateTimeSent of the referenced previous message, concatenated with a ":" delimiter (should appear at least once in any message which updates, cancels or otherwise refers to another message.) </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="explicitAddress" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <xsd:element name="lowestConfidentiallity" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation> Special requirements regarding confidentiality of the content of this <messageElement>. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="targetArea" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> The container element for geospatial or political-area targeting of the message. Multiple <targetArea> blocks may appear in a single <EDXLDistribution> element, in which case the target area for the current message is the union of all areas described in the various <targetArea> structures. </xsd:documentation> <xsd:documentation> TargetArea is a container for location information. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="messageElement" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="targetArea"> <xsd:annotation> <xsd:documentation>T argetArea is a container for location information. </xsd:documentation> <xsd:documentation> The container element for geospatial or political-area targeting of the message. Multiple <targetArea> blocks may appear in a single <EDXLDistribution> element, in which case the target area for the current message is the union of all areas described in the various <targetArea> structures. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element name="circle" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> An enclosed area within a given radius around a geographic point, represented in the form "latitude, longitude radius". The central point is represented per the specification for <site>, while the space-separated radius value is expressed in kilometers </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="polygon" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> An enclosed geographic area within a simple closed polygon defined by an ordered set of vertices. Represented by a space-delimited series of latitude, longitude pairs, with the last pair identical to the first. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="country" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> The two-character ISO 3166 alpha-2 Country Code for the country concerned. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="subdivision" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> The ISO 3166-2 designator for the administrative subdivision concerned. The first two characters, before the hyphen, is the ISO 3166 alpha-2 Country Code for the country within which the designated subdivision is located. The following one-to-three characters following the hyphen designate the particular subdivision. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="location" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> The UN/LOCODE designator for the location concerned. The two first digits are the ISO 3166 alpha-2 Country Code for the country in which the place is located. The following three characters are the UN/LOCODE designator for the particular location within that country. No spaces or punctuation are used within this designator. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="messageElement"> <xsd:annotation> <xsd:documentation> 1. The container element for message content. 2. This element MUST assert an explicit namespace for any included XML content in <keyXmlContent> and/or <contentObject>. If no namespace is asserted in the <messageElement> tag, the enclosed content MAY be assumed to be non-XML. </xsd:documentation> <xsd:documentation>MessagaeElement is a container for</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element name="keyXMLContent" minOccurs="0"> <xsd:annotation> <xsd:documentation> 1. A container element for collected fragments of a valid XML document contained within an <xmlContent> element within the current <messageElement> block. 2. All content within this element MUST be explicitly namepaced as defined in the enclosing <messageElement> tag. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element ref="valueListUrn"> <xsd:annotation> <xsd:documentation> The content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="value"> <xsd:annotation> <xsd:documentation> The content of "value" is a string (which may represent a number) denoting the value itself. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="messageSenderRole" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the sender, in the form: <senderRole> <valueListUrn>valueListUrn</valueListURN> <value>value</value> </senderRole> </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element ref="valueListUrn"> <xsd:annotation> <xsd:documentation> The content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="value"> <xsd:annotation> <xsd:documentation> The content of "value" is a string (which may represent a number) denoting the value itself. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="messageRecipentRole" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation> 1. Any value from a discrete managed list, used to inform message routing decisions by describing the functional role of the recipient, in the form: <recipientRole> <valueListUrn>valueListUrn</valueListURN> <value>value</value> </recipientRole> where the content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions, and the content of "value" is a string (which may represent a number) denoting the value itself (e.g., valueListUrn = "http://www.dhs.gov/NiemRoleType" and value = "ICS Operations Branch".) 2. Multiple instance of <value> MAY occur within a single <recipientRole> structure. 3. Multiple instances or <recipientRole> MAY occur within a single <messageElement> block. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element ref="valueListUrn"> <xsd:annotation> <xsd:documentation> The content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="value"> <xsd:annotation> <xsd:documentation> The content of "value" is a string (which may represent a number) denoting the value itself. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="responseType" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>??</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element ref="valueListUrn"> <xsd:annotation> <xsd:documentation> The content of "valueListUrn" is the Uniform Resource Name of a published list of values and definitions. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element ref="value"> <xsd:annotation> <xsd:documentation> The content of "value" is a string (which may represent a number) denoting the value itself. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="confidentiality" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation> Special requirements regarding confidentiality of the content of this <messageElement>. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:choice> <xsd:element ref="contentObject"> <xsd:annotation> <xsd:documentation> 1. Container element for the actual message content. That content MAY be either a separately-namespaced XML document or some item of non-XML content. 2. If the enclosed content is XML it MUST be explicitly namepaced as defined in the enclosing <messageElement> tag. Enclosed XML content may be encrypted and/or signed within this element. 3. This element MUST be present unless the EDXLDistribution Element is used in a query to, or a response from, a directory service. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:choice> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="contentObject"> <xsd:annotation> <xsd:documentation> 1. Container element for the actual message content. That content MAY be either a separately-namespaced XML document or some item of non-XML content. 2. If the enclosed content is XML it MUST be explicitly namepaced as defined in the enclosing <messageElement> tag. Enclosed XML content may be encrypted and/or signed within this element. 3. This element MUST be present unless the EDXLDistribution Element is used in a query to, or a response from, a directory service. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element name="resourceDesc" type="xsd:string" minOccurs="0"/> <xsd:element name="mimeType" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation> MIME content type and sub-type as described in [RFC 2046]. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="size" type="xsd:integer" minOccurs="0"> <xsd:annotation> <xsd:documentation> Approximate size of the content item (in its un-encoded form) in bytes. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="uri" type="xsd:anyURI" minOccurs="0"> <xsd:annotation> <xsd:documentation> Either a full absolute URI, typically a Uniform Resource Locator, that can be used to retrieve the resource over the Internet, or a relative URI naming the file represented in the <derefUri>. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="derefUri" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation> The base-64 encoded data content. MAY be used either with or instead of the <uri> element in contexts where retrieval of a resource via a URI is not feasible. </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="digest" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation> The digital digest ("hash") of the content item calculated using the Secure Hash Algorithm (SHA-1) per [FIPS 180-2] </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="value"/> <xsd:element name="valueListUrn" type="xsd:string"/> <xsd:element name="valueName" type="xsd:string"/> </xsd:schema>
OASIS Emergency Management Technical Committee:
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]