Home Integrator guide Creating and managing Recipes
Covered in this article
Related articles
Embedded Recipe Deployment Embedded Recipe External agencies use case Recipe Deployment Recipe access rights

Creating and managing Recipes

The Recipe is a set of flows templates that on activation will create a single Recipe Deployment which includes a set of flows based on templates.

Create Recipe - Flows Export

Open the Flows page. Press a gear button of the first Flow which you want to be a part of the Recipe. Choose the “Export to a Recipe” menu item:

Export Recipe

The multi-select mode will be enabled and you can choose other flows which will be a part of the Recipe. Then click the “Export to recipe” button in the top right corner.

Select Multiple Flows

Export to a new Recipe

By default, you will be suggested to create a new Recipe. Enter its name (1), description(2) (supports Markdown), and description of its credentials(3).

You can also change its visibility(4). On Save, you will be redirected to the newly created Recipe:

Configure Export

Export to an existing Recipe

The “Save as” dropdown allows you to choose “Update existing recipe”. In this case, you will be able to choose an existing Recipe to update:

Select Recipe

The rest of the form is the same except for the credentials mapping block:

Set Credentials

Please Note: When you want to activate a Recipe based on the Flow with Topics you have to follow the steps described in above. However, there is one important difference from a recipe with topics from a recipe without topics - a recipe using topics can only be activated within one workspace.

Create and manage recipes with API

You can create and manage recipes not only through our platform, but also directly through API endpoints. You can find all information on this subject in our API Docs.

Visibility

The Recipe can have 4 visibility levels:

  1. Workspace. The Recipe is visible only to those who have an access to the workspace where it was created.
  2. Contract. The Recipe is visible to every member of the workspace which is part of the contract where it was created.
  3. Tenant. The Recipe is visible to any user of the tenant where it was created.
  4. Global. The Recipe is visible throughout the platform.

To change the visibility, use this API endpoint.

Credentials

The Recipe can contain a list of credentials that a user must fill in during its activation. Each credential will contain a description, which you need to provide, and will be visible to the user to better understand the purpose of the credential.

Mapping

On the Recipe update, it’s forbidden to change the number of credentials that the user must fill in. During the update, you need to set a match between old credentials that all users filled in on activation of the previous version and credentials in the new set of flows. This process is called “mapping”. E.g. version 1 of the Recipe had 2 credentials:

  1. flow 1 - step 1 (input, JDBC component)
  2. flow 1 - step 5 (output, JDBC component)

You decided to split the flow into 2 flows, one for input and another for output. You create a new set of flows. Now credentials look like this:

  1. flow 1 - step 1 (input, JDBC component)
  2. flow 2 - step 3 (output, JDBC component)

You do the export into an existing recipe of version 1. During the update, you will be asked to make a match between credentials #1 and #2 of version 1 of the recipe and credentials #1 and #2 of the new version of the recipe. The match in your case should look like this:

  • flow 1 - step 1 (input, JDBC component) → flow 1 - step 1 (input, JDBC component)
  • flow 1 - step 5 (output, JDBC component) → flow 2 - step 3 (output, JDBC component)

The reason for this mechanism is that we don’t want to ask the user of the Recipe Deployment to re-enter the credentials on the version update. And we can’t do the match automatically.