Skip to main content

Event System to Create Mapped Structure Groups for Binary Publish

By Unknown
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.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) {
            structureGroupNames.Push(folder.Title);
            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, "-");
        sg.Save();

        return sg;
    }
}

The configuration file should look like this:

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


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