Skip to main content

Generate Structure Group Navigation - Recursive TBB

Image
By
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).

Description

Name
Generate Structure Group Navigation Reorder TBB
Type
·    Template in .NET Assembly
Description
Used to:
·    Generate navigation XML;
Notes:
This TBB reads the Publication's Root Structure Group and retrieves all child SGs and Pages using the .GetListItems() method in a recursive way.
The template retrieves the SG/Pages directly under the given SG and it then iterates each node, invoking a recursive step for each SG it encounters, thus ensuring the entire hierarchical structure is visited.
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".
Parameters
N/A
Applicable to
Page Templates - no other TBB is required on the PT

The XML

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>
  <tcm:Item ID="tcm:1-4-64" Title="020 Contact Us" DisplayTitle="Contact Us" Url="/contact-us.html"/>
</tcm:ListItems>

The Code

The TBB uses templating API method .GetListItems(filter) to retrieve all Structure Groups and Pages directly under the given SG and it then iterates each node, invoking a recursive step for each SG it encounters, thus ensuring the entire hierarchical structure is visited.

On exiting the recursion, the template applies hierarchy to the resulting XML document by adding the found nodes to the current parent.

private XmlElement BuildNavigation(StructureGroup structureGroup) {
    List<XmlNode> toRemove = new List<XmlNode>();
    XmlElement navigationXml = structureGroup.GetListItems(filter);

    foreach (XmlElement item in navigationXml.ChildNodes) {
        string itemTitle = item.Attributes["Title"].Value;
        if (IsNavigable(itemTitle)) {
            // enhance node
            TcmUri itemId = new TcmUri(item.Attributes[ATTRIBUTE_ID].Value);
            ItemType itemType = itemId.ItemType;
            if (itemType == ItemType.StructureGroup) {
                StructureGroup childSG = m_Engine.GetObject(itemId) as StructureGroup;
                EnhanceNode(item, childSG);

                // recursive step
                XmlElement childNavigation = BuildNavigation(childSG);
                foreach (XmlElement childItem in childNavigation.ChildNodes) {
                    XmlNode importedNode = item.OwnerDocument.ImportNode(childItem, true);
                    item.AppendChild(importedNode);
                }
            } else if (itemType == ItemType.Page) {
                Page childPage = m_Engine.GetObject(itemId) as Page;
                EnhanceNode(item, childPage);
            }
        } else {
            toRemove.Add(item);
        }
    }

    // remove non-navigation items
    foreach (XmlNode node in toRemove) {
        navigationXml.RemoveChild(node);
    }

    return navigationXml;

}

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);
}


Labels:

Comments

Post a Comment

Popular posts from this blog

Running sp_updatestats on AWS RDS database

By
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: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , 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...
2 comments
Read more

REL Standard Tag Library

By
The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...
2 comments
Read more

Publish Binaries to Mapped Structure Groups

By Unknown
Today's TBB of the Week comes from the high demand in the field to publish binary assets to different mapped Structure Groups. By default SDL Tridion offers two ways of publishing binaries: All binaries publish to a folder defined in your Publication properties; All binaries rendered by a given template publish to a folder corresponding to a given Structure Group; In my view, both cases are terrible, over-simplified and not representing a real use-case. Nobody in the field wants all binaries in one folder and nobody separates binary locations by template. Instead, everybody wants a mapping mechanism that takes a binary and publishes it to a given folder, defined by a Structure Group, and this mapping is done using some kind of metadata. More often than not, the metadata is the TCM Folder location of the Multimedia Component. I have seen this implemented numerous times. So the solution to publish binaries to a given location implies finding a mapping from a TCM Folder to a...
10 comments
Read more