Data Fields

For a more condensed summary this information is available in table view

The specification for Data has these fields:

name

Required-string
Name of the data resource.

Example

"CNSPiezoBolt#1 (in directory: factory 1 , machine1 , piezobolts)"

version

Optional-string
Version of the data resource (not of the metadata), defined by the provider in the format of his/her choice (typically: major.minor.patch)

Example

"1.0.0"

description

Optional-string
Human readable description of the data resource characteristics, contents.

Example

"This sensor measures temperature in Celsius, sends data via ConSenses edge device via an MQTT broker"

description_url

Optional-string
More detailed specification of data source characteristics (doc, pdf, …)

Example

"https://some-host/docs/data-source-specification-sheet.pdf"

size

Optional-integer
Estimated/exact size of data (e.g. file size, volume size, or message size); might be used to assess HW requirements (RAM, CPU). In bytes.

Example

tags

Optional-string[]
A list of tags freely added to help in searching/indexing (not limited to a basic set of tags, keywords)

Example

["sensor", "celsius", "press machine"]

kind

Required-enum [FILE, DATABASE, STREAM]
Main category of the data resource (e.g. file/object storage, database management system, streaming broker). FILE can mean a single file or a folder.

Example

"STREAM"

direction

Required-enum [SOURCE, SINK, BIDIRECTIONAL]
Direction of data flow (source: data provider, sink: data consumer/storage)

Example

"SOURCE"

format

Optional-string[]
Format/encoding of the data produced or consumed by the data resource as a MIME type (IETF RFC 6838 https://www.sitepoint.com/mime-types-complete-list/). More than one can appear here (remote directory with several files).

Example

["application/json"]

type

Required-string
The exact type of the data resource. Typically (but not always) corresponds to the scheme part (scheme://) of URI. E.g.: mysql, mqtt.

Example

"MQTT"

uri

Optional-string
Accessibility of the data resource, including host, port information, protocol, and other fields (path is protocol dependent, can be a topic name). GUI may show host, port, path separately. Hidden at search. Format: scheme://host:port/path. Pseudo vars: SCHEME, HOST, PORT, PATH, QUERY, FRAGMENT.

Example

["kafka://host/topic#1"]

auth_type

Required-string[]
One or more authentication types that can be accepted by the storage resource.

Example

["tls_client_certificate"]

credentials

Optional-string
Credentials (e.g. string/json, zip, config file). Its content (structure) depends on authentication type (e.g. token, username and password). OPEN means must not be filled here, but asked from user on startup.

Example

aux_info

Optional-string
List of key-value pais (JSON object/YAML dictionary) for additional specification of the data resource. New keys can be added on demand, a list of known keys is available.

Example

{"PROTOCOL": "tcp", "MQTT_PROTOCOL_VERSION": "3.1.1", "KAFKA_BROKER_VERSION": "2.7.0"}

schema

Optional-string
Describes message internal structure, semantics, ontology. It can be any file (doc, rdf, owl, etc.). Asset Administration Shell, IEC 61360 - Common Data Dictionary, ...

Example

"Messages constain raw sensor values as floats in Celsius, each is a JSON object with key name 'temperature'."

schema_url

Optional-string
URL to schema specification document (in some format, rdf, owl, xsd, …)

Example

"https://schemas.org/data.rdf"