TemplateNode API

Each entry in the map contains a sequence of the Node objects on the end of the association. For example:

mynode.assocs["cm:translations"][0]

Each entry in the map contains a sequence of the Node objects on the end of the child association. For example:

myforumnod.childAssocs["fm:discussion"][0]

companyhome.childByNamePath["Data Dictionary/Content Templates"]

Under the covers, this method is building an XPath and executing a search against the cm:name attribute on children of the current node. This method allows you to find a specific child node if you know its name.

mynode.children[0]

It returns a sequence of nodes that represent the objects from the results of the search.

The value can be any valid Lucene search string supported by SkyVault Community Edition. Note that you might need to escape Lucene special characters. The entire repository is searched; the current node is only used as an access point to retrieve the search object.

For example, execute a Lucene full-text search and list the resulting documents:

<table>
  <#list companyhome.childrenByLuceneSearch["TEXT:alfresco* AND TEXT:tutorial*"] as child>
    <tr><td><a href="/alfresco${child.url}" target="new">${child.properties.name}</a></td></tr>
  </#list>
</table>

It returns a sequence of child nodes that represent the objects from the results of the search. For example:

companyhome.childrenBySavedSearch["workspace://SpacesStore/92005879-996a-11da-bfbc-f7140598adfe"]

The value specified must be a NodeRef to an existing Saved Search object.

companyhome.childrenByXPath["*[@cm:name='Data Dictionary']/*"]

The map executes an XPath search against the current nod and returns a sequence of the nodes as results of the query.

<#if userhome.hasAspect("cm:templatable")>...</#if>

<#if userhome.hasPermission("Write")>...</#if>

In another example, find a node from a hardcodedNodeRef value:

Found: ${companyhome.nodeByReference["workspace://SpacesStore/e661dccb-ecc0-11da-9974-63f65406985a"].id}

[ALLOWED|DENIED];[USERNAME|GROUPNAME];PERMISSION'

For example, ALLOWED;kevinr;Consumer can be easily tokenized on the semicolon (;) character.

A map of the properties for the node, such as userhome.properties.name.

Properties can return several different types of objects. This depends entirely on the underlying property type in the repository. If the property is multi-value, the result will be a sequence that can be indexed like any other sequence or array. If the result is an unknown or unsupported type, the toString() result is generally used; therefore, the result will mostly be a string type. If the property can potentially contain a 'null' value, take care when accessing it and use the exists FreeMarker built-in method to check for null values before accessing.

Date and boolean property values should be handled carefully. The FreeMarker built-in methods is_date and is_boolean can be used to check if the page developer is unsure of the property value type. These values can then be formatted as appropriate.

For example, iterate over all properties for a node called document and render the values as appropriate for the data-types returned:

<table>
 <#-- Get a list of all the property names for the document -->
 <#assign props = document.properties?keys>
 <#list props as t>
    <#-- If the property exists -->
    <#if document.properties[t]?exists>
       <#-- If it is a date, format it accordingly-->
       <#if document.properties[t]?is_date>
       <tr><td>${t} = ${document.properties[t]?date}</td></tr>
       
       <#-- If it is a boolean, format it accordingly-->
       <#elseif document.properties[t]?is_boolean>
       <tr><td>${t} = ${document.properties[t]?string("yes", "no")}</td></tr>
       
       <#-- Otherwise treat it as a string -->
       <#else>
       <tr><td>${t} = ${document.properties[t]}</td></tr>
       </#if>
    </#if>
 </#list>
</table>

If the type of the property is a NodeRef object (d:noderef in the content model), the template model will automatically convert the property type into another TemplateNode object. This means the template developer can continue to dynamically walk the object hierarchy for that node. For example, if a document node has a NodeRef property called locale, you could execute the following to retrieve the name of the node the property references:

${document.properties.locale.properties.name}

If a property is of the datatype d:content, additional API methods are available on the returned object. Methods are provided to retrieve the content, mimetype, displayMimetype, encoding, size, and url for the content property. For example:

${document.properties.content.mimetype}
${document.properties.content.content}

As most document nodes are derived from the default Content Model type cm:content, shortcut APIs to access properties on the default cm:content content property are supplied directly on the TemplateNode object.

Helper methods to perform some simple textual operations on the content properties are also provided:

content.getContentMaxLength(length)

Returns content up to a maximum length.

content.getContentAsText(length)

Converts binary content (such as Word and PDF) to text, up to a maximum length.

Each entry in the map contains a sequence of the Node objects for the given association that reference this node. For example:

mynode.sourceAssocs["cm:avatarOf"][0]

If the node content is valid XML and the XML can be parsed, then this method returns the root of the DOM for this node. The DOM can be walked and processed using the syntax as per the FreeMarker XML Processing Guide.

For example, process the XML document content of the current document, assuming the node content contains the following XML:

          
<?xml version="1.0" standalone="yes"?>
<book title="Book Title">
  <chapter>
    <title>Chapter 1</title>
    <para>p1.1</para>
    <para>p1.2</para>
    <para>p1.3</para>
  </chapter>
  <chapter>
    <title>Chapter 2</title>
    <para>p2.1</para>
    <para>p2.2</para>
  </chapter>
</book>

<#if document.mimetype = "text/xml">
   <#assign dom=document.xmlNodeModel>
   <h1>${dom.book.@title}</h1>
   <#list dom.book.chapter as c>
      <h2>${c.title}</2>
   </#list>  
</#if>