Configuring Validation Scenarios

You can distribute a framework with a series of already configured validation scenarios. Also, this provides enhanced validation support that allows you to use multiple grammars to check the document. For example, you can use Schematron rules to impose guidelines, otherwise impossible to enforce using conventional validation.

To associate a validation scenario with a specific framework, follow these steps:

  1. Open the Preferences dialog box and go to Document Type Association.
  2. Edit the specific framework to open the Document Type configuration dialog box, then choose the Validation tab. This tab displays a list of document types in which you can define validation scenarios. To set one of the validation scenarios as the default for a specific document type, check the Default box for that specific document type.
  3. 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.
  4. If you want to add a new validation unit, press the Add button.
  5. 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

  6. Select the File type of the validated document.
    Note that this determines the list of possible validation engines.
  7. Select the Validation engine by clicking its cell and selecting it from the drop-down list.
  8. Select the Automatic validation option if you want the current unit to be used by the automatic validation feature.
  9. Choose the schema to be used during validation (the schema detected after parsing the document or a custom one).
  10. Press Ok.
    The newly created validation scenario is now included in the list of scenarios in the Validation tab.
Parent topic: Advanced Customization Tutorial - Document Type Associations
Previous topic: Configuring Transformation Scenarios
Next topic: Configuring Extensions