Porovnávané verzie

Kľúč

  • Tento riadok sa pridal
  • Riadok je odstránený.
  • Formátovanie sa zmenilo.

...

Both the Comet and the REST API interfaces share the same way of communication serialization using using the JSON format. The only exception is calling SBA RPC methods which serve for sending and acquiring binary data from D2000 - in this case, the data is sent in a binary form. The JSON format is a universal format implemented almost in every programming language. Its advantage is not only native support in every browser but also easy readability for people since it is a text format. The disadvantage of the bigger capacity of a message in comparison with any binary format is minimalized by the use of a gzip compression implicitly supported by the REST and also the Comet API. 

...

AttributeValue typeMandatoryDefault valueNote
typetextyes

valueaccording to the typeno
unset attributes automatically mean invalid value, set attributes mean valid value (it if the attribute is not overloaded in the status attribute) 
valueTimeinteger (number of milliseconds from epoch)nocurrent timetime stamp
valueTimestwo-dimensional field (row, column) of integers (number of milliseconds from epoch)nocurrent time time stamps of values in a structure, only for the "record" type
alarmTimeinteger (number of milliseconds from epoch)no
time stamp of an alarm
alarmTimestwo-dimensional field (row, column) of integers (number of milliseconds from epoch)no
time stamps of alarms in a structure, only for the "record" type
flagsfield of texts (listed Flag type)nono flagsfield of user flags, possible values are from "A" to "P"
flagsSetstwo-dimensional field (row, column) of text fields (listed Flag type)nono flagstwo-dimensional field of fields of user flags of structure values, only for the "record" type
limitStatustext (listed LimitStatus type)no"InLimit"limited state, possible values are: "InLimit", "VeryLow", "Low", "High", "VeryHigh", "LimitsProblem"
limitStatusestwo-dimensional field (row, column) of text fields (listed LimitStatus type)no"InLimit"two-dimensional field of limited statuses of structure values, only for the "record" type
processAlarmStatustext (listed ProcessAlarmStatus type)no"NoAlarm"status of a process alarm, possible values are: "NoAlarm", "ToOn", "ToOff", "On", "Off", "Err", "Oscillate", "ErrCmdOn", "ErrCmdOff", "SwToTrans", "SwToOff", "SwToOn", "SwToErr", "SwTrans", "SwOff", "SwOn", "SwErr", "ErrZalCmdOff", "HL", "VHL", "LL", "VLL", "ToHL", "ToVHL", "ToLL", "ToVLL", "ErrWriteCmd", "Change", "A29", "A30", "A31", "SysPrAl"
processAlarmStatusestwo-dimensional field (row, column) of text fields (listed ProcessAlarmStatus type)no"NoAlarm"two-dimensional field of statuses of process alarms ina structure, only for the "record" type
statustext fields (listed Status type)no"Valid"status fields, possible values are: "Valid", "ProcAlarm", "NoAckPAlarm", "PrAlSilent", "Weak", "NoAckValue", "Transient", "Default", "Manual", "AlCrit", "Unknown"
statusSetstwo-dimensional field (row, column) of text fields (listed Status type)no"Valid"two-dimensional field of statuses of structure values, only for the "record" type
formattedValuetextno
in the attribute, the formatted value of D2000 object returns in the answer from the server, unnecessary when calling RPC methods 
structTypetextyes
structure name, only for the "record" type, mandatory on every "record" type sent to D2000
definitionD2RecordDefinition object-
structure definition, only for the "record" type, set on every value with the "record" type returned from D2000
returnAstextno
have sense only when calling RPC methods with output parameters, defines logical name which will have the returned output value 
returnFieldstext fieldsnoempty fielda special attribute defines additional returning attributes required by a client from the server 
returnTransformationReturnTransformation objectnonullonly for the "record" type with one numerical column and growing time stamps of values, it contains the configuration of processing (downscaling) of a numerical column performed on a server before sending answers to a client, because of the big data range, values are described below  

Kotva
implicitConversion
implicitConversion

...

Implicit Conversion of Simple JSON Types to Unival Value

To simplify working through the API interface, it is possible to use simple types instead of Unival type objects as input values to the D2000 system. Such values have the validity attribute, the time of origin to the current time automatically set and other attributes gain their default value.

JSON format typeCorresponding Unival typeNote

Pre zjednodušenie práce cez API rozhrania je možné ako vstupné hodnoty do systému D2000 používať aj jednoduché typy namiesto objektov typu Unival. Takéto hodnoty majú automaticky nastavený príznak platnosti, čas vzniku na aktuálny čas a ostatné príznaky nadobúdajú ich predvolenú hodnotu.

