Skip to main content

Get Current Publish Transaction

I was struggling a while back to retrieve the current Publish Transaction from template code. This is the Publish Transaction that is currently being executed in the Publisher. I needed it to identify who sent the current item to publish and with which priority. I found out it wasn't easy to retrieve the current Publish Transaction. In fact, it was impossible to identify it with absolute certainty.

I tried looking at the Publishing Queue and pick the transaction 'In Progress' or with status Rendering. However, this doesn't work reliably due to possible concurrent rendering threads or even multiple Publishers, so it is impossible to know for sure which exactly is the current Publish Transaction.

Then the following hack came to light thanks to a post by Chris Summers. And what a hack it is indeed: take the Binary storage path of the RenderInstruction and extract the Publish Transaction TCMURI from it.

The Binary storage path looks something like C:\Temp\tcm_0-164479-66560.Content\Binaries, so I can apply a Regular Expression to it to extract the TCMURI.

public PublishTransaction GetPublishTransaction(Engine engine)
    String binaryPath = engine.PublishingContext.PublishInstruction.RenderInstruction.BinaryStoragePath;
    Regex tcmRegex = new Regex(@"tcm_\d+-\d+-66560");
    Match match = tcmRegex.Match(binaryPath);

    if (match.Success) {
        String transactionId = match.Value.Replace('_', ':');
        TcmUri transactionUri = new TcmUri(transactionId);
        return new PublishTransaction(transactionUri, engine.GetSession());

    return null;

In the meantime, I filed an enhancement request on this topic.


Chris Summers said…
Thanks for sharing Mihai - this just saved my ass. I have no idea where that post of mine was (I have little recollection of it), but I had certainly forgotten this trick.

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

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