Recipes

Recipes are pre-built templates based on the most common integration needs and can significantly reduce the effort required to build a Workflow or a FlowService.

Browse through the different automated Workflows and FlowServices and learn how to use a Workflow or a FlowService recipe in your project.

Getting started with Recipes

To begin with Recipes, follow the instructions given below:

  1. Log in to your webMethods.io Integration tenant.
  2. From the webMethods.io Integration navigation bar, click on the Recipes tab.

    The Recipes page appears.

    From here, you can view and readily use several pre-configured workflow and FlowService recipes in any desired project.

Understanding workflow recipes

The Recipes section contains several pre-configured workflows that you can readily use. A workflow recipe consists of a trigger and/or a set of actions that are configured with a business logic.

To start using workflow recipes, click on the ‘Workflow’ tab that appears on the Recipes page.

You will see a list of pre-created workflows that are added by the webMethods.io Integration administrator.

Using filters to search Recipes

By default, recipes for all connectors/external web services are displayed. However, webMethods.io Integration allows you to search recipes by the name of a connector. On the left panel of the Recipes page, you will see a list of connector icons that are available in webMethods.io Integration. By default, the connector icons are placed alphabetically. However, you can also search for a connector-specific recipe by entering the connector name in the search box located above the connector icons.

Let’s say you want to search all recipes that are specific to the application - Trello. Simply select the connector icon from the left panel of the screen or type in ‘Trello’ in the search box and click on the Search icon. You will now see a list of workflows that are Trello-specific.

In addition, webMethods.io Integration allows you to search recipes by the name or description of a recipe. To do so, enter the name or description of a recipe in the search box that is located on the top-right corner of the Recipes page.

Let’s say you want to search all recipes associated with the connector - Asana. Type in ‘Asana’ in the search box and click on the Search icon. You will now see a list of workflows that are Asana-specific.

For a more refined search, you can also enter the description of a recipe.

Listing Recipes

webMethods.io Integration provides you two layout options to view workflow recipes, namely Card view and List view. The default view is the Card View, which allows you to see the recipes as blocks.

However, you can switch to List view by clicking on the List icon located on the top-right corner of the Recipes page.

You will now see all the information related to workflow recipes, including connectors used in a recipe, description of the recipe, and actions (Preview and Use Recipe) to be performed, in a spreadsheet-like display.

To change back to the Card view, simply click on the Card icon situated beside the List icon on the top-right corner of the Recipes page.

You will now see all the recipe information inside cards.

Importing Recipes

webMethods.io Integration allows you to readily use pre-built workflows from the Recipes page. In addition, it also allows you to import your own workflow-specific schema onto the Recipes section. To do so, click on the Filter icon situated beside the search box on the top-right corner of the Recipes page.

On clicking the Filter icon, you will see two options, namely All Recipes and My Recipes.

All Recipes

By default, the All Recipes option is selected. This option allows you to browse, view, and use pre-built recipes that are created by webMethods.io Integration administrator. Read Previewing recipes and Using Recipes under Understanding workflow recipes section to know more.

The All Recipes option also allows you to upload workflow-specific schema onto the Recipes section. Once uploaded, these schemas are automatically converted to workflows which you can import to your projects. To do so, click Import.

You will be prompted to upload the schema file for the workflow you want to import.

Select the workflow schema you want to upload and click Open. You will be redirected back to the All Recipes screen, where you can see the workflow card for the schema you just uploaded.

Note that this workflow is added to both All Recipes and My Recipes section. Now that this workflow is added, you can use it anytime in your project.

My Recipes

webMethods.io Integration allows you to upload workflow-specific schema onto the Recipes section. Once uploaded, these schemas are automatically converted to workflows which you can import to your projects.

To do so, click on the Filter icon situated beside the Card icon on the top-right corner of the Recipes page, and then click My Recipes .

Next, click Import.

You will be prompted to upload the schema file for the workflow you want to import.

