Skip to main content

Create and Publish Page for Component in Workflow using Core Service

It seems like this use case keeps coming back time and time again. The requirement: when a new Component is in workflow, part of the approval workflow on the Component should be an automatic Page generation (where the Component is placed on the Page) and possibly publishing of the Page for the purpose of previewing the new Component in a Page context. All this while Component is in workflow, so approver can actually see how the Component looks like before approving/rejecting it.

The only issue, as described in the previous post, is that it is not possible to add a v0.x Component to a Page, when the Page is in a child Publication. The solution is to do all this programmatically.

In the following example, I use the Core Service to create a new Page (with values taken from a Folder metadata, for example) and place the v0.x Component on it.

using (CoreServiceSession coreService = new CoreServiceSession())
    if (component.Version < 1)
        TcmUri pageTcmUri = coreService.CreatePage(title, fileName, sgTcmUri, ptTcmUri, localComponentTcmUri, ctTcmUri);
        PublisherHelper publisherHelper = new PublisherHelper();
        publisherHelper.Publish(pageTcmUri, targetTcmUri, true);

The Page is first created, then published (as described in my earlier posts about "How to Publish Stuff Programmatically"). The CoreServiceSession method CreatePage is the following:

public TcmUri CreatePage(String title, String fileName, TcmUri sgTcmUri, TcmUri ptTcmUri, TcmUri componentTcmUri, TcmUri ctTcmUri)
    PageData pageData = new PageData();
    pageData.Id = TcmUri.UriNull.ToString();
    pageData.Title = title;
    pageData.FileName = fileName;

    LinkToPageTemplateData linkToPageTemplateData = new LinkToPageTemplateData();
    linkToPageTemplateData.IdRef = ptTcmUri.ToString();
    pageData.PageTemplate = linkToPageTemplateData;
    pageData.IsPageTemplateInherited = false;

    LinkToOrganizationalItemData linkToOrganizationalItemData = new LinkToOrganizationalItemData();
    linkToOrganizationalItemData.IdRef = sgTcmUri.ToString();
    LocationInfo locationInfo = new LocationInfo();
    locationInfo.OrganizationalItem = linkToOrganizationalItemData;
    pageData.LocationInfo = locationInfo;

    ComponentPresentationData[] cps = new ComponentPresentationData[1];
    cps[0] = new ComponentPresentationData();
    LinkToComponentData linkToComponentData = new LinkToComponentData();
    linkToComponentData.IdRef = componentTcmUri.ToString();
    cps[0].Component = linkToComponentData;
    LinkToComponentTemplateData linkToComponentTemplateData = new LinkToComponentTemplateData();
    linkToComponentTemplateData.IdRef = ctTcmUri.ToString();
    cps[0].ComponentTemplate = linkToComponentTemplateData;
    pageData.ComponentPresentations = cps;

    IdentifiableObjectData objectData = _coreServiceClient.Create(pageData, ReadOptions);

    return new TcmUri(objectData.Id);


Nivlong said…
Great timing, Mihai. I mentioned the classic automatic page creation scenario the other day waving my hands on the technical details ("it's magic"). Whew, good to know we have multiple ways to combine workflow with code: event system, but also the core service.

Nice naming conventions and clean code, too (no hard-coded ids!). Are the LinkTo...Data objects your own--are they helping manage IDs?
Mihai Cădariu said…
Thanks Alvin! All the *Data objects are Core Service standard objects. That's how content & metadata is represented on the client when using the Core Service.

Popular posts from this blog

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

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: I stumbled upon the following post from 2008 (!!!), , 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

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