Overview
Recipe Builder is a versatile tool that enables you to automate workflows. In addition to creating your own recipes, you can also leverage prebuilt recipes in the community page of Recipe Builder.
This documentation will guide you through the process of installing community-built recipes in Recipe Builder.
NOTE: Per GUIDEcx terms and conditions, recipes installed need to be part of an integration between GUIDEcx and another system.
Installing Community-Built Recipes
To install community-built recipes in Recipe Builder, follow these steps:
Navigate to the Community Page.
Click on the Custom connectors Tab.
Search for GUIDEcx.
Select the App.
Click Install.
Click Accept and Install in the modal that pops up.
Click Release Connector.
Browse or Search Recipes.
Browse through the available recipes or search for specific recipes using keywords. Recipes marked “GUIDEcx Connect Recommended” have been developed by our internal team.
Select and Review a Recipe.
Click on the recipe to access the recipe details page. This page provides information about the recipe, such as its description, integration details, and user reviews.
Take some time to review the recipe details to ensure it meets your needs. Pay attention to any prerequisites, requirements, or limitations mentioned in the documentation.
Install the Recipe.
Click the Use this recipe button.
Select the project you would like to copy the recipe to.
Clicking + New project allows you to create a new project without navigating to the recipes page.
Click Copy and Save to install the recipe. After the recipe is successfully installed, you will be directed to the editing environment.
Set up the Recipe.
Create connections for any account used in the recipe.
Configure any necessary mappings or settings. Steps with a warning need to be configured before the recipe can run. Refer to the instructions provided in the recipe documentation to identify anything that needs configured before running the recipe.
Customize the recipe to fit any workflow-specific requirements.
Test and Validate the recipe.
Before deploying the recipe, it's crucial to test and validate its functionality. Follow the instructions in the Testing section of Creating Your Own Recipes in Recipe Builder to verify the recipe performs as expected.
Deploy the Recipe.
Save the recipe and Exit the editing environment.
Click Start Recipe.
NOTE: When searching for recipes, hitting enter will adjust the results' granularity to show a list of recipes instead of apps. If you're looking for a specific recipe, save time by typing the name of it and clicking enter, instead of filtering it to the application and looking for it manually.
Editing Existing Recipes
After deploying the community-built recipe, regularly monitor its performance to ensure it continues to meet your expectations. If necessary, you can modify or update the recipe configuration to accommodate any changes in your business processes. For more information on editing recipes refer to Creating Your Own Recipes in Recipe Builder.
Follow these steps to navigate to the editing environment for an existing recipe:
In the Recipes Page, navigate to the project where the recipe exists.
Either:
Click on the three dots for the recipe and select Edit recipe.
or
Click on the recipe tile to open the Recipe Details and click Edit recipe.
Note: Edit recipe will be greyed out if the recipe is running. If this is the case, you will need to stop the recipe by clicking on "Stop recipe" before you can edit.
FAQ
Where do I find the Recipe's Documentation?
Where do I find the Recipe's Documentation?
Recipes have built in documentation in the right-hand section of the recipe details. Many GUIDEcx-built recipes also have Help Center articles with more detail. Check them out, here.
Why can't I edit the Recipe I've installed?
Why can't I edit the Recipe I've installed?
If the Edit recipe button is greyed out, it means that your recipe is still running. If this is the case, you will need to stop the recipe by clicking on "Stop recipe" before you can edit.
How can I make changes to a Recipe without having any downtime on a critical automation?
How can I make changes to a Recipe without having any downtime on a critical automation?
If you need to make changes to a recipe that is already running and interrupting it would be detrimental, you can clone the recipe and make changes to it. Once you're satisfied with the changes, start the new recipe before stopping the existing.