Central and ActiveVOS Screenflow > Creating Guides > Setting Guide Properties

Setting Guide Properties

All guides share some common characteristics. These include having a name, the type of object that the guide applies to (for example, lead, campaign, opportunity, and so on), possible outcomes (for example, "Lead is qualified"), and the way it looks when displayed.
You use will use the Guide Properties dialog to set these and other characteristics.


You can specify the following General properties for guides and processes:
A descriptive name to identify the process or guide in the Process Designer and the name that appears when it is available for use in other objects such as embedded guides or subprocess steps. This name also displays in applications like Salesforce that may have a guide launching area.
Applies To
The type of object associated with the guide or process. The objects that display in this list are the process objects you defined separately, or generated in a defined connection. Drill-down in the list to see process objects and connections, and then select one of these items. Select a process object only if the process will be embedded in another process.
Note: To change the Applies To property of a published guide or process, you must first unpublish the guide or process. Then, change the Applies To property and republish the guide or process
There are two special values:
  • - Any: Choose Any if you do not want to associate the guide or process with a specific object. You might use this for embedded guides that do not require a context. When you select this option, the guide or process does not automatically have access to an object's fields.
  • Use this object type when a guide or process creates a new object and does not access information within existing objects.
  • - Home (Salesforce): Select Home if you want a guide to be visible from Home or any initial location where users launch all guides, regardless of the object type.
Note: If you directly invoke a process, the Applies To setting must be either Any or a specific object in a service, but not a process object.
If the guide applies to a Salesforce object that has a page associated with it (for example, a Lead), and the administrator has placed a guides area on that page, the guide will automatically appear on that Salesforce page.
A description of the process or guide.
A category name that you use to group processes, guides, and other objects. Separate multiple tags with a colon (:).
Run [Process or Guide] On
Use this list to specify where this process or guide will run.
For a process, choose Cloud Server or a specific agent. For a guide, choose Desktop/Tablet or Smart Phone.
If your process uses a connector that is event based, make sure that you run the process on the same agent that the connector runs on.
Run As (Salesforce only)
For Salesforce only, you can choose whether to run the guide or process as the Current User or System.
Choose Current User if the guide should have the same privileges as the user who is running it.
Choose System if the guide should have system-level permissions to enable actions hat the guide user may not otherwise be able to access. For example, if a user does not have access to account objects, If the guide is running as System, the guide can still access the account objects to the extent needed to run the guide.
When embedding guides, each embedded guide can have its own setting. This means you can create guides that temporarily access information while the user is running the embedded guide and, if necessary, each embedded guide could access different objects.


When a user finishes the last step in the guide, you will often want to note how it ended. These endings are called "outcomes". For example, here is part of a guide that assesses future needs and which has three outcomes:
The way in which you name possible outcomes is by using the Outcomes tab within the Guide Properties dialog. In the following illustration, a "Qualified" outcome is defined for the guide.
To add additional outcomes, press the "+" button. To remove an outcome, press the "x" button.
You can also add an outcome while editing an End/Milestone Step by selecting dd new outcomes in the list of available outcomes.


The fields available for a guide or process are those contained in the object(s) to which the guide or process applies. This is specified in the Applies To property (on the General tab).
You define a name and type for each of the following field categories, for use in a guide or process:
Field Categories
The Input field values are available in all steps of the process or guide.
An embedded guide may need to access information from the embedding process or guide. Creating input fields is also a way to define this information so that it can be passed to the embedding guide.
If the field is required for the guide or process to execute, check Required.
The Output field values are set when the process executes and are then available in the steps that follow. Define output fields only for use in an embedded process or guide. These output fields do not appear in lists until the values are returned from an embedded process or guide.
The Temporary field values be used in all of the current guide's steps. However, a temporary field's value is not available to an embedded guide or process.
This image shows the steps in which a field's data is available:
For information on how to use input and output fields in embedded guides, see Embedded Guides Step.
For more information on fields, see Introduction to Data Types and Field Properties.


On the Advanced tab, you can set the properties described below.
Guide Properties Advanced tab
Allow Restart
Determines whether users can restart this guide from the first step. If you enable this option, when the guide restarts, it undoes previously executed steps.
Run As
Select the user account to apply when the guide runs. You can choose Current User (the guide has the same privileges as the user who is running a guide) or System (the guide has system-level permissions for actions performed if the guide's creator has system-level privileges).
Note: If you choose System, the person running the guide can access all objects available to the System user. For example, if you select this option for the guide and the guide applies to Account objects, then all persons who run the guide can access the Account objects, regardless of their individual user account settings.
Each embedded guide can have a different Run As setting. This allows guides to temporarily access information while the embedded guide is running. If necessary, each embedded guide could access different objects.
Execution Logging
If checked, Process Designer logs details about the guide steps and execution, so it is available for reports.
Roll back screens
If checked, your application can undo changes made to the database when a user clicks Go Back One Step or clicks a step in the History panel. (Your application may not have this capability.) If it is disabled, changes are not undone.
If an embedded guide enables roll back, then the undo is applicable only to the scope of the embedded guide, unless the parent guide also enables roll back.
Always Start New
If checked, opening a guide always creates a new instance of the guide.
Feedback email list
If you want users to send feedback, add one or more email addresses (separated by commas) to receive feedback. Users can then click the feedback option on the guide to display the following dialog:
Send Feedback Dialog
The dialog shows the guide's name and the step being executed.
Show Guide Only When (Salesforce only)
You can specify criteria that determine when this guide displays in the "Guides" area on a user's Salesforce page.