You are here

SkyVault 2.0 » For Developers » Developing Applications and Extensions » SkyVault API Reference

Repository FreeMarker Template reference

The Repository FreeMarker Template API lets you render output using the FreeMarker template engine. This is the full list of public APIs that compose the Repository FreeMarker Template API.
Important: This section of the documentation documents objects that are available to scripts running in the Repository context. They are not necessarily available to scripts running in the Share context.
  • Template framework architecture Templates are widespread throughout SkyVault: they are used within the repository core to generate emails and activities, in the Explorer client to build custom views, at the remote REST API layer, and also as the default rendering mechanism for the web script and Surf frameworks.
  • Template files Templates can be stored either on the classpath (for example, in SkyVault/config/templates) or in the repository store.
  • Template models A model consists of a number of objects or hierarchy of objects from which a template file retrieves values that can be used to dynamically generate the output. The model is like the API for the template page: it provides the objects from which properties and values can be accessed.
  • TemplateNode APITemplateNode objects and any subsequent child node objects provide access to the common SkyVault concepts, such as properties, aspects, and associations. The following template API is provided. TemplateNode extends BasePermissionsNode.
  • Classification API The classification object provides read access to classifications and root categories.
  • Current Date The date object returns the current date.
  • Default Model Methods Custom template methods can be added to the FreeMarker language for use on template pages. The default model provides the following methods:
  • JSP Page Custom JSP pages can be written to render templates.
  • People API The People API provides basic user and group query and inspection capabilities.
  • VersionHistoryNode API The VersionHistoryNode is an extension of the BaseContentNode type. The versionHistory property of the TemplateNode object returns a sequence of VersionHistoryNode objects that represent the version history for the document.
  • Workflow API The workflow root object provides read access to the in-progress and finished tasks for the current user. It also provides a function to look up a single task by its task ID. The functions described mostly return WorkflowTaskItem objects.
Parent topic: SkyVault API Reference

© 2017 TBS-LLC. All Rights Reserved.