Extending product function by using the Engineering Publishing Java API

IBM Engineering Lifecycle Optimization - Publishing (PUB) provides an API to the Engineering Publishing Core, which the client applications also use to publish documents.

The PUB Java™ API can be used to create or load document specifications and to execute them locally or remotely.
Note: The PUB packages that expose these APIs also expose other APIs such as the one used by the Document Studio application for creating and editing templates. Those APIs are not meant for public usage and must not be used. Do not use classes from the com.ibm.rational.rpe.template package.
Using PUB through the Java API does not require a PUB installation, but the API can be made to use a PUB installation.
Tip: Make applications based on the PUB Java API self-contained, so that changes to the PUB installation, such as uninstall or upgrade, on the same computer do not affect your application.
Figure 1. API document generation process overview
General process overview for using the PUB
API Initializing and preparing the Java API Creating a document specification through the Java API Adding a template to a new document specification through the Java API Loading a document specification through the Java API Configuring variables Configuring outputs through the Java API Configuring a data source through the Java API Generating documents with the Java API Downloading results published remotely Verifying document generation success