Typ formátu JSONZodpovedajúci typ UnivalPoznámka
boolean"bool"
number"bool"Ak je cieľový typ v D2000 BOOL. Čísla sú interpretované podľa poradia v type VBoolIf the target type is in the D2000 BOOL. Numbers are interpreted according to the order in the VBool type.
number"int"Ak je cieľový typ v D2000 INT. Ak bolo zadané reálne číslo, tak bude zaokrúhlené na celéIf the target type is in the D2000 INT. If the given number was a real number, it will be rounded to an integer number.
number"real"Ak je cieľový typ v If the target type is in the D2000 REAL.
number"time"Ak je cieľový typ v If the target type is in the D2000 TIME. Pozor: Číslo je interpretované ako počet sekúnd od  Warning: The number is interpreted as a number of seconds from 1972-01-01 00:00:00 UTC, nie ako počet milisekúnd od epochynot as a number of milliseconds from the epoch.
string"text"

Kotva
returnAs
returnAs

...

Defining of Returned Values from RPC Methods

The attribute returnFields defines the logical name of an output parameter required by a client from the server. 

Image Added

In the figure, there is represented an example of the SimpleSum method calling by a client. The first two parameters are simple JSON types that are implicitly converted to right Unival values. The third parameter is an output one and the client defines in the returnAs attribute the logical name under which will be the output Unival value returned; in this case, it is the logical name 

Atribút returnFields definuje logický názov výstupného parametra požadovaného klientom od servera.

Image Removed

 Na obrázku je znázornený príklad volania metódy SimpleSum klientom. Prvé dva parametre sú jednoduché JSON typy ktoré su implicitne konvertované na správne Unival hodnoty. Tretí parameter je výstupný a klient definuje v atribúte returnAs, logický názov pod ktorým mu bude výstupná unival hodnota vrátená, v tomto prípade je to logický názov "vysledok".

Kotva
returnFields
returnFields

...

Optimization of the Content of the Returned Unival Value

Because of the minimization of transmitted data, the Unival objects standardly contain on the output from D2000 only type and value attribute (if the value is valid). In the case of need of other extended value attributes, which are provided by the D2000 system, it is possible to set the returnFields attribute when calling and name required attributes in it.  The value of the returnFields attribute has a format of a text field. Allowed values are in the following table.

Value in the returnFields fieldFilled in attributes in response form server 

Kvôli minimalizácii prenášaných dát Unival objekty štandardne na výstupe z D2000 obsahujú len atribút type value (ak je hodnota platná). V prípade potreby ostatných rozširujúcich atribútov hodnoty, ktoré poskytuje systém D2000, je možné pri volaní nastaviť atribút returnFields a v ňom vymenovať požadované atribúty. Hodnota atribútu returnFields má formát poľa textov. Prípustné hodnoty sú v nasledujúcej tabuľke.

Hodnota v poli returnFieldsVypĺňané atribúty v odpovedi zoservera
"AlarmTime"alarmTime, alarmTimes
"Flags"flags, flagsSets
"LimitStatus"limitStatus, limitStatuses
"ProcessAlarmStatus"processAlarmStatus, processAlarmStatuses
"Status"status, statusSets
"ValueTime"valueTime, valueTimes
"FormattedValue"formattedValue

Unival

...

type Structure ("record")

...

 

The value of the structure type has its values and attributes stored as a two-dimensional field (row, column). Values gain the type according to the definition of structure in the D2000 system. It does not use extended attributesHodnota typu štruktúra má svoje hodnoty a atribúty uložené ako dvojrozmerné pole (riadok, stĺpec). Hodnoty nadobúrajú typ podľa definície štruktúry v systéme D2000. Nepoužíva rozširujúce atribúty alarmTime, flags, limitStatus, processAlarmStatus, status a valueTime. Namiesto nich používa atribúty Instead of them, it uses attributes alarmTimes, flagsSets, limitStatuses, processAlarmStatuses, statusSets, valueTimes, ktoré sú dvojrozmerným poľom a prvky majú rovnaký typ ako pôvodné atribúty. Ďalšími atribútmi používanými len pri štruktúrach sú definition structType. Atribút definition (objekt D2RecordDefinition) je vždy automaticky nastavený na všetkých štruktúrovaných hodnotách, ktoré vystupujú zo systému D2000. Tento atribút popisuje názvy stĺpcov a ich typy v štrukturovanej premennej. Typy stĺpcov v štruktúre sú zjednodušenou verziou typov Unival.which are a two-dimensional field and components have the same type as the original attributes. Other attributes used only in structures are definition and structType. The definition attribute (D2RecordDefinition object) is always automatically set on all structural values that come from the D2000 system. This attribute describes columns' names and their types in a structured variable. Columns' types in a structure are a simplified version of Unival types.

