XCRI Knowledge Base

Setting standards for more effective courses information management

  • Increase font size
  • Default font size
  • Decrease font size

All About XCRI

The XCRI community blog: all about eXchanging Course Related Information (XCRI) and its Course Advertising Profile (XCRI-CAP).

Validation Library structure

by Craig Hawker
Craig Hawker
Craig Hawker is a software developer from Northampton who has been involved with
User is currently offline
on Jan 30 in validation 0 Comments

This is the second in a series of blog posts aimed at documenting the development of an XCRI-CAP 1.2 validator.  The entire series can be found by visiting the validator blog post list.  My aim is to post a new blog post every week until the development is complete, then at least once every month to document both the usage of the validator as well as any community-highlighted modifications or issues.

In this blog post I have decided to concentrate on the top-level structure of the validation routine with the aim for users to understand the basic terminology used and how it fits within the project as a whole.  The validator library is built as a .NET 4 library using C# and builds upon the base validation functionality exposed by the .NET library itself.

Validation of an XCRI-CAP 1.2 feed is done in three separate ways: by ensuring the document is a valid XML document, that the XML document is valid according to the XML schemas involved, and that the XML document passes some additional rule-based validation.  At each level, each exception captured by the document is presented back to the user along with guidance on how to resolve the issue.

  • The first level of validation ensures that the document itself is a valid XML document.  This captures issues such as incorrectly escaped characters like ">" and "<" within the document, incorrect tag nesting and undeclared namespace prefix issues.
  • The second level of validation ensures that the document is valid according to the XML Schemas that it references.  The XML Schema itself for XCRI-CAP 1.2 can be found on Google Code and the XCRI.co.uk website (note, though, that the XML Schema documents are interpretations of the specification not the specification itself - the specification is found on the XCRI wiki).  This level of validation highlights, for example, invalidly used elements or elements that are used that are in the wrong namespaces.
  • The third level of validation runs various validation rules over the document to ensure both compliance with the specification (above and beyond that enforced by the XML Schemas), and to aim to ensure a consistency of information within the feed itself.  The current document can be found within the validator code repository.

The rule base used in the validation is fed in from both the official XCRI-CAP 1.2 standard, through guidance issued via associated JISC-funded projects, and through the wider XCRI-CAP community.

The XCRI-CAP 1.2 validation library and an online tool to validate feeds are expected to be completed by the end of February 2012.

Hits: 282
0 votes

About the author

Craig Hawker

Craig Hawker is a software developer from Northampton who has been involved with the XCRI community for the last two years and is author of both an XCRI-CAP 1.1 online validator and also a .NET library used for generating XCRI-CAP feeds.

Trackbacks

Trackback URL for this blog entry
  • small business seo

    by small business seo on Tuesday, 30 November 1999
    Validation Library structure - All About XCRI ...

Comments

Please login first in order for you to submit comments

News

Prev Next

The sixth issue of the Course Data Programme Stage 2... Read more

After consultation with the Course Data Programme community, the Data... Read more

The fifth issue of the Course Data Programme Stage 2... Read more

The fourth issue of the Course Data Programme Stage 2... Read more

BS8581 (aka XCRI CAP) out for public comment From Scott Wilson... Read more

The third issue of the Course Data Programme Stage 2... Read more

A video about XCRI-CAP is now available.This video has been... Read more

Data Specification and Vocabularies Framework Elluminate Online Sessions As previously mentioned... Read more

The second issue of the Course Data Programme Stage 2... Read more

Text from event information: "The regulatory landscape in higher education is... Read more

JISC has issued the 1st edition Stage 2 Course Data Newsletter (13... Read more

JISC has issued the special edition Course Data Newsletter (16 December 2011). Read more

Follow XCRI on Twitter Follow XCRI on Facebook Follow XCRI on You Tube


JISC