Getting Started

Getting Started

For more details on specifics of workflow and toolbox schemas, differences, and full examples, see the links below: Workflow Schema

Overview

Form Bio schemas currently support the configuration of workflows and toolbox tools as JSON. They define metadata for the workflow or tool, the necessary and optional parameters needed for a successful run, how those parameters should be presented in forms in our web application, as well as conditionals that allow the schema to dynamically respond to certain input values being provided by users.

Schemas between workflows and tools differ slightly but overall follow the same pattern centered around inputs, ui, and conditionals properties.

Inputs

The inputs property represents the parameters to be passed into the run. They can be static inputs or field inputs. See Inputs for more information.

UI (and Groups)

The ui property gives users the ability to display field inputs in a particular order when displayed in the web application, while also allowing for aggregating field inputs into separate groups. See UI (and Groups) for more information.

Conditionals

The conditionals property allows users to configure highly dynamic forms for the web application by allowing field inputs’ and groups’ properties to change based on values for other inputs provided by a user. See Conditionals for more information.