Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

What is “Structural Metadata”?

Structural metadata describes the variables within a dataset. This was previously referred to as Technical Metadata.

What do I need to include?

We recommend sites to provide a data dictionary of structural metadata that includes the following information:

...

Metadata Field

Completion Guidance

Constraints

Mandatory?

Table Name *

Name of the table in the dataset. Use a fully qualified name if appropriate.

255 characters max

Yes

Table Description

Description of the table in the dataset.

20,000 characters max

No

Column Name *

Name of the column in the table dataset

255 characters max

Yes

Column Description *

Description of the column in the table dataset.

20,000 characters max

Yes

Data Type  *

Type of data contained in the column.

255 characters max

Yes

Where can I see some concrete examples of valid Structural Metadata?

Please see the following example for your reference. If you require further clarification, we also have several fully populated submissions from other sites that we would be happy to walk through with you. Please contact us via Service Desk to arrange a session.

Structural Metadata Example

Table Name

Table Description

Column Name

Column Description

Data Type

Summary

The summary

Identifier

The identifier

String

Summary

The summary

Title

The title

String

Summary

The summary

Description

The description

String

Required

The required elements

Release Date

The release date

Date

Required

The required elements

Data Controller

The controller

String

Required

The required elements

Data Processor

The data processor

String

Required

The required elements

License

The license

String

Recommended

The recommended elements

Periodicity

The periodicity

Integer

Recommended

The recommended elements

Frequency

The frequency

String

What format should this be in?

The standard format required is an excel file which includes the Metadata Fields listed in the table above (Table Name, Table Description, Column Name, Column Description, Data Type, Sensitive).

...

View file
nameStructuralMetadataTemplateForONS.xlsx

Is an Excel spreadsheet the only option in which I can upload metadata?

Definitely not! The simple excel template is used as the low common denominator that makes our "lite" user interface as accessible as possible.

...