Building Quick Start Templates

×

REQUEST FREE TRIAL

Share A Little Information To Request Free Trial

Created with Sketch.
REQUEST FREE TRIAL

The most effective way to share a customizable workflow across your organization, allowing multiple teams to meet their exact needs.

Quick start templates allow users to build and share workflows.  Your Tray administrator will be in charge of configuring all logic for the initial flow.  Once this is complete, the workflow may be shared.  Other members of your organization may then configure the workflow by simply adding the credentials required for authentication and selecting a few dropdown options.

Create your Workflow

First, create a workflow how your normally would.  Instructions for creating your first workflow can be found in our getting started guide here:  https://docs.tray.io/category/76-welcome-to-tray

Configure your test workflow as described below:

  1. Create a new workflow with a manual trigger.
  2. Add a Slack connector.
  3. Change the Operation of the Slack connector to Send Message.
  4. Leave the channel and message blank for now.  These will be our Config variables.

Identify and Create Configuration Variables

There will be certain variables within your flow that you would like other users in your organization to be able to dynamically change.  These variables are called configuration variables and will be presented when the QST is configured by the next user in the Configuration panel, as pictured below.

For this example, we are going to be creating a QST to send a Slack message on command.  We will be setting Config variables for the following fields: <Slack_channel><Slack_message_text>

  1. At the top left, click on the gear.  You will be presented with the Workflow Settings panel.
  2. In the left-hand menu, select Config Data.
  3. Add 2 Config Data elements.
    1. Name: $.config.slack_channel
      1. Value: A legitimate Slack channel of your choice, prefixed with the '@' symbol.
    2. Name: $.config.slack_message_text
      1. Value: Any text you wish to send.  For the example, we used 'Hello!'.

Pass Configuration Variables into your Workflow

  1. Click on the Slack connector.
  2. Select the Channel field.
    1. Change the data type to JSON Path.
    2. Pass in the value $.config.slack_channel.
  3. Select the Message field.
    1. Change the data type to JSON Path.
    2. Pass in the value $.config.slack_message_text.

Now your workflow is ready to be turned into a Quick Start Template!

Create your Template

  1. Navigate back to your Dashboard.
  2. Near the top, select the tab My Templates.
  3. Click Create Template.

Source Workflows

In the Workflow dropdown, select the title of the workflow you constructed in the previous steps.

Template Details

  • Title: This will identify your Template in the list.

  • Status: You may choose Draft, Private, or Published.
    • Draft: Your template is still being edited and may only be viewed in your account.
    • Private: Your template is complete, and is only accessible via the template link.
    • Published: Your template is complete, and visible to all Tray users in the library.
  • Slug: The static URL for your template.
  • Content: This is where we place the description of our template, as well as any configuration functions.  This box supports Markdown, a convention for marking up text.

  • Tags: These are used for optimizing search.  Currently, the best-practice for tagging is to refer to general "categories" of the template - e.g. "sales", "crm", "marketing"

Connector Icons

  • Select an icon for the Trigger for your workflow, as well as a single icon for each service you are connecting.  For this example, we have selected the following configuration:

Note: These icons are both displayed in the list view, as well as the title page view as displayed above.

Services

  • Selecting items here will determine which categories your QST lives in on the Services page. 

Template Configuration

  • Introduction: This is the first paragraph displayed when configuring the QST for the first time.  Best practice here is to give a brief summary of the information required to complete this QST, to ensure users are prepared when going through configuration.

  • Configure Sections: These will be broken down by the services you have chosen to use Config variables.  In this example, we have a single service and therefore are only presented with a section titled 'Configure Slack'.
    • Here, we may rename the configuration sections to our preference.
    • In each configuration section, there will be a list of Config variables that are relevant to that section's connector.  Give each item a Title and Help text that will be convey a coherent message to those wishing to use your template.
      • Use Config Default: If this checkbox is selected, the value you hard-coded into the configuration variables when initially building the workflow will display as the first option the user may select from.
      • Move Up/ Move Down: You may use the right-hand toggle to change the ordering of the Config variables if you deem a more logical way to present this information to others in your organization.
      • Hide Config: Upon enabling, the relevant section will not be displayed to the user at configuration time.

  • Call to Action Title: Displayed when the user finishes configuring their QST.
  • Call to Action Help:  Displayed as helper text when a user finishes configuring their QST.

Last updated 11th May 2017

REQUEST FREE TRIAL

Share A Little Information To Request Free Trial

Created with Sketch.