Various types of renditions are available for binary content files to provide their information in different formats.
Table of Contents
Introduction
Renditions are alternative representations of the content assigned to DMS objects. As such, they are only retrievable with a read permission for the concrete object instances.
Please note that a rendition is not an exact representation of the original file. Deviations to the original file may arise and are NOT considered as bugs in our software.
Typical use cases for the individual rendition types are:
| Rendition type | Typical use cases |
|---|---|
text | full-text search |
| content preview | |
slide | thumbnails for content visualization within hit lists in client applications |
Calculation and Storage
The yuuvis® Momentum core system offers automated rendition calculation for various supported formats of binary content files.
Note: The responsible services are enabled in the default configuration but the rendition repository has to be configured manually.
| Rendition type | text | slide | |
|---|---|---|---|
| Service for calculation | CONTENTANALYZER | RENDITION | RENDITION |
| Automated calculation | during import with content and content update processes | on (first) request | on (first) request |
| Manual input | during import or via the update endpoint for existing objects, or via the dms.request.objects.upsert.database-before webhook | - | - |
| Storage location | search index | rendition repository | rendition repository |
| Availability for DMS object versions | only for the current version | for any (not deleted) version | for any (not deleted) version |
As the text rendition is used for full-text search, it is stored in the search index. If you want to extend the core system's functionality in terms of supported formats, it is possible to set or update the text rendition via API gateway endpoints. Thus, it is possible to, e.g., integrate an OCR implementation to automatically calculate a full-text for binary content files of image file types.
The text renditions are not stored as content streams but as plain text in the search index where only data for the current version of DMS objects are stored. Thus, text renditions are only available for the current version of DMS objects.
Note: A dbs-reindex Command via Commander Service will undo all manual text rendition inputs.
The pdf and slide renditions are calculated from the binary content file by the rendition service on request. To reduce the workload and processing time for repeated retrieval of the same rendition, a default rendition repository can be configured. It is a separate repository to allow for a different storage configuration as it might be required for the binary content files themselves. Whenever a pdf or slide rendition is requested for an object, it is retrieved from the default rendition repository. If available, the stored rendition will be returned. If not available, the requested rendition is generated from the binary content file that is assigned to the object, stored in the default rendition repository and finally returned.
The rendition repository uses the content's digest as rendition identification to avoid duplicate filing. The digest is calculated by the CONTENTANALYZER during each content import or update process and referenced in the content stream properties section of the corresponding DMS object. If the same content file is assigned to multiple DMS objects, the digest is the same, and only one rendition for each kind (pdf or slide) is stored within a tenant.
It is not possible to set retention for a rendition.
Supported Formats
The following table provides an overview of various binary content file types and the types of rendition that can be provided (
) by yuuvis® Momentum.
| Binary content file type | Extension | text rendition | pdf rendition | slide rendition |
|---|---|---|---|---|
| MS Office Word 97-2016 | doc, docx | | | |
MS Office PowerPoint 97-2016 | ppt, pptx | | | |
| MS Office Excel 97-2016 | xls, xlsx | | | |
| OpenDocument Text | odt | | | |
| OpenDocument Presentation | odp | | | |
| OpenDocument Spreadsheet | ods | | | |
| Rich Text Format | rtf | | - | - |
| Visio Drawing File | vsd, vsdx | - | (limited range of functions) | |
| Plain Text | txt | | - | - |
| Comma Separated Values | csv | | - | - |
| HyperText Markup Language (HTML) | html | | - | - |
| XML | xml | | - | - |
| JavaScript Object Notation | json | | - | - |
| MS Outlook | msg | | - | - |
| Encapsulated Portable Document Format | epdf | | - | - |
| Encapsulated Portable Document Format | | - | | |
Tagged Image File Format | tiff / tif | - | | |
Portable Bitmap Image | pbm | - | | - |
Bitmap Image File | bmp | - | | |
Graphical Interchange Format File | gif | - | | |
JPEG Image Exchangeable image file format (JPEG) | jpg, jng, jpeg | - | | (only jpg and jpeg) |
| Portable Network Graphic | png | - | | |
| Weppy Image Format (Lossy Compression) | webp | - | | |
Operations on Renditions
The API gateway provides the following endpoints for the handling of renditions. The individual operations are documented in the corresponding object's audit trail.
| Type of rendition | text | slide | |
|---|---|---|---|
Retrieval for current object version | GET /api/dms/objects/{objectId}/contents/renditions/text | GET /api/dms/objects/{objectId}/contents/renditions/pdf | GET /api/dms/objects/{objectId}/contents/renditions/slide |
| Retrieval for any object version | - | GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/pdf | GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/renditions/slide |
| Update | POST /api/dms/objects/{objectId}/contents/renditions/text | - | - |