7 Health

Developers can review guide issues from either the guide card for an individual guide or a list of all errors from the navigation panel.

View errors of a single guide

If a guide has an error, for example if a smart tip has been incorrectly flagged as a sticky guide, this will show on the guide card as an error, as in the image below.
tile display example

You can click on the heart icon icon to display the error in the Guide Health modal.

health check

Viewing all errors in your application

Clicking on the error link shows details about the reported error and any recommendations to resolve it. You can now make the necessary change to the guide to resolve the issue if needed.

Alternatively, you can also see all guide health issues by selecting the Check Guide Health icon located at the top of the console.

Health issues

The Health modal will appear displaying a list of all guide errors identified within the Content library and any details about the errors.

Errors list

Available Actions

For each reported error, you have three options:

  • Edit Guide

    (EG ):

    Opens the guide in the Redwood Guide Editor to allow you to resolve the error.
  • Mark as Resolved

    ( mark as resolved ):

    Removes the error from the Guide Health error list. Note: If the error is not corrected, it will appear again after the next health check.)
  • Ignore

    ( ignore ):

    Hides the error from the Guide Health error list.
  • Don't Ignore

    ( dont ignore ):

    To display all ignored errors, select "Show Ignored" at the bottom of the Guide Health modal. For any ignored error, select Don't Ignore to unhide the error.
  • Details

    ( details ):

    Displays the Domain, URL, and Environment associated with the error.

To show/hide ignored errors in the error list, select one of the following options located at the bottom of the Guide Health modal:

  • show ignored Show Ignored: Toggles the Guide Health error list to show all ignored errors.
  • hide ignored Hide Ignored: Toggles the Guide Health error list to hide all ignored errors.

Sorting and Filtering Errors

To sort errors by their severity, select the Severity

( Severity )

drop-down menu and select a sort order:

Sev1

To filter errors by a specific keyword contained within the guide and/or error, select the Search

( search )

bar and enter a keyword.

Some examples of search terms include:

  • Guide name
  • apiName
  • Status
  • Issue description
  • Recommendation

To filter errors by specific domains, select the Domains

( Domain )

drop-down menu and select one or more domains on from which to display errors.

Domain Select

To show/hide the Domain, URL, and Environment associated with a specific error, select the Details

( details )

, button or Close Details

( close details )

button below the error.

Close det

Potential Guide Health Issues

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

Issue Error Description
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.

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.

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: Publish this content or find the other one which triggers its launch.

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.

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.

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.

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.

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 or recover/activate the existing guide.

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.

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.

Guide cannot be completed ERROR_TYPE.GUIDE_CANNOT_ADVANCE

The guide has a step where none of the tip\'s selectors can be found, therefore the guide cannot advance to the next step.

Note: Beginning in OGL 24D release, the "Guide cannot be completed" health check and error message will be temporarily removed from the Guide Health tool. This health check and related error code are being redeveloped and recalibrated for better accuracy and will be reintroduced to the Guide Health tool in a future release.

separator