Naming restrictions

The naming restrictions that apply to a HCL Compass schema prevent naming conflicts.

When defining names of elements of a schema (such as fields, record types, actions, states, hooks, or variables in hooks), consider the following restrictions:
  • Names cannot be the same as any reserved keywords for the database, prohibited by HCL Compass interfaces (for example, Date), or contain any characters that are not valid.
  • To prevent name conflicts or ensure correct references between entities, do not change the names of record types, fields, actions, and states in most instances.
    • Names included in packages must not be modified.
    • Names in your schema must not be changed if you intend to apply a package to your schema or plan to upgrade a package.
    • Names can be modified or added to a schema, but these changes can cause package failures because references to the original names (for example, in hook code or in queries) might exist.

    If you are developing your own schema and creating record types without using packages, you can rename all field, action, state, and record names. However, changing these names might affect existing references to names in hooks, scripts, and queries.