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
  • Module Dependencies
  • Layer Dependencies
  1. About the Generated Documentation
  2. Models

Dependency Relationship Model

PreviousInheritance Relationship ModelNextViews

Last updated 6 years ago

SitecoreDXG is designed to provide robust Sitecore architecture visualization for your Sitecore template architecture, and one of the most important sets of features are the dependency diagramming features. The dependency relationship model generation is part of the Helix Diagramming feature set of SitecoreDXG, and will work for any solution that you configure the Helix settings for in your item.

In SitecoreUML, UML Dependency models are used to represent dependencies. It is worth noting that the actual dependency adds no additional information about your architecture to the documentation, but rather is meant to consolidate the inheritance information that is already there.

UML Dependency models and their documentation pages are effectively just scoped summaries of the inheritance information described by the other models.

Module Dependencies

Module dependencies are added to a source module when one or more of its templates has a dependency on a template in a different, target module. The source module is said to depend on the target module, and any template dependencies from the source module to the target module are added to the module dependency's description for summary display in the output documentation.

Each source module that contains templates that inherit from one or more templates from a different, target module will have a dependency model that shows that the source module depends on the target module.

Layer Dependencies

Layer dependencies are added to a source layer when one or more of its modules' templates has a dependency on a template in a different, target layer. The source layer is said to depend on the target layer, and any template dependencies from the source layer to the target layer are added to the layer dependency's description for summary display in the output documentation.

Each source layer that contains templates that inherit from one or more templates from a different, target layer will have a dependency model that shows that the source layer depends on the target layer.

Documentation Configuration
Module dependency representing the Teasers module's dependency on the Theming module
Layer dependency representing the Feature layer's dependency on the Foundation layer