Building a flow from a recipe

Overview

A recipe is a template for a complete integration flow.

Recipes allow you to set up a typical, re-usable complex flow without you needing to understand the entirety of the flow from scratch. A number of Connect recipes are already available on the Squiz Marketplace.

Once you initiate a recipe’s activation process (first from Squiz Marketplace and then in Connect, after signing in if necessary), you are taken to the Quick Recipe Setup panel in Connect, where you can configure the workspace in which your recipe will be activated, as well as all the credentials required by all relevant steps within the resulting flow.

After completing the recipe’s set-up and activation process, your flow will be created, ready for you to use.

The visibility of your flow can be at either the workspace or contract level. Setting a certain visibility level requires corresponding permissions.

Learn how to add a recipe from Squiz Marketplace

Obtaining and activating a flow’s recipe

To obtain a recipe for a flow in Connect, begin the process from the Squiz Marketplace:

  1. Visit the Squiz Marketplace’s Recipes tab and click the appropriate Connect recipe’s tile to begin activating that recipe.

    All recipes listed in Squiz Marketplace are designed for Connect, and each of these recipes works with other Squiz Digital Experience Platform (DXP) products.
  2. On the specific recipe’s page in Squiz Marketplace, click the Activate Recipe button, which begins the activation process and opens the recipe’s overview page in a new browser tab within Connect.

    If you are not already signed in to Connect, you will be prompted to do so before continuing.
  3. On the recipe’s overview page in Connect, click the Activate button within the Recipe Summary section to open the Quick Recipe Setup panel.

    quick recipe setup
    Figure 1. Quick Recipe Setup panel
  4. Within the Quick Recipe Setup panel:

    1. In Step 1, choose the Contract and Workspace that the recipe’s resulting flow will be scoped to.

      Click the Next or Back buttons to navigate between each step of the Quick Recipe Setup process.
    2. In Step 2, choose the credentials for the webhook that activates the resulting flow.

      For the Matrix-based recipes, these Matrix credentials would be configured at this step.
    3. In Step 3, choose the credentials for the third-party application that the resulting Connect flow interacts with. For example, Salesfore or Squiz Datastore.

    4. If Step 4 appears, specify Datastore admin user credentials in this step. This is typically required for integrations with Datastore, where your blueprint requires 'isAdmin':true is required in the JWT payload for requests to its Datastore service.

    5. Click Finish and Connect creates your recipe’s flow.

The resulting flow should function 'as is'. However, you may implement further configurations (e.g. modifications to components) if necessary.

© 2015- Squiz Pty Ltd