Documentation Center

Validating references and BREX from the Contenta S1000D interfaces

About this task

This task describes how to validate references and/or BREX from Contenta Explorer and Contenta Web. To validate from an XML editor, see Validating References and BREX in the XML editor.

Procedure

  1. In Contenta S1000D, navigate to the container, DM, PM, SCPM, or graphic that you want to validate. If you run Validate from a container object, all modules and graphics in that section of the CSDB hierarchy are validated.
  2. Click Tools, then click S1000D Validate.
  3. Check the objects that you want to validate. By default, all objects are selected: Select All is checked.
  4. Decide if you want to validate references, BREX, or both. Check or uncheck the Validate References and Validate BREX checkboxes accordingly.
  5. Optionally, to validate references within referenced objects (for example, validate all references in a PM that refers to a DM that in turn refers to other DMs), check Recurse.
  6. If you are validating BREX, click either Selected items only or All references.
    See the Validate Options table below to see which combinations to select in order to achieve the desired results.
  7. Click Start Validation.

Options to mix and match in the Validate interface

Table 1. Validate Options
Select:To:
Validate ReferencesValidate References (non-recursive) on only the objects that are checked in the first column.

Result: Second column contains Validate References results.

Validate References > RecurseValidate References recursively, i.e., validate the objects checked in the first column and validate the objects found by Validate References.

Result: Second column contains Validate References results, including objects that are referenced in the objects checked in the first column.

Validate BREX > Selected items onlyValidate BREX only against modules that are checked in the first column.

Result: Second column contains the BREX compliance results.

Validate References

and

Validate BREX > Selected items only

Validate References (non-recursive) and Validate BREX only against modules that are checked in the first column.

Result: Second column contains Validate References results. Third column contains the BREX compliance results.

Validate References

and

Validate BREX > All references

Validate References (non-recursive) and Validate BREX against all modules checked in the first column and modules found by Validate References in the second column.

Result: Second column contains Validate References results. Third column contains BREX compliance results.

Validate References > Recurse

and

Validate BREX > Selected items only

Validate References recursively and Validate BREX only against modules that are checked in the first column.

Result: Validate References results are in the second column and include modules that are referenced in the modules that are checked in the first column.

BREX compliance results are in the third column and include only the modules that are checked in the first column, not the modules found by Validate References in the second column.

Validate References > Recurse

and

Validate BREX > All references

Validate References recursively, and Validate BREX against all modules checked in the first column and modules found by Validate References in the second column.

Result: Validate References results are in the second column and include modules that are referenced in the modules checked in the first column.

BREX compliance results are in the third column and include the modules that are checked in the first column, and the modules found by Validate References in the second column.

Viewing Validate References Results
  • References to other modules, illustrations, and multimedia are displayed first. No references is displayed if the object in the first column doesn't reference any other modules or graphics.
  • References from other modules are displayed next. Not referenced is displayed if no other modules reference the object in the first column.
  • In multi-language CSDBs, when you run Validate References on graphics, references from other modules in all languages will be displayed, since graphics are language-neutral in S1000D.
  • References that are found are reported as: OK (in green)
  • References that are found but which the user cannot access are reported as: OK/ACCESS DENIED (in orange)
  • References that are not found are reported as: MISSING (in red)
  • If you ran Validate References recursively, the parent of each reference is listed below each reference that is reported: (in module_name) This information helps you know which module to edit to fix missing references.
Viewing BREX Compliance Results
  • If a module does not comply with its BREX rules, the message Not compliant with N rules is displayed in red followed by a More... link. Click the More... link to view the BREX compliance report for the module.
  • If a module complies with the BREX rules that could be validated, the message BREX compliant is displayed in green followed by a More... link.
  • If a module cannot be validated, the message Not validated is displayed in red, followed by a brief description of why the module could not be validated. For detailed information, see Understanding BREX compliance reports and error messages.
  • To view summary information for all modules, click the View Summary BREX Report link in the upper right banner.
  • To view the full BREX compliance report for all modules, click the View Full BREX Report link in the upper right banner.