Skip to main content

Toolkit - JSON Models

Image
By
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



Labels:

Comments

Post a Comment

Popular posts from this blog

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...
2 comments
Read more

REL Standard Tag Library

By
The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...
2 comments
Read more

Publish Binaries to Mapped Structure Groups

By Unknown
Today's TBB of the Week comes from the high demand in the field to publish binary assets to different mapped Structure Groups. By default SDL Tridion offers two ways of publishing binaries: All binaries publish to a folder defined in your Publication properties; All binaries rendered by a given template publish to a folder corresponding to a given Structure Group; In my view, both cases are terrible, over-simplified and not representing a real use-case. Nobody in the field wants all binaries in one folder and nobody separates binary locations by template. Instead, everybody wants a mapping mechanism that takes a binary and publishes it to a given folder, defined by a Structure Group, and this mapping is done using some kind of metadata. More often than not, the metadata is the TCM Folder location of the Multimedia Component. I have seen this implemented numerous times. So the solution to publish binaries to a given location implies finding a mapping from a TCM Folder to a...
10 comments
Read more