Document Preview Generation

This stage allows for generating document previews, in form of PDFs as well as PNGs. These previews are stored within the configured database (see Database Settings ).

The previews look as follows:

Screenshot which shows our Search Interface with a Preview Image

Screenshot which shows our Search Interface with a Preview PDF

APIs and Permissions

Our Suite in turn provides two API endpoints, i.e.,
/api/v1/preview/thumbnail
and
/api/v1/preview/pdf

which for instance our search frontend (see Search Interface Configuration ) uses to server previews side by side with the search results. Previews are only accessible to authenticated users and only if these users have access to the according documents in search and the underlying content source.

Preview Generation Service

Our (PDF) preview generation relies on Libre Office and an external service, which customers have to deploy. The deployment of this service is described here.

Configuration Parameters

image-20260326-075922.png
  1. Endpoint: This is the http address of Libre Office PDF converter service

  2. Use basic authentication: if set, the connector will use the provided username and password to authenticate against the conversion service

  3. Public keys for SSL certificates: this configuration is needed, if you run the environment with self-signed certificates, or certificates which are not known to the Java key store.
    We use a straight-forward approach to validate SSL certificates. In order to render a certificate valid, add the modulus of the public key into this text field. You can access this modulus by viewing the certificate within the browser.

Details of a Self Signed Certificate
  1. Response timeout (ms). Defines how long the connector until an API call is aborted and the operation be marked as failed.

  2. Connection timeout (ms). Defines how long the connector waits for a connection for an API call.

  3. Socket timeout (ms). Defines how long the connector waits for receiving all data from an API call.

  4. Rate limit: limits the number of API requests for second against the endpoint.