Migrating from the integrated Document Renderer to Document Renderer Service

Follow these steps to migrate from the integrated (deprecated) Document Renderer to the new Document Renderer Service.

Blueriq Document Renderer Service

Installation

The service can be installed through the Blueriq installer or manually on both Windows and Linux platforms. See Document Renderer Service for installation instructions.

Configuration

• If you are using custom document templates (xsl) and/or fonts, move these from the current location to the <blueriq installation home>\Services\document-renderer\Resources\documents folder (or configure a different folder through the Document Renderer Service properties)
• Review the Document Renderer Service properties in <blueriq installation home>\Services\document-renderer\Properties\blueriq-document-renderer.yml (See Document Renderer Service for configuration options)

Font Configuration

The ibex-config.xml can be removed from the documents\ibex as the new Document Renderer Service uses a different way of loading fonts when generating PDF files. The Document Renderer Service uses the operation system's default font location to render fonts as well as custom fonts that are configured in using the properties.(See Document Renderer Service for configuration options)

Blueriq Runtime

Configuration

Configure the runtime to use the Blueriq Document Renderer Client:

• Add the document-renderer-client profile to your bootstrap.properties file in the Runtime configuration directory.
• Configure the required properties as described in Document Renderer Client Properties

Custom images

If you were using a plugin to add custom images to a generated document, please refer to Document Renderer Client component for information on how to add custom images to a document through the Blueriq Document Renderer Client.

Images rendering differences

The Document Renderer Service renders background images and watermarks differently then the Ibex Java implemenation in the Runtime did. The Ibex Java implementation was not able to read image metadata for .bmp and .png images, which resulted into inflated watermarks and background images. As for those types of images we are unable to send additional information about how to render the images, unlike for regular images. 

By verifying generated pdf files with background images we have concluded that the Runtime implementation inflates the background images bij 33,5 percent. To ensure that you are stil rendering the same documents with the Blueriq Document Renderer Service, the uploaded images in Blueriq Studio need to upscaled by 33,5 percent.