|
<< Click to Display Table of Contents >> RayQC > 7.3 u2 > User Guide > Appendices Basic Checklist Structure |
Every checklist a user wants to open and process with RayQC has to be valid against the RayQC XML Checklist Schema Definition. The definition file ChecklistSchema.xsd is available from the root of the application installation directory (e. g., C:\Program Files (x86)\RayQC\). Open this file in a suiting editor of your choice to take a look at the requirements for a minimal RayQC checklist:
•XML version must be 1.0 or higher
•Encoding must be utf-8
•Root node must be <checklist>
•<checklist> child <checklistHeader> must be present exactly once
•<checklistHeader> child <title> must be present exactly once but may be empty
•<checklistHeader> child <description> may be present exactly once but may be empty
•<checklistHeader> child <reportFilename> may be present exactly once but may be empty
•<checklistHeader> child <bypassMessage> may be present exactly once but may be empty
•<checklist> child <checklistContent> must be present exactly once
•<checklistContent> child <group> must be present at least once
•<group> attribute [id] must be present exactly once per <group> and unique throughout the checklist structure
•<group> child <groupHeader> must be present exactly once
•<groupHeader> child <title> must be present exactly once but may be empty
•<groupHeader> child <description> must be present exactly once but may be empty
•<group> child <groupContent> must be present exactly once
•At least one <groupContent> Can have unbounded number of following child elements with unique global id
o<checkpoint> with attribute {id ]present and unique throughout the checklist structure
o<information> with attribute [id] present and unique throughout the checklist structure
o<dataField> with attribute [id] present and unique throughout the checklist structure
o<multiOption> with attribute [id] present and unique throughout the checklist structure
According to this description, the following checklist source code is valid:
<?xml version="1.0" encoding="utf-8"?> <checklist lastChange="2015-04-14T11:05:21.6638863+02:00" allowBypass="false"> <checklistHeader> <title /> <description /> <reportFilename>RayQC Report - #title#</reportFilename> <bypassMessage>Bypassing will invert the result. A bypass reason should be provided.</bypassMessage> </checklistHeader> <checklistContent> <group id="Group_381632152800"> <groupHeader> <title /> <description /> </groupHeader> <groupContent> <information id="Information_381632152800">Description</information> </groupContent> </group> </checklistContent> </checklist> |
However, a checklist file without any content may be valid, but is definitively useless at the same time. In order to understand the required and optional elements and nestings of RayQC checklists, it is highly recommended to review the sample checklist files that are available with the RayQC application installation directory (e. g., C:\Program Files (x86)\RayQC\Samples\).