Select the workflow schema you want to upload and click Open. You will be redirected back to the My Recipes screen, where you can see the workflow card for the schema you just uploaded.

Note that this workflow is added to both My Recipes and All Recipes section. Now that this workflow is added, you can use it anytime in your project.

Previewing Recipes

webMethods.io Integration allows you to see a view-only mode of the workflow details of a recipe.

To do so, follow the instructions given below:

  1. From the webMethods.io Integration navigation bar, click Recipes , and then click on the Workflows tab.
  2. Navigate the recipe that you want to preview. Let’s say, you want to preview a recipe associated with the Application - Asana.

  3. Next, click on Preview.

  4. You will now be redirected to the canvas that contains a pre-built workflow.

    Note: In Preview mode, editing or deleting of trigger/action(s) is disabled.

  5. Click Details located on the top-right corner of the screen to view a detailed description of the recipe.

    You will now see a detailed description of the recipe such as the date it was created on, created by, version number, working of the workflow, and connector(s) used.

  6. If you want to use the recipe directly from the Preview mode, click on the Use Recipe button located beside the Details option. Read Using Recipes under Understanding workflow recipes section to know more.

Using Recipes

You can use the pre-created workflows from the Recipes or Preview page. The procedure to use a recipe from the Recipes or Preview page remains the same.

To use the workflows available in the Recipes section, you will have to first import them to your project.

On the Recipes page, you will see the list of all workflows available in the webMethods.io Integration recipes. Each workflow card contains the icons associated with the connectors being used in the workflow and workflow name with two options, namely Preview and Use Recipe.

To use a recipe, follow the instructions given below:

  1. Go to the recipe that you want to import.
  2. From the Recipes or Preview page, click on the Use Recipe option.

  3. You will be prompted to specify the project where you want to import the workflow. Once you specify the project, click Done.

  4. You will be redirected to the Import workflow form screen where you will see the workflow name, description, along with the account fields and lookup fields (if any) associated with the connectors being used in the workflow. Provide the relevant details in the specified fields and click Import.

This will import the selected workflow in the specified project. You can now execute this workflow anytime you want.

Understanding FlowService recipes

Recipes are pre-built FlowService templates that can be used to create a FlowService. Recipes are based on the most common FlowService needs and can significantly reduce the effort required to build a FlowService. A recipe includes associated assets, for example Applications, Operations, Reference Data, and so on, that are used to create a FlowService.

To start using FlowService recipes, click on the ‘FlowServices’ tab that appears on the Recipes screen.

You will see a list of pre-created FlowServices that are added by the webMethods.io Integration administrator.

Using filters to search Recipes

By default, recipes for all connectors/external web services are displayed. However, webMethods.io Integration allows you to search recipes by the name of a connector. On the left panel of the Recipes page, you will see a list of connector icons that are available in webMethods.io Integration. By default, the connector icons are placed alphabetically

However, you can also search for a connector-specific recipe by entering the connector name in the search box located above the connector icons.

Let’s say you want to search all recipes that are specific to the application - Coupa. Simply select the connector icon from the left panel of the screen or type in ‘Coupa’ in the search box and click on the Search icon. You will now see a list of FlowServices that are Coupa-specific.

In addition, webMethods.io Integration allows you to search recipes by the name or description of a recipe. To do so, enter the name or description of a recipe in the search box that is located on the top-right corner of the Recipes page.

Let’s say you want to search all recipes associated with the connector - Coupa. Type in ‘Coupa’ in the search box and click on the Search icon. You will see a list of recipes that are Coupa-specific.

For a more refined search, you can also enter the description of a recipe.

Listing recipes

webMethods.io Integration provides you two layout options to view FlowService recipes, namely Card view and List view. The default view is the Card View, which allows you to view recipe information on blocks. However, you can switch to List view by clicking on the List icon located beside the search box on the top-right corner of the Recipes page.

On clicking the List icon, you will see all the information related to the recipes, including connectors used in a recipe, description of the recipe, and actions (Preview and Use Recipe) to be performed, in a spreadsheet-like display.

