Use Guided Setup to step through the initial configuration of any product or application that provides a Guided Setup module. Guided Setup assists you with planning the roll-out of the product and performing the basic configuration to go live.

Note: The Guided Setup player is supported by Playbooks.

Guided Setup organizes configuration activities into categories. Each category provides information, such as planning guidance, pre-setup steps, and links to useful help content. Categories also provide a set of links to the pages in your instance where you perform the configuration.

The Guided Setup process keeps track of what tasks you have completed, so that you can stop and start again where you left off.

Multiple-run support in Guided Setup

It's important to note that the Guided Setup builder and player support multiple run or execution of tasks. You can switch between the two execution types, single and multiple. You can skip the execution creation page and load your default configuration with each run when you select multiple run on the configuration page.

Guided Setup home page

The Guided Setup homepage contains an overview of configuration types for your Guided Setup. You can select the Guided Setup type and Continue to launch the Guided Setup steps and begin configuration.

Guided Setup categories page

guided setup categories page.

The categories page contains an overview and descriptions of the categories and associated tasks. You can click either the drop down arrow to view information about the category or the Start button to open the Guided Setup steps and begin configuration.

1. Completion indicator
The completion indicator shows all progress through Guided Setup steps at a glance. Each circle represents a category and its status.
  • Empty circle: Category is not started.
  • Lock symbol: Feature is not activated. You can look at the setup tasks, but not perform them.
  • Purple circle: Category is completed.
2. Category task completion status
For each category you can start or continue working on tasks, or edit the statuses of completed tasks.
3. Category information
The category name and description appear. The description includes further planning information and links to additional content to help you with configuration.
4. Tasks
Lists the tasks and completion status for each activity. Click a task to go to the tasks for that category.

Use the filter above the task list to display only complete or incomplete tasks, as desired.

Guided Setup task page

guided setup task page.'

To perform a task click on one of the tasks listed and select Mark as complete once completed.

Other actions you can take include:
  • <Category>: Click your category drop down to view a list of all categories.
  • Add Notes: Add notes when assigning task, such as stating how far you got before you had to exit. Notes can help another administrator who continues the work.
  • Mark as Complete: Click this to mark a task as complete in your Guided Setup.
    Note: It may be necessary to mark a task as complete to move on to the next task.
  • You can also create a UI page by accessing a Guided Setup task template in the UI Builder template section.
  • Embedded Help Click help icon. to learn more about the task.

Other Guided Setup features

Lock icon
When it appears against an activity, task, or subtask, you cannot access the item. You may need to activate a plugin or complete a prerequisite task to unlock it.
Action buttons
After beginning Guided Setup tasks, Get Started options are changed to Continue. Other action buttons change to prompt you to continue with or edit completed tasks.