The properties tab groups general checklist settings into one view. Properties defined here take effect on any project file saved from the template.
Checklist Title
The checklist title is saved directly within the checklist template XML structure. It is an arbitrary alphanumerical string, displayed within the application title bar whenever the checklist project is opened.
The default value for newly created checklist templates is simply "Checklist Title".
|
Tip: The title cannot only be edited from this view, but from any Checklist Editor tab. The title is displayed above the actual tab content, and may be edited by a click on the edit icon at its right-hand side. |
Checklist Description
The checklist description should provide information about the purpose of the checklist. What is actually evaluated by the elements? Is there special information or resource material required to evaluate the elements correctly?
Since the description is directed towards the checklist structure, it is saved within the overall XML structure of the checklist template.
It is possible to format the description text by using special markup tags. Please refer to the topic Formatting Markup Options for further details.
The report file naming format determines the standard file name generated when users export project data from the internal RayQC .rqcp file type into .docx, *.pdf, or .html. Besides static strings, users have the option to use checklist specific variables within the naming format string.
The default format definition already contains the title variable. To define a variable within the format string, the variable keyword has to be encapsulated with a leading and trailing hash key (e. g. #title#).
As for now, the following list of variables is available for report file naming format definitions:
Variable |
Content |
Example |
#title# |
The checklist title |
"Checklist title" |
#date# |
The current date (yyyy-mm-dd) |
"2015-04-01" |
#status# |
The current project status (passed, failed or not finished) |
"passed" |
#bypass# |
The bypass status of the checklist result (regular or bypassed) |
"regular" |
Reports generated from a project give a one time snapshot of a specific evaluation status for the underlying check routine. Therefore, the given format string is saved within the checklist header section of the underlying XML structure.
|
Tip: Use the FILE button from the Main Toolbar above the Editor area, and select Export to generate a report file. |
Allow Bypass
The bypass option allows evaluators to bypass the final result of a checklist run. In some exceptional cases it might be required to override the original evaluation result manually (e. g. define a failed evaluation run as passed, even though some partial results may differ from the expected results). RayQC offers a bypass option for this purpose within projects if the Allow bypassing this list checkbox has been activated for the checklist.
The legitimacy of a bypass usually depends on the overall scope of the checklist evaluation procedure. Therefore the bypass option setting is not stored within the individual, project-specific part of the checklist, but as an attribute of the checklist header within the XML core structure itself.
Due to the same reasons, the Bypass message property is also saved as part of the checklist core structure. This advice is intended to give instructions regarding the circumstances that allow, or even demand, a bypass. The bypass message is a direct element of communication between checklist designer and checklist evaluator.
Please refer to the Checklist Viewer section for details on how to accomplish a result bypass for a specific checklist project evaluation result.