Tray Platform / Getting Started / Editing Workflows

Editing Workflows

Undo workflow changes

When making changes to your workflow, it is possible to undo/redo your changes using the appropriate buttons in the top-left corner of the workflow editor:

Changes are grouped in timed batches. When you undo, it will undo the last three seconds worth of steps (i.e. the last three seconds worth of editing activity as recorded on the server).

Note: when editing workflows you should be careful with refreshing your page. The changes available for an undo action are stored in the current page session and will be lost with a page reload!

Before undoing any changes, you will be informed what changes will be included in the undo:

Once an undo is made you can, of course, redo by clicking on the redo button.

Rollback workflow history

Beyond simple undo / redo is the much more comprehensive 'Rollback Workflow History' function, accessed via the 'View History' link at the bottom of the workflow editor screen:

You will immediately see that this allows you to go back through workflow edits made on particular dates.

IMPORTANT!: The previous versions of your workflow which you can rollback to are only stored for 30 days. So if your last edit was perhaps three months ago then you would see the record of the changes in the edit history, but would not be able to rollback to those workflow versions before the edits.

Note also that the edit history (just the record of the changes) is only stored for 12 months.

In the following screenshot there is a 'Rollback to this Version' option for changes that were made on both the current and as would be displayed for alternative dates:

Filters and searches

PLEASE NOTE: The search bar options vary depending on which search bar or panel setting you are in.

The Step Search bar helps you locate particular connector steps (and triggers) within your workflows.

Due to the potential size of workflows, it can be difficult to locate a particular workflow step. This is where the Step Search Bar comes in handy.

Options will display as soon as the cursor is present:

The search bar can help filter and find connector steps by the following filters:

  • Type
  • Description
  • Name

Once the desired step is selected, the search bar will automatically redirect you to the chosen connectors input panel:

Version history panel

Within the the Version History panel, you have the option to filter by Actions, Dates and users:

When the show only my activity' option is selected, this will add a further refinement to your search results:

In the logs debug panel, you can filter your runs by clicking on the search bar. This will show that you can filter the runs by action, date (before/after), user and more besides:

Undoing a rollback

When you rollback to a previous version the rollback will become the latest edit at the top of the workflow timeline:

So in order to undo, you can just rollback to the most recent edit before the rollback.

Changing step input property types

Some step input properties can be represented by different types, such as String, Number, Boolean, Object, Array, Null and JSON Path. If you want to change the type for a particular input property, you can use the TYPE SELECT button to the right of the properties label.

It most often appears as the letter A as the default is set to string/ text.

Renaming a workflow step

You can change the title of a step in your workflow so that it is more identifiable to the task that it is performing.

Hovering over a step will bring up the edit name option as will using the 'Describe' section.

Editing step description

Hovering over a step will also bring up the 'Edit Step Description' option.

Adding Step Descriptions is best practice - it allows you to add a detailed explanation of what the current step is actually doing. This is of great benefit to yourself and particularly to co-workers (particularly less technical ones!) with whom you are sharing your workflows. It is a powerful tool to help them understand what your workflows are doing.

Copying & pasting workflow steps

When you copy a step, you also copy the configuration. This can save you time an effort especially for workflows that need several similar connector steps. You can copy/ duplicate all the different types of connectors available (Core, Helper, etc) but please remember that the nested steps under or within them will not be copied.

The main reasons for wanting to repeat a workflow step are as follows:

  • Duplication will give yourself a similar base to build on a similar step process.
  • You wish to repeat the current step configuration onto another connector step.
  • The same step is necessary within a separate workflow.
  • There is a need to reproduce a workflow step and using the loop connector is not possible - see Loop connector documentation for more details.

Depending on WHERE you wish to reproduce your workflow step, will dictate the best copy method to use:

  1. Duplicate Step: You wish to create an identical step within your current workflow.
  2. Copy & Paste Step: You wish to create an identical step within a completely separate workflow or you need to duplicate the configuration of one step into another.

Hovering over and right clicking a step will bring up all the copy type options available (you can also click on the three dots displayed when you hover over the connector step for the same result):

