Skip to main content

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:

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.OpenMappedExeConfiguration(fileMap, ConfigurationUserLevel.None);

        EventSystem.Subscribe<Component, SaveEventArgs>(OnComponentSaveCommitted, EventPhases.TransactionCommitted);

    private void OnComponentSaveCommitted(Component component, SaveEventArgs args, EventPhases phases) {
        if (component.ComponentType == ComponentType.Multimedia) {
            Session session = component.Session;

            TcmUri rootFolderUri = new TcmUri(configuration.AppSettings.Settings["rootBinariesFolderId"].Value);
            TcmUri rootStructureGroupUri = new TcmUri(configuration.AppSettings.Settings["rootBinariesStructureGroupId"].Value);

            Stack<string> structureGroupNames = new Stack<string>();
            PopulateStructureGroupToBeCreated(component.OrganizationalItem, rootFolderUri, structureGroupNames);

            StructureGroup rootStructureGroup = new StructureGroup(rootStructureGroupUri, session);
            OrganizationalItemItemsFilter structoreGroupsFilter = new OrganizationalItemItemsFilter(session);
            structoreGroupsFilter.Recursive = false;
            structoreGroupsFilter.ItemTypes = new Tridion.ContentManager.ItemType[] { Tridion.ContentManager.ItemType.StructureGroup };

            while (structureGroupNames.Count > 0) {
                string structureGroupName = structureGroupNames.Pop();
                IEnumerable<StructureGroup> childStructureGroups = rootStructureGroup.GetItems(structoreGroupsFilter).Cast<StructureGroup>().Where(w => w.Title.Equals(structureGroupName));

                StructureGroup childStructureGroup;
                if (childStructureGroups.Count<StructureGroup>() == 0) {
                    childStructureGroup = CreateStructureGroup(structureGroupName, rootStructureGroup, session);
                } else {
                    childStructureGroup = childStructureGroups.First<StructureGroup>();
                rootStructureGroup = childStructureGroup;

    private void PopulateStructureGroupToBeCreated(OrganizationalItem folder, TcmUri rootFolderId, Stack<string> structureGroupNames) {
        if (folder != null && folder.Id != rootFolderId) {
            PopulateStructureGroupToBeCreated(folder.OrganizationalItem, rootFolderId, structureGroupNames);

    private StructureGroup CreateStructureGroup(string structureGroupName, StructureGroup parentStructureGroup, Session session) {
        StructureGroup sg = new StructureGroup(session, parentStructureGroup.Id);
        sg.Title = structureGroupName;
        sg.Directory = SAFE_DIRNAME_REGEX.Replace(structureGroupName, "-");

        return sg;

The configuration file should look like this:

<?xml version="1.0" encoding="utf-8" ?>
        <add key="rootBinariesFolderId" value="tcm:1-2-2" />
        <add key="rootBinariesStructureGroupId" value="tcm:1-3-4" />


Popular posts from this blog

A 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

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