Custom entity type

Quick info

A separate entity is an independent entity, which gets its own rights, its own database table and its own menu.

The data structure is configured completely freely and has the same functionality as a system-side entity, such as import/export interface, event handling, etc.

Common

images/download/attachments/106961525/image2021-9-22_11-48-19-version-1-modificationdate-1658326293255-api-v2.png


Each custom entity needs a Namespace and a Name.
Namespaces can be managed using the Dynamic enumerations (namespace). They are needed to avoid name conflicts with types of the same name.
For example, a 'warehouse management' process with the same namespace could include an 'issue' type, and similarly one of a 'ticket management' type.
Nevertheless, both types with the same name would be clearly distinguishable from each other by the namespace.

Therefore, the combination of namespace and type name is unique and reflects the class, XML and database table name:

Namespace

Name

Class name

Table

History table (only if 'Disable history' is deactivated)

Custom

MyDemoEntity

custom.MyDemoEntity

custom_my_demo_entity

custom_my_demo_entity_history

MyNamespace

MyEntity

mynamespace.MyEntity

mynamespace_my_entity

mynamespace_my_entity_history

Configuration

images/download/attachments/106961525/image2021-9-22_11-51-28-version-1-modificationdate-1658326293251-api-v2.png


Option

Description

1

Here you can specify where this entity should be inserted in the menu.

2

The overview icon.

3

The detail view icon.

4

Option to activate the form editor.

5

Option to split the details overview into two separate views.

6

Option to activate custom overviews.

7

Option to disable logging for data that does not change or does not need/should not be logged. Example: Log/Trace data like GPS positions.
This reduces the time needed for saving and of course also saves hard disk space.
If this option is deactivated, two new database tables (data + history) are created with the corresponding name and the configured columns.

8

The definition of the fields (structure).

9

The definition of the database indices.

10

The definition of extensions.

11

Tree view of the custom entity.