Skip to main content

Toolkit - JSON Models

This post if part of a series about the File System Toolkit - a custom content delivery API for SDL Tridion.

This post explains the format of JSON model files, which look typically like this:

{
  "cp" : [ {
    "c" : 10,
    "cnt" : "Rendered CP content",
    "pr" : 300,
    "p" : 6,
    "t" : 15
  }, {
    "c" : 10,
    "cnt" : "Rendered CP content",
    "pr" : 200,
    "p" : 6,
    "t" : 25
  } ],
  "cstm" : {
    "meta" : {
      "Float" : {
        "k" : "Price",
        "n" : [ 2.0 ],
        "t" : "NUMERIC"
      },
      "Date" : {
        "k" : "ArticleDate",
        "d" : [ 72602000 ],
        "t" : "DATE"
      },
      "String" : {
        "k" : "Authors",
        "s" : [ "Lolek", "Bolek" ],
        "t" : "STRING"
      }
    }
  },
  "m" : 1450673231000,
  "p" : 1482016384618,
  "lnk" : [ {
    "c" : 10,
    "pg" : 20,
    "pr" : 300,
    "p" : 6,
    "u" : "/page1.html"
  }, {
    "c" : 10,
    "pg" : 30,
    "pr" : 300,
    "p" : 6,
    "u" : "/page2.html"
  } ],
  "sch" : 46,
  "tcm" : {
    "p" : 6,
    "i" : 10,
    "t" : 16
  },
  "t" : "News Article Sample",
  "mm" : false
}

The JSON above is saved in file 6-10.json, where 6 stands for the Publication id and 10 is the Component item id.

The model contains several parts: Component Presentations (cp), CustomMeta (cstm) and Links (lnk). Also it contains the last modified date (date when it was last saved in Tridion) - (m), last published date (p), Schema Id (sch), TcmUri (tcm), Title (t), Multimedia (mm).

The Component Presentation section contains all Dynamic Component Presentations on this Component and specifies their Component id (c), content (cnt), linking priority (pr), Publication Id (p) and Component Template Id (t).

The CustomMeta section contains all custom meta field and defines it as an array of metadata items (meta). Each item defining a key (k), a value and a type (t). The value can be one of three possible values: numeric (n), date (d), or string (s).

The Link section contains information about all links to this Component, such as Component Id (c), Page item Id (pg), link priority (pr), Publication Id (p), and page URL (u).

The TcmUri is represented as an object having a Publication Id (p), and Item Id (i) and a Type Id (t).

The static Component Presentations of a Component appear on the Page model that contains them. For example on the Page model below, there is one static Component Presentation specified by its Component Id (c), Linking priority (pr), Publication Id (p) and Component Template item Id (t).

{
  "cp" : [ {
    "c" : 10,
    "pr" : 200,
    "p" : 6,
    "t" : 15
  } ],
  "f" : "/page3.html",
  "m" : 1447029194000,
  "p" : 1482016423976,
  "pt" : 54,
  "tcm" : {
    "p" : 6,
    "i" : 12,
    "t" : 64
  },
  "t" : "Sample Page 3",
  "u" : "/page3.html"
}

JSON models are placed in a folder structure under the jsonRoot folder specified in the toolkit.properties file.

The location of a JSON model file on the file system, under the jsonRoot folder is given by a path derived from the TCM URI of the item. The hash-code of the TcmUri is calculated, using Java's String.hashCode() method. Then we retain the last 4 digits of this hash-code. This gives us the 4-level deep path for the specified model.

Example:
We want to calculate the path for model with TCM URI: tcm:6-1225-64
1. First we calculate the string hash-code: 866716204
2. We retain the last 4 digits: 6204
3. We calculate the path: 6/2/0/4/
4. We append the TCM URI without prefix "tcm:", which gives: 6/2/0/4/6-1225-64.json
5. We prepend the jsonRoot folder: /my/jsonRoot/6/2/0/4/6-1225-64.json



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