This article explains how to gather some technical data that can help our Support team at effective issue resolution.
At times when troubleshooting rare or unique issues, gathering specific details is crucial for resolving the problem effectively. In such instances, we may kindly request your assistance in providing comprehensive information regarding the error you're encountering. Here's a helpful checklist of details that will greatly assist us in pinpointing and resolving the issue:
- ID of the project/experiment/task/inventory where you encountered an error
- Username of the user that ran into an error
- Timestamp (down to a minute) of when the issue happened
- Screenshots (or video capture) of the error and any steps that you take (before/after) to replicate the issue
- Browser information (Chrome/Firefox/Safari) and OS (Windows, MacOS)
- Browser logs (see section below to learn how to collect browser logs)
How to collect browser logs
Browser logs show us some communication between your browser and SciNote server. We can see any errors that show us what might be causing the issue.
Console starts capturing data only after it is activated so it is important to have it open before you start replicating the issue in SciNote.
Mozilla Firefox:
- Open browser console by navigating to Menu button and clicking on More tools and then opening Web Developer Tools. (You can also use keyboard shortcut by holding down Ctrl+Shift and then pressing letter i.)
- When the console windows is open try and replicate the steps that bring you up to the issue in SciNote. Console logs should be now gathered in the background.
- Navigate in the Network tab in the console window and provide us a screenshot of the logs. You can also resize the window to capture as many logs in the screenshot as you can.
- Navigate to Console tab in the console window and provide us a screenshot of the logs:
Google Chrome
- Open browser console by navigating to Menu button and clicking on More tools and then opening Developer Tools. (You can also use keyboard shortcut by holding down Ctrl+Shift and then pressing letter i.)
- When the console windows is open try and replicate the steps that bring up the issue in SciNote. Console logs should now be gathering in the background.
- Navigate in the Network tab in the console window and provide us a screenshot of the logs:
- Navigate to Console tab in the console window and provide us a screenshot of the logs:
Safari:
- If you don’t see the Develop menu in your Safari menu bar, choose Safari > Settings, click Advanced, then select “Show features for web developers.”
- At the top of your Safari browser, over the developer console by navigating to Develop and clicking on Show Web Inspector (You can also use keyboard shortcut by holding down Option+Command and then pressing letter i.)
- When the console windows is open try and replicate the steps that bring you up to the issue in SciNote. Console logs should be now gathered in the background.
- Navigate in the Network tab in the console window and provide us a screenshot of the logs. You can also resize the window to capture as many logs in the screenshot as you can.
- Navigate to Console tab in the console window and provide us a screenshot of the logs:
Microsoft Edge
- Open browser console by navigating to Menu button in the upper righthand corner and clicking on More tools and then opening Developer Tools. (You can also use keyboard shortcut by holding down Ctrl+Shift and then pressing letter i.)
- When the console windows is open try and replicate the steps that bring up the issue in SciNote. Console logs should now be gathering in the background.
- Navigate in the Network tab in the console window and provide us a screenshot of the logs:
- Navigate to Console tab in the console window and provide us a screenshot of the logs: