Skip to main content

Experience Manager in DD4T with Service-Oriented Architecture Providers

Image
By
This post describes the architecture for Tridion's Experience Manager (XPM) when used with an MVC framework such as DD4T in a Service-Oriented Architecture. This architecture implies that the website is completely independent of Tridion Content Delivery APIs. The only place where the CD APIs are used is on the Provider's Services Layer, as described in the following diagram.
I am going to focus on this diagram to explain the basics of XPM and Session Preview mechanism in a DD4T with SOA providers setup.

Publishing Flow

This flow is a standard Content Delivery DB publishing flow: TRIDION CONTENT MANAGER publishes Pages, Components and Binaries to a DEPLOYER that writes everything in the CONTENT DELIVERY DATA STORE.

It is very important to emphasize here that all publishing types go to the CD DB and that nothing is written to a file-system.





Content Delivery Flow

This flow represents the normal delivery of pages and binaries from the web-application DD4T WEBSITE to the visitor's browser.

The visitor's request to DD4T WEBSITE goes through the MVC controller into a model factory, which invokes a provider on the PROVIDER SERVICES LAYER using a RESTful call.

The provider reads the content from the CONTENT DELIVERY DATA STORE and returns it as string (or some serialized format) to the factory on the DD4T WEBSITE.

Here the response is deserialized into an MVC model (e.g. a Page meta object). Further, the model is forwarded to a View, which renders and sends the response to the visitor's browser.

Experience Manager Flow

This flow describes the high-level actions occurring when a Page or Dynamic Component Presentation is edited through XPM. This flow succeeds the Content Delivery Flow, when an editor enables XPM on a Page in the Staging DD4T WEBSITE.

TRIDION CONTENT MANAGER loads the page in an Iframe through its XPM module running as an extension on the CME website.

When the editor makes changes to the content (adding, changing or reordering items), they are saved immediately to their respective Tridion items on the TCM. However, the changed items are not published immediately -- they only get published when the editor clicks the button Finish Editing in the XPM toolbar. Instead, these changes are 'fast-track published' (i.e. posted) to an ODATA WEBSERVICE, which writes them into a SESSION PREVIEW DATA STORE.

Session Preview Flow

This flow succeeds the Experience Manager Flow and it consists of the high-level actions occurring when the editor clicks the 'Update Preview' toolbar button in XPM. This update is required when the content the user is seeing in an XPM session has been modified but not published. XPM detects that the last modified timestamp of the content is newer than the last published timestamp, and as such an update is needed.

Instead of the editor publishing the modified items, they just click 'Update Preview'.

The XPM module on the TRIDION CONTENT MANAGER sets a cookie on the edited page containing the id of the current XPM session (i.e. preview-session-token) and then triggers the reload of the edited page.

The Content Delivery Flow occurs with the DD4T WEBSITE invoking the PROVIDER SERVICES LAYER requesting a serialized model. In this request, the cookie preview-session-token needs to be present.

The provider uses the preview session token to look up the content in either the CONTENT DELIVERY DATA STORE or in SESSION PREVIEW DATA STORE. If modified content is available in the Session Preview DB, it is returned. Otherwise, it returns published content from Content Delivery DB.

Problem with Session Preview Flow

Because the current approach is MVC and SOA providers, the DD4T WEBSITE lacks all knowledge of Tridion. This means there is no Tridion software running on it. In a non-SOA approach, we would run the Ambient Data Framework on the web-application, and ADF would provide the session preview token to the underlying CD API. Based on this token, the API 'knows' which content to look for.

XPM sets the cookie with the preview session token on the edited page, but there is no software module that uses it or makes it available to PROVIDER SERVICES LAYER.

The solution consists in us writing the logic to attach the preview session token to the RESTful request to the services layer. As such, the factories are responsible to attach a cookie to their RESTful request containing the preview session token.

Once this token is in the RESTful request, the ADF module running on the PROVIDER SERVICES LAYER is able to intercept it and use it during the content lookup.

Conclusion

XPM with DD4T using SOA providers is possible and it works, but not OOTB. Some minimalistic code is needed to send the preview session token to the providers.


Labels:

Comments

Post a Comment

Popular posts from this blog

Scaling Policies

By
This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the
Post a Comment
Read more

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
1 comment
Read more

Toolkit - Dynamic Content Queries

By
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
Post a Comment
Read more