Versions Compared

Old Version 3

changes.mady.by.user Unknown User (a.szuflicki)

Saved on

compared with

New Version Current

changes.mady.by.user Terry van der Griend

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of contents 

Table of Contents

Description

The Document Renderer Client Component provides the ability to render PDF documents, using the Document Renderer Service. Documents can be generated by modelling the AQ_Document_Generate, AQ_Document_Renderer, or AQ_DocumentLink.

Requirements

This component requires the document renderer service to be installed and configured. See configuring the document renderer service to enable it. 

Installation

In order to use this component, the 

Include Page
_ProfileDocumentRendererClient
_ProfileDocumentRendererClient
profile must be active. If the profile is not active, the deprecated embedded document renderer will be used.

...

Add the artifact with groupId com.blueriq and artifactId blueriq-component-document-renderer-client as a dependency to your Blueriq runtime POM file if you want to depend on it.

Configuration

Note

Please note that you need to add the following configuration. There are no default value for these properties, and the project does not run without setting these properties.

Include Page
Document Renderer Client Properties
Document Renderer Client Properties

Custom images

Blueriq enables developers to provide custom images to be used in a document. In order to do so, provide a Spring bean of the IDocumentImageProvider type. Consult the Javadoc for details about this interface.

Custom documents renderer

To create custom renderer create Spring bean implementing IXmlElementRenderer interface with AquimaDocumentXmlRenderer annotation. AquimaDocumentXmlRenderer annotation has a required elementClass parameter which has to be type of class that extends IElement.

Performance

By decoupling document rendering from the Runtime into its own service, a performance penalty was introduced. The Runtime will send the document rendering request to the renderer service which contains the document layout and contents including the to be renderer images. This done via a standard HTTP call. We have noticed that the size of the document and the images will influence the overall roundtrip of the rendering request.