The Entity Type structure is defined in JSON format. JSON stands for Java Script Object Notation, and simply put, JSON is a javascript object written as a text string. Thanks to this feature, the structure can be modified at any time with minimal restrictions. Another major advantage is that it can be done during normal system operation.
A sample structure for an entity type
Sample attribute structure (web editor jsoneditoronline.org)
In the textual detail of the JSON definition it looks like this.
List of mandatory Attributes
Each Type of Entity has a so-called mandatory attributes so that everything works reliably in the system despite its enormous genetics and adaptability. Mandatory attributes are:
status
This attribute represents the state of objects from the point of view of operation. Its values can be as follows:
- virtual – represents a ready digital object that is not yet connected to any incoming telemetry. The virtual value is also the default value
- OK – represents a telemetry-recorded value representing a properly functioning digital object
- NOK – represents a telemetry-recorded value representing a malfunctioning digital object (i.e. an object showing an anomaly with respect to the OK state)
icon_anme
This attribute expresses the technical name of the icon representing the given Entity Type.
fill_color
This attribute expresses the color value in hexadecimal representation of the given digital object. And it doesn’t matter if it’s an icon or a polygon.
Technically, the definition of mandatory fields in JSON format looks like this.
Due to the effort to keep incoming data to individual Entities in a flawless state, it is not yet possible to change the structure of the Entity Type through the user interface. The new or modified Entity Type created by you will be uploaded to the system by the platform operator via the help desk request you entered. The change will be made free of charge, and this activity is already part of the monthly fee. At the same time, it will check the consistency of the changes and, if discrepancies are detected, it will alert you to potential risks and at the same time help you eliminate them.
Attribute structure
Parameters are used to define the attribute, with the help of which we can “model” the attribute in such a way that its use is simple and intuitive. In the following section, we will describe the individual parameters of the attribute:
type
(mandatory parameter)
This parameter defines the type of the Attribute from the point of view of the data acquisition method. It can have the following values:
- static – data is entered and changed manually via City Studio
- telemetry – the data will be sent as input telemetry from the device or software integration
- computed – the field will be calculated from other parameters of Attributes and Attributes of other Entities in the system defined by type static or telemetry.
unit
(mandatory parameter)
This parameter defines the unit of the physical quantity of the given Attribute (e.g. pcs, %, €, etc.)
value_type
(mandatory parameter)
This parameter defines the type of variable stored in the given Attribute. It can acquire the following values:
- string – text string
- number – An integer or a number with decimal places.
- bool – status flag i.e. boolean (true, false)
value_default
(mandatory parameter)
This parameter specifies the initial value of the attribute at creation. If the value_type is a number, then through the initial value we can set whether it is a whole number or a decimal. For example if the initial value is 0, it will be whole numbers. If the initial value is 0.01, it will be a value with decimal places.
trans
(mandatory parameter)
This parameter acts as an object and allows specifying translations of the Attribute name. For each language it is translated through language tags ( ISO 639-1)
value_min
(optional parameter)
It represents the setting of the lower limit of the possible value of the field in the case of input by the user via the web interface. This restriction only applies if the field type is numeric (integer).
value_max
(optional parameter)
It represents the setting of the upper limit of the possible value of the field in the case of input by the user via the web interface. This restriction only applies if the field type is numeric (integer).
rich_type
(optional parameter)
Extending the value_type parameter allows you to display a special UI element or formatting.
You can see more about this in the Digital Entity Attribute Types section.