To change back to the Card view, simply click on the Card icon situated beside the List icon on the top-right corner of the Recipes page.

On clicking the Card icon, you will see all the recipe information, including connector icons, description of the recipe, and actions (Preview and Use Recipe) to be performed, inside cards.

Previewing Recipes

webMethods.io Integration allows you to see a view-only mode of the details of a recipe. To do so, follow the instructions given below:

  1. From the webMethods.io Integration navigation bar, click Recipes, and then click on the FlowServices tab.
  2. Go to the recipe that you want to view. Let’s say, you want to view a recipe associated with Cumulocity and Slack.

  3. Next, click on Preview.

  4. You will now see a pre-built FlowService, which includes steps and constructs - connectors, operations, actions, and controls.

    Note: In Preview mode, editing or deleting of trigger/action(s) is disabled.

    By default, the steps of a FlowService are hidden. However, you can expand the steps by clicking the Expand All option located below the name of the FlowService.

    Note: To view the field-level mappings of a particular step, click the Pipeline icon on the respective step. The Pipeline panel displays the field-level mappings. The Pipeline icon is disabled for any step that includes custom operations or integrations.

  5. The inline comments are hidden by default. To view the inline comments, simply toggle on Comments located on the top-right corner of the FlowService Recipe page.

  6. Click Details to view a detailed description of the recipe and the references in the Recipe Details page.

    You will now see a detailed description of the FlowService recipe, including created on, created by, version number, and reference data.

    To get a quick view of the FlowService recipe details, click on the drop-down icon located beside the name of the FlowService.

    You will see the details, including connectors used, description of the recipe, author, version number, and usage. Usage refers to the number of times you have used a recipe to create FlowServices and the connectors referenced in the recipe. If the main FlowService created out of a recipe does not have connectors but has sub-FlowServices, and if the sub-FlowServices have connectors, then the connectors are pulled from the sub-FlowServices.

  7. If you want to use the recipe directly from the Preview mode, click on the Use Recipe button located on the top-right corner of the screen. Read Using Recipes under Understanding FlowService recipes section to know more.

Using Recipes

You can use a FlowService recipe to create a new FlowService from the Recipes or Preview page. The procedure to use a recipe from the Recipes or Preview page remains the same. To use the workflows available in the Recipes or Preview section, you will have to first import them to your project.

On the Recipes page, you will see the list of all FlowServices available in the webMethods.io Integration recipes. Each FlowService card contains the icons associated with the connectors being used in the FlowService and FlowService name with two options, namely Preview and Use Recipe. To do so, follow the instructions given below:

  1. Go to the recipe that you want to apply to create a FlowService.
  2. From the Recipes or Preview page, click Use Recipe.

    The Save as dialog box appears.

  3. In the Save as dialog box, select the project where you want to use this recipe. In our example, we have selected the Default project. Next, specify a suitable name for this FlowService. You can alternatively change the description of the FlowService. Once this is done, click Save.

    The Account Configuration screen appears.

  4. Select the Account for each Application or create a new Account, and then click Save.

  5. You can also configure accounts for operations that are used in this FlowService recipe. To provide operation-based configuration, select the option located at the right-side of the page.

  6. After you configure the accounts for the operations of connectors/external web services used in the recipe, click Save.

    Notes:

    • If the asset(s) used in the recipe already exist(s) in the specified project, you can either choose to overwrite the existing asset(s) with the assets in the import or you can import the recipe in a different project.
      • If you click Proceed, the existing asset(s) will be overwritten and cannot be recovered. Hence, it is recommended to take a backup if you want to overwrite the existing assets.
      • You can alternatively click Back and import the recipe in a different project.
    • If you are importing a recipe and another user tries to import the same or another recipe in the same tenant concurrently, webMethods.io Integration tries to load the recipe for the user. If the recipe does not get loaded even after five minutes, a message appears asking the user to try after some time.

    With this, the FlowService will be available in the selected project. You can now execute this FlowService anytime you want.