Structure of digital Entities
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:
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)
This attribute expresses the technical name of the icon representing the given Entity Type.
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.
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:
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 Factory 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.
This parameter defines the unit of the physical quantity of the given Attribute (e.g. pcs, %, €, etc.)
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)
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.
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).
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).