Overview
The Application Diagnostics page provides a centralized view of the health and configuration status of key Znode components. Administrators can use this page to identify potential configuration issues that may affect application functionality and verify that required platform services are configured correctly.
Application Diagnostics is intended to validate the health and configuration of application dependencies. Diagnostic results help identify potential issues but should not be considered confirmation that all related business processes are functioning successfully.
For example, a successful diagnostic result confirms that a configuration validation passed, but it does not guarantee successful execution of downstream processes such as email delivery, search indexing, file operations, or application transactions.
Prerequisites
- Administrative access to the Znode Admin Console.
- Permission to access Diagnostics & Maintenance.
Navigate to Application Diagnostics
- In the Admin Console, navigate to Admin.
- Select Diagnostics & Maintenance.
- Click Diagnostics.
The Diagnostics Details page displays the status of supported application components.
Diagnostic Categories
The Application Diagnostics page validates the health and configuration of the following components:
| Category | Description |
|---|---|
| Database | Validates SQL Server connectivity and configuration. |
| Elastic Search | Validates Elasticsearch connectivity and configuration. |
| Permission | Validates required application folder permissions. |
| SMTP | Validates SMTP configuration health. |
Understanding Status Indicators
The Status column displays the result of each validation.
| Status | Meaning |
|---|---|
| Green | The configuration validation completed successfully. |
| Red | A configuration issue was detected and requires review. |
Select Refresh to run the diagnostics again and display the latest validation results.
Startup Configuration Validation
During application startup, Znode validates several critical configurations, including:
- SQL Server configuration
- MongoDB configuration
- Elasticsearch configuration
- SMTP configuration
If a configuration issue is detected, the corresponding diagnostic status reflects the failure and can be used as a starting point for troubleshooting.
Database Diagnostics
What the Database Status Validates
The Database diagnostic validates that the application can connect to the configured SQL Server database and that the required database configuration is accessible.
Green Status
A Green Database status indicates that the application successfully connected to the configured SQL Server instance and completed the database connectivity validation.
Red Status
A Red Database status indicates that the database validation failed.
Possible causes include:
- Invalid database connection string
- Incorrect database credentials
- SQL Server service unavailable
- Network connectivity issues
- Firewall or security restrictions
Important Considerations
A Green Database status confirms that the configured SQL Server connection is accessible at the time the diagnostic is performed.
A Green status does not guarantee:
- Optimal database performance
- Successful execution of all database transactions
- Data integrity or data accuracy
- Freedom from blocking, deadlocks, or performance bottlenecks
- Availability of sufficient database resources
If application performance or transaction issues occur, additional database investigation may be required even when the Database diagnostic displays Green.
Elastic Search Diagnostics
What the Elastic Search Status Validates
The Elastic Search diagnostic validates that the application can communicate with the configured Elasticsearch service and that the search configuration is accessible.
Green Status
A Green Elastic Search status indicates that the Elasticsearch connectivity and configuration validation completed successfully.
Red Status
A Red Elastic Search status indicates that the validation failed.
Possible causes include:
- Elasticsearch service is unavailable.
- Incorrect Elasticsearch endpoint configuration.
- Authentication or security configuration issues.
- Network connectivity issues.
- Invalid search service configuration.
Important Considerations
A Green Elastic Search status confirms that the configured Elasticsearch service is accessible at the time the diagnostic is performed.
A Green status does not guarantee:
- Search indexes are current.
- Newly added products or content have been indexed.
- Search results are complete or accurate.
- Search performance meets business requirements.
- Indexing jobs are executing successfully.
If storefront search or indexing issues occur, search functionality should be validated separately from the Application Diagnostics page.
Permission Diagnostics
What the Permission Status Validates
The Permission diagnostic validates that the application has access to the required file system locations and that the necessary folder permissions are available.
Green Status
A Green Permission status indicates that the required folder permission validation completed successfully.
Red Status
A Red Permission status indicates that one or more required permissions could not be validated.
Possible causes include:
- Missing read permissions.
- Missing write permissions.
- Restricted service account access.
- Security policy changes.
- File system access restrictions.
Important Considerations
A Green Permission status confirms that the required folder permissions were available when the diagnostic was executed.
A Green status does not guarantee:
- Future file operations will succeed.
- External storage locations remain accessible.
- Third-party integrations have sufficient permissions.
- Permissions have not changed since the validation was performed.
If issues occur with file uploads, exports, media management, logging, or integrations, the underlying folder and service account permissions should be reviewed separately.
SMTP Diagnostics
What the SMTP Status Validates
The SMTP diagnostic is a configuration and health validation indicator that helps administrators identify potential SMTP configuration issues.
The SMTP diagnostic validates that a usable SMTP configuration exists for the store evaluated by the diagnostic process.
How SMTP Status Is Evaluated
The SMTP diagnostic evaluates the SMTP configuration associated with the store that has the lowest Portal ID, which is typically the Default Store.
Green Status
A Green SMTP status indicates that the evaluated store contains a valid SMTP configuration and that the SMTP configuration validation completed successfully.
Red Status
A Red SMTP status indicates that an SMTP configuration issue was detected for the evaluated store.
For example:
| Store | Portal ID | SMTP Configured |
|---|---|---|
| Default Store | 1 | No |
| B2B Store | 2 | Yes |
| Retail Store | 3 | Yes |
In this scenario, the SMTP diagnostic evaluates the Default Store because it has the lowest Portal ID. Since SMTP is not configured for the Default Store, the SMTP diagnostic displays a Red status even though SMTP is configured for other stores.
Important Considerations
A Green SMTP status confirms that the SMTP configuration validation passed.
A Green status does not guarantee:
- Emails were successfully sent.
- Emails were received by intended recipients.
- Emails were delivered to recipient inboxes.
- Emails were not filtered as spam or junk mail.
- All stores have valid SMTP configuration.
- The email provider accepted and delivered every message.
Actual email delivery may still be affected by:
- Store-specific SMTP configuration.
- Authentication or credential issues.
- Spam and security filtering.
- Recipient mailbox rules.
- Email suppression lists.
- Domain reputation policies.
- Email provider restrictions.
- Third-party email service behavior.
Because of these factors, Application Diagnostics should not be used as confirmation of successful end-to-end email delivery.
Validate Store-Level SMTP Configuration
SMTP configuration should be reviewed separately for each store.
To review SMTP settings:
- Navigate to Stores and Reps > Stores.
- Select the store.
- Click Manage.
- Open the SMTP tab.
- Review and update the SMTP settings as required.
- Save the changes.
If email delivery issues occur, verify both:
- The SMTP status in Application Diagnostics.
- The SMTP configuration configured for the affected store.
NOTE: For two-factor authentication, the SMTP configuration defined under Global Settings > Two-Factor Authentication Settings is used instead of the default store SMTP configuration.