Installing RenderX for Right-To-Left (RTL) PDF Document Processing (Windows)

Due to the lack of support for RTL writing languages in Apache FOP the XML Server also provides the functionality to use alternative rendering tools.

RenderX is one of a number of third party document rendering engines that supports RTL writing languages. If RenderX is installed, and the XML Server is configured to use RenderX, the XML Server will automatically use RenderX to generate all RTL PDF documents. In order to use the default RenderX implementation in IBM Cúram Social Program Management the following steps should be completed:

Install RenderX according to RenderX 's installation guide.
Set a system environment variable RENDERX_HOME to point to RenderX 's installation directory.
Customize xmlserver_config.xml to use curam.util.xmlserver.RenderXDocumentGenerator to process Right To Left PDF documents. See example below for details.

Figure 1. Setting up RenderX as the rendering tool for Right To Left Document processing

<XML_SERVER_CONFIG>
  ...
  <RENDERX_CONFIG_FILE>C:/RENDERX/xep.xml</RENDERX_CONFIG_FILE>
  <RENDERX_LOGGING>off</RENDERX_LOGGING>
  ...
  <JOBS>
    ...
    <JOB type="pdf" direction="RTL"
    class="curam.util.xmlserver.RenderXDocumentGenerator"/>
  </JOBS>
</XML_SERVER_CONFIG>

The customizations in this example assume RenderX is installed to c:/RenderX directory

Note: In order to use a relative path with a default installation of RenderX, the images should be stored relative to the RenderX location. For example, if the RENDERX_HOME is C:\projects\RenderX\, and the images are stored in C:\projects\RenderX\images, then the relative path to an image would be "./images/curam/curam.jpg" which is the equivalent of C:\projects\RenderX\images\curam\curam.jpg.