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.

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

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.

1. Open Guide health modal from the heart button on the top right corner of the console.
   
   
   
   
   

2. The Guide health modal opens displaying the guide error. Click on the Fix Guide button to go ahead and fix the issue.
   
   
   
   
   

3. Clicking on the Fix guide button redirects you to the required location to fix the error, which in this case, is the Activation conditions modal.There is also an OGL guide up and running to provide instructions on how to fix the error.

   p

   
   
   
   
   

4. The guide instructs the user to assign values to undefined roles or delete the condition. The user would like to assign a value to the role and clicks on the pointed link. This redirects them to the required location, i.e. the Custom Roles modal.
   
   
   
   
   

5. Notice how the guide continues to this place as well, instructing the user on what must be done.
6. The user now adds a value to the role and clicks on Save.
7. The error is now fixed!
   
   
   
   
   

Note:

This is an example user flow and the behavior would be different based on the guide error that the user is trying to resolve.

Known Issues/Expected Behavior

1. Expected Behavior:

• The “Fix Guide” option for “NOT_PUBLISHED_AND_LAUNCHED” guide errors
• Activate/Unarchive guide option under Fix guide for “GUIDE_BRANCHED_GUIDE_ERROR” guide errors

  Both the options would redirect the user to Guide health user documentation.

2. Known Issue: Currently, the documentation redirection for NOT_PUBLISHED_AND_LAUNCHED and GUIDE_BRANCHED_GUIDE_ERROR scrolls to the respective guide errors on the documentation. There can be scenario where an update of the documentation might make the scroll not work and redirect to the top of Guide health documentation.

Available Actions

For each reported error, you have three options:

• Fix Guide
  
  
  
  
  Opens the relevant modal where the guide error has to be fixed along with the instructions using OGL Guides.
• 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
  Hides the error from the Guide Health error list.
• Don't 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
  
  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: Toggles the Guide Health error list to show all ignored errors.
• 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

drop-down menu and select a sort order:

To filter errors by a specific keyword contained within the guide and/or error, select the 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

( )

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

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

, button or Close Details

button below the error.

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