# Presentation: 458982

## Federal XML Developers GuideMark CrawfordLogistics Management Institute

## Genesis

**DON CIO issued XML Developers Guide in October 2001**
**Federal XML Working Group established action item in November 2001 to create Federal version**
**Co-Chair is establishing Committee**
**Co-Chair commissioned initial ‘federalized’ version of DON Guide**

## Background – DON Developer’s Guide

**Purpose**
**To rapidly provide a technically sound set of initial guides that:**
- Were specific enough to get DON XML developer’s moving in the right directions
- Were general enough to minimize chance of conflict with future guidance

## Background – DON Developer’s Guide

**Initial motivation**
**Navy Task Force Web initiative specified XML as the medium of information exchange**
**Via SOAP and using a portion of the UDDI specification**

## Background – DON Developer’s Guide

**Evolution**
**Realized early on the pressing need**
**Began development in early September**
**Series of drafts released and reviewed in Sep-Oct**
**DON CIO signed “Initial” guidance document 29 October –**
**Available on line at: **_**[http://quickplace.hq.navy.mil/navyxml](http://quickplace.hq.navy.mil/navyxml)**__** (click on “DON Guidance”)**_

## Background Guide Influences

**OASIS Registry TC**
**EPA Registry Study**
**DoD DII COE Shade**
**DoD DLIS **

**LMI**
**Federal Tag Standards for XML**

**Schema Best Practices**
- _[www.xfront.com](http://www.xfront.com/)_

**UML and RUP**

- OASIS
- UBL TC

- E P A

## The Guide Layout

**Uses RFC 2119 Terminology to express requirements**
** ****Requirements: MUST (NOT), SHALL (NOT), MAY, REQUIRED**
**Normative -**
**Guidance**
**Explanation**
**Examples**

## Sections of the Document

**Background**
**Recommended XML Specifications**
**XML Component Conventions**
**Schema Design Conventions**
**Document Annotation Conventions**
**Attribute/Element Conventions**
**Federal XML Registry**
**Appendices**

## Background

**Introduction**
**Terminology**
**Implementation Requirements**

## Chapter 2 - Recommended XML Specifications

**W3C Recommendations: All production applications MUST conform**
**Competing standards not allowed**
**No RELAX, or Schema Reduced...**
**Proposed Recommendations: May implement but must be ready to update**
**Candidate Recommendations: Suitable for Pilot applications**
**Working Drafts & Notes: Suitable for demonstrations**

## Chapter 2 - Recommended XML Specifications

**Other recognized specifications from credible consortia or recognized standards bodies: **
**Suitable for production if no competing W3C product exists.**
**Special Case - SOAP**
**Special Case - SAX**
**Other Guidance:**
**Use of proprietary extensions only for “private” implementation and only with government PM approval**
**Must fully understand implications**

## Chapter 3 - XML Component Conventions

**Case Convention**
**Acronyms and Abbreviations**
**Component and Creation**

## Chapter 4 - Schema Design Conventions

**Schema Languages – W3C Schema and ISO DTD**
**Development Methodology – Process Modeling Methodology**
**Capturing Metadata – In the document and related guide**

## Chapter 5 - Document Annotation Conventions

**Versioning**
**Headers**

## Chapter 6 - Attributes and Elements

**Elements for all parsed data**
**Attributes for metadata needed by Server**

## Chapter 7 - Federal XML Registry

**Registry and reuse of XML artifacts**

## Appendices

**Appendix A – ebXML and UN/CEFACT**
**Appendix B – Schema Development Procedure**
**Appendix C – tools and References**
**Appendix D – Examples**
**Appendix E – Sample Document Headers**
**Appendix F – Points of Contact**
**Appendix G – Glossary and Acronyms**

## Next Steps

**Call for volunteers**
**Begin deliberations**