Skip to main content

Messing with the Engine

Don't ask me why -- well, ok, ask me and I'll tell you -- but I have been investigating lately how to create my own Engine instance (i.e. Tridion.ContentManager.Templating.Engine). Engine is an abstract class and as such cannot be instantiated directly. Time to get decompily...

I figured out there are a couple of implementations for Engine, but question is when is one used over the other. The simple solution was to log somehow the engine.GetType() method call in different contexts and see what comes back.

I ended up with a very simple C# Fragment:

package.PushItem("TYPE",
    package.CreateStringItem(ContentType.Text, engine.GetType()));

And its DWT counterpart:

Engine type: @@TYPE@@

The result is the following:
  • executing the template in Template Builder displays:  Tridion.ContentManager.Templating.Debugging.DebuggingEngine
  • executing in CME Preview or doing an actual publish displays :  Tridion.ContentManager.Templating.TemplatingRenderer
Creating an instance of DebuggingEngine seems like black magic, so I didn't even try. TemplatingRenderer on the other hand is doable, although very laborious:

Session session = new Session();
Page page = new Page(new TcmUri("tcm:20-102-64"), session);
Template template = new PageTemplate(new TcmUri("tcm:20-715-128"), session);
ResolvedItem resolvedItem = new ResolvedItem(page, template);

PublishInstruction publishInstruction = new PublishInstruction(session);
PublicationTarget publicationTarget = new PublicationTarget(new TcmUri("tcm:0-1-65537"), session);

RenderInstruction renderInstruction = new RenderInstruction(session) { RenderMode = Tridion.ContentManager.Publishing.RenderMode.PreviewDynamic };
RenderedItem renderedItem = new RenderedItem(resolvedItem, renderInstruction);

RenderContext renderContext = new RenderContext();

IRenderer engine = new TemplatingRenderer();
engine.Render(resolvedItem, publishInstruction, publicationTarget, renderedItem, renderContext);

If you notice, engine is in fact initialized when the Render method is executed. Weirdly, Render is a method defined by IRenderer. That is pretty weird! TemplateRenderer extends/implements both Engine and IRenderer.

The code above will in fact start the publishing of the given Page with the given Page Template. That's a bit too much from what I was intending to do in the first place.

My goal is to simply have an Engine object so that I can instantiate a Package object. It seems like the following code is enough:

Engine engine = new TemplatingRenderer();
Package package = new Package(engine);

// test it 
package.PushItem("name", package.CreateHtmlItem("value"));

This will create a new item in the Package, so I can now use the object locally without having to perform an actual publish or preview in Template Builder.

What a hack!


Comments

Chris Summers said…
Please tell us why...
Mihai Cădariu said…
For short, I wanted to be able to run templates in a stand-alone application (e.g. Console app).

For long, I wanted to play with it in my Java Mediator quickly, without having to go load the TBB in Template Builder, execute it, stop TB because it locked all my JARs/DLLs, etc.

However, I also see a strong use-case for unit testing your templates! A continuous build environment (CM side). This can be fine grained (even at TBB level). Kinda: if that's the input package, that's the output. Is it the expected one?

Pretty cool :)

Popular posts from this blog

Toolkit - Performance

This post if part of a series about the File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents performance data that was captured for each major functionality with and without caching Linking, CP Assembler, Component Presentation Factory, Dynamic Content Queries, Model Factory. The data was captured on a 2014 Macbook Pro 15", 16 GB RAM, 2.6 GHz Intel Core i7 running OS X El Capitan. Test methodology: each test was run for 3 minutes and the total number of successful Toolkit API calls was measured. Then the number of calls per second was computed 'with cache' and 'without cache' test runs. Then a cache boost factor was calculated by diving (the number of API calls with cache) / (number of API calls without cache). Each cache test was executed 3 times, with different cache time-to-live values of 1 second, 5 seconds and 0 seconds (eternal cache, no expiration). The rationale is to see what impact different cache expiration/evi...

Running sp_updatestats on AWS RDS database

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

A Core Service Java Client

I have seen many times the creation of a .NET client for SDL Tridion's Core Service, but not once a Java client. In .NET / Visual Studio is extremely easy to create the proxy classes based on the service's WSDL. So how hard can it be in Java? The entire code in this example is available in my Google Code project . Which Tool? Doing a bit of research on the multiple ways of creating Java proxy classes for web services left me quite confused as to which framework / utility to use. They are quite a few (AXIS, JAXB, Apache CXF, XFire, NetBeans plugin, IDEA plugin, Eclipse plugin, etc). They seemed to be cumbersome to use, too specific, limited, quirky, buggy, etc. What I wanted was a simple generic too that worked. Enter wsimport.exe ... Generating the Proxies Note: Check out the update post available here  http://yatb.mitza.net/2012/12/java-core-service-trouble-with-datetime.html Wsimport.exe is part of the JDK (mine is located in C:\Progrm Files\Java\jdk1.6.0_33\bin ),...