Create guided setup
- UpdatedAug 3, 2023
- 4 minutes to read
- Vancouver
- Adoption services
The Vancouver release is no longer supported. As such, the product documentation and release notes are provided for informational purposes only, and will not be updated.
Create a guided setup to assist users with planning the roll-out of a product and performing the basic configurations to go live.
Before you begin
Role required: admin
Procedure
- Navigate to All > Adoption Services > Guided Setup.
- Select Build your guided setups tab.
- Select Create new.
-
Select Get started.
-
Fill in the form.
Table 1. Introduce the guided setup form Field Definition Name The name of your guided setup. Description Describe the purpose of this guided setup. User roles Roles required to access the guided setup. This setup will include installation of plugin Select if the guided setup requires the use of plugins. Note: If selected, a Plugins category is created for you. -
Select Continue.
The category and task dashboard is displayed.
-
To edit the Plugins category, do the following:
-
Select the more actions menu
on your category.
- Select View/edit category from the options list.
- Fill in the form.
-
Select the more actions menu
-
To add a category to your guided setup, do the following:
Figure 1. Guided setup category and tasks - Select Add category.
- Give your category a name.
-
Select the more actions menu
on your category.
- Select View/edit category from the options list.
-
Fill in the form.
Table 2. Define category Field Description Name The name of your category. Description The description of the category. Article title The title of an article you’re linking to for additional context. Video title The title of a video you're providing for additional context. Article URL The URL for an external article. Note: It will open in a new browser tab for the user.Video URL The URL for an external video. Note: It will open in a new browser tab for the user. - Select Continue to task.
-
To add tasks to your guided setup category, do the following:
Figure 2. Guided setup task page -
Fill in the form
Table 3. Task form Field Description Name The name of your task. Instructions The instructions for completing your task. Task type Task types options are as follows: - Input form: adding records to existing tables.
- I-framed page: show any page as Inline frame.
- External links: add articles and videos.
- Select Continue.
-
Fill in the form
-
To delete a category or task, do the following:
-
Select the more actions menu
on your category.
-
To delete a category, select Delete category
from the options list.
Note: Deleting a category deletes all tasks under that category.
- To delete a task, select Delete task from the options list.
-
Select the more actions menu
-
To configure a task input form, do the following:
Figure 3. Guide setup input form -
Fill in the form
Table 4. Input form Field Description Select table The table to be input. Select table view The table view. - Select Continue.
-
Fill in the form
-
To configure a task inline frame page, do the following:
Figure 4. Guided setup inline frame page -
Add a URL to the I-frame.
Note: Select the pencil edit button, to edit your URL.
- Select Continue.
-
Add a URL to the I-frame.
-
To configure external links for your task, do the following:
Figure 5. Guided setup external links -
Note: Additional links can be added with the Add Link button.Fill in the form.
Table 5. External links article form Field Description Link type The type of external link to create. Article title The title of the article. Article URL The URL for the article. Table 6. External links video form Field Description Link type The type of external link to create. Video title The title of the video. Video URL The URL for the video. - Select Continue.
-
- (Optional)
Fill in task settings
-
Select event to unlock task after.
Note: Select event dependency can’t be defined on the first task.
- (Optional) Select the box to enable users to delegate plugin installation task to other users or user groups.
-
Select the setup scope for this task:
Table 7. Setup scope Field Description Mandatory task Task is required and includes all options. Best experience and custom Task includes best experience and custom. Custom only Task is custom. - Select Continue.
-
Select event to unlock task after.
-
Select Finalize.
A check for dependency conflicts message appears.
- Select that you’ve viewed your guided setup for dependency conflicts and select Continue.
-
Create a pre-setup checklist.
For example:
- Image for header
- Content for company description
- Company logo
- Select Finalize.