| title | url | weight | tags | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Entities |
/refguide9/entities/ |
10 |
|
An entity usually represents a class of real-world objects, such as customers, invoices, CDs, etc. An instance of an entity is called an object.
For example, the object representing the CD 'Exodus' could be an instance of the entity 'CD'.
{{< figure src="/attachments/refguide9/modeling/domain-model/entities/example-entity.png" alt="Example of a CD entity" class="no-border" >}}
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.
For example, you have a collection of CDs like the one in the table below:
| Title | Artist |
|---|---|
| How to Dismantle an Atomic Bomb | U2 |
| Exodus | Bob Marley and The Wailers |
The rows in the table are CDs. The type of the two rows is CD and this is the entity name. A specific CD like How to Dismantle an Atomic Bomb from the band U2 is called an object of the entity CD. Characteristics like the title and artist are called attributes.
The entity type defines how the data is handled and there are two types:
{{< figure src="/attachments/refguide9/modeling/domain-model/entities/type-of-entities.jpg" class="no-border" >}}
{{% alert color="info" %}} You can also use data sources from other applications in your app through the Data Hub pane. These data sources are represented in the domain model as external entities which are displayed as purple entity containers in the domain model.
For further information see External Entities. {{% /alert %}}
When an entity is declared persistable, a database table is created for the entity. These type of entities are colored blue in the domain model. For more information on persistable entities, see Persistability.
Non-persistable entities are stored in the runtime memory and never get committed to the database. These type of entities are colored orange in the domain model. For more information on persistable entities, see Persistability.
An example of the entity properties is represented in the image below:
{{< figure src="/attachments/refguide9/modeling/domain-model/entities/entity-properties.png" width="300" class="no-border" >}}
Entity properties consist of the following sections:
{{% alert color="info" %}} For more information, see the Properties section of External Entities. {{% /alert %}}
For more information on access rules, see Access Rules.
This allows you to describe aspects of the entity which may be useful to you or other team members when using the entity within the app.
The name property defines the name of the entity. This name is used to refer to the entity in forms, microflows, queries, constraints, etc.
The name has to be unique only within a module domain model. You can have two entities with the same name, provided they are in the domain models of different modules.
{{% alert color="info" %}} Export level is only available for add-on and solution modules. For more information on types of modules, see the Module Types section in Modules.
This property will not be shown for attributes if the entity is set to Hidden, all attributes will be hidden automatically and cannot be set to Usable. {{% /alert %}}
Export level allows you to define access level to this document on the consumer (customer) side when developing an add-on module or a solution.
| Value | Description |
|---|---|
| Hidden (default) | The document/element content is hidden from a consumer. |
| Usable | Consumers can see the entity in the domain model and use it in their app. |
An entity can be a more specialized version of a general entity. This means that the specialized entity has all the attributes, associations, events, and other properties 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 could have Vehicle as its generalization.
The generalization specifies the entity from which a specific entity derives its properties (attributes, associations, events, and other properties). It is used when entities have common attributes and can be generalized using a super entity. In object oriented programming (OOP) the generic term for generalization and specialization is called inheritance.
When an entity that has a specialization is retrieved (for example, in a data grid or microflow), specializations of that entity are included in the result. When a specialization is retrieved, its generalizations are not included in the result. Using the previous example, if Vehicle is retrieved, the resulting set will contain objects of types Vehicle and Car. If Car is retrieved, only objects of Car are included in the result set.
One important use of this feature is to derive functionality from the System module (for example, images from the Image entity and files from the FileDocument entity).
For example, this property can be used in a situation where, you have a Student entity and a Professor entity, which have some generic properties. They both have a name, telephone number, and email address and can be a member of one or more courses. Both entities are generalized in the Member entity. Conversely, this means that the Member entity is specialized in the Student and Professor entities.
{{< figure src="/attachments/refguide9/modeling/domain-model/entities/917900.png" class="no-border" >}}
For more information, and a discussion on the relative merits of using generalization or associations, see Generalization vs 1-1 Associations.
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.
Define whether instances of this entity can be stored in the database. For more information, see Persistability.
This property defines whether the entity contains the system attribute 'createdDate'. This is an attribute of type Date and time 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 (default) | Entity does not contain the system attribute 'createdDate'. |
{{% alert color="info" %}} We do not support displaying this system member of the System.User entity or its specializations in a data grid directly. {{% /alert %}}
This property defines whether the entity contains the system attribute 'changedDate'. This is an attribute of type Date and time that stores the most recent date and time when the object was changed.
| Option | Description |
|---|---|
| True | Entity contains the system attribute 'changedDate'. |
| False (default) | Entity does not contain the system attribute 'changedDate'. |
{{% alert color="info" %}} The 'changedDate' property is updated when a value is set. In Mendix 9.5.0 and above, setting an attribute to the value it already had and committing the entity updates the 'changedDate'. In Mendix 9.4 and below, the behavior is the same as for Mendix 8 and the 'changedDate' property is only updated when the value is different. {{% /alert %}}
{{% alert color="info" %}} We do not support displaying this system member of the System.User entity or its specializations in a data grid directly. {{% /alert %}}
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 (default) | Entity does not have the system association 'owner'. |
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 (default) | Entity does not have the system association 'changedBy'. |
You can also edit an entity by opening the entity properties dialog box.
{{< figure src="/attachments/refguide9/modeling/domain-model/entities/example-entity.png" alt="Example of a CD entity" class="no-border" >}}
In addition to the properties described above, there are also tabs which allow you to edit the following:
See the detailed pages for each of these tabs for more information.