Work with step-by-step guides

For context on what step-by-step guides can be used for, see Understand step-by-step guides.

Create a new guide

1. Select the symptom, solution, question, or message node for which you want to use a step-by-step guide. This opens its edit panel.

2. Check the "Use step-by-step guide" box.

3. In the dropdown menu, select "Create new".

4. Edit the guide as needed - see Edit a guide.

Reuse an existing guide

1. Select the symptom, solution, question, or message node for which you want to use a step-by-step guide. This opens its edit panel.

2. Check the "Use step-by-step guide" box.

3. In the dropdown menu, select the guide you want to use.

4. If needed, click "Edit" and edit the guide as needed - see Edit a guide.

Edit a guide

1. Enter a title for the guide. This will be used in the assistant builder and is also visible to the user when they are using the guide.

2. In the left pane, add steps and set titles as necessary. They will be numbered automatically.

3. With a step selected in the left pane, edit its description in the right pane to add any more details.

4. If you need more advanced logic within your guide such as branching steps, you can edit it as a flow component - see Edit a guide as a component.

5. When finished, click the X in the top-right corner to exit the guide editor.

Edit a guide as a component

1. While editing the guide, click "Open Component".

2. The guide is opened on the canvas as a flow component.

3. Make changes to the guide as desired. Note that you will only be able to use steps and not any other node types, but these steps can have multiple options available to the user which then lead to different other steps.

4. When finished, return to the parent flow by clicking its name.