Custom entities

If the built-in system entities are not enough, for example for storing specific user data such as external reference lists, you can add new entities (tables). In the Administration section, under Settings - Entities, create a new one:

In the Name field, specify a user-friendly name of the entity. In the Table name field, specify the name of the DBMS table in which records (objects) of this entity will be stored. A particular DBMS has its own restrictions on table names. The table name is usually filled in with Latin letters, and the first character is always a letter. It is better not to use markup characters.

Module is the user-friendly name of the custom module used to edit records of the entity. This name can be used in the search bar, and also when configuring navigation inside projects.

By default, a new entity has only one field, "Name". To define additional fields and links to other entities of the system, use the standard "Attributes" module in the Settings of the project where this entity will be used.

Data can be imported into the new reference list using Excel or the REST API, or, using script automation, you can implement loading of data into the reference list from external systems; examples: Custom Lookups.

The system lets you build charts using records of this entity, in the same way as for the other entities of the system.

Additional options:

  • Data is bound to projects. If the option is enabled, the entity has a different set of data in different projects. If the option is disabled, the data is common to all projects. This way you can implement a data reference list that is global for the whole system.
  • Can be hierarchical. When the option is enabled, you can implement custom reference lists with a hierarchical structure, in other words tree-like reference lists.

A record in the table of a custom entity has its own identifier (UID).

You can define your own scheme for identifying artifacts, different from the one used in the system by default. To do this, open the settings of the "UID" attribute and set a formula there for calculating the default value.


As the formula for calculating the Requirement identifier, write an expression following the example from the description. Here are several variants of custom identification of Requirements:

  • {PageType.ShortCaption,R}.{Id} - the Requirement ID starts with the short name of its type, for example, SR.123
  • {PageType.ShortCaption,R}-{IdProject} - the "IdProject" field value is filled by an automatic counter within the project. In each project the counter starts at 1. This way you can get identifiers such as: BR-1, SR-2, and so on.
  • {PageType.ShortCaption,R}-{IdType} - the "IdType" field value is filled by a counter for each Requirement type. This way you can get identifiers such as: BR-1, SR-1, and so on.
  • {PageType.ShortCaption,R}-{IdHierarchy} - the "IdHierarchy" field value is filled by a counter within the hierarchy (document), that is, the counter increases for each next child element inside the document.
  • {PageType.ShortCaption,R}-{IdParent} - the "IdParent" field value is filled by a counter within the parent section, that is, the counter increases for each next child element inside one section.

You can form an identifier using leading zeros; for example, given the expression {Id,6}, the system forms the identifier as 000001, 000002, and so on.


Search results