Skip to main content

TBB of the Week - Render Page Text Block

I thought about starting a new section on my blog -- TBB of the Week. The intention is to publish a new TBB every week that is somehow worthy. Maybe it is a very generic one, or a best practice, or even a bad practice. There should be a description of the TBB, what it does, where/how to use it in a Compound Template. Of course, there will be source code too.

So to start with, the first "TBB of the Week" is going to be Render Page Text Block TBB. I first got this TBB from a colleague of mine, Eric Huiza, so I won't take credit for it.

Name
Render Page Text Block TBB
Type
· Template in .NET Assembly
Description
Used to:
· Publish Text Block scripts (JS or CSS) attached to a Page as metadata;
Notes:
This TBB expects the Page to have metadata field ‘script’ that contains a Component Link to the Text Block Component. The TBB creates an Output item (or overwrites the existing one) with the content of the TextBlock field in the linked Text Block Component.
The Page in this case should not contain any Component Presentations.
Parameters
n/a
Applicable to
Page Templates

I like the idea a lot -- you don't have to create Component Presentations on your Page in order to publish 'static' text assets like JavaScript or CSS. Instead you just attach them to your Page Metadata.

One thing I don't like, is the inability to use the "Where Used" publishing. Namely, if you want to publish the JS/CSS Text Block Component, this setup will not allow that. In a normal situation, where the Component appears on the Page as CP, publishing the Component will publish the Page using it. Not in this case...

The Code

[TcmTemplateTitle("Render Page Text Block TBB")]
public class RenderPageTextBlock : ITemplate {

    public void Transform(Engine engine, Package package) {
        Item pageItem = package.GetByName(Package.PageName);
        Page page = engine.GetObject(pageItem) as Page;

        ItemFields metaFields = new ItemFields(page.Metadata, page.MetadataSchema);
        ComponentLinkField textblockField = metaFields.Where(w => w.Name.Equals("script")).Cast<ComponentLinkField>().ElementAtOrDefault(0);

        if (textblockField != null) {
            Component textblock = textblockField.Value;
            ItemFields itemFields = new ItemFields(textblock.Content, textblock.Schema);

            MultiLineTextField textField = itemFields.Where(w => w.Name.Equals("TextBlock")).Cast<MultiLineTextField>().ElementAt(0);

            Item output = package.GetByName(Package.OutputName);
            if (output == null) {
                package.PushItem(Package.OutputName, package.CreateStringItem(ContentType.Text, textField.Value));
            } else {
                output.SetAsString(textField.Value);
            }
        }
    }
}


Comments

Popular posts from this blog

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

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Debugging a Tridion 2011 Event System

OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven