Avatar Diagnostic

Overview

AppNavi Avatar Diagnostic helps identify potential issues in applications where AppNavi is integrated. It checks whether native JavaScript objects have been modified and helps identify website event handlers that may interfere with AppNavi functionality.

Some applications modify standard JavaScript methods or register event handlers that affect how AppNavi works.

For example:

• If an application overrides JSON.parse in a non-standard way, AppNavi may not function correctly.
• If an application prevents default selection events, users may be unable to interact with the Avatar tooltip editor.

Avatar Diagnostic provides technical information that helps developers investigate these issues.

Also some websites attach event listeners which work in such a way that may prevent proper AppNavi functions.

For example, if following event exists, It may prevent clicking inside the tooltip editor.

window.onselect = function (e) { e.preventDefault(); }

Therefore, looking at the above issues, its necessary for AppNavi to detect which Native objects have been modified and which events have been registered by the website so that when its time to debug the issues, developers are equiped with the information that they need.

When to Use Avatar Diagnostic

Use Avatar Diagnostic when:

• AppNavi features do not work as expected in a specific application.
• Users cannot interact with Avatar elements, tooltips, or editors.
• AppNavi behaves differently from one application to another.
• Developers suspect that the application has modified native JavaScript objects.
• The development or support team needs additional information to investigate an issue.

What objects does it track?

Currently it checks for the following Native objects. These are the most used objects used in AppNavi.

• Date
• Array
• Object
• String
• Number
• Boolean
• Function
• BigInt
• Symbol
• JSON
• Map
• Set
• WeakMap
• WeakSet
• Promise
• RegExp
• Window
• Document

The diagnostic output helps developers investigate potential modifications to these objects. A reported difference should be investigated before concluding that it is the cause of an AppNavi issue.

When Does Avatar Diagnostic Run

Its run 2 seconds after AppNavi is initialized and only runs when globalDebug is on.

To enable Global Debug Mode through the browser console, use:

appnavi.runtime.setGlobalDebug(true)

After the diagnostic runs, its output appears in the browser Developer Tools console.

Please note that diagnostic output is logged as debug and therefore only visible to user when All or Verbose mode is selected in the browser console.

For more information, see Global Debug Mode.

How to Run Avatar Diagnostic Manually

Sometimes its desirable to not rely on the automatic diagnostic call, instead call it manually. In order to call it manually one can use following code.

Standard Diagnostic

Run the following command in the browser Developer Tools console

This runs the diagnostic and displays its output in the console.

appnavi.diagnostic.run()

Detailed Diagnostic

To include the method body in the diagnostic output

Use the detailed diagnostic when additional information is required to investigate a suspected JavaScript modification.

To see more detailed diagnostics, call diagnostic with true parameter and it will output the method body as well.

appnavi.diagnostic.run(true)

Note: The detailed output is intended for technical investigation. If you are unsure how to interpret it, share the relevant information with AppNavi Support or your development team.

Whats the impact?

In order to keep impact of diagnostic class minimum, we execute it 2 seconds after AppNavi is initialized. Also the automatic run is conditional as it only runs when global debug is on.

Therefore we can say that for normal users, there is no impact at all. For tech users who have global debug enabled, there is only minimum impact as it runs after 2 seconds.

Global Debug Mode

Display the enhanced logging to the console.

The global debug mode is primarily designed to provide core members with enhanced details on the console regarding AppNavi.

When "global debug mode" is activated, users will have access to this enhanced level of detail. This includes all functions necessary for debugging an application, such as API calls, z-index calculations, mining events, and more.

If this option is disabled, users will not be able to view additional events or details on the console.

To enable this option, users can follow these steps:

1. Navigate to the avatar icon.
2. Click on the "Open Settings" icon.
3. Access the "Settings" menu by clicking button.
4. Locate the "Global Debug Mode" option from General settings section.
5. Enable it to activate detailed logging on the console for both logged-in and logged-out users.

When to Use Global Debug Mode

Enable Global Debug Mode when you need to:

1. Investigate an AppNavi or Avatar issue.
2. Troubleshoot why an AppNavi feature is not working as expected.
3. Verify whether AppNavi events are being generated.
4. Inspect API requests and responses related to AppNavi.
5. Investigate element positioning or z-index-related issues.
6. Provide additional technical information to AppNavi Support or development teams.
7. Collect console information while reproducing an issue.

For normal users, Global Debug Mode should remain disabled unless troubleshooting instructions specifically require it.

Prerequisites

Before enabling Global Debug Mode:

1. You must have access to the AppNavi Avatar.
2. You should be able to open the browser's Developer Tools.
3. If you are troubleshooting a specific issue, reproduce the issue after enabling debug mode so the relevant diagnostic information is captured.
4. Use a supported browser and ensure the AppNavi Avatar is loaded correctly.

Tip: If AppNavi Support has asked you to collect diagnostic information, keep the issue description, affected application, URL, and steps to reproduce available while collecting the logs.

How to Enable Global Debug Mode

1. Open the AppNavi Avatar.
2. Click the Avatar icon.
3. Click Open Settings.
4. Open the Settings menu.
5. In the General settings section, locate Global Debug Mode.
6. Enable Global Debug Mode.
7. Open the browser's Developer Tools.
8. Select the Console tab.
9. Reproduce the issue or perform the action that you want to investigate.

Global Debug Mode enables detailed logging in the console for logged-in users.

Where Debug Information Appears

The additional information is displayed in the browser's Developer Tools → Console.

Depending on the feature being investigated, the console can contain information related to:

1. AppNavi API calls.
2. Mining events.
3. z-index calculations.
4. Other AppNavi diagnostic information.

The exact messages displayed can vary depending on the AppNavi features being used and the activity performed while debug mode is enabled.

Privacy and Security Considerations

Debug information may contain technical details about the current application session, requests, events, URLs, or other information generated while using AppNavi.

Therefore:

• Only enable Global Debug Mode when it is required for troubleshooting.
• Do not share console output publicly.

When to Disable Global Debug Mode

Disable Global Debug Mode when troubleshooting is complete.

To disable it:

1. Open the AppNavi Avatar.
2. Click the Avatar icon.
3. Open Settings.
4. Go to General settings.
5. Turn Global Debug Mode off.

After disabling it, AppNavi will no longer display the additional debug information provided by Global Debug Mode in the console.

Recommended : Keep Global Debug Mode disabled during normal usage and enable it only when troubleshooting or when requested by AppNavi Support team.

Troubleshooting: Symptoms, Results, and Actions

Use the following table to determine when to run Avatar Diagnostic, what the results may indicate, and what to do next.

Important: Diagnostic output provides investigation clues, not a definitive diagnosis. A reported modification does not automatically mean it is responsible for the observed problem.