Documentation - Overview
Regno Standard documents are a collection of plain text documents using the industry standard JSON format. Each of the Regno Standard documents provides a subset of functionality that when combined provide a rich specification to handle all data types irrespective of format or source.
Each of the Regno Standard documents is described in detail using the side bar links to the left. Each document detail contains an overview summary followed by a detailed specification table.
Each document table contains the following columns:
- Field
- Data Type
- Required
- Description
Time Domain: All timestamps in the Regno Standard are represented as the number of nanoseconds since the reference time of midnight, 1st January 1970.
Required Fields: For all tables fields with the “Required” column set to a value of “True”, the Field
name and value must be included in the document with a valid value as defined in the Description.
Fixed Values: For some table fields there exists only a fixed set of allowed values. Where ever the Data Type
of a Field is set to “Fixed String”, the value for that Field must use one of the allowed values as
defined in the Description column. For some fields there exists only a single allowed value.
Structure: When discussing documents in the context of a single data set instance, the complete set of documents
relating to a single data set is called the “Configuration Document Collection”. For
each data set there will be a single ConfigDoc document and N number of associated child documents
of various types. Each of the child documents will contain a reference to the
parent ConfigDoc document by populating the field configDocId with
the id value of the parent ConfigDoc document.