Flow service recipes
Recipes are pre-built Flow service templates that can be used to create a Flow service. Recipes are based on the most common Flow service needs and can significantly reduce the effort that is required to build a Flow service. A recipe includes associated assets, for example Applications, Operations, Reference Data, and many more, that are used to create a Flow service.
The IBM® webMethods Integration administrator adds a list of pre-created Flow services to the Recipes section. To start using Flow service recipes, click the Flow services tab that appears on the Recipes screen.
Using filters to search Recipes
By default, recipes for all connectors and external web services are displayed. However, you can search for recipes based on a specific connector name. On the left side of the Recipes page, a list of connector icons is arranged alphabetically. However, you can also search for a connector-specific recipe by entering the connector name in the search box that is located above the connector icons.
For example, to search all recipes that are specific to the Coupa connector, select the connector icon from the left side of the screen or type in 'Coupa' in the search box and click the Search icon. A list of Flow services that are Coups-specific appears.
In addition, you can 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 on the upper-right of the Recipes page.
For example, to search all recipes associated with the Coupa connector, type in 'Coupa' in the search box and click the Search icon. A list of recipes that are Coups-specific appears.
For a more refined search, you can also enter the description of a recipe. For example, extracts accounts from NetSuite...
Listing recipes
IBM webMethods Integration provides you two layout options to view Flow service recipes, 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 the List view by clicking the List icon located beside the search box on the upper-right of the Recipes page.
On clicking the List icon, you see all the information that is related to the recipes, including connectors that are 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, click the Card icon that is situated beside the List icon on the upper-right of the Recipes page.
On clicking the Card icon, you see all the recipe information, including connector icons, description of the recipe, and actions (Preview and Use Recipe) to be performed inside the cards.
Previewing Recipes
You can see a view-only mode of the details of a recipe. To do so, follow the instructions,
- From the IBM webMethods Integration navigation bar, click Recipes, and then click the Flow services tab.
- Go to the recipe that you want to view. Next, click Preview. You now see
a pre-built Flow service, which includes steps and constructs - connectors, operations, actions, and
controls.Note: In Preview mode, editing or deleting of a trigger and actions is disabled.
By default, the steps of a Flow service are hidden. However, you can expand the steps by clicking the Expand All option that is located below the name of the Flow service.
Note: To view the field-level mappings of a particular step, click the Pipeline icon on the respective step. The Pipeline option displays the field-level mappings. The Pipeline icon is disabled for any step that includes custom operations or integrations. -
The inline comments are hidden by default. To view the inline comments, toggle Comments on the upper-right corner of the Flow service Recipes page.
-
Click Details to view a detailed description of the recipe and the references in the Recipe Details page.
You see a detailed description of the Flow service recipe, including created on, created by, version number, and reference data.
To get a quick view of the Flow service recipe details, click the dropdown icon located beside the name of the Flow service. You will see details such as the connectors used, recipe description, author, version number, and usage. Usage indicates how many times you have used the recipe to create Flow services and the connectors referenced. If the main Flow service lacks connectors but its sub-Flow services have them, the connectors are pulled from the sub-Flow services.
-
If you want to use the recipe directly from the Preview mode, click the Use Recipe button that is on the upper-right of the screen. Read Using Recipes under the Flow service recipes section to know more.
Using Recipes
You can use a Flow service recipe to create a new Flow service 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 must first import them to your project.
On the Recipes page, you see the list of all Flow services available in the IBM webMethods Integration recipes. Each Flow service card contains the icons that are associated with the connectors that are used in the Flow service and the Flow service name with two options, Preview and Use Recipe.
To do so, follow the instructions,
- Go to the recipe that you want to apply to create a Flow service. From the Recipes or Preview page, click Use Recipe. The Save as dialog box appears.
- In the Save as dialog box, select the project where you want to use this recipe. Next, specify a suitable name for this Flow service. You can alternatively change the description of the Flow service. Next, click Save. The Account Configuration screen appears.
- Select the Account for each Application or create a new Account, and then click Save.
- You can also configure accounts for operations that are used in this Flow service recipe. To provide operation-based configuration, select the Provide operation-based configuration checkbox that is at the right-side of the page.
-
After you configure the accounts for the operations of connectors/external web services used in the recipe, click Save. The Flow service is available in the selected project. You can now run this Flow service anytime you want.
Note:-
If one or more assets that are used in the recipe exists in the specified project, you can either choose to overwrite one or more existing assets with the assets in the import or you can import the recipe in a different project.
-
If you click Proceed, the existing assets are 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, IBM webMethods Integration tries to load the recipe for the user. If the recipe does not get loaded even after five minutes, a message appears to ask the user to try after some time.
-