An entity is an element which allows you to keep business information in a persistent way. The information is stored in Attributes. Entities are used to represent and manage your data base model. You can think of an entity as a table or view of a database.

How to Create an Entity

You can create an Entity by executing one of the following operations:

Entity Identifier

When an entity is created, OutSystems Platform automatically creates an attribute called Id; this attribute uniquely identifies the entity.

By default, this attribute is a Long Integer and the OutSystems Platform generates its value, assuring uniqueness; this is done through the auto-number facility provided by the development environment. See how to guarantee uniqueness.

However, if you want, you may switch off the auto number facility or change the identifier type to text.

To set another attribute to be the identifier simply set that attribute as identifier.


When you delete an entity, OutSystems Platform is permissive, i.e. no test is done to check whether the entity is being used. However, module validation detects this and returns an error. The module is not valid and you have to fix the elements where the entity is being used.


To handle a single entity element, use the type 'Record' with the entity definition. To handle multiple entity elements use the type 'List'.


When designing your application use Static Entities to benefit from strong typing. Learn more About Static Entities.

Using an Entity from another Module

Development environment provides you with mechanisms to reuse Entities among modules. You can use entities defined in another module or expose your entities to other modules.

See Also

Entity Properties | Entity Editor | Manage Entities