Skip to main content
Skip table of contents

Creating Entities

Each entity corresponds to an object in your application, e.g. "order" or "customer". The relationship between two or more entities is represented via associations. Each entity (object) contains fields (properties) and is labeled with a unique technical ID field which is needed for associations.

To create a new entity:

  1. Right-click on the Entities folder.
  2. Choose New > Entity.
  3. Enter an entity name in the File Creation Wizard dialog. 
  4. Choose Finish.

In the next step, you can add properties to your entity. To do so, double-click on the .entity file in the Projects view to open it in the Entity Editor.

Choose Add to add the desired properties, e.g. name or id:

Please observe the applicable naming conventions for XML elements when making entries in the Name column. Otherwise, an error message will be displayed in the Problems view, and the .entity file cannot be used.

You can sort the entries by selecting an entry and move it up or down using the arrows on the top right. This way you can arrange the entries as desired.


The table in the .entity file contains the following fields:

FieldDescription
Name

You enter the desired name for your property in this field.

Use the Add button to add a new property.

Use the Remove button to remove properties you do not need anymore.

Type

You use this drop-down to set the type of the property.

Possible values:

  • STRING
  • INTEGER
  • DECIMAL
  • BOOLEAN
  • DATE
  • DATETIME
Is IDUse this checkbox to define whether the property is a defined ID.
MandatoryUse this checkbox to define whether the property is mandatory or optional.
Read onlyUse this checkbox to define whether the property is read-only.

In addition to the Design view shown above you can also open the .entity file in the Source view and define the properties as XML elements and the corresponding attributes.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.