Column typeValue type
"bool"VBool type
"integer"integer
"real"real number
"time"integer (number of milliseconds from epoch
Typ stĺpcaTyp hodnoty
"bool"typ VBool
"integer"celé číslo
"real"reálne číslo
"time"celé číslo (počet milisekúnd od epochy)
"timespan"reálne číslo (počet sekúndreal number (number of seconds)
"text"text
"object"podľa typu referencovaného D2000 objektuaccording to the type of referenced D2000 object

The structType attribute is a text attribute and defines the name of the D2000 object of the structure definition type. It is mandatory to set it for every structured value that is inputted into the D2000 systemAtribút structType je textový a určuje meno objektu D2000 typu definícia štruktúry. Je povinné ho nastaviť pre každú štrukturovanú hodnotu, ktorá vstupuje do systému D2000.

Blok kódu
languagejs
titlePríklad posielanéj hodnoty typu štruktúra - definícia SD.ArrReal_Text, 2 stĺpce (int, text), 3 riadky:
{
  "type": "record",
  "structType": "SD.Arr_Real_Text",
  "value": [[1, "One"], [2, "Two"], [3, "Three"]]
}

...

Blok kódu
languagejs
titlePríklad vracanej hodnoty typu štruktúra - definícia SD.ArrReal_Text, 2 stĺpce (int, text), 3 riadky:
{
  "type": "record",
  "definition": {
    "columnTypes": ["integer", "text"],
    "columnNames": ["digit", "name"]
  },
  "value": [[1, "One"], [2, "Two"], [3, "Three"]]
}

Transformácie časových radov

Pod časovým radom sa rozumie jednostĺpcová štruktúra, kde hodnoty sú reálne čísla a majú nastavené rastúce časové značky. Pri zobrazení časových radov často nie sú potrebné alebo žiadané (najmä kvôli výkonu) všetky hodnoty z požadovaného intervalu. Pre takéto potreby sú implementované transformácie časových radov, ktoré zmenšujú počet prenášaných dát. Transformáciu je možné vyžiadať nastavením atribútu transformation na výstupnej štrukturovanej hodnote.

Downsampling

Transformations of Time Rows

Time row is a one-column structure in which values are real numbers and have increasing time stamps set. When displaying time rows, all values from requested interval are often not necessary or required (especially because of performance).  For such needs, transformations of time rows are implemented which decrease the number of transmitted data. It is possible to request the transformation by setting the transformation attribute on the output structured value.

Downsampling

Downsampling is reducing the number of values according to the given step or to the given number of values. The used algorithm tries as much as possible to keep the course of the curve of the original time row and does not smooth the final curve as the common resampling using averaging.  Downsampling je zredukovanie počtu hodnôt podľa daného kroku alebo na daný počet hodnôt. Použitý algoritmus sa snaží čo najviac zachovať priebeh krivky pôvodného časového radu a nevyhladzuje výslednú krivku ako bežné prevzorkovanie používajúce priemerovanie.

Blok kódu
languagejs
titleVyžiadané zredukovanie algoritmom Largest Triangle Three Buckets na 100 hodnôt
{
  "type": "record",
  "structType": "SD.Arr_Real",
  "returnTransformation": {
    "type": "lttb",
    "threshold": 100
  }
}

...

Blok kódu
languagejs
titleVyžiadané zredukovanie algoritmom Largest Triangle Three Buckets s krokom 86400 sekúnd (1 deň)
{
  "type": "record",
  "structType": "SD.Arr_Real",
  "returnTransformation": {
    "type": "lttb",
    "step": 86400
  }
}

OHLC

The OHLC (Open-High-Low-Close) algoritmus transformuje výstupný časový rad tak, že pre každý interval nájde prvú, maximálnu, minimálnu a poslednú hodnotu. Voliteľne pri tomto algoritme je možné nastaviť či majú byť intervaly spojité (po sebe nasledujúce intervaly majú spoločnú poslednú a prvú hodnota - predvolene) alebo diskrétne - atribút discrete a kde má byť umiestnená časová značka hodnoty reprezentujúcej celý interval (začiatok "Start" alebo stred "Midpoint" - predvolene) - atribút timestampPlacement.algorithm transforms the output time row in a way that for every interval it finds first, maximal, minimal and last value. Optionally when using this algorithm, it is possible to set whether the intervals should be continuous (successive intervals have the first and the last value common - by default) or discrete - the discrete attribute and where should be the time stamp of the value representing the whole interval placed (the beginning "Start" or in the middle "Midpoint" - by default) - the timestampPlacement attribute. 

Blok kódu
languagejs
titleVyžiadané OHLC transformácie s krokom 86400 sekúnd (1 deň) s diskrétnymi intervalmi a časovými značkami na začiatku intervalu
{
  "type": "record",
  "structType": "SD.Arr_Real",
  "returnTransformation": {
    "type": "ohlc",
    "step": 86400,
    "discrete": true,
    "timestampPlacement": "Start"
  }
}

...