# Deploying a project to an environment

WHO CAN USE THIS FEATURE?

This guide is applicable to accounts with the Environments feature enabled. The Environments feature is not currently available for Embedded users.

With just a few clicks, you can easily deploy projects to different environments. For example: When a recipe is ready for testing, you can deploy it from the Development environment to the Test environment.

In this guide, we'll cover:


# Prerequisites

To deploy a project to an environment, you'll need:

  • A Workato account with the Environments feature enabled.
  • Access to the project you want to deploy.
  • The deployment privilege enabled in the main (Development) environment. Projects can only be deployed from this environment.
  • The deployment privilege enabled in the environment you plan to deploy the project to.

Note: If you only have access to one environment, you won't be able to deploy projects.


# Step 1: Set up the deployment

1

Sign in to your Workato account.

2

Navigate to the main (DEV) environment, if you're not in it already.

3

Open the project you want to deploy and click the Deployments tab.

4

Click Deploy project.

5

In the window that displays, click the environment you want to deploy the project to. For example: Test

Note: The Download package option creates a ZIP file of the project.

6

In the Notes field, summarize the changes in this version of the project. This info can be handy when auditing changes or identifying, should they arise.

7

Click Next.


# Step 2: Customize the deployment

On the next page, you'll be prompted to select the type of deployment you want to perform:

  • Deploy entire project: This option deploys the entire project to the Target environment selected in Step 1. If you select this option, click Next and skip to Step 3.

  • Customize deployment: This option allows you to select individual assets in the project to deploy. If you select this option, you can include or remove assets in the deployment by checking and unchecking the box next to the asset.

    When finished customizing the deployment, click Next and move to Step 3.

Note: When deploying connections for the first time, you'll need to reconnect them in the target environment before recipes can run, regardless of what deployment type you select.


# Step 3: Review and deploy the changes

Next, Workato will calculate the changes and display them for you to review.

Refer to the Understanding Project Deployment with Environments guide to learn more about how changes are detected.

When finished reviewing the changes, click Deploy.

After Workato deploys the changes, you can click View changes in [ENVIRONMENT] to check things out.


# Step 4: Re-establish connections

When a project is deployed, dependent relationships in recipes are maintained. However, when connections are deployed to an environment for the first time, you'll need to reconnect them in the target environment. Recipes won't run until connections are re-established.

In the target environment, re-establish connections as needed to ensure recipes can run successfully. Note: If working in a non-production environment, we recommend using sandbox credentials as a best practice.


# Resolving post-deployment errors

If you encounter an error message such as 503 Service unavailable after deploying a project to the target environment and starting a recipe, you must refresh the recipe's schema. This allows you to fix any broken external dependencies.

To refresh the recipe schema:

1

Log in to your Workato account.

2

Open the side panel and click your profile icon.

3

Select the environment you deployed the project to.

4

Select the project and recipe that encountered the error message.

5

Select Edit recipe.

6

Select the Refresh button in the upper right to refresh the recipe schema.

Select the Refresh button Select the Refresh button

7

Resolve any design-time recipe errors that Workato identifies. Fields with errors are outlined in red.

8

Select the Save button to save your changes.


# Resources


Last updated: 2/12/2024, 5:15:52 PM