Data to Submit with an ArchFX Bug Report or Enhancement Request

Important:

• If the problem appeared in the ArchFX React web app (the main app/set of tabs, not a Grafana dashboard or ArchFX Batch Report or Qlik App) and there is a "Report Issue" button on the screen, click the "Report Issue" button right away when you see the problem to submit a "crash report" with browser debugging information. Then email help@archsys.io to start your official bug report.
• All bug reports must be emailed to help@archsys.io in order to receive a response and follow-up. (Please do not email individual Arch employees directly; such emails are likely to be overlooked.)
• Please submit only one issue per bug report so that each ticket and its follow-up messages will concern a single problem. (It slows us down when one ticket includes multiple problems. We'd prefer to get 10 tickets with 1 problem each than 1 ticket with 10 problems that we then have to break apart into separate tickets. )

Data to submit

Please submit as much of the below data as possible with any bug report or enhancement request to help us understand, reproduce, and isolate issues as quickly as possible.

• (if React) "Report Issue" crash report (by clicking the "Report Issue" button)
• User First Name and Last Name or email address
• Site name
• Line name
• Machine name (if machine-specific issue)
• Job Name (if applicable, e.g. when running a particular job in React)
• Exact date and time the bug occurred (including exact, absolute times in 24-hour clock and local time zone)
• URL of the screen you saw the problem on
• What you were doing when the problem occurred
• What you expected to happen
• What actually happened
• Screen shot and/or video of the bug occurring (if possible)
• HAR file downloadable from the browser dev console (see below) 

Text template for submitting your bug report / enhancement request

FULL NAME OF USER WHO EXPERIENCED PROBLEM: [FIRST NAME AND LAST NAME]

EMAIL OF USER WHO EXPERIENCED PROBLEM: [EMAIL ADDRESS]

SITE:

LINE: 

MACHINE (if applicable): 

JOB NAME (if applicable): 

On the [NAME OF SCREEN], I was [FILL IN WHAT YOU WERE DOING] at [YYYY-MM-DD HH:MM IN 24-HOUR CLOCK] in the [TIME ZONE] time zone.

URL: [COPY URL]

SCREEN SHOT: [INSERT]

Expected result: When I [ACTION], I expected it would [FILL IN WHAT YOU EXPECTED TO HAPPEN]

Actual result: Instead, [FILL IN WHAT ACTUALLY HAPPENED]

(if ArchFX React) Were you able to submit a "Report Issue" crash report? [Y/N]

Can you reproduce the problem? [Y/N]

What is the business impact of the problem? [PLEASE EXPLAIN]

How could we change the product to eliminate the problem or provide the desired functionality? [PLEASE PROVIDE ADDITIONAL INFORMATION IF NECESSARY, e.g. "Use the following more precise formula for calculating METRIC NAME."]

On Grafana dashboards, specify the time zone and an absolute time period if possible

Grafana defaults to using the browser's current time zone and to using relative time periods (e.g. "last two days"), as shown here:

That's usually convenient for end users, but it makes bug reports harder to analyze because the engineer first has to figure out what time in what time zone the user was looking at the screen and THEN look into our data on the cloud.

To save time on troubleshooting problems with Grafana dashboards, please see if you can reproduce the problem while using an absolute time period, specifying the time zone (like 2023-07-03 15:46 CEST to 2023-07-05 15:46 CEST), as follows:

• On the Grafana dashboard, click the date picker in the top-right corner of the screen:
   
• Click "Change time settings"
  
• Choose your time zone:
  
• Change the time period reference from a relative time range (such as from "now-2d" to "now") to an absolute time range (like 2023-07-03 15:46 CEST to 2023-07-05 15:46 CEST), being sure to enter the times using the 24-hour clock:
  
• Click "Apply time range" to apply the values you just selected:
  

How to generate a HAR file

• On Windows Edge or Chrome: Press (Ctrl + Shift + J; go to the “Network” tab;  reproduce the bug and wait for the problem to occur; click on the”Download” button (which is an arrow towards the button) and you’ll get the HAR file
• On Mac Chrome: Press Command Option J; go to the “Network” tab;  reproduce the bug and wait for the problem to occur; click on the”Download” button (which is an arrow towards the button) and you’ll get the HAR file

How to collect a console log (Chrome browser only)

Please see "Collecting console logs (Chrome browser only)."