Viewtools - Documentation topics on: ecommerce,integration,plugin,velocity,velocity tools,viewtool,viewtools,.

This documentation is a static copy for this version. For current documentation, see:


Viewtools are java classes that encapsulate functionality and are exposed to velocity.  All velocity contexts have access to use dotCMS viewtools.  Viewtools are mapped to a key in velocity in the toolbox.xml file, which is loaded at startup.  Viewtools can also be mapped dynamically, using OSGI.

Viewtools are important for web developers to understand as they provide access to the dotCMS content repository along with a huge amount of methods and utilities that help with things such as String formatting, date and date calculation, XML/Json manipulation, math and other functions often needed when building the display layer.

Viewtools are important for Java developers to understand as they allow java developers to build custom APIs and Java classes that integrate and encapsulate business systems and functionality for use by the web development team.

By way of a hypothetical example, think about integrating dotCMS with an external ecommerce system. The Java developers on the team could build a viewtool called StoreApiTool that was accessible to web developers for use in building templates, widgets, containers, etc.

We would expect the StoreApiTool have methods like:

  • $store.getProduct($UPN)  

or even cleaner:  

  • $store.product($UPN)

Velocity would parse this, map $store to the StoreApiTool class and call the getProduct(String upn) method on the StoreTool.  This method could then perform a webservice or any other integration call to build and return a Product object for use in the velocity template.

To continue or example, the StoreApiTool could offer other convenience methods for the web developers such as:

  • List<OrderLine> $store.getCart() (or $store.cart)
  • List<Product>$store.getItems("$category")
  • Account $store.getUserAccount()

Keep in mind, ViewTool methods return full fledged Java Objects and or Lists that can be used in building the presentation layer in dotCMS.