Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Using guided setup

Log in to subscribe to topics and get notified when content changes.

Using guided setup

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.

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 you have completed, so you can stop and start again where you left off.

Guided setup home page

The home page for most guided setup modules contains an overview and descriptions of the categories and associated tasks. You can click either the home icon or the Get Started button to open the guided setup steps and begin configuration. Click the home icon on the left to return to this page.

Figure 1. Example layout of the guided setup home page
Sample guided setup home page

Guided setup categories page

Guided setup category page
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: The task is not started.
  • Circle with a lock: Feature is not activated. You can look at the setup tasks, but not perform them.
  • Partial blue border: The percentage of tasks that are complete.
  • Circle with curved arrow: Activity tasks were skipped.
  • Green circle with check mark: Activity tasks are completed.

Point your cursor at any circle to see what it represents. The percentage at the top is updated as tasks are completed.

2. Category task completion status
For each category, you can view its completion status, which matches its indicator to the left. 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 often 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 (same as clicking an action in the second column).

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

Guided setup task page

Guided setup tasks

To perform a task, click the Configure button. This button opens the page in your instance where the configuration is completed. Embedded help is often available to assist you. If it does not open automatically, click the (?) icon on the upper right.

Other actions you can take include:
  • Breadcrumb: Click < Product> Guided Setup to go back to the categories page.
  • Assign (upper right): Provides a way to assign tasks to other administrators. All tasks in the category can be assigned to a single admin or each can be assigned individually. The list only displays users with the admin role. When a task is assigned, the admin receives a notification to the email address in their user file.
  • Accept Best Practices: Click this action if the link appears. Accepting best practices completes some or all of the tasks for that category.
  • Skip: Click to skip a task if it does not apply to your business process, or you want to implement the feature later.
  • Add Notes: Click to comment the 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 button when the configuration was completed outside of guided setup. After a task is marked complete, the button changes to Mark as Incomplete, allowing you to start the task over.
  • More information: Click this link to read more about the task. The page refreshes with more informative content to help you with the configuration. To return, click the category name in the breadcrumb.

Some tasks have subtasks, represented by tabs below the task information. Task 2 in the illustration is an example of a task with subtasks.

Other guided setup features

Lock icon
When it appears in front of 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.
Unlock by activating plugins
When a category is locked because the associated plugin is inactive, click the View Plugins link to see the details in a pop-up window.
Action buttons
After beginning guided setup tasks, Get Started buttons are changed to Continue buttons. Other action buttons change to prompt you to continue with or edit completed tasks.
Task status and time stamp messages
Below each task in a task page is a status message. It indicates when the task was last visited or completed and the user who took the action.