Validating schemas

When you check in a schema, it must be validated to prevent checkin if the schema has any errors.

Before you begin

The validation process consists of a series of tests that determine whether or not all of these conditions are satisfied:

  • The name of each field and action is unique.
  • Each field has a data type and a behavior for each state of the record type.
  • Each field with the REFERENCE or REFERENCE_LIST data type includes a record type that supports the reference_to property
  • All state transition actions have a source state and a destination state.
  • A unique key is defined for all stateless record types.
  • SQL reserved words are used correctly.

If you have applied any packages to the schema, those components are also validated.

If you cannot validate all schema changes, you can save them and continue editing later. You can also cancel a schema checkout, which reverts the schema to its previous version.

Procedure

To validate a schema:
  1. Start the Designer.
  2. In the Schema Repository Explorer view, right-click the schema version that you want to validate and click Validate.
    Validation errors are displayed in the Console view.
  3. Review the validation results and modify the schema as needed to correct errors.