Validate with Schematron

Choose the Schematron file (.sch) to test for the presence or absence of patterns. If left blank, a default Schematron that scans for invalid styles is applied.

Validate with Schematron isn't compatible with Schematrons that load other files, for example with sch:include or doc(). For security, Typefi Server checks your Schematron before running it, so all your rules and lookup data need to be in a single Schematron file.

Choose how the action reacts to validation errors:

• Report, then fail (default): reports every finding, then fails the job when any error remains. Best when you want one pass that surfaces every problem at once.
• Report only: reports every finding and lets the job continue. Useful while you're building a workflow, and instead of stopping the workflow, you can follow this action with Annotate errors, using this action's report as its input. Annotate errors then inserts the flagged issues directly into the source document.

Whether a finding actually fails the job also depends on the schema itself. Each rule can carry a severity, and only errors affect the job's outcome:

• A rule marked error or fatal fails the job under Report, then fail. Under Report only, it's still reported but doesn't fail the job.
• A rule marked warning or info never fails the job, under either option.
• A rule with no severity set defaults to error if it checks for a requirement, or informative if it just reports a finding.

If the XML itself is broken (for example, mismatched or unclosed tags), or the schema fails to compile, the job fails no matter which option you choose.

Enter the filename for the Schematron Validation Report Language (.svrl) report. Output is optional: if you leave it blank, the action still validates and logs results, it just doesn't write a report file.

A report that lists errors, even though the job succeeded, is expected under Report only. The report always reflects whether the document is valid; the job's outcome is decided separately by your On error choice.

Enter any optional parameters. For example, selecting a subset of patterns and only validating against those, or defining the active phase to be applied according to the state of a document within its lifecycle.

Requirements:

• Parameters must be defined globally in the Schematron file.
• Parameters must be entered as key-value pairs, separated by the equals (=) sign.
• Enter each parameter on its own line, one key=value pair per line.

Example 1: Selecting a subset of patterns

You are validating an XML file that contains contact information for people in your organisation. At a minimum, each person should have a mobile phone number and first name listed in the XML file.

The XML file might look like this:

<Person>
  <firstname>Luigi</firstname>
  <ContactDetails>
  <mobile>123456789</mobile>
  </ContactDetails>
</Person>

And the Schematron file has these defined parameters:

<!-- Externally passed parameters are declared globally -->
<sch:let name="phone" value="''"/>
<sch:let name="expected" value="''"/>

These parameters are used in the Schematron assertions, which are used to specify the constraints that should be checked.

Then, you can pass the values for those parameters as:

phone=mobile
expected=firstname

Example 2: Defining the active phase

Typefi uses ph-schematron to convert the source Schematron file (.sch) to an XSLT script and apply this XSLT on the Input document (.xml or .cxml) to be validated.

You can define the active phase by passing in a parameter:

phase=value

If a value is not set for the phase (phase=), then the default value is null.

If a phase is not defined via a parameter, then the defaultPhase attribute of the Schematron is used. If there is not a defaultPhase attribute in the Schematron, then all patterns are active.

Note: If the phase name doesn't match any phase in your Schematron, the job succeeds with no findings. Check the spelling if you expected findings.