Documentation Center

Understanding BREX compliance reports and error messages

After you run the S1000D Validate tool to validate BREX on one or more modules, resolve any error messages and review the resulting BREX reports to find BREX compliance issues.

BREX validation error messages

When a data module cannot be validated, one of the following errors is reported:
  • Not validated - Missing reference to a BREX DM
  • Not validated - Missing BREX DM DMC
  • Not validated - Invalid BREX DM reference: Non-BREX DM references itself
  • Not validated - Version mismatch between BREX DM (Issue N) and module being validated (Issue N)

where module is a DMC, PMC, or SMC, and N is an S1000D Issue number (3.0, 4.0, 4.1, 4.2, or 5.0).

If there is no data to validate, one of the following errors is displayed:
  • Not validated - Module being validated is empty
  • Not validated - BREX DM contains no rules to validate
  • Not validated - Empty BREX DM DMC

BREX compliance reports

To view BREX compliance reports from the Contenta S1000D Validate interface, click one of the following links:
More...
Click the More... link next to the Not compliant with N rules or BREX Compliant message to see the BREX rules with which the module does not comply or rules which could not be validated.
View Summary BREX Report
This report lists how many modules were and were not validated and how many modules are and are not compliant with their BREX rules.
View Full BREX Report
This report contains information about all modules that were validated. It lists the following information:
  • Modules that are compliant
  • Modules that are not compliant
  • Modules that cannot be validated
  • BREX rules that cannot be programmatically validated
  • BREX rules that contain syntax errors

BREX compliance reports are stored on the Contenta Web server in the Contenta_home/temp/username/cas_validate directory.

If you run the Validate tool multiple times on the same object, the BREX report contains only the results from the most recent Validate operation.

When you run Validate from Arbortext Editor or Oxygen XML Author (via Contenta > Validate), summary BREX reports are displayed in the BREX Compliance tab.