SitecoreDXG Documention
OverviewGetting StartedDownloadsGitHub Repository
Search…
SitecoreDXG: The Documentation Experience Generator
Overview
SitecoreDXG: The Documentation Experience Generator
Comparison with SitecoreUML
CI/CD Integration
Helix Dependency Validation
Getting Started
Compatibility and System Requirements
Installing SitecoreDXG
Upgrading and Downgrading
Downloads
Using SitecoreDXG
Architecture
Architecture Overview
Roles
Components
Plugins
Middlemen
Understanding the Default RabbitMQ Middleman and Trigger
How To
CI/CD Integration
Creating a Custom Trigger
Slack and Microsoft Teams Integration
Creating a Custom Completion Handler
Creating a Custom Middleman
Viewing Helix Validation Errors
About the Generated Documentation
Overview
Models
Views
Diagrams
Samples
Powered By GitBook
Viewing Helix Validation Errors
As of SitecoreDXG 1.1.0, the new Helix Validation features have been implemented and validation errors can be reviewed in several ways.

Diagrams

Invalid dependencies are automatically colored "red" in your diagrams. If a red dependency is displaying, view the dependency for more details. If you are looking at a Layer Diagram or a Module Diagram and you are unsure of the source and target templates of the dependency then refer to the Layer and Module Dependency Models section below for more.

Layer and Module Dependency Models

On the documentation page for the Dependency Model that lives under the layer, e.g. (Feature->Feature), or module, e.g. (Multisite->Multisite), you can see all dependencies contained in the layer/module, including any invalid dependencies. Any entries with the INVALID:... prefix are invalid and will state the reason why the dependency is invalid, as well as the source and target template path information to help you track down the offending template(s).

Dependency Models

On the model for the dependency itself you can see the same INVALID:... documentation for the dependency that you find on a Layer or Module dependency model.

Slack and Microsoft Teams Notifications

The completion handlers for Slack and Microsoft Teams natively display any validation errors detected during generation in the generation completion notifications that they send. For more information, refer to the Slack integration and Microsoft Teams integration documentation pages.

Custom

Remember that SitecoreDXG was designed specifically with extensibility in mind. All detected validation errors are passed to the completion handlers via the metaball parameter, thus you can create your own custom error handling logic that runs after generation has completed by creating a custom completion handler.
​
​
​
​
​
​
How To - Previous
Creating a Custom Middleman
Next - About the Generated Documentation
Overview
Last modified 2yr ago
Copy link
Contents
Diagrams
Layer and Module Dependency Models
Dependency Models
Slack and Microsoft Teams Notifications
Custom