Department of the Navy XML Naming and Design Rules Office of the DON Final Version 2.0 Chief Information Officer January 2005 Department of the Navy XML Naming and Design Rules January 2005 18 January 2005 MEMORANDUM FOR DISTRIBUTION Subj: EXTENSIBLE MARKUP LANGUAGE (XML) NAMING AND DESIGN RULES OFFICIAL RELEASE To comply with joint requirements as embodied in the DoD Net-Centric Data Strategy and to achieve the FORCEnet requirement for a common structure and language for information handling, the Department of the Navy (DON) is issuing Naming and Design Rules (NDR) that facilitate the discovery and use of common data across the naval enterprise. XML, an open standards based technology, is a key enabler of the Department's net-centric data strategy. The NDR provides additional rigor necessary to efficiently and effectively operate in a net-centric data-sharing environment. These rules move the DON forward to ensure that all XML is based on a consistent set of schema through the application of open standards that align with the Federal Enterprise Architecture Data Reference Model and Global Information Grid. The result will be an environment that is sustainable, responsive, and agile. The NDR is the product of expertise and energies contributed by representatives from 13 key Navy, Marine Corps, and Secretary of the Navy organizations who participated in the DON XML Working Group. To ensure these rules are applicable and current, the DON Chief Information Officer (DON CIO) has established the XML Business Standards Council and is proceeding to charter the Net-Centric Technical Standards Council to serve as liaison to organizations developing national and international standards for XML and Web Services technologies. All commands in the Navy and Marine Corps that are developing systems that use XML, in accordance with our DON XML Policy, should apply these standards in order to maximize interoperability and enable a net-centric environment for enhancing supportability of operations across the Department. The DON XML NDR can be downloaded from the web at www.doncio.navv.mil. If you have questions concerning DON XML policy and guidance, or would like to participate in our DON XML initiatives, you can contact u5 from thc D0?4CTCl webpage Contents Section 1 Introduction....................................................................................... 1-1 1.1 PURPOSE ..................................................................................................................... 1-2 1.2 AUTHORITY................................................................................................................. 1-2 1.3 AUDIENCE ................................................................................................................... 1-3 1.4 SCOPE ......................................................................................................................... 1-3 1.5 NDR DOCUMENT VERSIONING ................................................................................... 1-3 1.6 GUIDING PRINCIPLES................................................................................................... 1-3 1.7 DOCUMENT ORGANIZATION........................................................................................ 1-6 1.8 TERMINOLOGY AND NOTATION................................................................................... 1-6 Section 2 Information Analysis Rules .............................................................. 2-1 2.1 PURPOSE ..................................................................................................................... 2-1 2.2 AGGREGATE (ABIE) AND ASSOCIATION (ASBIE) BIES............................................. 2-1 2.2.1 Reference Associations ..................................................................................... 2-3 2.2.2 X-Link Associations ......................................................................................... 2-4 2.3 BASIC BUSINESS INFORMATION ENTITIES (BBIE)....................................................... 2-4 2.4 QUALIFIED AND UNQUALIFIED DATATYPES................................................................ 2-6 2.5 DEVELOPING THE SYNTAX NEUTRAL MODEL............................................................. 2-7 2.6 MIXED CONTENT ........................................................................................................ 2-9 Section 3 Data Management Rules................................................................... 3-1 3.1 PURPOSE ..................................................................................................................... 3-1 3.2 GLOBAL ELEMENT DATA MANAGEMENT.................................................................... 3-1 3.3 CONCLUSIONS ............................................................................................................. 3-5 Section 4 Namespace and Schema Modularity Rules ...................................... 4-1 4.1 PURPOSE ..................................................................................................................... 4-1 4.2 XML NAMESPACE RULES ............................................................................................ 4-1 4.3 SCHEMA STRUCTURE MODULARITY RULES ................................................................ 4-8 4.3.1 Enterprise Namespace....................................................................................... 4-8 Department of the Navy XML Naming and Design Rules iii 4.3.2 Schema Module Types.................................................................................... 4-10 4.3.3 Development Namespace................................................................................ 4-12 4.3.4 Run-Time Schema .......................................................................................... 4-14 Section 5 Versioning Rules............................................................................... 5-1 5.1 PURPOSE ..................................................................................................................... 5-1 5.2 NAMESPACE (URN) VERSIONING RULES.................................................................... 5-1 5.3 SCHEMA VERSIONING RULES ...................................................................................... 5-3 5.3.1 Enterprise Reusable Schema............................................................................. 5-4 5.3.2 Core Component Versioning Rules .................................................................. 5-4 5.4 VERSIONING SUMMARY .............................................................................................. 5-5 Section 6 General XML Rules.......................................................................... 6-1 6.1 PURPOSE ..................................................................................................................... 6-1 6.2 OVERALL SCHEMA STRUCTURE .................................................................................. 6-1 6.3 General XSD Rules.................................................................................................... 6-2 6.3.1 Built-in Simple Types....................................................................................... 6-3 6.3.2 XSD:substitution............................................................................................... 6-3 6.3.3 XSD:final .......................................................................................................... 6-3 6.3.4 XSD:notation .................................................................................................... 6-4 6.3.5 XSD:all ............................................................................................................. 6-4 6.3.6 XSD:choice....................................................................................................... 6-4 6.3.7 XSD:any............................................................................................................ 6-5 6.3.8 XSD:nil ............................................................................................................. 6-5 6.3.9 XSD:appinfo ..................................................................................................... 6-5 6.4 EXTENSION AND RESTRICTION.................................................................................... 6-5 6.4.1 XSD:complexTypes.......................................................................................... 6-5 6.4.2 XSD:import....................................................................................................... 6-6 6.4.3 XSD:include...................................................................................................... 6-6 6.4.4 XSD:union ........................................................................................................ 6-6 6.5 DOCUMENTATION ....................................................................................................... 6-6 6.5.1 Annotation and Documentation ........................................................................ 6-6 6.5.2 Schema Annotation........................................................................................... 6-7 6.5.3 Embedded Documentation................................................................................ 6-7 Department of the Navy XML Naming and Design Rules iv Contents Section 7 Naming, Definition, and Declaration Rules ..................................... 7-1 7.1 PURPOSE ....................................................................................................................