Developing EDEN XML Files October 2005

1
Developing EDEN XML FilesOctober 2005
2

• Topics
• Introduction
• Structure and Content of XML File Format
  Specifications Documents
• Going to the next level

3

• Extensible Markup Language - XML
• XML is a standard for creating documents that
  describe and contain structured data
• XML document are self-describing making them
  readable by both humans and computers
• Extensible means there are not a fixed set of
  elements like HTML. Authors can define their own
  tags.
• A common format for exchanging data over the Web.

4

• Extensible Markup Language - XML
• XML uses text files contrast to binary files
• Similar to HTML
• lthtmlgt
• ltbodygtGreetings from the ltbgtEDENlt/bgt
  team.lt/bodygt
• lt/htmlgt
• Can be viewed within a browser such as Internet
  Explorer

5

• Example of XML
• ltFILETRANSMISSION FILELAYOUTTYPE"SEA MEMBERSHIP
  TABLE"
• FILEID"SEA MEMBERSHIP 15 OCT 2005"
  SCHOOLYEAR"2005-2006"gt
• ltAGENCY FIPSSTATECODE"99" STATEAGENCYIDNUMBER
  "01
• STATELEAIDNUMBER"518"gt
• ltTABLETYPE TYPEABBRV"MEMBER"
  TOTALINDICATOR"N"gt
• ltCATEGORY TYPE"GRADELVMEM"
  VALUE"03"/gt
• ltCATEGORY TYPE"RACEETHNIC"
  VALUEHI"/gt
• ltCATEGORY TYPE"GENDER" VALUE"F"/gt
• ltAMOUNTgt456lt/AMOUNTgt
• ltEXPLANATION/gt
• lt/TABLETYPEgt
• lt/AGENCYgt
• lt/FILETRANSMISSIONgt

6

• Why should I consider using XML?
• Easy to tell if XML is Well Formed
• Use XML schemas for validation.
• Stop playing find the error

7

• Why should I consider using XML? (contd)
• Stop using formats that only computers can
  practically read
• Example A health care claim. (ANSI X12 format)
• ST837872391
• BHT001900(0123)199704101339CH
• REF87004010X098
• CHIROPRACTIC4677BH666
• PERICLARRYTE3215556677
• COMPANY46123456789
• HL1201
• CHIROPRACTICXX777BH666
• N35 LUMBAR LANE
• N4GOLFERS HAVENFL91919

8

• Structure and Content of XML File Format
  Specifications Documents
• Mandatory/Optional Data Elements In XML Format
• Code Characteristic
• M Mandatory Element/Attribute
• O Optional
• C Conditionally Required
• MR Mandatory and Repeatable Element
• OR Optional and Repeatable Element
• CR Conditional and Repeatable Element

9

• Structure and Content of XML File Format
  Specifications Documents
• File Type Names
• File Naming Convention
• XML Format Specifications
• Error Messages and Helpful Hints

10

• Structure and Content of XML File Format
  Specifications Documents (continued)
• Category XML Object
• Table Name XML Object
• Agency XML Object
• File Transmit XML Object
• Required Categories and Applicable Totals

11

• Well Formed XML
• Every start-tag must have a matching end-tag or
  be a self-closing tag
• Elements must be properly nested
• There can only be one root element (for EDEN the
  root element is ltFILETRANSMISSIONgt)
• Element names must conform to XML naming
  conventions
• FYI XML tags are case sensitive

12

• Tools can help with well-formed validation

13

• Going to the next level
• XML Schemas
• Simple
• Precise
• XSLT
• Future Enhancements to EDEN

14

• What is a XML Schema?
• A document that describes an XML document
• Think of it as a contract it specifies the
  rules to which the XML document must adhere
• Structure
• Required Elements
• Valid Values or Ranges
• XML schemas are themselves XML documents

15

• Schema Uses
• Schemas are passed between data trading partners
  defines how data will be exchanged
• Use a schema to verify that a XML document is
  valid (i.e. the XML document meets all the
  requirements defined within the schema)
• Provides documentation (meta-data) about XML
  data. Supports annotations of any schema
  component.
• Augment XML data for example define a default
  value for an element or attribute

16

• Snippet from example EDEN Schema
• ltxselement name"OPSTATUS"gt
• ltxsannotationgt
• ltxsdocumentationgtLEA Type conforms to the CCD
  NCES code set for operational status of
  education agencylt/xsdocumentationgt
• lt/xsannotationgt
• ltxssimpleTypegt
• ltxsrestriction base"xsstring"gt
• ltxslength value"1"/gt
• ltxsenumeration value"1"/gt
• ltxsenumeration value"2"/gt
• ltxsenumeration value"3"/gt
• ltxsenumeration value"4"/gt
• ltxsenumeration value"5"/gt
• ltxsenumeration value"6"/gt
• ltxsenumeration value"7"/gt
• ltxsenumeration value"MISSING"/gt
• lt/xsrestrictiongt
• lt/xssimpleTypegt
• lt/xselementgt

17

• Current metric file schemas have limited
  validation
• ltTABLETYPE TYPEABBRV"MEMBER" TOTALINDICATOR"N"gt
  
• ltCATEGORY TYPE"GRADELVMEM" VALUE"01"/gt
• ltCATEGORY TYPE"RACEETHNIC" VALUE"HI"/gt
• ltCATEGORY TYPE"GENDER" VALUE"F"/gt
• ltAMOUNTgt48lt/AMOUNTgt
• lt/TABLETYPE gt

18

• Enhanced Schemas (borrowed from S. Kings
  presentation)
• ltxsdelement name"race_ethnic"gt
• ltxsdsimpleTypegt
• ltxsdrestriction base"xsdstring"gt
• ltxsdenumeration value"AS"/gt
• ltxsdenumeration value"AM"/gt
• ltxsdenumeration value"BL"/gt
• ltxsdenumeration value"HI"/gt
• ltxsdenumeration value"WH"/gt
• ltxsdenumeration value"MISSING"/gt
• ltxsdenumeration value"NOTCOLLECT"/gt
• lt/xsdrestrictiongt
• lt/xsdsimpleTypegt
• lt/xsdelementgt

19

• XSLT Extensible Stylesheet Language
  Transformation
• A language for transforming XML documents into
  other documents such as XML or HTML

20

• Process Steps
• Extract data from database or source files
• Use XSLT as necessary to create file that
  corresponds to validation schema
• Use validation schemas to validate content
• Use XSLT to transform to EDEN format
• Submit data file to EDEN