How to Create an Entity

To start creating an Entity, click on the Add button at the top left of the Entity Builder page:

Add an Entity

This will take the user to a new Form Builder to start creating a new Entity, with an Overview page to fill in their Entity’s basic identifying details:

Entity Builder Overview

1. Title: What the user would like to call the Entity as a whole
2. Description: A small description of what the Entity serves to function

Once the user has named & described their Entity, they can then click on Save in the bottom right corner, or the Entities tab, to proceed to the next stage.

This will take the user to the Entities tab, which holds all the details and formatting the user will need to create their Entity:

Entity Builder

1. Data Types: The available types of data for building the Entity. See the Entity Data Types section for more information.
2. Tables: The Entity’s composite tables.
3. Properties: The qualities of each table and data type selected, as modified by the user. See the Entity Properties section for more information.

To insert a particular data type into a table, expand the section within which the targeted data type resides, and drag that data type onto the table:

Data Type Selection

These data fields can be adjusted as per the necessary requirements using the General Properties section on the right:

Data Properties

When a data field is inserted onto a table, hovering over it will produce some actions the user can employ to adjust their table:

Data Field Editing

1. Delete: symbolised by an X, click this to delete the data field from the table.
   • The user cannot delete the UUID field on the default table.
2. Move: symbolised by a four-way arrow, click and hold this to select the data field whose position needs adjusting in relation to the table, and drag it to where the data field should go.

To create a new table within the Entity, click on the tab on the top right of the Table section, and select “Add Entity” to display a new table:

New Entity Table

This also adds a reference to this table to the Entities section of the Operations tab on the home page.

The default table in an Entity cannot be deleted. To delete a created table from the Entity, click on the dustbin icon to the right of the name of the table:

Delete Entity Table

This will delete the table from the existing Entity, and the Entities section on the Operations tab.