Config - ConfigDoc

The ConfigDoc document is a configuration document that sits at the highest document level. Each of the child documents in a Configuration Document Collection reference the ConfigDoc document.

The ConfigDoc document provides an overview of the type and structure of data contained in the child documents, it also acts as a basic meta data container to describe the data stored by this configuration.

Field Data Type Required Default Description
id String Yes - A unique identifier that is referenced by all other documents see section Unique Id Generation.
subConfigDocs Array [SubConfigDoc] No - An array of SubConfigDoc that store the metadata data recorded.
timeSpanDocs Array [TimeSpanDoc] No - An array of TimeSpanDoc which hold segmented time intervals at which data was recorded.
startTime 64-bit Long No - A 64-bit Long timestamp specifying start time of the data that this document holds. If this document holds no data, then the value represents the last modified time of the source document.
endTime 64-bit Long No - A 64-bit Long timestamp specifying end time of the data that this document holds. If this document holds no data, then the value represents the last modified time of the source document.
timeOffset 64-bit Long No - A 64-bit Long value specifying the time offset in nanoseconds that is applied to all timestamp fields within the collection of subConfigDocs documents in this document.
description String No - A free form string description of the data that this document holds.
name String No - A free form string name for the data that this document holds.
source String No Regno The source file name (including extension) for the data held by this document.
state String No Unknown A free form string description of the state of this document. This field can be excluded when generating the id.
sourceType Fixed String No Data A fixed type description of the primary data held by this document. Valid options are: Configuration, Data, Experiment, Simulation, Run, Period, Session, Event, Day, Month, Year, Lap, Audio, Video, Metrics.
tags Array [TagDoc] No - An array of TagDoc (key/pair) free form string values. Used to store meta data related to the data stored by this document.
configDefsDocIds Array [String] No - An array of the unique identifiers (id) of each associated ConfigDefinitionsDoc document. Used for informational purposes to enable fast retrieval of all the definitions used in a single Configuration Document Collection. This field can be excluded when generating the id.
identityDocIds Array [String] No - An array of the unique identifiers (id) of each associated IdentityDoc document.
type Fixed String Fixed ConfigDoc The fixed value is always set to ConfigDoc.