How to Create a Validation Scenario

Select the

Configure Validation Scenario(s) from the Document > Validate menu, or the

Validation toolbar drop-down menu, or from the Validate submenu when invoking the contextual menu on a file in the Project view .

The Configure Validation Scenario(s) dialog box is displayed. It contains the following types of scenarios:

Predefined scenarios are organized in categories depending on the type of file they apply to. You can identify Predefined scenarios by a yellow key icon that marks them as read-only. If the predefined scenario is the default scenario of the framework, its name is written in bold font. You can use the options in the Settings drop-down menu to filter which scenarios are shown.
User defined scenarios are organized under a single category, but you can use the options in the Settings drop-down menu to filter them.
Note: If the current file has no associated scenarios, the preview area displays a message to let you know that you can apply the default validation.

Figure: Configure Validation Scenario

To edit an existing scenario, select the scenario and press the Edit button. If you try to edit one of the read-only predefined scenarios, Oxygen XML Editor creates a customizable duplicate (you can also use the Duplicate button).

To add a new scenario, press the

New button.

The New scenarios dialog box is displayed. It lists all the validation units for the scenario.

Figure: Add / Edit a Validation Unit

The New scenario dialog box includes the following information:

Name - The name of the current validation scenario.
Storage - You can choose between storing the scenario in the Global Options or Project Options.
URL of the file to validate - The URL of the main module that includes the current module. It is also the entry module of the validation process when the current one is validated.
File type - The type of the document that is validated in the current validation unit. Oxygen XML Editor automatically selects the file type depending on the value of the URL of the file to validate field.
Validation engine - One of the engines available in Oxygen XML Editor for validation of the type of document to which the current module belongs. Default engine means that the default engine is used to run the validation and is set in the Preferences pages for the current document type (XML, XML Schema, XSLT, XQuery, etc.).
Automatic validation - If this option is checked, the validation operation defined by this row is also applied by the automatic validation feature. If the Automatic validation feature is disabled in Preferences, then this option is ignored, as the Preference setting has a higher priority.
Schema - This option becomes active when you set the File type to XML Document.
Settings - Opens the Specify Schema dialog box that allows you to set a schema for validating XML documents, or a list of extensions for validating XSL or XQuery documents. You can also set a default phase for validation with a Schematron schema.

If you want to add a new validation unit, press the Add button.

To edit the URL of the main validation module, double-click its cell in the URL of the file to validate column.

Specify the URL of the main module by doing one of the following:

Enter the URL in the text field or select it from the drop-down list.
Use the Browse drop-down button to browse for a local, remote, or archived file.
Use the Insert Editor Variable button to insert an editor variable or a custom editor variable.
Figure: Insert an Editor Variable

Select the File type of the validated document.

Note that this determines the list of possible validation engines.

Select the Validation engine by clicking its cell and selecting it from the drop-down list.

Select the Automatic validation option if you want the current unit to be used by the automatic validation feature.

Choose the schema to be used during validation (the schema detected after parsing the document or a custom one).

Press OK.

The newly created validation scenario is now included in the list of scenarios in the Configure Validation Scenario(s) dialog box. You can select the scenario in this dialog box to associate it with the current document and press the Apply associated button to run the validation scenario.