Struktura digitálních entit
Struktura Typu Entity je definována v JSON formátu. JSON je zkratka z Java Script Object Notation a zjednodušeně by se dalo říci, že JSON je javascriptový objekt zapsaný jako textový řetězec. Díky této vlastnosti lze kdykoli strukturu upravit s minimálními omezeními. Další zásadní výhodou je, že je to možné provést během běžného provozu systému.
Vzorová struktura pro Typ Entity
Struktura atributů vzorové struktury (web jsoneditoronline.org editor)
V textovém detailu definice JSON vypadá následovně.
{
"status": {
"type": "telemetry",
"unit": null,
"trans": {
"cs": "Stav",
"de": "Status",
"en": "Status",
"sk": "Stav"
},
"value_type": "string",
"value_default": "virtual",
"attribute_rules": {
"fill_color": [
{
"value": "#adadad",
"condition": "virtual"
},
{
"value": "#1eff00",
"condition": "OK"
},
{
"value": "#ff2a00",
"condition": "NOK"
}
]
}
},
"icon_name": {
"type": "static",
"unit": "",
"trans": {
"cs": "Méno ikony",
"de": "Symbolname",
"en": "Icon name",
"sk": "Meno ikony"
},
"value_type": "string",
"value_default": "first-aid-kit"
},
"fill_color": {
"type": "static",
"unit": null,
"trans": {
"cs": "Barva výplně",
"de": "Füllfarbe",
"en": "Fill color",
"sk": "Farba vyplnenia"
},
"rich_type": "color",
"value_type": "string",
"value_default": "#ff2a00"
},
"atribut_1": {
"type": "static",
"unit": "",
"trans": {
"cs": "Popis attributu 1 v cs jazyku",
"de": "Popis attributu 1 v de jazyku",
"en": "Popis attributu 1 v en jazyku",
"sk": "Popis attributu 1 v sk jazyku"
},
"value_type": "string",
"value_default": ""
},
"atribut_2": {
"type": "telemetry",
"unit": "",
"trans": {
"cs": "Popis attributu 2 v cs jazyku",
"de": "Popis attributu 2 v de jazyku",
"en": "Popis attributu 2 v en jazyku",
"sk": "Popis attributu 2 v sk jazyku"
},
"value_type": "string",
"value_default": ""
},
"atribute_date": {
"type": "telemetry",
"unit": " ",
"trans": {
"cs": "Popis attribute_date v cs jazyku",
"de": "Popis attribute_date v de jazyku",
"en": "Popis attribute_date v en jazyku",
"sk": "Popis attribute_date v sk jazyku"
},
"rich_type": "datetime",
"value_type": "number",
"value_default": 0
},
"atribute_flow": {
"type": "static",
"unit": "",
"trans": {
"cs": "Popis attribute_flow v cs jazyku",
"de": "Popis attribute_flow v de jazyku",
"en": "Popis attribute_flow v en jazyku",
"sk": "Popis attribute_flow v sk jazyku"
},
"value_type": "number",
"value_default": "0.001"
},
"atribute_url": {
"type": "static",
"unit": " ",
"trans": {
"cs": "Popis attribute_url v cs jazyku",
"de": "Popis attribute_url v de jazyku",
"en": "Popis attribute_url v en jazyku",
"sk": "Popis attribute_url v sk jazyku"
},
"rich_type": "url",
"value_type": "string",
"value_default": ""
}
}
Seznam povinných Atributů
Každý Typ Entity má tzv. povinně atributy, aby v systému i přes obrovskou genetičnost a přizpůsobitelnost vše spolehlivě fungovalo. Povinné atributy jsou:
status
Tento atribut reprezentuje stav objekty z pohledu fungování. Jeho hodnoty mohou být následující:
- virtual – představuje připravený digitální objekt, který ještě není napojen na žádnou příchozí telemetrii. Hodnota virtual je také přednastavená hodnota
- OK – představuje telemetrií nahranou hodnotu vyjadřující správně fungující digitální objekt
- NOK – představuje telemetrií nahranou hodnotu vyjadřující nesprávně fungující digitální objekt (tj. objekt vykazující anomálii vůči stavu OK)
icon_anme
Tento atribut vyjadřuje technický název ikony reprezentující daný Typ Entity.
fill_color
Tento atribut vyjadřuje hodnotu barvy v hexadecimálním vyjádření daného digitálního objektu. A je jedno zda jde o ikonu nebo polygon.
Technicky definice povinných poli v JSON formátu vypadá následovně.
{
"status": {
"type": "telemetry",
"unit": null,
"trans": {
"cs": "Stav",
"de": "Status",
"en": "Status",
"sk": "Stav"
},
"value_type": "string",
"value_default": "virtual",
"attribute_rules": {
"fill_color": [
{
"value": "#adadad",
"condition": "virtual"
},
{
"value": "#1eff00",
"condition": "OK"
},
{
"value": "#ff2a00",
"condition": "NOK"
}
]
}
},
"icon_name": {
"type": "static",
"unit": "",
"trans": {
"cs": "Méno ikony",
"de": "Symbolname",
"en": "Icon name",
"sk": "Meno ikony"
},
"value_type": "string",
"value_default": "first-aid-kit"
},
"fill_color": {
"type": "static",
"unit": null,
"trans": {
"cs": "Barva výplně",
"de": "Füllfarbe",
"en": "Fill color",
"sk": "Farba vyplnenia"
},
"rich_type": "color",
"value_type": "string",
"value_default": "#ff2a00"
},
// ...
// ďalšie atribúty
// ...
}
Vzhledem ke snaze, udržet přicházející údaje do jednotlivých Entit v bezvadném stavu, není zatím možné změnit strukturu Typu Entity přes uživatelské rozhraní. Vámi vyzvořený nový, nebo upravený Typ Entity Vám do systému nahraje provozovatel platformy, přes Vámi zadaný helpdeskový požadavek. Změnu provede bezplatně ai tato činnost je již součástí měsíčního poplatku. Zároveň zkontroluje konzistentnost změn a v případě zjištění nesrovnalostí Vás upozorní na potencionální rizika a zároveň Vám je pomůže eliminovat.
Struktura Atributu
Pro definici atributu se používají parametry, pomocí kterých dokážeme „vymodelovat“ atribut do takové podoby, aby jeho používání snadné a intuitivní. V následující části si popíšeme jednotlivé parametry atributu:
type
(povinný parametr)
Tento parametr definuje typ Atributu z pohledu způsobu získávání údajů. Může mít následující hodnoty:
- static – údaj se zadavá a mění ručně přes Factory Studio
- telemetry – údaj bude zasílán jako vstupní telemetrie ze zařízení nebo softwarové integrace
- computed – pole bude vypočítáváno z ostatních parametrů Atributů a Atributů jiných Entit v systému definovaných typem static nebo telemetry.
unit
(povinný parametr)
Tento parametr definuje jednotku fyzikální veličiny daného Atributu (např. ks, %, €, apod.)
value_type
(povinný parametr)
Tento parametr definuje typ proměnné uložené v daném Atributu. Může nabývat následující hodnoty:
- string – textový řetězec
- number – Celé nebo číslo s desetinnými místy.
- bool – příznak stavu tj.boolean (true, false)
value_default
(povinný parametr)
Tento parametr určuje iniciální hodnotu atributu při založení. Pokud je value_type number, tak přes iniciální hodnotu můžeme nastavit zda se jedná o celé číslo, nebo o desetinné. Např. bude-li inicialní hodnota 0, tak půjde o celá čísla. Pokud bude iniciální hodnota 0.01 tak půjde o hodnutou s desetinnémi místy.
trans
(povinný parametr)
Tento parametr vystupuje jako objekt a umožňuje zadat překlady názvu Atributu. Pro každý jazyk se překládá přes značky jazyků ( ISO 639-1)
"trans": {
"cs": "Méno ikony",
"de": "Symbolname",
"en": "Icon name",
"sk": "Meno ikony"
},
value_min
(volitelný parametr)
Představuje nastavení spodní hranice možné hodnoty pole v případě zadávání uživatelem přes web rozhraní. Toto omezení platí, pouze pokud typ pole je číselný (integer).
value_max
(volitelný parametr)
Představuje nastavení horní hranice možné hodnoty pole v případě zadávání uživatelem přes web rozhraní. Toto omezení platí, pouze pokud typ pole je číselný (integer).
rich_type
(volitelný parametr)
Rozšíření parametru value_type, umožňuje zobrazit speciální prvek uživatelského rozhraní nebo formátování.
Více si o tom můžete prohlédnout v části Typy atributů digitálních entit.