Skip to main content

How to Create Blueprint Variables#

Overview#

To create an effective Blueprint, you'll need to add multiple Blueprint Variables that a user can fill out on the Inputs tab while building a Vessel. The data from these Blueprint Variables will then pass directly to the code as environment variables every time the Vessel runs. This how to guide will walk you through the steps to create these Blueprint Variables.

Steps#

Step 1 - Required Fields#

  1. Edit an existing Blueprint, or create a new one.
  2. On the Input tab, click the + button next to the "Blueprint Variables" header. A drawer on the right hand side of the screen will open up.
  3. Give your variable a Display Name that will be shown to users.
  4. Give your variable a Reference Name that will be passed to the script.
  5. Select the Variable Type. This changes the format of how the user needs to provide their input.

Step 2 - Optional Fields#

The following steps are optional, but strongly recommended to increase usability.

  1. Set a default value for the variable to use.
  2. Select if the field should be required or not.
  3. Give the variable placeholder text as an example of what should be entered.
  4. Give the variable a tooltip explanation.

Step 3 - Create the Variable#

  1. Click the Add Variable Button at the bottom.
success

You've successfully made a new Blueprint Variable.