2.2. Root element

The root element of an XML file or message that conforms to the tutor message format is the <tutor_related_message_sequence>. The XML Schema Definition defines the possible contents of this element.

Here's how your XML should start and end:

<?xml version="1.0" encoding="UTF-8"?>
<tutor_related_message_sequence version_number="4">

  <!-- Tutor message elements go here -->

</tutor_related_message_sequence>

As in the above code, start your XML with:

an XML prolog (XML version, encoding);
the opening tag for the tutor_related_message_sequence root node;
a version_number attribute with value 4—this is the version of the Tutor Message format described in this document.

	Note
	The DataShop will continue to accept logs that conform to version 2 of the Tutor Message format, as well as logs conforming to version 4.

Be sure the data in your XML complies with the encoding specified in the XML prolog. UTF-8 is not required; other ISO encodings are permitted.

End your XML by closing the root element, </tutor_related_message_sequence>.

If you are using the older DTD version of the schema, your XML should start and end like this:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE tutor_related_message_sequence SYSTEM
  "http://pslcdatashop.web.cmu.edu/dtd/tutor_message_v4.dtd">
<tutor_related_message_sequence version_number="4">

  <!-- Tutor message elements go here -->

</tutor_related_message_sequence>

A note about sending XML to an OLI logging database

When logging to an Online Learning Initiative (OLI) database, your XML must be transported as the text value of OLI's log_action element. In this way, the XML you create can be stored in an OLI logging database such as that used by PSLC DataShop. This property of nesting XML is commonly referred to as "XML within XML".

Send your XML in the OLI log_action container when:

Logging directly to an OLI log database. The DataShop team, for example, hosts such a database on their server. The CTAT software, for example, provides this functionality.
Logging from an OLI course delivery system. This behavior is somewhat automatic, however, so contact the OLI group for details.
Logging to files that will be loaded directly into an OLI log database. The CTAT software, for example, also provides this functionality.

The diagram below shows the position of the <tutor_related_message_sequence> when sent in its OLI container:

Figure 1. The OLI log_action element with embedded XML (tutor_related_message_sequence).

Note

If logging to an OLI logging database (instead of to file), session_id must be a globally unique identifier (GUID).
When embedding a tutor_related_message_sequence as XML within the OLI log_action element, the info_type attribute's value must be set to tutor_message.dtd. This tells the system interpreting the log that the contents conform to this schema. Use this value (tutor_message.dtd) even if you are writing XML that will conform to the XSD (XML Schema).
If your tutor application is implemented in Java or Flash, use the Java or Flash logging library to wrap and send the tutor_related_message_sequence XML. These libraries are available from the DataShop.

Prev	Up	Next
2. The Tutor Message format	Home	2.3. Message types