Validation Best Practice

Working with the SI Template to Avoid Validation Errors

There are a number of actions that users can take to minimise the likelihood of an SI having validation errors.

If you are interacting with the SI document you should have the SI Template installed on your PC.  Not having the SI Template installed could lead to the unintentional introduction of validation errors.

Ensure that you have the access to the User Manual, FAQs and the SI Validation Error Message Guide.

Have the style pane visible at all times so you can see the styles being used.

Use the “show” button so you can see all spaces, tabs and returns.

Validate your SI every time you make changes.  The following diagram shows the recommended validation points of an SI.

Use the SI template functionality as it is intended to be used.

Do not modify SI template styles; if you have to change a style then you are probably using the wrong style.

If you bring text in from another source then ensure that it does not have any existing formatting by pasting into notepad first.  The plain view (notepad) text should be visually checked for any anomalies (for example foreign character fonts) before pasting it into the target SI document.

Resolving Some Common SI Validation Problems

Have the SI Validation Error Message Guide available. Read the text that details the error and tells you how to fix it.

Leave the default dates and Signature Block untouched until you need to change them so as to avoid unnecessary validation errors.

If you encounter any errors following completion of the Signature Block it may be best to delete it and replace it using the Autosig function.

Run the fix tool after you have edited the document before submitting for validation.

Dealing with complex scenarios /non-standard SIs

If you need help with more complex SI Template features then contact the SI Support team for advice in advance.