Looking for the previous version? View v2024.06 documentation →
Troubleshoot
Run platform diagnostics to quickly identify and resolve configuration or connectivity issues.
Overview
The Troubleshoot section in System Preferences provides a guided diagnostic utility that checks key platform components — database connections, middleware connectivity, and configuration integrity — and reports any issues found. Running the troubleshooter is the recommended first step when diagnosing unexpected platform behaviour or after making infrastructure changes.
Prerequisites
- You are logged in to Data Trust with an Admin Pro-User role.
- Admin Console access has been granted by your system administrator.
Navigating to Troubleshoot
Path: Data Trust › Admin Console › System Preferences › Troubleshoot
Figure 1: Admin Console — System Preferences landing page
Open Admin Console and navigate to System Preferences to find the Troubleshoot tile among all available platform configuration options. Only users with an Admin Pro-User role have access to Admin Console and the Troubleshoot diagnostic utility. The Troubleshoot feature is a key tool for identifying connectivity and configuration issues quickly without needing to inspect server-side files manually.
Figure 2: Troubleshoot tile in System Preferences
Click the Troubleshoot tile on the System Preferences page to access the guided diagnostic utility for the Data Trust platform. The tile provides a clear label so it is easy to identify among the other configuration tiles on the page. This utility should be your first step when users report unexpected errors or after any infrastructure change that could affect platform connectivity.
Running the Troubleshooter
- On the Troubleshoot page, review the list of diagnostic checks that will be performed.
- Click Run or the appropriate action button to start the diagnostic process.
- Review the results for each check.
Figure 3: Troubleshoot diagnostics page
The Troubleshoot diagnostics page lists all checks the utility will run, including database connectivity, middleware health, scheduler status, and configuration integrity validations. Each check is described so you understand what is being tested before initiating the diagnostic run. Review the list to confirm all relevant checks are included for your specific issue before clicking Run.
Figure 4: Troubleshoot diagnostics completed successfully
A successful diagnostic run shows a green status indicator for every check, confirming that all core platform components are healthy and functioning correctly. If any check shows a warning (amber) or failure (red) status, the corresponding check result will include a brief description of what was found. Use the information from failed checks to guide your investigation — navigate to the relevant configuration section to correct the identified issue and re-run the diagnostics.
Figure 5: Troubleshoot — Menu icon for additional options
The menu icon on the Troubleshoot page provides additional options, such as exporting the complete diagnostic report as a file or re-running individual checks in isolation. Export the diagnostic report when opening a support ticket so the support team has full visibility into the platform health at the time of the issue. Re-running a specific check after applying a fix is a quick way to confirm the resolution without repeating the full diagnostic suite.