Entity variables

A variable of type Entity provides access to data for an entity. It has the following variables:

Name Type Description
name String scalar The name of the entity.
description String scalar The description of the entity.
numTestRecordsActual Number scalar The number of records that should be generated for this entity when generating test records.
userIdentifier Attribute hash The user identifier for the entity.
attributes Attribute sequence Returns the list of attributes for the entity.
relationships Relationship sequence The list of relationships for the entity.
parents Entity sequence The list of entities that are the parent entities in the relationships of this entity (excluding this entity).
children Entity sequence The list of entities that are the child entities in the relationships of this entity (excluding this entity).
oneToOneParents Entity sequence The list of entities that are the parent entities in the one-to-one relationships of this entity (excluding this entity).
oneToManyParents Entity sequence The list of entities that are the parent entities in the on-to-many relationships of this entity (excluding this entity).
oneToOneChildren Entity sequence The list of entities that are the child entities in the one-to-one relationships of this entity (excluding this entity).
oneToManyChildren Entity sequence The list of entities that are the child entities in the one-to-many relationships of this entity (excluding this entity).
getRelationshipsWithParent method returning a Relationship sequence, requiring parameter:
Entity parent - the entity that is the parent
Returns the relationships for the entity, where the parent entity is the specified parent entity.
getIdentifyingRelationshipWithParent method returning a Relationship, requiring parameter:
Entity parent - the entity that is the parent
Returns the identifying relationships for the entity, where the parent entity is the specified parent entity, or null if there is none.
identifyingRelationshipsWithChildren Relationship sequence The list of identifying relationships for the entity where that entity is the parent.
nonIdentifyingRelationshipsWithChildren Relationship sequence The list of non-identifying relationships for the entity where the entity is the parent.
identifyingRelationshipsWithParents Relationship sequence The list of identifying relationships for the entity where the entity is the child.

Related concepts

Template data model
Entity
Attribute variables
Relationship variables

Related tasks

Customising a template