IDS Conventions

Before you read this page, you need to have the basic knowledge of IDS. Please start with Understanding IDS Design if you are new to it and then come back.

Introduction

If you want to create your own IDS, you need 3 files in your IDS folder:

  • schema.json
  • elasticsearch.json
  • athena.json

Because TetraScience uses Elasticsearch and AWS Athena for data indexing, every IDS must follow certain rules when creating these files for your data to be correctly indexed. The IDS Convention is a set of rules IDS designers should follow when designing IDS, otherwise your data may not be correctly indexed.

In general, the convention can be broken down into two parts:

520520
  • Platform Requirements: the rules every IDS must follow
  • Design Guideline: the rules mainly for design consistency across different IDS. TetraScience has abstracted data and formed opinions on the data structure. TetraScience developers are following this guideline.

Each file has a convention doc associated with it. You need to start with schema.json. Then move on to elasticsearch.json and athena.json.

Convention Doc Links

IDS Validator

TetraScience has an IDS validator that will validate whether your IDS complies with the platform requirements when you deploy it. The validator can be found here: https://github.com/tetrascience/ts-ids-validator