Potential Guide Health Issues

Below is a list of the potential issues that you might find in Guide Health:

Issue Error Description Fix Guide Function
Sticky Smart Tip/Beacon ERROR_TYPE.STICKY_FLAG_NOT_EXPECTED

The Sticky Guide setting is selected in the Guide Settings. Because this is a smart tip or beacon, Sticky Guide is not necessary and can cause performance problems.

Recommendation: Turn off the Sticky Guide in Guide Settings.

Navigates to guide settings and scrolls to the Sticky Guide option with a message tip.
Always Activation ERROR_TYPE.WRONG_ACTIVATION

The Guide Activation conditions includes a "Display this Guide in Autoload Always" condition. These conditions can slow down Guided Learning because the content is checked on every page.

Recommendation: Avoid "Display this Guide in Autoload Always" conditions by using more specific Guide Activation conditions, like limiting the guide to certain pages if possible.

Navigates to Activation conditions modal.
Not published and launched ERROR_TYPE.NOT_PUBLISHED_AND_LAUNCHED

This content is not published, but it was launched somehow. Typically, another content can trigger launching, so you should search for dependencies.

Recommendation: Search for the guide in the "Content" dashboard and Publish it or Search for the guide that is launching this guide and remove the dependency.

Redirects to User Guide documentation.
Launcher\'s guide to launch is not active ERROR_TYPE.LAUNCHER_LAUNCH_GUIDE_ERROR

The selected guide in "Launch a guide" setting in guide settings is deleted/inactive.

Recommendation: Select a new guide or recover/activate the existing guide.

Navigates to Launcher guide settings to the place where the guide being launched can be updated.
Launcher\'s guide to launch guide\'s start step is missing ERROR_TYPE.LAUNCHER_LAUNCH_GUIDE_STEP_ERROR

The selected guide\'s start step is deleted in "Launch a guide" setting in guide settings.

Recommendation: Select another guide or a new step to start for the exiting guide.

Navigates to Launcher guide settings to the place where the guide being launched can be updated.
Task list has one or more not active guide(s) included ERROR_TYPE.TASKLIST_INCLUDED_GUIDE_ERROR

The deleted/deactivated guide(s) will not show up in the task list.

Recommendation: Delete these guides from the task list or recover/activate the existing guides.

Navigates to task list editor where the relevant guide can be updated.
Task list has no active guide included ERROR_TYPE.TASKLIST_NO_INCLUDED_GUIDE_ERROR

All of the task list\'s guides are deleted/deactivated.

Recommendation: Add active guides to the task list.

Navigates to task list editor where the relevant guide can be updated.
Branched/guide to launch guide is not active ERROR_TYPE.GUIDE_BRANCHED_GUIDE_ERROR

The selected guide in "Branch a guide" or in "Launch a guide" setting in step settings is deleted/inactive.

Recommendation: Select a new guide in the relevant step setting from the Full Editor (can be done by clicking Edit Guide in Fix Guide button)

or

The selected guide in the setting has to be unarchived/ activated.

To activate the guide, search for the guide in "Content" dashboard and Activate it To unarchive the guide, search for the guide in "Archive" dashboard and recover it.

Navigates to OGL Full Editor with the relevant step

or

Redirects to User Guide documentation

Branched/guide to launch guide\'s start step is missing ERROR_TYPE.GUIDE_BRANCHED_GUIDE_STEP_ERROR

The selected guide\'s start step is deleted in "Branch a guide" or in "Launch a guide" setting in step settings.

Recommendation: Select another guide or a new step to start for the exiting guide.

Navigates to OGL Full Editor with the relevant step

or

Redirects to user guide documentation.

Some of the role conditions has undefined role(s) ERROR_TYPE.UNMAPPED_ROLE_CONDITION

The Guide Activation conditions includes an Undefined Role condition. These conditions make guides not to be visible to users because of Undefined roles.

Recommendation: Avoid adding Undefined Roles in activation conditions, or add Application roles to empty OGL role in Custom roles.

Navigates to activated condition to update the condition

or

Further navigates to Custom Roles modal.

Guide cannot be completed ERROR_TYPE.GUIDE_CANNOT_ADVANCE The guide includes a step where none of the tip's selectors are found, preventing the guide from advancing to the next step. Navigates to OGL Full Editor to the step that has the issue.