How to Build a New Vessel using a Custom Blueprint

Overview

Every unique solution you create will require you to build a Vessel. If you're creating the solution from a pre-built blueprint, designed by other technical team members or Shipyard staff, you'll want want to build a Vessel using a Custom Blueprint.

Steps

  1. Navigate to the Vessels tab underneath a project.

  2. Click the "PreviousHow to Build a New Vessel using a Code BlueprintVessel" button in the top-right.

  3. Select "Custom Blueprint".

At this point you'll be walked through the following 4 pages of setup. If at any point in the process, you want to go to a previous step, you can either click on the step process number at the top, or click the "Back" button at the bottom. You can also completely delete your unfinished progress by clicking "Cancel".

Select Blueprint

  1. Select the Custom Blueprint that you want to use to build your Vessel. The Blueprint you select will determine how options are presented to you on future pages.

Form Inputs

This page will look different for every Blueprint. The left hand side will contain a description of the Blueprint, how you should use it, and how you should set it up. If you have questions about the functionality, reach out to the blueprint creator.

  1. Fill out input fields on the right-hand side of the screen. Those with a red star will be required.

  2. Click Next Step once you're done.

Set Schedule

All of the information on this page is optional.

  1. Provide any of the triggers that you want to cause your Vessel to run. You're able to set a Schedule and/or an Internal Trigger.

  2. Click Next Step once you're done.

Save Settings

  1. If you want to test your Vessel out before letting it run live, keep the State as "Inactive". Otherwise, set to "Active".

  2. Give your Vessel a unique, descriptive name.

  3. Optionally, edit the notifications to send users emails about the Vessel.

  4. Optionally, edit the guardrails to make the system automatically retry your Vessel upon an error. These default to whatever was set at the Blueprint level.

  5. Click Save and Finish once you're done

At this point, you should have successfully built a Vessel and will see the following screen.

Further Reading

How-to

How to Edit an Existing Vessel

Reference

Learn what Vessels are, how they work, and when they should be used. Understand how Custom Blueprints and their core components work.

PreviousHow to Build a New Vessel using a Code BlueprintNextHow to Duplicate a Vessel

Last updated

Was this helpful?