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

Description

Name
Generate Structure Group Navigation GetItems 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 .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".
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 .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);
    dom.AppendChild(navigationXml);

    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);
                }
                navigationXml.AppendChild(itemElement);
            } else {
                parent.AppendChild(itemElement);
            }
        }
    }

    // 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;
        item.Attributes.RemoveNamedItem(ATTRIBUTE_PARENT);
        XmlNode parent = dom.SelectSingleNode(String.Format("//tcm:Item[@{0}='{1}']", ATTRIBUTE_ID, parentId), namespaceManager);
        parent.AppendChild(item);
    }

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


Comments

Popular posts from this blog

Toolkit - Dynamic Content Queries

This post if part of a series about the  File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine . The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached. Query Class This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterio

A DD4T.net Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component) . This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries. The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher . I therefore extended the BinaryPublisher and overrode method PublishItem. public class CustomBinaryPublisher : BinaryPublisher { private Template currentTemplate; private TcmUri structureGroupUri; In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryConten

Scaling Policies

This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the