To import recipes and dependencies into a Workato instance, you will need a package containing exported assets. Importing a package is the final step in the recipe development lifecycle where finished recipes are deployed in a Workato instance.
There are multiple ways to deploy a tested package to a new environment.
- Package Import UI A package zip file can be deployed manually using package import UI.
- Deployment APIs A package zip file can be deployed using Workato platform APIs. E.g: You can initiate the deployment from your CI/CD server using a cURL request.
This section covers how Workato recipes and dependencies are deployed (imported). If you have already imported a package, you may move on to the last section on working with external source control systems:
- Planning for lifecycle management
- Exporting: Packaging recipes and dependencies
- Importing: Deployment (current)
- Working with external source control systems
When importing, you are able to choose the folder into which you want to import, which must already exist. It will be helpful if it is clear from the naming scheme which folder should be used for import.
Navigate to the main recipe development lifecycle page.
From the recipe development lifecycle page, click on the ‘Import’ tab to begin.
Start the import process by selecting an import target folder. If the folder is not shown in the list of import target folders, click on ‘Import package to new folder’.
Select the .zip file to import from the computer as well as the target folder. The wizard will begin reading the package and loading its contents. It will also compare the corresponding recipes and dependencies in the account and look for changes.
Import status tags
On the import preview screen, each item is assigned a tag that will inform the user of its import status.
All possible status tags for recipes
- Recipes that do not exist are added to the folder will be tagged "Creates a new recipe".
- Recipes that exist and were not changed will be tagged with "No change".
- Recipes that already exist that have been edited will be tagged with "Overwrites recipe".
- If a running recipe needs to be updated it will be tagged with "Overwrites running recipe". The recipes will be stopped, updated and then automatically restarted.
Updating a running recipe
Running recipes will be automatically stopped and then restarted
If there are running recipes that need to be updated, a warning will appear after the review process. Acknowledge that the recipes with triggers that are subscribed to webhooks may miss events in the time that it takes for the recipe to be updated and that recipes with pending jobs cannot be stopped.
As a best practice, it is recommended that the recipes to be updated are stopped manually before the import process.
The list of stopped recipes are temporarily stored and will be automatically restarted after the import process is complete. Any errors with restarting the recipes have to be fixed manually. Once the process is completed, the new/updated recipes and dependencies should be successfully imported and restarted.
If errors occur with starting a recipe after the import process, you should click on the link to the recipe, resolve any errors and restart the recipe manually.
One of the main advantages of separate accounts for the different lifecycle phases is that each can have its own set of connections, and these can be different: for example, a development account can use an application sandbox account for its recipes, while a production account uses the production application account with live data.
For security reasons, exporting a package does not export any credentials, keys or other private data needed to make a connection to applications. Those are kept private. Only the connection name, application type and other non-sensitive information will be exported. Here, a placeholder connection is created. This placeholder contains only the application and name of the connection. Authentication to this placeholder is required after import.
When importing a package, Workato will attempt to automatically fill in connection details with existing connections in the importing account. Workato checks that this connection type exists and that that there are no multiple connections of that type (for example, multiple Gmail accounts). If these conditions are met, the connections required in the imported recipes will be configured automatically. If this is not possible, then you may need to manually re-establish connections needed by the recipes after import.
Lookup tables in the zip file will always contain schema data (name and column names) but may or may not contain data. During import, users can specify if the table data should be or overwritten or ignored.
If the lookup table contains no data, it will be created/updated with only column names. If the lookup table contains data, use the radio buttons to select if the data should be overwritten or ignored.
'Import data' or 'Ignore data' on individual lookup tables to be imported
‘Overwrite’ will cause all table data to be overwritten and all data in the table to be replaced permanently. ‘Ignore’ will disregard all table data even though the table was exported with data.
Workato recommends you establish rules and procedures for the use of these options. The simplest approach is to use the defaults: “include data” on export and “overwrite data” on import. This assumes, however, that the lookup table in the importing account can be safely overwritten, without affecting recipes that are not part of the package being imported.
Other recipe dependencies will have the following tags according to their statuses.
- A new recipe/dependency will be added (Creates a new dependency)
- If there are no detected changes, the asset will be tagged with a ‘No change’ tag
- The current recipe/dependency will be overwritten with the changes in the import (Overwrites dependency)
Packages import behavior
The following table details how an imported package's assets are moved into your Workato account.
|Dependency type||What Workato does when package is imported||Location|
|Recipes||Overwrites recipe if a recipe with the same name exists in the folder.
Creates new recipe if no recipe with the same name exists in the folder.
|Custom connectors||Overwrites existing custom connector if connector with same name already exists in the Workato account. Creates new connector if no connector with the same name exists in the Workato account.||Connector SDK|
|Connections||Creates a connection placeholder. The user should connect the application after importing. Nothing is done if a connection with the same name already exists.||App Connections|
|Lookup tables||Creates a lookup table with the header rows. Imports the lookup table data if selected during export and import.||Lookup table|
|Properties||Adds properties to existing properties in the Workato account. Does nothing if a property with the same name already exists.||Account Properties|
|Common data models||Adds the schema to existing shared schemas in the Workato account or updates it if a schema with the same name already exists.||Common data models|
|Message templates||Adds the message template to existing templates in the Workato account or updates it if a template with the same name already exists.||Message templates|