How to Create a Validation Scenario

Follow these steps for creating a validation scenario:
  1. Open the Configure Validation Scenario dialog from menu XML or from the toolbar of the Oxygen XML Author plugin plugin. The following dialog is displayed. It contains the following types of scenarios:
    • Default validation scenario validates the input using Oxygen XML Author plugin default validation options that apply to the type of the current document;
    • Predefined scenarios are organized in categories depending on the type of file they apply to and can be easily identified by a yellow key icon that marks them as read-only. If the predefined scenario is the framework's default scenario its name is written in bold font. If you try to edit one of these scenarios, Oxygen XML Author plugin creates a customizable duplicate;
    • User defined scenarios are organized under a single category, but you can use the drop-down option box to filter them by the type of file they validate.

    Configure Validation Scenario

  2. Press the New button to add a new scenario.
  3. Press the Add button to add a new validation unit with default settings. The dialog that lists all validation units of the scenario is opened.

    Add / Edit a Validation Unit

    The table holds the following information:

    • URL of the file to validate - The URL of the main module which 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 validated in the current validation unit. Oxygen XML Author plugin 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 Author plugin for validation of the type of document to which the current module belongs. Default engine is the default setting and means that the validation is done by the default engine set in Preferences pages for the type of the current document (XML document, XML Schema, XSLT stylesheet, XQuery file, etc) instead of a validation scenario.
    • Automatic validation - If this option is checked, then the validation operation defined by this row of the table is applied also by the automatic validation feature. If the Automatic validation feature is disabled in Preferences then this option does not take effect as the Preference setting has higher priority.
    • Schema - Active when you set the File type to XML Document.
    • Settings - Contains an action that allows you to set a schema, when validating XML documents, or a list of extensions when validating XSL or XQuery documents.
  4. Edit the URL of the main validation module.
    Specify the URL of the main module:
    • browsing for a local, remote or archived file;
    • using an editor variable or a custom editor variable, available in the following pop-up menu, opened after pressing the button:

      Insert an Editor Variable

  5. Select the type of the validated document. Note that it determines the list of possible validation engines.
  6. Select the validation engine.
  7. Select the Automatic validation option if you want to validate the current unit when automatic validation feature is turned on in Preferences.
  8. Choose what schema is used during validation: the one detected after parsing the document or a custom one.