Validation rules

NEAT supports validation rules for data modeling based on best practices, CDF data modeling knowledge, and customer experience.

AI readiness (NEAT-DMS-AI-READINESS)

Validators for checking if the data model is AI-ready.

code	name	message
NEAT-DMS-AI-READINESS-001	DataModelMissingName	Validates that data model has a human-readable name.
NEAT-DMS-AI-READINESS-002	DataModelMissingDescription	Validates that data model has a human-readable description.
NEAT-DMS-AI-READINESS-003	ViewMissingName	Validates that a View has a human-readable name.
NEAT-DMS-AI-READINESS-004	ViewMissingDescription	Validates that a View has a human-readable description.
NEAT-DMS-AI-READINESS-005	ViewPropertyMissingName	Validates that a view property has a human-readable name.
NEAT-DMS-AI-READINESS-006	ViewPropertyMissingDescription	Validates that a View property has a human-readable description.
NEAT-DMS-AI-READINESS-007	EnumerationMissingName	Validates that an enumeration has a human-readable name.
NEAT-DMS-AI-READINESS-008	EnumerationMissingDescription	Validates that an enumeration value has a human-readable description.

Connections (NEAT-DMS-CONNECTIONS)

Validators for connections in the data model.

code	name	message
NEAT-DMS-CONNECTIONS-001	ConnectionValueTypeUnexisting	Validates that connection value types exist.
NEAT-DMS-CONNECTIONS-002	ConnectionValueTypeUndefined	Validates that connection value types are not None, i.e. undefined.
NEAT-DMS-CONNECTIONS-REVERSE-001	ReverseConnectionSourceViewMissing	Validates that source view referenced in reverse connection exists.
NEAT-DMS-CONNECTIONS-REVERSE-002	ReverseConnectionSourcePropertyMissing	Validates that source property referenced in reverse connections exists.
NEAT-DMS-CONNECTIONS-REVERSE-003	ReverseConnectionSourcePropertyWrongType	Validates that source property for the reverse connections is a direct relation.
NEAT-DMS-CONNECTIONS-REVERSE-004	ReverseConnectionContainerMissing	Validates that the container referenced by the reverse connection source properties exists.
NEAT-DMS-CONNECTIONS-REVERSE-005	ReverseConnectionContainerPropertyMissing	Validates that container property referenced by the reverse connections exists.
NEAT-DMS-CONNECTIONS-REVERSE-006	ReverseConnectionContainerPropertyWrongType	Validates that the container property used in reverse connection is a direct relation.
NEAT-DMS-CONNECTIONS-REVERSE-007	ReverseConnectionTargetMissing	Validates that the direct connection in reverse connection pair have target views specified.
NEAT-DMS-CONNECTIONS-REVERSE-008	ReverseConnectionPointsToAncestor	Validates that direct connections point to specific views rather than ancestors.
NEAT-DMS-CONNECTIONS-REVERSE-009	ReverseConnectionTargetMismatch	Validates that direct connections point to the correct target views.

Consistency (NEAT-DMS-CONSISTENCY)

Validators for checking consistency issues in the data model.

code	name	message
NEAT-DMS-CONSISTENCY-001	ViewSpaceVersionInconsistentWithDataModel	Validates that views have consistent space and version with the data model.

Containers (NEAT-DMS-CONTAINER)

Validators for checking containers in the data model.

code	name	message
NEAT-DMS-CONTAINER-001	ExternalContainerDoesNotExist	Validates that any container referenced by a view property, when the referenced container does not belong to the data model’s space, exists in CDF.
NEAT-DMS-CONTAINER-002	ExternalContainerPropertyDoesNotExist	Validates that any container property referenced by a view property, when the referenced container does not belong to the data model’s space, exists in CDF.
NEAT-DMS-CONTAINER-003	RequiredContainerDoesNotExist	Validates that any container required by another container exists in the data model.
NEAT-DMS-CONTAINER-005	RequiresConstraintCycle	Validates that requires constraints between containers do not form cycles.

Limits (NEAT-DMS-LIMITS)

Validators for checking if the defined data model adheres to CDF DMS schema limits.

code	name	message
NEAT-DMS-LIMITS-CONTAINER-001	ContainerPropertyCountIsOutOfLimits	Validates that a container does not exceed the maximum number of properties.
NEAT-DMS-LIMITS-CONTAINER-002	ContainerPropertyListSizeIsOutOfLimits	Validates that container property list sizes do not exceed CDF limits.
NEAT-DMS-LIMITS-DATA-MODEL-001	DataModelViewCountIsOutOfLimits	Validates that the data model does not exceed the maximum number of views.
NEAT-DMS-LIMITS-VIEW-001	ViewPropertyCountIsOutOfLimits	Validates that a view does not exceed the maximum number of properties.
NEAT-DMS-LIMITS-VIEW-002	ViewContainerCountIsOutOfLimits	Validates that a view does not reference too many containers.
NEAT-DMS-LIMITS-VIEW-003	ViewImplementsCountIsOutOfLimits	Validates that a view does not implement too many other views.

Performance (NEAT-DMS-PERFORMANCE)

Validators for checking performance-related aspects of the data model.

code	name	message
NEAT-DMS-PERFORMANCE-001	MissingRequiresConstraint	Recommends adding requires constraints to optimize query performance.
NEAT-DMS-PERFORMANCE-002	SuboptimalRequiresConstraint	Recommends removing requires constraints that are not optimal.
NEAT-DMS-PERFORMANCE-003	UnresolvableQueryPerformance	Identifies views with query performance issues that cannot be resolved.
NEAT-DMS-PERFORMANCE-004	MissingReverseDirectRelationTargetIndex	Recommends adding a cursorable index on direct relation properties that are targets of reverse direct relations for query performance.

Views (NEAT-DMS-VIEW)

Validators for checking views in the data model.

code	name	message
NEAT-DMS-VIEW-001	ViewToContainerMappingNotPossible	Validates that container and container property referenced by view property exist.
NEAT-DMS-VIEW-002	ImplementedViewNotExisting	Validates that implemented (inherited) view exists.
NEAT-DMS-VIEW-003	CyclicImplements	Validates that view implements are not forming a cycle (i.e. cyclic graph of implements)
NEAT-DMS-VIEW-004	DataModelViewDoesNotExist	Validates that views referenced in the data model actually exist.

Deploy

AI readiness (NEAT-DMS-AI-READINESS)

Connections (NEAT-DMS-CONNECTIONS)

Consistency (NEAT-DMS-CONSISTENCY)

Containers (NEAT-DMS-CONTAINER)

Limits (NEAT-DMS-LIMITS)

Performance (NEAT-DMS-PERFORMANCE)

Views (NEAT-DMS-VIEW)

Further reading

​AI readiness (NEAT-DMS-AI-READINESS)

​Connections (NEAT-DMS-CONNECTIONS)

​Consistency (NEAT-DMS-CONSISTENCY)

​Containers (NEAT-DMS-CONTAINER)

​Limits (NEAT-DMS-LIMITS)

​Performance (NEAT-DMS-PERFORMANCE)

​Views (NEAT-DMS-VIEW)

​Further reading

AI readiness (NEAT-DMS-AI-READINESS)

Connections (NEAT-DMS-CONNECTIONS)

Consistency (NEAT-DMS-CONSISTENCY)

Containers (NEAT-DMS-CONTAINER)

Limits (NEAT-DMS-LIMITS)

Performance (NEAT-DMS-PERFORMANCE)

Views (NEAT-DMS-VIEW)

Further reading