You are viewing the documentation for Blueriq 15. Documentation for other versions is available in our documentation directory.
Introduction
The Document Renderer Client was introduced in Blueriq 14.9.
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 document-renderer-client profile must be active. If the profile is not active, the deprecated embedded document renderer will be used.
More information on how to configure the application using Spring Profiles can be found here : External application configuration with Spring Profiles.
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
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.
| Subject | Property | Explanation | Default value | Property file |
|---|---|---|---|---|
| Document Renderer Client | blueriq.document.renderer-client.url | URL and credentials of the Document Renderer Service. | N/A, these properties are required to be set for the connection to the document renderer service |
|
| blueriq.document.renderer-client.username | ||||
| blueriq.document.renderer-client.password | ||||
blueriq.document.renderer-client.tagsUppercase | All XML tags are rendered uppercase. This influence on how your documents are rendered. By default Blueriq supports uppercase tags only. | true |
| |
blueriq.document.renderer-client.sortDomainValues | Boolean to enable/disable sorting by the short value of domain values. | false |
|
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 theIDocumentImageProvider 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.
Overview
Content Tools