companyhome — The Company Home template node

userhome — The current user's Home Space template node

person — The node representing the current user's Person object

template — The node representing the template itself

space — The current space template node

document — The current document template node

args — A map of any URL parameters passed via the template content servlet. This is a neat way to pass additional parameters to your template. FreeMarker has built-in methods to parse integers and check for the existence of values that can be used to make your template even more interactive and powerful. For example, you can output the names of the arguments passed to a template:

<#assign keys = args?keys>
<#list keys as arg>
   ${arg}
</#list>

session — Session-related information providing a single value session.ticket for the current authentication ticket; useful when generating some Alfresco URLs for accessing outside of the Web client.

classification — Read access to classifications and root categories.

url — Provides a single property url.context that can be used to retrieve the Alfresco container context path, such as /alfresco; useful when generating URL links to objects. This is not available when using the template as a custom view on a space.

workflow — Read access to information on workflow objects and the currently executing workflows for a user.

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

Properties may 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 the property.

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

<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:

children — A sequence (list) of the child nodes. For example:

mynode.children[0]

assocs — A map of the target associations for the node. 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]

sourceAssocs — A map of the associations to this node. 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]

childAssocs — A map of the child associations for the node. Each entry in the map contains a sequence of the Node objects on the end of the child association. For example:

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

aspects — A sequence of the aspects (as QName strings) applied to the node.

hasAspect(String aspectName) — A function that returns true if a node has the specified aspect. For example:

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

isContainer — If the node is a folder node, this is true; otherwise, it is false.

isDocument — If the node is a content node, this is true; otherwise, it is false.

isCategory — If the node is a category node, this is true; otherwise, it is false.

content — Returns the content for the default content property of the node as a string.

url — The URL to the content stream for the default content property for this node.

downloadUrl — The URL to the content stream for the default content property for this node as an HTTP1.1 attachment object.

displayPath — The display path to this node; constructed from the cm:name property of each parent node in the hierarchy.

webdavUrl — The WebDAV URL to the node, based on the cm:name-based path to the content for the default content property.

icon16 — The small icon image for this node.

icon32 — The large icon image for this node.

icon64 — The extra-large icon image for this node.

mimetype — The MIME type encoding for content for the default content property attached to this node.

displayMimetype — The human-readable version of the MIME type encoding for the content attached to this node.

encoding — The character encoding for content attached to the node from the default content property.

size — The size, in bytes, of content attached to this node for the default content property.

isLocked — If the node is locked, this is true; otherwise, it is false.

id — GUID for the node.

nodeRef — NodeRef string for the node.

name — Shortcut access to the name property.

type — Fully qualified QName type of the node.

typeShort — Prefix string or "short" QName type of the node.

parent — Parent node will be null only if this is the root node.

permissions — Sequence of the permissions explicitly applied to this node; strings returned are of the format [ALLOWED|DENIED];[USERNAME|GROUPNAME];PERMISSION. For example, ALLOWED;kevinr;Consumer can be easily tokenized on the semicolon (;) character.

inheritsPermissions — If the node inherits its parent node permissions, this is true; if the permissions are applied specifically, this is false.

hasPermission(permission) — Returns true if the current user has the specified permission on the node. For example:

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

childrenByXPath — Returns a map capable of executing an XPath query to find child nodes, such as companyhome.childrenByXPath["*[@cm:name='Data Dictionary']/*"]. The map executes an XPath search against the current node and returns a sequence of the nodes as results of the query.

childByNamePath — Returns a map capable of returning a single child node found by name path, such as 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.

Note that the previous API calls use the node they are executed against as the current context for the query. For example, if you have a folder node called myfolder and you execute the call myfolder.childByNamePath["MyChildFolder"], the search tries to find a folder called MyChildFolder as the child of the myfolder node.

childrenBySavedSearch — Returns a map capable of executing a search based on a previously Saved Search object.

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.

childrenByLuceneSearch — Returns a map capable of executing a search against the entire repository based on a Lucene search string.

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 Alfresco. Note that you may 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.

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

