Cross-references in generated documents may turn out to be broken (indicated in Word by an error message where the cross-reference should be) or have the wrong appearance (e.g. “Schedule 0.Annex 0.Part I1” instead of just “1”). The causes are predictable and generally easy to remedy.

A. BROKEN CROSS-REFERENCE
Each cross-reference in the Weagree Wizard points to a specific clause within the database. This is extremely reliable in itself, but dependent on the content of the document that is ultimately generated. Missing clauses will result in broken cross-references.

The cause will most likely be one of the following:

  • The cross-reference is pointing to a non-existent template component (a building block, clause or choice option) or library component (such as a global building block, definition or schedule). If so, erase or replace the cross-reference.
  • The cross-reference is pointing to a template component whose inclusion is conditional. If so, inclusion of the cross-reference itself should be dependent on the same conditionality. This requires the use of at least one global question.
  • The cross-reference is contained in a library component, pointing either to another library component not included in the template or to a clause in another template. Ensure that the other library component is also included in the template or create a separate library component without the cross-reference.

B. WRONG APPEARANCE
A cross-reference such as “Schedule 0.Annex 0.PartI1” is caused by its position within the template relative to the referenced building block or clause. It is a side-effect of how automatic numbering in Microsoft Word works.

This can occur in two cases:

  • The cross-reference is directly inserted into the template (i.e. not into a definition, schedule or annex that is tagged in the template) and points to a building block or clause inside the template, but is placed in a template component preceding the first building block or clause with a numbered Level styling (Level 1, Level 2, etc.).
  • The cross-reference is included in a definition, schedule or annex and points to a building block or clause in the template.

In either case, this can be resolved by changing the parameters of the reference tag. If the tag is already inserted, change the ‘RH’ variable to ‘NH’ (e.g. [reference.Definitions.RH.12345] becomes [reference.Definitions.NH.12345]).

Alternatively, when creating a new cross-reference, first click Options and then select Inserts the paragraph number from the cross-referred paragraph as that number appears in the document.

kb contract lifecycle management troubleshooting cross reference 1 broken cross-reference      kb contract lifecycle management troubleshooting cross reference 2 broken cross-reference

The same issue may arise with the use of the [annex] tag in a template component preceding the first building block with a numbered Level styling. To resolve this, replace the tag with a regular cross-reference to the title of the annex (or schedule). You will have to open the annex (or schedule), generate the cross-reference there in the manner described above and copy it into the actual template.

In order for the annex (or schedule) to actually be added to your contract, however, an [annex] tag will still be required. If the annex (or schedule) is not explicitly referenced anywhere else in the template, consider hiding it in a separate clause with appropriate formatting (for instructions, click here).

Alternatively, using the HTML editor (for more information, click here), you can insert the tag using the following format at the end of the same clause as the cross-reference:

<span style=”font-size: 0pt; color: white;”>[annex.Name]</span>

Note that this will render the link to the schedule or annex effectively invisible not just in the generated document, but also in the Template Creation Tool. Finding it again may therefore require use of the Template Creation Tool’s search functionality.