Creating New Entity Types

You can create a new entity type by using the Data Modeler application.

The Create New Entity Types feature in Data Modeler provides the convenience of creating an entity type by using a user interface instead of a JSON file.

Adding an Entity Type

To create a new entity type, click on the Entity Types page. The Add entity type page appears.

Selecting an Icon and Color

You can add an icon as the image to the entity that you are creating by clicking the edit (pen) icon on the image on the left. The Entity type icon selection box allows you to choose an icon from the ICON tab.

In addition, you can choose a color from the color palette provided in the COLOR tab to change the background color of your icon.

Click SELECT to apply your selection.

Note: After you have added an icon, you can click the remove icon () (cross symbol) on the image to remove the selected image. The selected icon is removed and the first character of the Display Name is shown as the image, by default.

Adding details in the Add entity type page:

In the Name field, enter a unique name which is used in the URI (the path to reach the entity type). For example: SalesDept. The URI for creating an entity type is configuration/entityTypes/.
Tip: As a best practice, do not use special characters and spaces while creating entity types.
In Display Name, enter a name that would identify your entity type in the user interface. For example: Sales.
Note: If you had not selected an icon earlier, the first character of the Display Name is shown as the image, by default.

Optionally, in Inherited abstract entity type, select the entity type that your new entity is based on. An Abstract entity type can be further expanded upon, if needed. For example, the Sales entity type could be a type of organization abstract entity. To learn more about abstract entity type, see The Entity Type.

To make this entity type an Abstract Entity Type that could be useful for creating other entity types, turn on the Abstract Entity Type option.

In the Data label pattern field, enter the pattern that is used to build the entity object label.

Optionally, you can specify the Secondary label pattern, any other attributes to be displayed in the Search Results and Profile pages as Business card attributes, and a Description for the entity type that you are creating.

You can choose to save the details and add the attribute details at a later stage. Alternatively, you can go on to add the attributes for the entity type as the next step. To do so, click the SAVE AND ADD ATTRIBUTE button. The Create a new attribute page appears. To learn more about adding attributes, see Creating New Attributes.

The new entity type is added to the Entity types page. If there are any validation errors or warnings in the details of the entity type, a small triangle is displayed on the entity type.

Editing an Entity Type

You may want to modify the details of an existing entity type. Depending upon the abstract entity type that was used for creating an entity type, the system allows you to edit the entity type details.

To modify the details of an entity type, on the Entity types page, click the edit (pen) icon on the right side of the listed entity. The Edit entity type page appears.

You can edit only the image, Display Name, Data label pattern and other details that appear in the More Options section.

Note: After you have added an icon, you can click the remove icon () (cross symbol) on the image to remove the selected image. The selected icon is removed and the first character of the Display Name is shown as the image, by default.

You can click SAVE to update the entity type details.