Entities

4 minutes to read Download PDF Edit

An entity represents a class of real-world objects, such as customers, invoices, work items, etc. An instance of an entity is called an object. For example, the object representing the person ‘Bob Marley’ could be an instance of the entity ‘Person’.

The properties or features of an entity are described using attributes. An attribute represents a small piece of information about an entity, such as the name or birth date of a person.

The domain model editor uses the following symbols for visualization on entities:

Symbol Description
This entity has one or more event handlers.

Components

General Properties

Name

The name property defines the name of the entity. This name is used to refer to the entity from forms, microflows, queries, constraints, etc.

Generalization

An entity can be a more specialized version of a general entity. This means that the specialized entity has all the attributes, associations, events etcetera of the more general entity. Using the generalization property you can specify which entity is the generalization of the entity. For example, the Car entity has Vehicle as its generalization.

The generalization specifies the entity of which this entity derives her properties (attributes, associations, events, etc.). This is used when entities have common attributes and can be generalized using a super entity. Using this feature it is possible to derive functionality from the System module like images from the entity ‘Image’ and files from the entity ‘FileDocument’. In object oriented programming (OOP) the generic term for generalization and specialization is called inheritance.

Image

The image property can be used to associate the entity with an image. In the domain model this image is visualized in the right-top corner of the entity representation. The image is also visible in entity selection windows and in the Connector. For instance, when selecting an entity for a data view.

Persistable

Define whether instances of this entity can be stored in the database. See persistability for more information about this property. Non-persistable entities are painted orange instead of blue to indicate the difference.

System Members Properties

Store ‘createdDate’

This property defines whether the entity contains the system attribute ‘createdDate’. This is an attribute of type DateTime that stores the date and time when the object was created. The value of this attribute is automatically set by the server upon creating an object.

Option Description
True Entity contains the system attribute ‘createdDate’.
False Entity does not contain the system attribute ‘createdDate’.

Default value: True

Store ‘changedDate’

This property defines whether the entity contains the system attribute ‘changedDate’. This is an attribute of type DateTime that stores the most recent date and time when the object was changed.

Option Description
True Entity contains the system attribute ‘changedDate’.
False Entity does not contain the system attribute ‘changedDate’.

Default value: True

Store ‘owner’

This property defines whether the entity has the system association ‘owner’. This is an association to the system entity ‘User’ that (initially) stores a reference to the user that created the object. This association is automatically set by the server upon creating an object.

Option Description
True Entity has the system association ‘owner’.
False Entity does not have the system association ‘owner’.

Default value: True

Store ‘changedBy’

This property defines whether the entity has the system association ‘changedBy’. This is an association to the system entity ‘User’ that stores a reference to the user that most recently changed the object.

Option Description
True Entity has the system association ‘changedBy’.
False Entity does not have the system association ‘changedBy’.

Default value: True