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 Protocol Scripts

Protocols script files that contain the configuration and code needed to process data and produce output data or files. You can view some of these files on the Manage Pipeline page. For an overview of pipelines see the Pipeline Overview page.

To view protocol scripts, complete the following steps.

  1. In the TDP, select View Master/Task Scripts from the main menu.
  2. The list of scripts appear.
  3. Use the search box to narrow the number of scripts.
  4. Select the script you want to look view from the left side of the page.
  5. Information about the script appears on the right-hand side of the page. Select the version number if there is more than one. The source, the repository commit number, build number, and when it was created appears on the screen.
  6. You can view the following script files.
    • script.js – Runs the protocol, which is in protocol.json. Declares the inputFile and result variables, then returns the result. The namespace, slug, and version are part of the result script.
    • protocol.json – Provides information about steps and configurations. Protocol.json references the names of the task scripts associated with each of the steps, as well as the configurations that are needed for the protocol to run. Displays the protocol’s name, description, step number, step number.slug, step number.description, step number.type – and the step number.script.slug and step number.script.version variables.
    • build-record.json – displays information about the build for the script.js, README.md, and protocol.json files.

Updated 7 months ago


Viewing Protocol Scripts


Suggested Edits are limited on API Reference Pages

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