Skip to main content

Generate Structure Group Navigation - GetItems TBB

This TBB Generates an XML containing all Structure Groups and Pages whose title abides to a naming convention, in hierarchical structure. The naming convention is given by regular expression (e.g. title starts with 3 digits followed by underscore or space).


Generate Structure Group Navigation GetItems TBB
·    Template in .NET Assembly
Used to:
·    Generate navigation XML;
This TBB reads the Publication's Root Structure Group and retrieves all child SGs and Pages using the .GetItems() method.
It creates an XmlDocument object and start building its nodes. Each SG object is represented as a tcm:Item node that has potential sub-nodes (other SGs and Pages).
The Page objects are represented also as tcm:Item nodes and they are the leaf nodes in the XML document.
The produced XML document is added to the Package as item named "Output".
Applicable to
Page Templates - no other TBB is required on the PT


Each node is the navigation XML has the following attributes:
  • ID - the SG or Page TCMURI;
  • Title - the name of the SG or Page (as defined in Tridion CM);
  • DisplayTitle - the name of the SG or Page after removing the three digit and underscore or space prefix;
  • Url - the PublicationLocationUrl of the SG or Page;
Sample navigation XML:

<tcm:ListItems ID="tcm:1-1-4" Title="Root">
  <tcm:Item ID="tcm:1-2-4" Title="010 About Us" DisplayTitle="About Us" Url="/about-us">
    <tcm:Item ID="tcm:1-3-64" Title="010 Who are we?" DisplayTitle="Who are we?" Url="/about-us/who-are-we.html"/>
  <tcm:Item ID="tcm:1-4-64" Title="020 Contact Us" DisplayTitle="Contact Us" Url="/contact-us.html"/>

The Code

The TBB uses templating API method .GetItems(filter) to retrieve the Structure Group and Page objects.

An XmlDocument is created and each SG and Page object is added in hierarchical order into this document as tcm:Item nodes.

private XmlElement BuildNavigationGetItems(StructureGroup structureGroup) {
    XmlDocument dom = new XmlDocument();
    dom.AppendChild(dom.CreateXmlDeclaration("1.0", "UTF-8", null));
    namespaceManager = new XmlNamespaceManager(dom.NameTable);
    namespaceManager.AddNamespace("tcm", TCM_NAMESPACE_URI);

    XmlElement navigationXml = dom.CreateElement("tcm:ListItems", TCM_NAMESPACE_URI);
    EnhanceNode(navigationXml, (RepositoryLocalObject)structureGroup);

    foreach (RepositoryLocalObject item in structureGroup.GetItems(filter)) {
        if (IsNavigable(item.Title)) {
            XmlElement itemElement = dom.CreateElement("tcm:Item", TCM_NAMESPACE_URI);
            EnhanceNode(itemElement, item);

            // enhance item node
            TcmUri itemId = item.Id;
            ItemType itemType = itemId.ItemType;
            if (itemType == ItemType.StructureGroup) {
                EnhanceNode(itemElement, (StructureGroup)item);
            } else if (itemType == ItemType.Page) {
                EnhanceNode(itemElement, (Page)item);

            // build hierarchy
            TcmUri parentId = item.OrganizationalItem.Id;
            XmlNode parent = dom.SelectSingleNode(String.Format("//tcm:Item[@{0}='{1}']", ATTRIBUTE_ID, parentId), namespaceManager);
            if (parent == null) {
                if (parentId != structureGroup.Id) {
                    itemElement.SetAttribute(ATTRIBUTE_PARENT, parentId);
            } else {

    // fix orphan items
    foreach (XmlNode item in dom.SelectNodes(string.Format("/tcm:ListItems/tcm:Item[@{0}]", ATTRIBUTE_PARENT), namespaceManager)) {
        string parentId = item.Attributes[ATTRIBUTE_PARENT].Value;
        XmlNode parent = dom.SelectSingleNode(String.Format("//tcm:Item[@{0}='{1}']", ATTRIBUTE_ID, parentId), namespaceManager);

    return navigationXml;

Enhance the XmlElement corresponding to a SG or Page with information such as ID and Title.

private void EnhanceNode(XmlElement item, RepositoryLocalObject rlo) {
    item.SetAttribute(ATTRIBUTE_ID, rlo.Id);
    item.SetAttribute(ATTRIBUTE_TITLE, rlo.Title);

Enhance the XmlElement corresponding to a SG or Page with information such as DisplayTitle, URL, etc.

private void EnhanceNode(XmlElement item, Page page) {
    string displayTitle = navigationItemRegex.Replace(page.Title, "");
    item.SetAttribute(ATTRIBUTE_DISPLAY_TITLE, displayTitle);

    string url = page.PublishLocationUrl;
    item.SetAttribute(ATTRIBUTE_URL, url);

private void EnhanceNode(XmlElement item, StructureGroup structureGroup) {
    string displayTitle = navigationItemRegex.Replace(structureGroup.Title, "");
    item.SetAttribute(ATTRIBUTE_DISPLAY_TITLE, displayTitle);

    string url = structureGroup.PublishLocationUrl;
    item.SetAttribute(ATTRIBUTE_URL, url);

Only consider items that match a given Regular Expression. In this instance, the expression is ^\\d{3}[_ ] (starts with three digits followed by an underscore or space).

private bool IsNavigable(string title) {
    return navigationItemRegex.IsMatch(title);


Popular posts from this blog

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: I stumbled upon the following post from 2008 (!!!), , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Event System to Create Mapped Structure Groups for Binary Publish

As a continuation of last week's Publish Binaries to Mapped Structure Group , this week's TBB is in fact the Event System part of that solution. Make sure you do check out the previous post first, which explains why and what this Event System does. To reiterate, the Event System intercepts a Multimedia Component save, take its Folder path and create a 1-to-1 mapping of Structure Groups. The original code was written, again, by my colleague Eric Huiza : [ TcmExtension ( "MyEvents" )] public class EventsManager  : TcmExtension {     private Configuration configuration;     private readonly Regex SAFE_DIRNAME_REGEX = new Regex ( @"[\W_]+" );     public EventsManager() {         ExeConfigurationFileMap fileMap = new ExeConfigurationFileMap ();         fileMap.ExeConfigFilename = Path .GetDirectoryName( Assembly .GetExecutingAssembly().Location) + "\\EventSystem.config" ;         configuration = ConfigurationManager