View an IDS and Associated Artifacts

The Tetra Data Platform (TDP) has a schema viewer that you can use to view the IDS. The following video describes:

How to search for a schema
How to interact with the visualization
Which types of artifacts are available for each IDS

Search for a Schema and View the Schema Visualization

To search for a schema:

Select Data Schemas, then View IDS Types from the hamburger main menu.
The View IDS Types page appears. It has three parts - a list of IDS Types, a Schema Viewer, and a Details section.
To find the schema you want, 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.
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 Hide Details to hide the "Details" section of the page.
To display the "Details" section of the screen again, click Show Details.

Display Artifacts Associated with a Schema

To display artifacts associated with a schema:

Select Data Schemas, then View IDS Types from the main menu.
The View IDS Types page appears. It has three parts - a list of IDS Types, a Schema Viewer, and a Details section.
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.
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. This 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.

Manually Reconfiguring an IDS Custom Filter

If you cannot find files when you apply a specific IDS custom filter, first confirm that the files can be found using a filter you manually configure. (NOTE: I’ll add the doc reference here for creating a query).

If you can find the files using the manual filter, but not with the IDS custom filter, there might be a problem with how the IDS custom filter was cached. To fix this, complete the following steps to delete the IDS custom filter and add it again.

Select View IDS Types from the hamburger menu.
Select the Schema from the left hand side of the screen. Make sure the right version is selected.
Select Configure Filter Fields from the right side of the screen.
Click the field that you want include in the filter.
Click Edit, then Remove to remove the search filter that is not working properly.
With Configure Search Fields still selected, click Edit, then click the node on the Schema View that you want to filter and click Done. The custom filter should be re-added.
Once you’ve done this, select Search Files from the Hamburger menu and try to filter the results again. The problem should be resolved.