nodeByReference — Returns a map capable of executing a search for a single node by NodeRef reference. This method allows you to find a node if you have the full NodeRef string or NodeRef object.

qnamePath — QName-based path to the node; useful for building Lucene PATH-style queries that constrain to a path location

primaryParentAssoc — ChildAssociationRef instance for the node

auditTrail — Returns a sequence of AuditInfo objects representing the Audit Trail for a node; available only if auditing is active for the repository

isTemplateContent(object) — Returns true if the given object is a TemplateContentData instance; useful to determine if a value returned from a property is of the d:contentdatatype

isTemplateNodeRef(object) — Returns true if the given object is a TemplateNodeRef instance; useful to determine if a value returned from a property is a d:noderefdatatype

versionHistory — Returns a sequence of Version History record objects for a versioned TemplateNode

id — GUID for the node

nodeRef — NodeRef string for the node

name — Name property of the node version record

type — Fully qualified QName type of the node

createdDate — Created date of the version

creator — Creator of the version

versionLabel — Version label of the version record

isMajorVersion — Boolean true if this was a major version

description — Version history description

url — URL to the content stream for the frozen content state

getRootCategories(String aspectQName) — A function to get a sequence of root categories for a classification

getAllCategoryNodes(String aspectQName) — A function to get a sequence of the category nodes for a classification

allClassificationAspects — Returns a sequence of QName objects of all classification aspects

categoryMembers — Gets all members of a category

subcategories — Gets all subcategories of a category

membersAndSubCategories — Gets all subcategories and members of a category

immediateCategoryMembers — Gets all immediate members of a category

immediateSubCategories — Gets all immediate subcategories of a category

immediateMembersAndSubCategories — Gets all immediate subcategories of a category

xmlNodeModel — Returns the XML DOM model object for the content of the node

assignedTasks — The sequence WorkflowTaskItem objects representing the assigned tasks for the current user

pooledTasks — The sequence WorkflowTaskItem objects representing the pooled tasks for the current user

completedTasks — The sequence WorkflowTaskItem objects representing the pooled tasks for the current user

getTaskById(taskId) — A function to return a single task given a known task ID

getPerson(username) — Returns the person node (cm:person) for the given username; returns null if not found

getGroup(groupname) — Returns a group node (usr:authorityContainer) for the given group authority name; returns null if not found

getMembers(group) — Gets the members (people) of a group, including all subgroups

getMembers(group, recurse) — Gets the members (people) of a group; optionally recurses into subgroups

getContainerGroups(person) — Gets the groups that contain the specified person (cm:person node)

isAdmin(person) — Returns true if the specified person (cm:person node) is a member of the Administrator group

isGuest(person) — Returns true if the specified person (cm:person node) is a guest user

getCapabilities(person) — Returns a map of capabilities (Boolean assertions) for the given person

isAccountEnabled(person) — Returns true if the specified user account is enabled; returns false if disabled

hasAspect(TemplateNode, String) — Returns the integer value 1 if the TemplateNode supplied has the aspect with the supplied QName String; otherwise, the integer value 0 will be returned.

dateCompare(DateA, DateB) — Compares two dates to see if they differ. This comparison returns 1 if DateA is greater than DateB; otherwise, returns 0.

dateCompare(DateA, DateB, Millis) — Compares two dates to see if they differ by the specified number of milliseconds. This comparison returns 1 if DateA is greater than DateB by at least the millisvalue in milliseconds; otherwise, returns 0.

dateCompare(DateA, DateB, Millis, Test) — Same as dateCompare(DateA, DateB, Millis) but with the test variable being one of the strings ">", "<", or "==" (greater than, less than, or equal to) as the test to perform.

incrementDate(Date, Millis) — Increments a date by the specified number of milliseconds and returns the new date.

message(String) — Returns the I18N message string (resolved for current user Locale setting) for the specified String message ID.

cropContent(TemplateNode, Length) — Returns the first n characters from the content stream for the specified node.

shortQName(String) — Returns the short, or prefix, version of a long QName.