Diagnostic Tool

Diagnostic Tool allows content developers to diagnose different types of guide issues they may encounter and efficiently troubleshoot them from within the application. This feature adds an additional option for content developers to independently troubleshoot and remediate common types of guide issues without the need to contact support. Content developers can enable the diagnostic tool on any page of the host application to quickly identify and resolve common guide issues.

Some common questions that this tool can help to answer include:

• What user fields are set for this user? (maybe the guides are not launching because the field you are expecting is not set.)
• Is OGL embedded with env = dev or prod?
• How do I identify the page I am on?
• What guides are currently running on this page? (this can be used to identify which guide is displaying an unwanted tooltip)

Launching the Diagnostic Tool

To invoke the Diagnostic Tool from any page on the host application, right-click anywhere on the page, then select Inspect.

In the Inspect panel, select Console, then enter the following text string into the command line: iridize.diagnose();Then press the Enter key

The Diagnostic Tool will open. Select an issue that best matches the issue that you are experiencing.

Note:

You may close the Inspect panel to expand the browser back to normal size.

The Diagnostic Tool will display any errors it identifies with a description of the error that includes relevant information about the guide error, including: AppID, Environment, OGL Server, Page ID, User Information (if applicable), Guide Name, ApiName, and Error Description.

Select Resolve the issue to be guided to the relevant OGL user documentation where you can find information on how to resolve this issue.If this does not resolve the issue, you can also select Log a service request to be directed to the appropriate OU Support page to submit a request for support.Select Save if you wish to download a text file containing all relevant information about this issue, which can be provided to the Support team to help facilitate a resolution more quickly.

Known Issues / Expected Behavior

The Diagnostic Tool will only work with OGL 24A Player Package and is not backward compatible to applications relying on an older version of OGL’s Player Package (prior to 24A).