SitecoreDXG Documention
  • 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
      • General Installation
        • 1. Install the SitecoreDXG Generation Service
        • 2. Install RabbitMQ
        • 3. Install the SitecoreUML Service for Sitecore
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. Install the Default RabbitMQ Middleman in a Custom Location
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline
      • Developer Installation
        • 1. Install the SitecoreDXG Generation Service for Developers
        • 2. Install RabbitMQ for Developers
        • 3. Install the SitecoreUML Service for Sitecore for Developers
        • 4. (Optional) Configure the Documentation Configuration Item for your Solution
        • 5. (Optional) Install the Default RabbitMQ Middleman for Developers
        • 6. (Optional) Integrate SitecoreDXG into your CI/CD Pipeline for Developers
    • Upgrading and Downgrading
    • Downloads
    • Using SitecoreDXG
      • Using the Default RabbitMQ Middleman and Trigger
        • Using the DocumentationConfiguration Object
      • Using the Provided AWS S3 Deploy Completion Handler
      • Using the Provided Azure Blob Storage Deploy Completion Handler
  • Architecture
    • Architecture Overview
    • Roles
      • Role Combinations
    • Components
    • Plugins
      • Trigger Plugins
      • Completion Handler Plugins
    • Middlemen
    • Understanding the Default RabbitMQ Middleman and Trigger
  • How To
    • CI/CD Integration
      • Integrating SitecoreDXG into your CI/CD Pipeline
      • Integrating the Default TeamCity RabbitMQ Meta-Runner
    • Creating a Custom Trigger
      • Executing Documentation Generation
      • Executing Meta-Data JSON Generation
    • Slack and Microsoft Teams Integration
      • Integrating with Slack via Webhooks
      • Integrating with Microsoft Teams via Webhooks
    • Creating a Custom Completion Handler
    • Creating a Custom Middleman
    • Viewing Helix Validation Errors
  • About the Generated Documentation
    • Overview
    • Models
      • Template Model
      • Template Field Model
      • Template Folder Model
      • Parent-Child Relationships of Models
      • Inheritance Relationship Model
      • Dependency Relationship Model
    • Views
      • Template View
      • Template Field View
      • Template Folder View
      • Parent-Child Relationship View
      • Inheritance Relationship View
      • Dependency Relationship View
    • Diagrams
      • SitecoreUML Syntax
      • Templates Diagram
      • Template Folders Diagram
      • Layer Diagrams
      • Module Diagrams
      • Module Templates Diagrams
    • Samples
Powered by GitBook
On this page
  • Diagrams
  • Layer and Module Dependency Models
  • Dependency Models
  • Slack and Microsoft Teams Notifications
  • Custom
  1. How To

Viewing Helix Validation Errors

PreviousCreating a Custom MiddlemanNextOverview

Last updated 6 years ago

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 or a and you are unsure of the source and target templates of the dependency then refer to the section below for more.

Layer and Module Dependency Models

On the documentation page for the 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 .

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 and 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 .

Layer Diagram
Module Diagram
Dependency Model
Slack integration
Microsoft Teams
creating a custom completion handler
Layer and Module Dependency Models
Layer or Module dependency model