How to Build a New Vessel using a Code Blueprint

Overview

Every unique solution you create will require you to build a Vessel. If you're creating the solution from scratch, you'll want want to create a Vessel using a Code Blueprint.

Steps

  1. Navigate to the Vessels tab underneath a project.

  2. Click the "Build Vessel" button in the top-right.

  3. Select "Code Blueprint".

At this point you'll be walked through the following 5 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 language that you want to use to build your Vessel. The language you select will determine how options are presented to you on future pages.

Provide Code

All of the information on this page is required.

  1. Provide the code for your solution, either by uploading a file or writing your code directly in the UI. This is required.

  2. Provide the command details necessary for your code to run properly. This is also required.

  3. Click Next Step once you're done.

Define Requirements

All of the information on this page is optional.

  1. Provide any environment variables that your script uses.

  2. Provide any external packages that your script needs to use.

  3. 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.

  5. Click Save and Finish once you're done

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

Every unique solution you create will require you to build a Vessel. If you're creating the solution from scratch, you'll want want to create a Vessel using a Code Blueprint.

  1. Navigate to the Vessels tab underneath a project.

  2. Click the "Build Vessel" button in the top-right.

  3. Select "Code Blueprint".

At this point you'll be walked through the following 5 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 language that you want to use to build your Vessel. The language you select will determine how options are presented to you on future pages.

Provide Code

All of the information on this page is required.

  1. Provide the code for your solution, either by uploading a file or writing your code directly in the UI. This is required.

  2. Provide the command details necessary for your code to run properly. This is also required.

  3. Click Next Step once you're done.

Define Requirements

All of the information on this page is optional.

  1. Provide any environment variables that your script uses.

  2. Provide any external packages that your script needs to use.

  3. 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.

  5. Click Save and Finish once you're done

At this point, you should have successfully created 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 Code Blueprints and their core components work.

PreviousHow to Edit a Vessel's Schedule TriggersNextHow to Build a New Vessel using a Custom Blueprint

Last updated

Was this helpful?