Tray Embedded / Getting started / Glossary of terms

Glossary of terms

  • On this page

When using Tray Embedded you will come across some common terms:

Workflows - These are the 'building blocks' of your integrations. A Tray workflow is what you use to build a sequence of related actions, as per the below example of sending a message to a Slack channel when a particular Trello Board is updated:

Note: Tray Embedded is a distinct product offering. Therefore when you have a Tray partner account activated, it is strongly advised that you do not try to add previously-created workflows to your projects. You should create new workflows to add to your projects.

Project workflows - Workflows that make up a project.

End users - The users of your integration.

Partner User - A user in your own administrating company.

Projects - These are a collection of related workflows, i.e. workflows working towards a common goal. Workflows must always be added to a Project.

Project configuration - When using Tray Embedded the config data you set can be shared between workflows in the same project (unlike in the Tray direct platform where config data is kept to within a single workflow)

Config Data - Workflows contain variables (e.g. Slack channel, Trello board ID) which might need to be set by the End User of your solution. In the workflow configuration screen (accessed via the settings wheel in the top left corner of the edit workflow screen), these can be set as Config Data which can be named something like "slack_channel" and "slack_message" before being added to a relevant field in the step editor as $.config.slack_channel and $.config.slack_message. Any Config Data set in this way can then be used to allow the user to set their own data in the Configuration Wizard.

Solutions - You can create a 'solution' based on the workflows contained within a project. The solution will include all of the project workflows. Via our API, this solution can then be included in your application and will be available for your End Users to activate and configure for their own use.

Solution Instance - When an End User activates a Solution for their own use, they create a Solution Instance

Authentication Data - The data which is required (url, username, access_key etc.) when End Users are activating Solution Instances and authenticating with the required services. It is possible to import already-made authentications as described in Importing authentications

Configuration wizard - In your application, when an end user clicks to use a solution, a wizard will pop up that they can use to add their own authentications and configurations for the solution (e.g. authenticate their Slack and Trello accounts and specify the content of automated messages).

Solution Release - A live version of a solution. When a solution is edited (e.g. new features are added) a new version of that solution is created. All end users who are using that solution will be updated with the new features the next time the Solution Instance is used/triggered.