Duplicating

Hover over the step you wish to copy and right click the connector itself. Your option for duplication will be displayed as follows:

Click on this option, and immediately you will have the same step replicated below the original - including all properties and settings:

Copying & pasting

Basic

Hover over the step you wish to copy and right click the connector itself. You can copy either by clicking the option displayed, or by using keyboard shortcuts such as: Option + C on Mac, Alt + C on Windows. Just make sure that the step itself is highlighted / selected if you are using keyboard shortcuts.

Once you have selected 'Copy step', move to the area that you wish to paste said step - you can do this by either hovering over the plus symbols + or over the blank connectors, that are available within your alternative (or current) workflow.

Provided you have correctly copied your step, when you move to your alternative workflow, right clicking either of these symbols will result in the 'Paste step' option displaying. Once again standard keyboard shortcuts apply as one of your pasting options: Option + V on Mac, Alt + V on Windows machines.

Note that if you do use the keyboard shortcut to paste your connector, it will result in a "floating step". This means that your connector will need to be deliberately dragged and placed into your desired workflow space.

See the below gif for more details (as keyboard shortcuts are utilised the keys themselves are not displayed but the end product is).


Once selected, your "new" connector step will have loaded itself onto your workflow, and will include all the settings, text and properties specified from the original step!

Note that you can only copy ONE STEP at a time - not multiple steps, but that like most copy/ paste instances, you do not have to re-copy to re-paste the same item. It will be stored in memory and you can re-paste to your hearts content until you copy another connector step.

Overwriting configuration

You can also use this method to overwrite the current configuration of another connector step. This means you will not have a "second" connector step as your pasted result; rather that the properties from the original step will be implanted into your other connector.

In order to use this method, select a connector step to copy ('List form fields').

Right click the connector who's configuration you wish to over-ride ('Get submission answers'), and select 'Paste configuration'.

As you can see from the example, the connector which was once 'Get submission answers' has now become a second 'List form fields' step.

Saving snippets

The snippets feature of Tray.io is a very powerful way of saving and reusing preconfigured steps in your workflows. It can act as both a great timesaver and a way to reduce errors and improve consistency in how you work.

For example you may have gone through quite a bit of work with the HTTP client to get a call to a particular endpoint working and you want to save yourself the trouble of having to do it again and again.

In the following example we are making a call to the Spotify /albums endpoint, with the authentication header set up correctly:

Once you have clicked 'save snippet' your snippet will appear at the top of the left-hand connector library:

Your snippets can then be dragged and used in any workflows like any other connector!

While you can use your snippet library in organization workflows, currently they are only visible to you and not other members of your organization

Replaying workflow runs

In the Logs page (please see the Logs and Troubleshooting article), you can "replay" previous runs of a workflow:

This allows you to re-run a previous run of a workflow, based on a trigger that was previously sent.

Common reasons for replaying workflow runs are:

  • There was an error in one of your workflow steps
  • A third party API went down for a long period of time
  • Your workflow is a scheduled workflow, and you want to manually re-trigger it

How replays work

When you replay a workflow run, the original data sent to the trigger is used to trigger the workflow again. If you've made changes to the workflow since the trigger, the workflow will be run using the current workflow configuration. (Not how the workflow was configured when it was originally run)

Running your workflow

When you are finished with your workflow or want to test that it works as expected you will want to run it. Most workflows have ENABLE and DISABLE buttons in the bottom right. In order for your workflow to run you need to enable it. Once enabled the workflow will run depending on the trigger that you have set up for that workflow.

If you have a workflow with a manual trigger then you will have a RUN WORKFLOW NOW button which will immediately run the workflow once.

Viewing advanced properties

Sometimes a step will have less common input properties which are not displayed by default.

These properties are called Advanced Properties and can be modified clicking on Show Advanced Settings button withing the Input/ Output data tabs.

Advanced input properties will then be visible along with the rest of the step input and highlighted with a darker background. Note that depending on the number of options available, you may need to scroll down in order to view this button.