Building the sample API application

IBM Engineering Lifecycle Optimization - Publishing comes with a sample application that demonstrates executing pre-configured document specifications locally or remotely with the API.

About this task

The application can be found in PUB_install_dir/lib/api/example. The home folder from your project is used at build time if no value for the -home option is provided. When deploying the application, you must provide the home folder in the same folder as the .jar file for the application to find the home folder.

Procedure

  1. Open PUB_install_dir/lib/api/example.
  2. Extract the com.ibm.rational.rpe.examples.zip archive.
  3. Provide your application access to the necessary .dll and .so files in the Engineering Publishing library.
    Important: The .dll and .so files that are provided in the root directory of the example archive might not be applicable to your environment.
    • 32-bit applications:
      1. PUB_install_dir/lib/rcl_telelogic.dll
      2. PUB_install_dir/lib/librcl_telelogic.so
    • 64-bit applications:
      1. PUB_install_dir/lib/64/rcl_telelogic.dll
      2. PUB_install_dir/lib/64/librcl_telelogic.so

    To provide the application access to these files, you can either:

    • Add the filepaths to the application startup script. This option ensures that your application is self-contained no matter where it runs.
    • Add the filepaths to the PATH system variable. If you choose this option, you must complete this step on every computer that uses the application.
  4. Copy the plug-ins in the lib directory in the PUB installation files.
    • To build 32-bit applications, copy the plug-ins in the PUB_install_dir/lib directory.
    • To build 64-bit applications, copy the plug-ins in the PUB_install_dir/lib/64 directory.
  5. Paste the plug-ins in the lib directory of the extracted example archive. Do not copy the .dll or .so files.
    Example: project/lib
  6. Open the PUB_install_dir/config directory.
  7. Copy the rpeconfig.xml and RPEElementsDefinitions.xml files.
  8. Paste the rpeconfig.xml and RPEElementsDefinitions.xml files into the home/config folder of your example.
    The example is designed to use the log4j2.xml file from the root of the src folder and cannot use the file from the home/config folder, even if provided.
  9. Optional: To generate document-style reports from IBM Engineering Requirements Management DOORS® , copy the PUB_install_dir/source/DOORS and PUB_install_dir/source/DB Structure folders.
  10. Optional: Paste the DOORS and DB Structure folders in the home/source folder of your project.
  11. Copy the PUB_install_dir/utils/Word and PUB_install_dir/utils/HTML folders.
  12. Paste the Word and HTML folders into the home/utils of your project.
  13. Update the class paths with the paths to the plug-ins in the project.