StudentAcademicRecord wrong ordering of elements

Bug #837886 reported by Jon Nicholson
Affects Status Importance Assigned to Milestone
Open ADK for Java
Fix Committed

Bug Description

This bug was discovered by Jon Kelly, which was discussed and confirmed in

Using the OpenADK to generate a StudentAcademicRecord object results in a XML that does not validate due to the ordering of elements.

Example. The following message is generated by the OpenADK and sent to the ZIS:

<SIF_Message xmlns="" xmlns:xsi="" Version="2.0r1">
    <SIF_ObjectData><StudentAcademicRecord RefId="53544430303031454F66516371595802" SIF_RefId="53544430303031454F66516371595802" SIF_RefObject="StudentPersonal">
  <StudentSchoolEnrollmentData SchoolAttendedRefId="534B4C30303031454F66657671595802">
  <StudentSchoolEnrollmentData SchoolAttendedRefId="534B4C30303031454F66657671595802"/>
    <SchoolAttended RefId="534B4C30303031454F666576726D5802">
        <SchoolName>Veterans Memorial School</SchoolName>
        <MarkValueInfoData RefId="475253303030303030334F495A6B5802"/>
    <SchoolAttended RefId="534B4C30303031454F66657671595802">
        <SchoolName>Oaklandvale Elementary School</SchoolName>
        <MarkValueInfoData RefId="475253303030303030334F495A6B5802"/>
          <MarkData MarkValueInfoDataRefId="475253303030303030334F495A6B5802">
          <Description>Social Studies</Description>

The ZIS replies with the following error:

<b>SIF_Response</b> acknowledged (not successful) XML Validation Error. cvc-complex-type.2.4.d: Invalid content was found starting with element 'SchoolAttendedRefId'. No child element is expected at this point.

After investigation, it was discovered that the OpenADK is generating classes that do not comply with the SIF Specifications. According to the US SIF specification 2.0r1 (the version the message is being sent in) the following series of elements are expected:


but according to the configuration file /open-adk-java/adk-generator/datadef/sif20r1/etranscripts.xml the following series of elements are (incorrectly) expected:


Because a MarkingPeriods element is expected by the ADK, it fails to order elements correctly when adding a MarkingPeriod to Course directly. This was confirmed when wrapping a MarkingPeriod element inside a MarkingPeriods element: the ADK correctly ordered the elements, but this does not produce XML that validates against the SIF spec.

The solution we found was to rebuild the ADK after editing the file:

/open-adk-java/adk-generator/datadef/sif20r1/etranscripts.xml (this can be viewed here:

On Line 246, replace the line:

<element name="MarkingPeriods" type="MarkingPeriods" flags="M" />


<element name="MarkingPeriod" type="MarkingPeriod" flags="M" />

I believe lines 338--341 can also be removed, although I am not familiar enough with the US spec to know this for certain.

To quote Jon Kelly: "Making this change throughout all the etranscripts.xml and rebuilding fixed the generation and validation issue I was having."

Indeed, I have also checked the 2.4 SIF Specification against the respective XML file, and this issue appears there too. All versions need to be checked and corrected as appropriate.

Revision history for this message
Brian Sneddon (brian-sneddon) wrote :

MarkingPeriod element added to Course object in etranscipts.xml in each datadef sif2.0 - sif2.4 This solves the ordering problem with StudentAcademicRecord.

Changed in open-adk-java:
status: New → Fix Committed
Revision history for this message
besthoverboardhub (besthoverboardhub) wrote :

Ok, thanks for letting us know about it, you can also check it provide you complete apk file with unlock features

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Related questions

Remote bug watches

Bug watches keep track of this bug in other bug trackers.