4.2 Schema
Each FOCUS dataset must have a metadata about the schema associated with it. The schema metadata provides information about the structure of the data provided.
4.2.1 Schema ID
The Schema ID provides the reference item to associate which Schema was used for the generation of a FOCUS Dataset.
The SchemaId MUST be present in the metadata. The SchemaId MUST be of String. It is RECOMMENDED for SchemaId to be a Universally Unique Identifier (UUID) or SemVer version.
4.2.1.1 Metadata ID
SchemaId
4.2.1.2 Metadata Name
Schema ID
4.2.1.3 Introduced (version)
1.0
4.2.2 Creation Date
Date the schema was created.
The CreationDate MUST be present in the metadata. This MUST be of type Date/Time and MUST NOT contain null values. CreationDate MUST conform to Date/Time Format.
4.2.2.1 Metadata ID
CreationDate
4.2.2.2 Metadata Name
Creation Date
4.2.2.3 Introduced (version)
1.0
4.2.3 FOCUS Version
The version of FOCUS utilized for building the dataset.
The FocusVersion MUST be provided in the metadata. FocusVersion MUST be of type String and MUST NOT contain null values. FOCUSVersion MUST match one of the published versions of the FOCUS specification. FocusVersion MUST match the version of the FOCUS specification that the FOCUS dataset conforms to.
4.2.3.1 Metadata ID
FocusVersion
4.2.3.2 Metadata Name
FOCUS Version
4.2.3.3 Introduced (version)
1.0
4.2.4 Column Definition
The FOCUS metadata schema column definition provides a list of the columns present in the FOCUS dataset along with metadata about the columns.
4.2.4.1 Column Name
The name of the column provided in the FOCUS dataset.
The ColumnName MUST be provided in the FOCUS Metadata schema. ColumnName MUST be of type String and MUST NOT contain null values.
4.2.4.1.1 Metadata ID
ColumnName
4.2.4.1.2 Metadata Name
Column Name
4.2.4.1.3 Introduced (version)
1.0
4.2.4.2 Data Type
The data type of the column provided in the FOCUS dataset.
The DataType MUST be provided in the FOCUS Metadata schema. DataType MUST be of type String and MUST NOT contain null values.
4.2.4.2.1 Metadata ID
DataType
4.2.4.2.2 Metadata Name
Data Type
4.2.4.2.3 Introduced (version)
1.0
4.2.4.3 Numeric Precision
Numeric Precision is the maximum number of digits for the values in the column.
NumericPrecision SHOULD be provided in the FOCUS Metadata schema for Numeric Format columns. NumericPrecision MUST be of type Integer and MUST NOT contain null values.
4.2.4.3.1 Metadata ID
NumericPrecision
4.2.4.3.2 Metadata Name
Numeric Precision
4.2.4.3.3 Introduced (version)
1.0
4.2.4.4 Number Scale
The number scale of the data provides the maximum number of digits after the decimal point in decimal numbers.
NumberScale SHOULD be provided in the FOCUS Metadata schema for Decimal columns. NumberScale MUST be of type Integer and MUST NOT contain null values.
4.2.4.4.1 Metadata ID
NumberScale
4.2.4.4.2 Metadata Name
Number Scale
4.2.4.4.3 Introduced (version)
1.0
4.2.4.5 Provider Tag Prefixes
The Provider Tag Prefixes defines the list of prefixes used in the tag name of provider-defined tags. This metadata is useful for the consumer to identify which tags are provider-defined vs user-defined.
The ProviderTagPrefixes MUST be provided when ColumnName is equal to Tags. The ProviderTagPrefix MUST be of type Array of Strings. The ProviderTagPrefixes SHOULD be easily associated with the provider who generated the FOCUS dataset.
4.2.4.5.1 Metadata ID
ProviderTagPrefixes
4.2.4.5.2 Metadata Name
Provider Tag Prefixes
4.2.4.5.3 Introduced (version)
1.0
4.2.4.6 String Encoding
The string encoding scheme of the column provided in the FOCUS dataset.
StringEncoding SHOULD be provided in the FOCUS Metadata schema when it is required to know this information in order to successfully read the data. StringEncoding MUST be of type String and MUST NOT contain null values.
4.2.4.6.1 Metadata ID
StringEncoding
4.2.4.6.2 Metadata Name
StringEncoding
4.2.4.6.3 Introduced (version)
1.0
4.2.4.7 String Max Length
The string max length of the data that can be stored in the column.
StringMaxLength SHOULD be provided in the FOCUS Metadata schema for String columns. StringMaxLength MUST be of type Integer and MUST NOT contain null values.
4.2.4.7.1 Metadata ID
StringMaxLength
4.2.4.7.2 Metadata Name
String Max Length
4.2.4.7.3 Introduced (version)
1.0