The HCL Web Content Manager API

You can use the Web Content Manager API to extend functions of HCL Web Content Manager.

Use the Web Content Manager API to:

  • create items
  • delete items
  • move items
  • copy items
  • retrieve items
  • approve items in a workflow
  • search for items

See the Javadoc documentation for further information. The Javadoc files for Web Content Manager are in the PortalServer_root/doc/Javadoc/spi_docs/com/ibm/workplace/wcm directory.

Getting started

To use the Web Content Manager API, you have 2 options:
  1. Write your code as JSPs that you deploy on your server in your Java enterprise application. These JSPs can then be used in your Web Content Manager content by using JSP components or custom JSPs in elements.
  2. Write you code as a compiled java enterprise application. In this case, you need to create a project in your development environment that has the two JAR files ilwwcm-api.jar and wp.base.jar in the build path. These JAR file files can be copied from your portal server from here:
    • /opt/WebSphere/PortalServer/wcm/prereq.wcm/wcm/shared/app/ilwwcm-api.jar
    • /opt/WebSphere/PortalServer/base/wp.base/shared/app/wp.base.jar
    This code can then be used in your Web Content Manager content by using custom plug-ins. See How to create custom plug-ins for further information.