Tray Platform / Getting Started / Using the builder

Using the builder

There are many features available within the workflow builder that are specifically designed in order to help you create and manage your workflows more efficiently and effectively.

Builder Menu Bar

Below is a breakdown of the Builder menu bar.

builder-menu-full

Below is a breakdown of the footer options available within the builder.

builder-footer-full

Workflow Settings

Below is a breakdown of the Builder menu bar -> Options -> Settings feature in further detail.

Please make sure to note the best practices recommended where relevant.

builder-settings-1
builder-settings-2

Editing connector steps

The Properties Panel

Each workflow step has a 'properties panel' which allows you to make all the relevant settings to get that step working:

props-panel

The properties panel has the following key features:

Working with input data

The Input tab fields vary depending on the connector and operation selected.

Every operation will have its own input requirements.

Always check the relevant Tray.io documentation for more information on operations and input fields.

The most common method of data input is to pull data from a previous workflow step or trigger. Please see our documentation on working with jsonpaths for a full guide on how to do this.

builder-input-main-v2

Working with output schema

In Tray.io, data output from one step is most commonly used as input for subsequent steps. Please see our documentation on working with jsonpaths for a full guide on how to do this.

The Output Data tab automatically generates the output schema (and associated jsonpaths):

builder-output-1

Searching

Searching workflow steps

Searching and adding connectors

Searching workflow logs

Copying & Pasting steps

PLEASE NOTE: If you are looking for information on how to copy the jsonpath for a particular field value checkout the Properties panel: Output data: Copy jsonpath section above for the walk through.

Overview

When you copy a step you also copy the configuration.

This will save you time and effort especially in workflows that need several similar connector steps.

Some examples for wanting to repeat a workflow step include:

  • You wish to repeat the current step and its configuration in your workflow.

  • The same step is necessary within a separate workflow.

  • You wish to create a very similar step to what you currently have.

  • You wish to save your step and its configuration for future use in this and other workflows.

  • There is a need to reproduce a workflow step and using the loop connector is not possible. See Loop connector documentation for more details on this use case.

Which method?

Where you wish to reproduce your workflow step will dictate the best copy / paste method:

  1. DUPLICATE: You wish to create an identical / similar step within your current workflow either next to or in close proximity to your copied step.

  2. COPY / PASTE: You wish to create an identical / similar step in another aspect of your workflow. Or within a completely separate workflow you have editing rights to.

  3. SAVE SNIPPET: You wish to save this step and its configuration for repeated use long term.

Basic info

In order to view the copy options available, hover over the step you wish to copy (regardless of method).

Either select the options button (that will become apparent) or right click the connector.

IMPORTANT!: Warnings will display if there are any failures to copy / paste your steps.

builder-copy-paste-info

History (rollback workflow edits)

IMPORTANT!: Please take note that your changes are grouped and recorded in timed batches. The timing varies depending on the reverting tool you choose. See below accordion tabs for more details.

Note that the Undo / Redo buttons reverse the effects of a recently taken action.

Rollbacks allow you to search through the workflow history and return to a previously auto-recorded workflow state.

Misc editing

Workflow scrolling and navigation

Replacing the trigger