schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
template.schema.json | descriptionDef | Detailed information about the device or system to be monitored by this device | {"type": "string", "minLength": 1, "maxLength": 800, "errorMessage": "description should be a string of at least one character and maximum 800 characters"} |
template.schema.json | rangerFilterDef | Tags used by Ranger to match discoverd devices with their respective templates | {"type": "object", "properties": {"deviceID": {"type": "string", "examples": ["0x0A01", "0x0A0B"], "errorMessage": "DeviceID should be a string"}, "vendorID": {"type": "string", "examples": ["0x002A"], "errorMessage": "vendorID should be a string"}}, "defaultSnippets": [{"label": "PROFINET based", "body": {"deviceID": "0x0A01", "vendorID": "0x002A"}}, {"label": "SNMP based", "body": {}}]} |
template.schema.json | deviceID | Regular expression for PROFINET device identification field in hexadecimal format | {"type": "string", "examples": ["0x0A01", "0x0A0B"], "errorMessage": "DeviceID should be a string"} |
template.schema.json | vendorID | Regular expression for PROFINET manufacturer identification field in hexadecimal format | {"type": "string", "examples": ["0x002A"], "errorMessage": "vendorID should be a string"} |
template.schema.json | description | Regular expression for SNMP sysDescr OID (1.3.6.1.2.1.1.1) device description | {"type": "string", "examples": ["SIMATIC NET, SCALANCE X2"], "minLength": 1, "maxLength": 800, "errorMessage": "description should be a string of at least one character and maximum 800 characters"} |
template.schema.json | defaultSnippets | Ranger filter for a PROFINET device | {"label": "PROFINET based", "body": {"deviceID": "0x0A01", "vendorID": "0x002A"}} |
template.schema.json | defaultSnippets | Ranger filter for a SNMP device | {"label": "SNMP based", "body": {}} |
template.schema.json | body | SIMATIC NET | {} |
template.schema.json | originTypeDef | Driver (Origin type) identification string for the driver | {"type": "string", "pattern": "^[a-zA-Z0-9-]{1,80}$", "errorMessage": "Should be a string and follow the pattern: alphanumerical characters and - symbol, maximum length 80"} |
template.schema.json | originTypeConfigDef | Driver (Origin type) configuration object. Check the specific documentation for each driver | {"type": "object", "properties": {"originType": {}}, "defaultSnippets": [{"label": "PROFINET Driver", "body": {"originType": "netin-ds-drv-pnio", "ipAddress": "/{DCP_IPAddress}/", "gsd": "GSDML-V2.35-Siemens-ET200SP-20200729"}}, {"label": "SNMP Driver", "body": {"originType": "netin-ds-drv-snmp", "basicConfig": {"retries": 2, "address": "/{ICMP_IPAddress}/", "port": 161, "version": 2, "timeout": 5000}, "snmpCommunities": {"readCommunity": "public", "writeCommunity": "private"}, "snmpV3Security": {"authAlgorithm": "MD5", "privacyAlgorithm": "DES", "usmUser": "", "authPassword": "", "privacyPassword": ""}}}, {"label": "ICMP Driver", "body": {"originType": "netin-ds-drv-icmp", "address": "/{ICMP_IPAddress}/", "count": 4, "timeout": 1000}}, {"label": "S7 Driver", "body": {"originType": "netin-ds-drv-s7", "s7basicConfig": {"address": "/{ICMP_IPAddress}/", "rack": 0, "slot": 2, "deviceType": "S7-300"}, "s7extraConfig": {"requestTimeout": 15000, "connectionTimeout": 3000, "port": 102}, "s7security": {"password": "", "accessProtection": false}, "s7diagnosticBuffer": {"loggingEnabled": false}}}, {"label": "MQTT Broker Driver", "body": {"originType": "netin-ds-drv-mqtt", "source": "/{DCP_IPAddress}/", "topics": [{"topicName": "MyTopic", "datapointSet": "MyDatapointSet", "originStrategy": {"strategyId": "property", "property": "MyProperty", "expression": "^[a-zA-Z0-9-]*"}, "operationMode": "extract"}]}}, {"label": "MODBUS Driver", "body": {"originType": "netin-ds-drv-modbus-tcp", "address": "/{DCP_IPAddress}/", "slaveId": 1, "port": 502}}], "additionalProperties": true, "required": ["originType"]} |
template.schema.json | defaultSnippets | Basic PROFINET Driver configuration | {"label": "PROFINET Driver", "body": {"originType": "netin-ds-drv-pnio", "ipAddress": "/{DCP_IPAddress}/", "gsd": "GSDML-V2.35-Siemens-ET200SP-20200729"}} |
template.schema.json | defaultSnippets | Basic SNMP Driver configuration | {"label": "SNMP Driver", "body": {"originType": "netin-ds-drv-snmp", "basicConfig": {"retries": 2, "address": "/{ICMP_IPAddress}/", "port": 161, "version": 2, "timeout": 5000}, "snmpCommunities": {"readCommunity": "public", "writeCommunity": "private"}, "snmpV3Security": {"authAlgorithm": "MD5", "privacyAlgorithm": "DES", "usmUser": "", "authPassword": "", "privacyPassword": ""}}} |
template.schema.json | defaultSnippets | Basic ICMP configuration | {"label": "ICMP Driver", "body": {"originType": "netin-ds-drv-icmp", "address": "/{ICMP_IPAddress}/", "count": 4, "timeout": 1000}} |
template.schema.json | defaultSnippets | Basic S7 configuration | {"label": "S7 Driver", "body": {"originType": "netin-ds-drv-s7", "s7basicConfig": {"address": "/{ICMP_IPAddress}/", "rack": 0, "slot": 2, "deviceType": "S7-300"}, "s7extraConfig": {"requestTimeout": 15000, "connectionTimeout": 3000, "port": 102}, "s7security": {"password": "", "accessProtection": false}, "s7diagnosticBuffer": {"loggingEnabled": false}}} |
template.schema.json | defaultSnippets | Basic MQTT Broker configuration | {"label": "MQTT Broker Driver", "body": {"originType": "netin-ds-drv-mqtt", "source": "/{DCP_IPAddress}/", "topics": [{"topicName": "MyTopic", "datapointSet": "MyDatapointSet", "originStrategy": {"strategyId": "property", "property": "MyProperty", "expression": "^[a-zA-Z0-9-]*"}, "operationMode": "extract"}]}} |
template.schema.json | defaultSnippets | Basic MODBUS Broker configuration | {"label": "MODBUS Driver", "body": {"originType": "netin-ds-drv-modbus-tcp", "address": "/{DCP_IPAddress}/", "slaveId": 1, "port": 502}} |
template.schema.json | datapointSetTypeDef | Define the data structure of this datapointSet, check the documentation for more information | {"type": "string", "enum": ["map", "tableStatic", "tableDynamic"], "errorMessage": "datapointSetType should be a string. DatapointSet type is datapointSetType, and should be one of: map, tableStatic, tableDynamic"} |
template.schema.json | datapointSetIdDef | DatapointSet identification string | {"type": "string", "pattern": "^[a-zA-Z0-9_-]{1,40}$", "errorMessage": "DatapointSet identification must be alphanumeric string [1-40], \"-\" & \"_\" are also allowed"} |
template.schema.json | tableAddressDef | Specific configuration for tabled based datapointSets | {"type": "object", "properties": {"rootAddress": {"type": "string", "maxLength": 240, "errorMessage": "rootAddress should be a string [0-240]"}, "indexes": {"type": "array", "items": {"type": "string", "pattern": "^[a-zA-Z0-9#&_-]{1,80}$"}, "errorMessage": "Indexes must be an array of datapoint identification strings"}}} |
template.schema.json | rootAddress | Main address for the table, this information is specific for each kind of driver | {"type": "string", "maxLength": 240, "errorMessage": "rootAddress should be a string [0-240]"} |
template.schema.json | indexes | Array of datapointIds that will act as table indexes, this means columns that acts as keys of the table | {"type": "array", "items": {"type": "string", "pattern": "^[a-zA-Z0-9#&_-]{1,80}$"}, "errorMessage": "Indexes must be an array of datapoint identification strings"} |
template.schema.json | items | One of the datapointId of the table type datapointSet | {"type": "string", "pattern": "^[a-zA-Z0-9#&_-]{1,80}$"} |
template.schema.json | broadcastDef | Flag to indicate that the alarm/datapointSet will be broadcasted to NetinHUB channels | {"type": "boolean", "errorMessage": "Broadcast flag should be a boolean"} |
template.schema.json | topic | Define the topic that should be used to transport the data | {"type": "string", "maxLength": 80, "errorMessage": "Should be a string of less than 80 characters"} |
template.schema.json | service | Define the service that should consume the information | {"type": "string", "maxLength": 80, "errorMessage": "Should be a string of less than 80 characters"} |
template.schema.json | serviceConfig | Object to define the specific configuration of the service | {"type": "object", "additionalProperties": true} |
template.schema.json | dataTypeDef | Define the type of the data in the NetinDS context, this means how NetinDS will manage the data before the conversions | {"type": "string", "enum": ["BYTE", "INTEGER", "LONG", "FLOAT", "DOUBLE", "STRING", "BOOLEAN", "DATE", "ARRAY", "INTEGER_ARRAY", "STRING_ARRAY", "DOUBLE_ARRAY", "BOOLEAN_ARRAY", "FLOAT_ARRAY", "LONG_ARRAY", "OBJECT"], "errorMessage": "DataType should be one of: BYTE, INTEGER, LONG, FLOAT, DOUBLE, STRING, BOOLEAN, DATE, ARRAY, INTEGER_ARRAY, STRING_ARRAY, DOUBLE_ARRAY, BOOLEAN_ARRAY, FLOAT_ARRAY, LONG_ARRAY, OBJECT"} |
template.schema.json | originDataTypeDef | Define the type of the data in the driver context, this means how the type of data that driver expect to collect | {"type": "string", "pattern": "^[a-zA-Z0-9-_]{1,80}$", "errorMessage": "Driver side data type should follow the pattern: alphanumerical string +\"-\" and \"_\", size [1-80]"} |
template.schema.json | originAddressDef | Define the address of this datapoint. This is specific for each driver | {"type": "string", "pattern": "^[\\w\\d_&#:$.-]{1,80}$", "errorMessage": "Datapoint address should be an alphanumerical string [1-80] and [_&#:$.-]"} |
template.schema.json | originAccessTypeDef | Access level to the datapoint. This is specific for each driver | {"type": "string", "enum": ["read-only", "write-only", "read-write", "not-accessible"], "errorMessage": "Datapoint access type should be a string and one of: read-only, write-only, read-write, not-accessible"} |
template.schema.json | receiveModeDef | Define how the driver should get the value of this datapoint. This is specific for each driver | {"type": "string", "enum": ["polling", "singleQuery", "subscription"], "errorMessage": "Receive mode should be a string and one of: polling, singleQuery, subscription"} |
template.schema.json | pollingGroupDef | Frequency in which the driver should update the value of this datapoint. This is specific for each driver | {"type": "string", "enum": ["5s", "10s", "30s", "1m", "5m", "10m", "15m", "30m", "1h", "4h", "6h", "12h", "1d"], "errorMessage": "Polling group should be a string and one of: 5s, 10s, 30s, 1m, 5m, 10m, 15m, 30m, 1h, 4h, 6h, 12h, 1d"} |
template.schema.json | datapointTypeDef | Define the kind of information types, within NetinDS context, that the driver/zavod instances will generate for this datapoint | {"type": "string", "enum": ["SIMPLE", "TIMEPOINT", "DATAPOINT", "@DATAPOINT", "@TIMEPOINT", "#DATAPOINT", "#TIMEPOINT"], "errorMessage": "DatapointType must be one of: SIMPLE, TIMEPOINT, DATAPOINT, @DATAPOINT, @TIMEPOINT, #DATAPOINT, #TIMEPOINT"} |
template.schema.json | datapointIdDef | Datapoint identification string | {"type": "string", "pattern": "^[a-zA-Z0-9#&_-]{1,80}$", "errorMessage": "Should be a string and follow the pattern: alphanumerical and symbols #&_- with less than 41 characters"} |
template.schema.json | symbolDef | Identification string for logic expression | {"type": "string", "minLength": 1, "errorMessage": "Should be a string of at least one characters and less than 40 characters"} |
template.schema.json | expressionDef | Expression to be evaluated by NetinDS-Zavod | {"type": "string", "examples": ["(^(5|[5-9]\\d*)\\.(3|[3-9]\\d*)\\.(0|[1-9]\\d*)?$).test(datapoint.value)", "datapoint.rawValue"], "minLength": 1, "maxLength": 800, "errorMessage": "Should be a string of at least one character and less than 800 characters"} |
template.schema.json | expressionLogicObjectDef | Expressions that will be checked in this evaluation | {"type": "object", "properties": {"expression": {}, "symbol": {}}, "additionalProperties": false, "required": ["expression", "symbol"]} |
template.schema.json | severityDef | Level of criticality of the alarm | {"type": "integer", "minimum": -1, "maximum": 1000, "errorMessage": "Should be a number greater than -1 and lower than 1001"} |
template.schema.json | severityForAlarmsDef | Level of criticality of the alarm | {"type": "integer", "minimum": 201, "maximum": 1000, "errorMessage": "Should be a number greater than 200 and lower than 1001"} |
template.schema.json | severityForLogsDef | Level of criticality of the log | {"type": "integer", "minimum": 1, "maximum": 200, "errorMessage": "Should be a number greater than 0 and lower than 201"} |
template.schema.json | textDef | Alarm/event descriptive text | {"type": "string", "minLength": 1, "maxLength": 800, "errorMessage": "Should be a string of at least one character and less than 500 characters"} |
template.schema.json | auditedDef | Flag indication for audit process | {"type": "boolean", "errorMessage": "Should be boolean"} |
template.schema.json | hiddenDef | Flag to indicate that the alarm is hidden by user request | {"type": "boolean", "errorMessage": "Should be boolean"} |
template.schema.json | facilityDef | Ident number for the resource group | {"type": "integer", "minimum": -1, "maximum": 255, "errorMessage": "Should be a number in the range [-1, 255]"} |
template.schema.json | logicDef | Logic operation to be applied between all the expressions | {"type": "string", "examples": ["evalID1 & evalID2"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one character and less than 80 characters"} |
template.schema.json | evaluationForLogsDef | Array with all the evaluations that will be checked | {"type": "object", "properties": {"expressions": {"type": "array", "items": {}}, "logic": {}, "severity": {}, "text": {}, "textHelp": {}, "onStartup": {"type": "boolean"}, "audited": {}, "hidden": {}, "broadcast": {}, "facility": {}, "routing": {}}, "additionalProperties": true, "required": ["expressions", "logic", "severity", "text", "textHelp", "onStartup", "audited", "hidden", "broadcast", "facility"]} |
template.schema.json | expressions | Array of logical expression than should return a boolean value | {"type": "array", "items": {}} |
template.schema.json | text | Alarm/event descriptive text | {} |
template.schema.json | textHelp | Descriptive information that help to understand the alarm | {} |
template.schema.json | onStartup | Indicates wether the alert must be sent when the conditions are met from the beginning | {"type": "boolean"} |
template.schema.json | evaluationForAlarmsDef | Array with all the evaluations that will be checked | {"type": "object", "properties": {"expressions": {"type": "array", "items": {}}, "logic": {}, "severity": {}, "text": {}, "textHelp": {}, "onStartup": {"type": "boolean"}, "audited": {}, "hidden": {}, "broadcast": {}, "facility": {}, "routing": {}}, "additionalProperties": true, "required": ["expressions", "logic", "severity", "text", "textHelp", "onStartup", "audited", "hidden", "broadcast", "facility"]} |
template.schema.json | expressions | Array of logical expression than should return a boolean value | {"type": "array", "items": {}} |
template.schema.json | text | Alarm/event descriptive text | {} |
template.schema.json | textHelp | Descriptive information that help to understand the alarm | {} |
template.schema.json | onStartup | Indicates wether the alert must be sent when the conditions are met from the beginning | {"type": "boolean"} |
template.schema.json | valueDef | Value or rawValue of a datapoint | {"anyOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "array"}, {"type": "object"}]} |
template.schema.json | commonConfigDef | Datapoint common configuration object | {"type": "object", "properties": {"alias": {"type": "string", "examples": ["Packets errors", "Partner"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one character and less than 80 characters"}, "syntaxInfo": {"type": "string", "minLength": 0, "maxLength": 1200, "errorMessage": "Should be a string of at least one character and less than 1200 characters"}, "datapointType": {}, "datapointId": {}, "additionalProperties": false}, "required": ["datapointId", "datapointType"]} |
template.schema.json | alias | Alias name for the datapoint, used as representation label | {"type": "string", "examples": ["Packets errors", "Partner"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one character and less than 80 characters"} |
template.schema.json | description | Detailed information about the datapoint | {"type": "string", "examples": ["Number of packets dropped for error", "Name of the partner"], "minLength": 0, "maxLength": 1200, "errorMessage": "Should be a string of at least one character and less than 1200 characters"} |
template.schema.json | syntaxInfo | Description about the syntax of this datapoints values | {"type": "string", "minLength": 0, "maxLength": 1200, "errorMessage": "Should be a string of at least one character and less than 1200 characters"} |
template.schema.json | addressConfigDef | Datapoint address configuration object | {"type": "object", "properties": {"dataType": {}, "originType": {}, "originDataType": {}, "originAddress": {}, "originAccessType": {}, "receiveMode": {}, "pollingGroup": {}}, "additionalProperties": false, "required": ["dataType", "originType", "originDataType", "originAddress", "originAccessType", "receiveMode", "pollingGroup"]} |
template.schema.json | alertConfigDef | Allows to configure trigger of alarms and events depending on the datapoint values | {"type": "object", "properties": {"evaluations": {"oneOf": [{"type": "array", "items": {}, "minItems": 1, "uniqueItemProperties": ["severity"]}, {"type": "array", "items": {}, "minItems": 1, "uniqueItemProperties": ["severity"]}]}}, "additionalProperties": false, "required": ["evaluations"]} |
template.schema.json | calcConfig | Allows to create new datapoints based on an expression | {"type": "object", "properties": {"expression": {}}, "additionalProperties": false, "required": ["expression"]} |
template.schema.json | convConfigDef | Allows to apply enrichment expressions on the value field | {"type": "object", "properties": {"expression": {}}, "additionalProperties": false, "required": ["expression"]} |
template.schema.json | defaultValueConfigDef | Allows to apply default values to a datapoint when the value or rawValue is null | {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "rawValue": {}, "value": {}}, "additionalProperties": false, "anyOf": [{"required": ["isDefault", "rawValue", "value"]}, {"required": ["isDefault", "value"]}, {"required": ["isDefault", "rawValue"]}]} |
template.schema.json | isDefault | Flag to indicate that the value is used as substitution value | {"type": "boolean"} |
template.schema.json | rawValue | Value to be assigned to rawValue field | {} |
template.schema.json | value | Value to be assigned to value field | {} |
template.schema.json | rowFilterConfigDef | Allows row filtering in table based datapointSets | {"type": "object", "properties": {"expressions": {"type": "array", "items": {}}, "logic": {}}} |
template.schema.json | expressions | Array of logical expression than should return a boolean value | {"type": "array", "items": {}} |
template.schema.json | unitsConfigDef | Allows converts between measure units | {"type": "object", "properties": {"from": {"type": "string", "examples": ["m", "g"]}, "to": {"type": "string", "examples": ["m", "g"]}, "toBest": {"type": "boolean"}, "exclude": {"type": "array", "items": {"type": "string", "examples": ["m", "g"]}}, "units": {"type": "boolean"}}, "additionalProperties": false, "anyOf": [{"required": ["from", "to"], "not": {"required": ["toBest", "exclude"]}}, {"required": ["from", "toBest"], "not": {"required": ["to"]}}]} |
template.schema.json | from | Actual measure units | {"type": "string", "examples": ["m", "g"]} |
template.schema.json | to | Desired measure units | {"type": "string", "examples": ["m", "g"]} |
template.schema.json | toBest | Select the measure unit that best fit | {"type": "boolean"} |
template.schema.json | exclude | Array of excluded measure units, when toBest is enabled | {"type": "array", "items": {"type": "string", "examples": ["m", "g"]}} |
template.schema.json | items | Exclude measure unit | {"type": "string", "examples": ["m", "g"]} |
template.schema.json | units | Flag to indicate that the unit of measure must indicated | {"type": "boolean"} |
template.schema.json | valueMapConfigDef | Allows converts rawValue to value based in a key/value map | {"type": "object", "properties": {"map": {"type": "array", "items": {"type": "object", "properties": {"key": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "integer"}]}}}}}, "additionalProperties": false, "required": ["map"]} |
template.schema.json | map | Key/Value map with the conversion options | {"type": "array", "items": {"type": "object", "properties": {"key": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "integer"}]}}}} |
template.schema.json | items | Entry in the key/value map | {"type": "object", "properties": {"key": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "integer"}]}}} |
template.schema.json | key | Entry key | {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]} |
template.schema.json | value | Entry value | {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {"type": "integer"}]} |
template.schema.json | datapointConfigDef | Object that define a complete datapoint configuration | {"type": "object", "properties": {"addressConfig": {}, "commonConfig": {}, "alertConfig": {}, "calcConfig": {}, "convConfig": {}, "defaultValueConfig": {}, "rowFilterConfig": {}, "unitsConfig": {}, "valueMapConfig": {}}, "additionalProperties": {"type": "object"}, "allOf": [{"if": {"properties": {"commonConfig": {"type": "object", "properties": {"datapointType": {"const": "#TIMEPOINT"}}}}, "required": ["commonConfig"]}, "then": {"properties": {"addressConfig": {}, "commonConfig": {}}, "required": ["commonConfig", "addressConfig"], "additionalProperties": false}}, {"anyOf": [{"required": ["commonConfig", "addressConfig"], "not": {"required": ["calcConfig"]}}, {"required": ["commonConfig", "calcConfig"], "not": {"required": ["addressConfig"]}}, {"required": ["commonConfig", "defaultValueConfig"], "not": {"required": ["addressConfig", "calcConfig"]}}, {"required": ["commonConfig", "defaultValueConfig, addressConfig"], "not": {"required": ["calcConfig"]}}, {"required": ["commonConfig", "defaultValueConfig", "calcConfig"], "not": {"required": ["addressConfig"]}}]}]} |
template.schema.json | datapointSetConfigDef | DatapointSet configuration object | {"type": "object", "properties": {"datapointSetType": {}, "datapointSetId": {}, "alias": {"type": "string", "default": "none", "examples": ["Port information"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one characters and less than 80 characters"}, "tableAddress": {}, "broadcast": {}, "routing": {}, "datapoints": {"type": "array", "items": {}, "minItems": 1, "errorMessage": "Should be an array of datapoint configuration objects. There should be at least one datapoint in a datapointSet"}}, "additionalProperties": false, "required": ["alias", "datapoints", "datapointSetId", "datapointSetType", "description"], "allOf": [{"if": {"properties": {"datapointSetType": {"enum": ["tableStatic", "tableDynamic"]}}}, "then": {"required": ["tableAddress"]}}]} |
template.schema.json | alias | Alias name for the datapointSet, used as representation label | {"type": "string", "default": "none", "examples": ["Port information"], "minLength": 1, "maxLength": 80, "errorMessage": "Should be a string of at least one characters and less than 80 characters"} |
template.schema.json | description | Detailed information about the datapoint set | {"type": "string", "default": "none", "examples": ["Information and statistics about the ethernet interfaces"], "minLength": 0, "maxLength": 1200, "errorMessage": "Should be a string of at least one characters and less than 1200 characters"} |
template.schema.json | datapoints | Array of datapoints for this datapoint set | {"type": "array", "items": {}, "minItems": 1, "errorMessage": "Should be an array of datapoint configuration objects. There should be at least one datapoint in a datapointSet"} |
template.schema.json | representationDataDef | Datapoints that widget will use for representation | {"type": "string", "pattern": "^device\\[[a-zA-Z0-9_-]{1,40}((\\.[0-9]+)?\\.[a-zA-Z0-9#&_-]{1,80})?\\]$", "examples": ["device[deviceInfo]", "device[deviceInfo.deviceSatate]", "device[pnioAPIs.0.cmInitiatorStationName]"], "errorMessage": "Data should be an string of device[datapointSetId] or device[datapointSetId.datapointId]"} |
template.schema.json | representationMapConfigDef | Specific configuration for map widget representation | {"type": "object", "properties": {"format": {"type": "array", "items": {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]}, "minItems": 1}}, "additionalProperties": false, "required": ["format"]} |
template.schema.json | format | Representation for each row | {"type": "array", "items": {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]}, "minItems": 1} |
template.schema.json | items | Row configuration | {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]} |
template.schema.json | order | Number of the row | {"type": "integer", "minimum": 0, "examples": [0, 1, 2]} |
template.schema.json | alias | Text to display | {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]} |
template.schema.json | fieldType | Format for row value | {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]} |
template.schema.json | utc | Format date to UTC time | {"type": "boolean"} |
template.schema.json | representationTableConfigDef | Specific configuration for Table widget representation | {"type": "object", "properties": {"format": {"type": "array", "items": {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}, "fieldGroup": {"type": "string", "enum": ["basic", "advanced"]}, "filterable": {"type": "boolean"}, "filterType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "width": {"type": "integer", "minimum": 1, "examples": [60, 120, 200]}, "minScreenSize": {"type": "string", "enum": ["xs", "s", "m", "l"]}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]}, "minItems": 1}, "pageSize": {"type": "number", "minimum": 2, "maximum": 10, "examples": [6, 7, 9]}, "filterable": {"type": "boolean"}}, "additionalProperties": true, "required": ["format"]} |
template.schema.json | format | Representation for each column | {"type": "array", "items": {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}, "fieldGroup": {"type": "string", "enum": ["basic", "advanced"]}, "filterable": {"type": "boolean"}, "filterType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "width": {"type": "integer", "minimum": 1, "examples": [60, 120, 200]}, "minScreenSize": {"type": "string", "enum": ["xs", "s", "m", "l"]}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]}, "minItems": 1} |
template.schema.json | items | column configuration | {"type": "object", "properties": {"order": {"type": "integer", "minimum": 0, "examples": [0, 1, 2]}, "datapoint": {}, "alias": {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]}, "fieldType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "utc": {"type": "boolean"}, "fieldGroup": {"type": "string", "enum": ["basic", "advanced"]}, "filterable": {"type": "boolean"}, "filterType": {"type": "string", "enum": ["string", "boolean", "numeric", "date", "severity"]}, "width": {"type": "integer", "minimum": 1, "examples": [60, 120, 200]}, "minScreenSize": {"type": "string", "enum": ["xs", "s", "m", "l"]}}, "additionalProperties": false, "required": ["order", "datapoint", "alias"]} |
template.schema.json | order | Number of the column | {"type": "integer", "minimum": 0, "examples": [0, 1, 2]} |
template.schema.json | alias | Text to display | {"type": "string", "minLength": 1, "maxLength": 80, "examples": ["Name", "Type", "Netmask"]} |
Subsets and Splits