Design

Back Next

Embedded Guide step

Use an Embedded Guide step to better orchestrate and manage your business processes. Design guides that embed other guides, similar to how you would create a subprocess that is called from another process.

Using an embedded guide has the following advantages:

Avoids Repetition
: If you place commonly used patterns in a separate guide, you can save time and create other efficiencies if you place the discrete set of steps into a guide that can be embedded and reused in other guides. When you change the embedded guide, you can easily make those changes available to all guides that use it.

Clarifies Design
: Embedding can make your design look simpler. Removing steps and placing them into an embedded guide means that the embedding object only shows one step rather than all of the steps. This can simplify the diagram on the canvas. Also, if a problem occurs in the ways steps occur, embedding can make it easier to locate a problem.

Clarifies Logic
: If there are many steps that need to operate on other objects, this allows you to create logical chunks of work that each apply to different objects (such as opportunities and leads). This decreases the complexities of working with multiple object types in a single guide.

You handle the data received from a guide and the data that can get sent back to it using the Input and Output fields defined in the guide properties.

For example, suppose there are a set of steps associated with entering client information. If there are different ways that your users interact with clients and many need to enter client information, you could group these client information steps into their own guide. Now, whenever a guide needs to enter client information, it just "embeds" the guide. This also means that all embedding guides use the same steps

When you create an Embedded Guide step, you enter the following properties:

Property	Description
General	The name of the Embedded Guide step. The name can contain only alphanumeric characters, underscores (_), spaces, and Unicode characters.
Guide	Select the guide that you want to embed within the current guide. The current guide is called the embedding guide. The guide that the embedding guide embeds is called the embedded guide.
Iteration Rule	Configure whether you want the embedded guide to run on a single object or on all objects. If you choose Run on a single object , the embedded guide runs on the specific object it receives as input. The embedded guide passes control to the step that follows in the embedding guide when execution completes. If you choose Run on each object in list until , you also choose an event that controls guide execution: You can also choose from the following objects to process at runtime: Field : A single object or a list of objects is passed to the embedded guide (based on the selected Run choice). Query : Available only with Run on a single object. Allows you to define a WHERE condition that selects the object passed to the embedded guide. List : Available only with Run on each object in list until outcome. Allows you to define a WHERE condition that selects the objects passed to the embedded guide.
Input Fields	Displays the input fields available for the selected object. If the embedded guide receives one of these fields as input, the value of that field may be updated while the embedded guide executes. If so, the value is updated in the parent guide after this embedded guide completes execution.