IDS artifact overview

“IDS artifact” refers to the collection of files which define an Intermediate Data Schema along with a specification for how the data integrates with other parts of the Tetra Data Platform such as Elasticsearch and Athena.

An IDS artifact consists of the following files:

  • schema.json: A JSON Schema definition, including property names and their data types, as well as metadata like field descriptions, and the overall structure and hierarchy of supported data. This is the schema definition of an Intermediate Data Schema which is used across the Tetra Data Platform - more information can be found in the IDS overview documentation.

  • elasticsearch.json: A specification for how data is integrated with Amazon Elasticsearch.

  • athena.json: A specification for how data is integrated with Amazon Athena.

  • expected.json: An example of JSON data which is a valid instance of this IDS, i.e. it is valid against schema.json using JSON Schema validation.

  • manifest.json: A manifest of the contents of the IDS such as its namespace and slug. This is used in task scripts and protocols. This file is not required for self-service artifacts uploaded with ts-sdk.

For more documentation about IDS artifact files and how to view them on the Tetra Data Platform, see the developer docs for viewing artifact information.

Each of these files has platform requirements - a set of rules the files need to comply with in order to make a valid IDS artifact which the Tetra Data Platform can use. The documentation in these pages explains how to create a valid IDS artifact using ts-ids-core and related tools.