Open Navigation

Setting Config Data

Please be sure to familiarize yourself with all sections of this page!

General use of project config data

Tray Embedded permits the use of Project Config Data.

This means that you can set Config Data which can be shared between Workflows in the same Projects and Solutions. You could then use, for example, "email-address" and "email-subject" as config data that is shared across multiple Workflows in the same Project (be sure to read the note on Avoiding Project Config Errors).

Project Config Data can be used for two main purposes:

  1. Set default values for the config data which are auto-set in all workflows. For example you wish "email-address" to be set as "info@acme.com" across all workflows. In this case you would set the default value as such, and set it to be hidden in the End User Config wizard so that it is set without the End User needing to know about it.

  2. Make fields available for End Users to set their own values in the End User Configuration Wizard. For example your goal might be for End Users to be able to e.g. set their own email address and over-ride the default value, specify the department they work in, or choose which Salesforce account types they are interested in. Any time you use Config Data in a workflow it will be available in the End User Configuration Wizard for an End User to set their own value, unless you set it to 'hidden' in the Solution Editor.

Creating config data

Prerequisite: Before reading this section, please be sure to look at the simple visual intro to how Config Data is managed on the Embedded Overview page here

In order to actually use Config Data in the workflow editor, you must use a JSON path in the form of $.config.<config-key> (e.g. $.config.email-subject)

When entering values into a field for any workflow step, you can create/enter config data by:

  1. Changing the file type to jsonpath
  2. Enter the config data using $.config.<config-key>

You can either click 'enter' to create the config data on the fly with no default value, or you can click the pencil icon to add a default value. You can also choose from a list of previously created config data.

The following animations show how Config Data is created using these methods:

You can create Config Data with no default value by typing and then hitting the 'enter' key:


Or you can create a default value by clicking the pencil icon when it appears:


You can also view and edit Project Config Data in the settings screen found by clicking on the settings wheel in the top-left corner of the screen:

config-data-settings-screen

Using config data in Projects and Solutions

When creating a Project you choose what workflows are included in the project:

choose-workflows-for-project

In the final project creation screen you will see that all of the config set in the selected workflows is pulled in and included as Project Config:

project-config-data

You can subsequently add more Project Config Data in this screen if needed.

Finally, when you are turning your Project into a Solution, you can then set exactly how you present your End Users with the Config Data options in the Solution Editor. Here you can set what number screen of the Config Wizard it appears in, and also add a prompt in the Description box:

solution-editor

Importing config data from external sources

If you already have a piece of data about an End User stored in your own external system (for example an email address, their department etc.), it is possible to import this without having to ask them to enter the data again.

This is done by specifying that the Config Data is not visible to End Users in the Solution Editor. Full instructions for this are found on the Importing external data page.

Presenting your End Users with drop-down lists

If a piece of config data in your solution uses a Tray.io connector operation which presents a field which is a drop-down list itself, then that drop-down will be presented to the End User in the Config Wizard.

Examples of this are:

  • The Salesforce 'Record Type' drop-down in the Find Records Operation
  • The Asana 'Projects' drop-down in the Create Task Operation

Most operations which present drop-downs do so as single item fields, such as the 'Channel' input for the Slack Send Message operation:


However, some operations present drop-downs as an array (i.e. a list). For example the Asana 'Projects' drop-down in the Create Task Operation is an array so that a task can be created in multiple projects:


Note that the above animation shows that the Config Data jsonpath must be set at the top Projects level - not at the individual Project level.

This means that the End User will be able to select multiple projects in the Config Wizard, as is intended with that operation:


Avoiding errors with drop-down lists

Please also be sure to read the note on avoiding errors when using drop-down fields

Was this article helpful?
Yes
No