1. Abstract

"Practical Code List Implementation" overviews in detail the representation and validation of controlled vocabularies such as code lists and identifier lists for XML documents of any XML vocabulary. The OASIS genericode format (a work item of the OASIS Code List Representation Technical Committee http://www.oasis-open.org/committees/codelist/) is used for the representation of values, and the OASIS UBL Methodology for Code List and Value Validation (a work item of the OASIS Universal Business Language Technical Committee http://www.oasis-open.org/committees/ubl/) is used for validating instances of any XML document model with controlled values.

Note that while UBL code lists and instances are used in the class for example and instruction, students are encouraged to bring to the hands-on class their own code lists and their own business document instances of their own XML vocabularies to supplement the exercises. Time is provided in class for students to create simple code lists and validation files for their own business documents as pro-forma artefacts that can be embellished after class into their own production files.

This is a course supporting the development and deployment of controlled vocabularies, including meta data specification, list maintenance, list restriction, list extension and the implementation and application of validation processes against instances that include constrained information items.

2. Length

This course runs in either a half-day lecture format or a full-day hands-on format. Please see the syllabi below. Note that these configurations are wholly contained within configurations of the Practical Universal Business Language Deployment course.

3. Expected Audience

This course is aimed at people needing to understand both conceptual and practical aspects of deploying controlled vocabularies and associated validation tasks. The class is technical in nature involving hands-on creation of artefacts and the configuration and invocation of validation processes.

4. Prerequisites

There are no formal prerequisites for this course, though the instructor assumes the student who participates in exercises well understands XML at the markup level (concepts and syntax editing). This is not a course to attend to learn XML, and the exercises are geared to engage students with at least a limited background in XML and who are comfortable editing and working with software tools from command line invocation interfaces.

To participate in the hands-on exercises, attendees must have working knowledge of markup and a Java-equipped personal computer. Copies of the exercise materials are available on USB sticks at the course. Complete solutions are provided to research in place of attendees deriving the exercise solutions on their own. More details regarding the exercise and working environment are below.

Attendees must have a firm knowledge of the operating system environment as there is no time for coaching from the instructor regarding the command-line environments of today's operating systems.

5. Exercise environments

Hands-on exercises are provided in a turnkey fashion for a Java-based environment under either Windows command-line or Linux shell invocation.  Students may use any editing tool they wish for modifying the exercise files when completing the exercise objectives.

Any processors supporting the technologies being covered are acceptable for working the exercises in this course. Note, however, that Java-based processors are brought to the course by the instructor and there is no time for coaching from the instructor on the use of other applications.

5.1. Self study in class

Students are encouraged to bring their own code lists and XML documents to class in order to create their own representations and validation environments. The code lists should be in a simple format such as an office spreadsheet or a CSV (comma separated values) file. The XML documents used for validating the values should have a schema. Please take the time before class to assemble these resources so as to leave as much time as possible in class to work on the new concepts and techniques.

6. Synopsis

Controlled vocabularies of code lists and enumerated identifiers govern a number of information items in the Universal Business Language (UBL) vocabulary. The technologies chosen and developed by the UBL TC to support the specification and validation of controlled vocabularies are applicable to all XML document vocabularies and not just UBL.

This technically-oriented course is written for both the user of UBL (as day two of the three-day configuration of the Practical Universal Business Language Deployment) and for anyone using controlled vocabularies with any XML document vocabulary. For the implementer and specifying authority for a controlled vocabulary it is important to understand candidate opportunities to work with the artefacts and to gain hands-on experience in their use and applicability in the context of the documented methodologies and deployment strategies.

The course addresses the following topics related to controlled vocabularies:

• code list and constrained value concepts

• controlled vocabulary representation

• controlled vocabulary extension and restriction

• methodology for controlled vocabulary and value validation

"Practical Code List Implementation" successfully equips the attendee with an understanding and hands-on practice of the representation of code lists and value lists, and the validation of constrained-value information items in XML documents.

The hands-on exercises help cement concepts by leading the attendee to mimic real-world situations under the supervision of the instructor and in collaboration with fellow students. Exercises cover important concepts with simple objectives. Attendees are invited to research completed exercise solutions without needing to derive the solutions on their own.

During the course the exercises are timed to cover breaks so that students can choose to balance work time with break time should extra exercise time be required, thus reducing the chance of delaying the progress of the course material.

Note this is not a course covering the use of W3C Schema XSD enumeration constructs. The XML expression of controlled variables uses OASIS genericode and the XML expression of the validation uses the OASIS UBL methodology for code list and value validation with ISO/IEC 19757-3 Schematron.

Answers to all exercises are available to attendees.

While this is a course supporting the deployment and use of code list artefacts, this is not a course in the interpretation of specific code lists in a business context or the adaptation of applications and systems to the semantics expressed by any code lists.  The instructor is not in a position to offer financial or legal advice regarding the application or suitability of code lists to any particular scenario or purpose.

7. Syllabi

7.1. Half-day Lecture Delivery Syllabus

 00:00   Course Introduction
         Instructor/Student Expectations
         Module 1: Controlled vocabularies (code lists & identifiers)
 01:00   Break
 00:00   Module 2: Declaring controlled vocabularies
 01:00   Break
 00:00   Module 3: Validating the use of controlled vocabularies
 01:00   End

7.2. Full-day Hands-on Delivery Syllabus

 00:00   Course Introduction
         Instructor/Student Expectations
         Module 1: Controlled vocabularies (code lists & identifiers)
 01:00   Break
 00:00   Module 2: Declaring controlled vocabularies
 01:00   Break
 00:00   Module 3: Validating the use of controlled vocabularies
 01:00   Lunch

 00:00   Module 4: Controlled vocabulary representation detail
         Exercise - controlled vocabulary representation
 01:00   Break
 00:00   Module 5: Controlled vocabulary validation detail
         Exercise - controlled vocabulary validation
 01:00   Break
 00:00   Module 6: Your own business document controlled vocabulary
         Exercise - your own business document controlled vocabulary
         Q&A
 01:00   End of day