TetraScience

Tetra Data Platform Documentation

Welcome to TetraScience Tetra Data Platform (TDP) documentation site. Here, you'll find Product Documentation, API Documentation, and Release Notes for TDP components.

Release Notes    API Documentation

Viewing an IDS and Associated Artifacts

TDP has a schema viewer that you can use to view the IDS. The following video walks you through how to search for a schema, how to interact with the visualization, and which types of artifacts are available for each IDS.

Searching for a Schema and Viewing the Schema Visualization

To search for a schema, complete the following steps.

  1. Select Data Schemas, then View IDS Types from the main menu.
Main menu buttonMain menu button

Main menu button

Main menu optionsMain menu options

Main menu options

  1. The View IDS Types page appears. It has three parts - a list of IDS Types, a Schema Viewer, and a Details section.

  2. To find the schema that you are interested in, either use the scrollbar to scroll through the list of IDS types or type a term in the search filter. For example, if you type "empower" you will see IDS types with the name "empower" included.

  3. The schema that you chose appears in the center of the screen. Note that:
    *The schema displays name of each field in the schema, along with its type (string, null, object, array, number)

  • The root node is properties.
  • Clicking on a field name that has a darkened circle beside it (node) displays child field(s). Click the field name again to hide the nodes.
  • A field name that has an empty circle beside it has no child nodes.
  • Some IDS's are rather large. To make more room to see them, click the Hide Details button to hide the "Details" section of the page.
  • To display the "Details" section of the screen again, click the Show Details button.
IDS Types pageIDS Types page

IDS Types page

Display Artifacts Associated with a Schema

To display artifacts associated with a schema, complete the following steps.

  1. Select Data Schemas, then View IDS Types from the main menu.
  2. The View IDS Types page appears. It has three parts - a list of IDS Types, a Schema Viewer, and a Details section.
  3. To find the schema that you are interested in, either use the scrollbar to scroll through the list of IDS types or type a term in the search filter.
  4. In the "Details" section of the screen, the README.md file appears by default. You can use the drop down menu to view the different files. The following table lists each file and its description.

File Name

Contents

athena.json

Helps to create the athena index.

elasticsearch.json

Helps to create elasticsearch index.

Elasticsearch Mapping

Resulting mapping after indexing occurs.

expected.json

Used primarily as a human-readable example; provides an example of what the resulting JSON should look like once processing is complete.

README.md

Provides details about the file as well as updates.

schema.json

IDS json file. This file is used in the pipeline for validation.

Updated 6 months ago


Viewing an IDS and Associated Artifacts


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.