TROUBLESHOOTING XML WHAT IS XML? 4/27/2015. Jim Hines CEPI Customer Support Manager

Transcription

1 TROUBLESHOOTING XML Jim Hines CEPI Customer Support Manager XML stands for Extensible Markup Language. Programming code, designed to be simple, widely used, and usable online (according to W3C Recommendation, November 2008). XML allows us to send and receive large, complex data files. CEPI uses these files primarily for the Michigan Student Data System (MSDS), but also in REP and EEM downloads. WHAT IS XML? 1

2 XML FILES XML works using tags: <Tag>Content</Tag> Tags are case-sensitive: <GoodTag>Data</GoodTag> <BadTag>Data</badtag> MSDS will not accept empty tags: <EmptyTag></EmptyTag> <EmptyTag /> ANATOMY OF AN XML FILE: TAGS 2

3 An XML file starts with header information. The header tells the system what kind of file it s reading, like an introduction: Early Childhood Fall Collection ID# Schema Schema Location on the Internet If the header information isn t consistent and correct, the system can t read the file. ANATOMY OF AN XML FILE: HEADER Each record is made up of a series of nested tags. The RequestforUIC tag marks the start and end of this Request for UIC record. Individual components in this record include: SubmittingEntity PersonalCore SchoolDemographics Enrollment ANATOMY OF AN XML FILE: BODY 3

4 Each component includes one or more fields. Start and end tags must be correctly nested. Good: <PersonalCore><Last Name>POTTER</Last Name> </PersonalCore> Bad: <PersonalCore><Last Name>POTTER</Personal Core></Last Name> ANATOMY OF AN XML FILE: BODY Components and individual fields must appear in the correct order, as specified in the.xml schema. Otherwise, you get a file-level error. Incorrect: Correct: ANATOMY OF AN XML FILE: BODY 4

5 The file header includes a line specifying the location of the XML Schema. For example: xsi:nonamespaceschemalocation= te.mi.us/msdsxml/springgeneralcollection xsd If you go to that Web address, you ll see the schema file that specifies the rules your file must follow. Warning: XML Schemas are written to be understood by computers, not necessarily by human beings WAIT, WHAT S THE XML SCHEMA? WAIT, WHAT S THE XML SCHEMA? 5

6 The schema specifies things like The order of all components and fields. Whether or not a component or field is required. How many times a component or field can be reported in a single record. What values can be reported in a particular field. WAIT, WHAT S THE XML SCHEMA? By default,.xml files will generally open in your internet browser. To edit an.xml file, you ll need to use a Text Editor or an XML Editing program. For CEPI applications, do not try to edit or create an.xml file in Microsoft Excel. HOW DO I OPEN AN XML FILE? 6

7 HOW DO I OPEN AN XML FILE? Editing your XML file in Excel will result in this: HOW DO I OPEN AN XML FILE? 7

8 The MSDS Web page includes a link to our XML Validation Guide. Free XML Validation Software: XML Notepad Notepad++ HOW DO I FIND ERRORS IN MY XML FILE? When you upload your file, you may see an Uploaded Successfully message. This does not mean your file is error-free. Upload means your file was successfully copied to our server. After the file is uploaded, the MSDS checks it for file-level errors. HOW DO I FIND ERRORS IN MY XML FILE? 8

9 After you ve uploaded, check your file status in the MSDS: Student Data Submission Uploaded File Status Enter your filter criteria and click Filter. HOW DO I FIND ERRORS IN MY XML FILE? Failed File Validation means your XML file has a file-level problem, and the MSDS could not read or load the data in your file. Click the file name link to view the details. HOW DO I FIND ERRORS IN MY XML FILE? 9

10 HOW DO I FIND ERRORS IN MY XML FILE? XML validation errors use single quotes instead of double quotes. Error message: The 'ExitStatus' element is invalid - The value '_' is invalid according to its datatype 'ExitStatusType' - The Enumeration constraint failed. Field name: ExitStatus Datatype and ExitStatusType refer to the specifications from the schema file. Value _ means you submitted a _ character in this field. Here s how that code will look in your file: <ExitStatus>_</ExitStatus> INTERPRETING XML VALIDATION ERRORS 10

11 Open your file in Notepad or another text/editor program. Control+F or Edit Find. Search for <ExitStatus>_</ExitStatus> HOW DO I FIND ERRORS IN MY XML FILE? Voila! There s the record that needs to be corrected, either in Notepad or in your student information system (SIS). HOW DO I FIND ERRORS IN MY XML FILE? 11

12 Remember, XML errors use single quotes. When an error says: The value is invalid, it s telling you there s an empty set of XML tags. The field is StudentResidentCounty, meaning your file has the following bad code: <StudentResidentCounty></StudentResidentCounty> Options: Search in Notepad or another editor. Run the file through an XML Validation program. COMMON ERRORS AND WHAT TO DO ABOUT THEM The XML schema specifies what can be entered in each field, including length. Phone numbers can only be a maximum of 10 digits. Hint: You can look the field up in the MSDS Data Field Descriptions manual to find those rules, if you don t want to read the schema. Options: Search in Notepad or another editor for the bad phone number. Run the file through an XML Validation program. COMMON ERRORS AND WHAT TO DO ABOUT THEM 12

13 CollectionID is part of the file header information. Each collection has its own specific header ID. You might get this error if you selected the wrong Collection in the File Upload drop-down, or exported the wrong file type from your SIS. Options: Compare your file header against the posted MSDS sample file on our website. Run the file through an XML Validation program. COMMON ERRORS AND WHAT TO DO ABOUT THEM This is another header error. There was nothing wrong with this file but the group name indicates this is an SRM file, and the user had tried to upload it into the Spring 2015 General Collection. Options: Compare your file header against the posted MSDS sample file on our website. Run the file through an XML Validation program. COMMON ERRORS AND WHAT TO DO ABOUT THEM 13

14 Yeah, this isn t an XML problem, and we re not going to be able to help you with it. COMMON ERRORS AND WHAT TO DO ABOUT THEM Your SIS should produce valid XML files. If you re getting error messages about bad XML code, please do the following: Make sure you have the latest version of your software. Download any updates. Contact your vendor. TALK TO YOUR VENDOR 14

15 You can always contact CEPI customer support for assistance. Phone: x3 Our hours are Monday Friday, 7:30 a.m. 5 p.m. Please do not send us unencrypted data files! TALK TO CEPI 15