Service Studio version:

Create an Entity to Persist Data

Last updated
Save as PDF

Edit

Collaborate with us

Edit this page on GitHub

In OutSystems, a database table is an Entity Entity, and the table columns are Entity Attributes.

To create an Entity you need to:

Open the Entity Diagram created by default in your application.
Right-click anywhere on the canvas and select 'Add Entity'.
In the window that pops up:
1. Give a name to the entity.
2. The entity already has the Id attribute created as Entity Identifier (primary key). Add the other attributes.
3. Add indexes if necessary.

Alternatively, you can create entities in the Data tab:

Right-click on the Entities folder and select 'Add Entity'.
It's a quicker way, but with access to less information about the entity.
Right-click on the Entities folder and select 'Import New Entities from Excel...'.

It's useful to create an entity and bootstrap data for it.

In mobile applications, you can create entities to store information in the device's local storage. This typically happens when end users need to take the data offline.

Example

We have an application called Go Out, that allows you to read and write reviews of places you go to, for instance restaurants. Let's see how to create the table that stores the information about these places.

In the Data tab, under Entity Diagrams, open the GoOutDataModel diagram.
Right-click and choose 'Add Entity to Database'.
Set the name of the entity to Place. OutSystems creates an Id attribute with data type Long Integer, set as AutoNumber.
Use the New button to create the attributes:
1. Create the Name attribute. By default the data type is set to Text and the length is 50, change it to 100;
2. Make the attribute mandatory by setting the Is Mandatory property to Yes.
3. Create the Address attribute as a mandatory Text attribute with 200 characters of length.
4. Create the PhoneNumber attribute. The data type of the attribute changes to Phone Number. Leave this attribute optional.
5. Create the Latitude and Longitude attributes as optional Decimal attributes. Use the default length (37) and decimals (8) to define the precision of the numbers stored in the database.
Publish your application.

When you publish your application, OutSystems creates the database table that corresponds to the Place entity.

Training

Documentation