Artifacts for the Java API

Review a list of Rational® Publishing Engine artifacts that are most commonly used in the API.
Table 1. Rational Publishing Engine artifacts
Artifact name Artifact description
RPEDocumentSpecification Models a document specification in memory. The customizations can be loaded from a .dsx file or created from scratch. This artifact is central to this API.
A document specification contains a RPEConfiguration object and a RPERuntime object.
  • RPEConfiguration: Loaded from rpeconfig.xml. The URI of the rpeconfig.xml is a mandatory argument to be provided when creating or loading a document specification.
  • RPERuntime: Built by using helper functions
RPEDocumentTemplate The model for a template that is used in the document specification
RPEDataSource The model for a data source from a template that is used in the document specification
RPEVariable The model for a variable from a template that is used in the document specification
RPEOutput The model for an output that is used by the document specification
RPEResult The model for a result. Information about the result is stored in the properties for the result:
  • The path property of the result gives the location of the result file. For remote document generation the location is a URL.
  • For local document generations the type property gives the type of the output. For remote generation, only two types are used: archive, which indicates the result archive, and log.

Feedback