Minimum Version Required: 26.01
Pre-Conditions
Must have an active internet connection and access to the web application or service.
Requires access to the specific URL or system workflow where the error was generated.
For advanced troubleshooting, requires administrative or developer access to system logs, environment configurations, and deployment history.
Steps
Refresh the Page: Hard refresh your browser (Ctrl+F5 on Windows, Cmd+Shift+R on Mac) to ensure the error is not a momentary connectivity glitch or a temporary timeout.
Clear Browser Cache and Cookies: Clear your browser's cached data and cookies to ensure you are not loading stale or conflicting session data that might be causing a bad request to the server.
Identify the Trigger: Attempt to replicate the issue by repeating the exact steps you took before the error occurred. Note if the error happens on a specific page, during a specific data entry, or upon submitting a specific form.
Check for Recent Deployments (System Administrators): Review the deployment log to see if any recent software versions, configuration updates, or environment changes were introduced right before the issue started.
Verify Configurations (System Administrators): Check environment configurations, including connection strings, key vaults, and required secrets, to ensure none are missing or expired.
Contact Support: If the issue persists after attempting the steps above, please contact our support team. To ensure efficient troubleshooting, gather and provide the following information:
Exact error messages or codes encountered (including any trace IDs or detailed text displayed on the screen).
Screenshots or video recordings of the issue occurring.
Log files (specifically server-side application logs or stack traces, if accessible).
The exact steps taken by the customer that led to the issue (e.g., "Logged in, clicked 'Reports', selected 'June', clicked 'Export'").
The date and time the issue was first observed, your time zone, and any recurrence patterns.
Any changes made to the system before the issue appeared (e.g., recent system upgrades, changed permissions).
Fields And Definitions
500 Internal Server Error: A generic HTTP status code indicating that the server encountered an unexpected condition that prevented it from fulfilling the request.
Unhandled Runtime Exception: An error that occurs during the execution of back-end code that the application is not programmed to handle or bypass gracefully.
Null Reference: A programmatic error where the code attempts to access or interact with an object, variable, or data point that has no assigned value (is null).
Type Cast Failure: A coding error that occurs when the system attempts to treat a piece of data as the wrong format (e.g., trying to read text as a number).
SQL Runtime Error: An error that occurs when the application attempts to communicate with the database, often caused by bad query formatting, missing data, or connection timeouts.
Downstream Dependency Failure: An outage or error that occurs when a secondary system, API, or service that the primary application relies upon fails to respond correctly.
Best Practices
Robust Error Handling: Ensure development teams implement comprehensive try/catch blocks within back-end code to gracefully handle exceptions and provide user-friendly error messages rather than raw 500 status codes.
Pre-Deployment Verification: Always verify environment configurations (like connection strings and key vaults) in a staging environment before deploying to production to prevent configuration incompatibilities.
Dependency Monitoring: Set up automated monitoring and alerting for all downstream dependencies and third-party APIs to quickly identify when an external service is causing internal failures.
Detailed Logging: Maintain detailed, centralized server logs that capture full stack traces for runtime exceptions, allowing for rapid root-cause analysis when 500 errors do occur.