Validation report panel

Validation reports are generated for all the documents in a selected folder.

When viewing a document, to open the Validation report panel on the left, click the icon in the left sidebar.

The panel opens to the last validation report that was generated by you in the group.

Generate a validation report

If there are no reports yet, in the Folder to validate field, click the icons to select a folder to validate. Or, if you want to only validate documents in the current publication, click the checkbox beside Validate documents in this publication only. If there is an existing report, to show this option click the Clear button.

In the Schema to use for validation field, click a schema in the drop-down then click the Validate button. A progress bar indicates the progress of the validation. If the progress is too slow, or you want to stop the validation, click the red icon to the right of the progress bar.

When the validation has finished, you see the name of the report in the View existing report field. If other reports had previously been generated, you can select a report from the drop-down.

Following, you see these values:

• Folder – name of folder selected.
• Schema – the schema selected.
• Documents – the number of documents in the selected folder.
• Date – the date and time the validation report was generated.

To update validation results, click the Validate again button to generate a new report. You see a progress bar and icon to the right of the button. Click Show logs to view and filter the logs for the validation. A Clear report button is to the right of the Show logs button – click to clear the current report.

If all documents in the folder are valid, you see a message in a green box stating there are no reports or errors.

If there are validation results, following the buttons, you see these possible icons – click the  icon to the right of each icon to filter the results:

• icon and number of successful reports.
• icon and number of warnings.
• icon and number of failed assertions.
• icon and number of errors.
• icon and number of tips.
• icon and number of info reports.

A list of validation results displays. For each document that has a result, you see the following:

• The title of the document, preceded by the icon for the media type of the document.
• The number of results in each document is in parenthesis.
• A list of individual results, each preceded by an icon is shown under each document title.
• A icon to the right of each individual result.

Click a document title to open the document in the main section. After opening the document, you can hold the pointer over the icon to the right of any individual result to highlight the fragment for that result. Click the icon to open the containing document and highlight the fragment containing the result. Once any errors are corrected, you can click the Validate again button to generate a new report.

Use the scroll bar on the right of the panel to navigate the list of validation results.

Add note

You can add a note to any result for a fragment by clicking the Add note beside the result to open the Add note dialog. In edit mode you see a in a yellow box advising that your draft note is not saved until you save the changes to your document. You can add a title in the Title field and an explanation in the Note field. Any pre-configured labels display – you can remove them or add custom labels. Click the Add note button to add the edit note.

You now see an Edit note button. In edit mode when you save the changes in your document you can see your edit note in your document, to the right of the fragment.