ADx 2.5 (25/11/2020) Release Notes
Overview
This release introduces the following key features and bug fixes:
For more details on each feature, see List of New Features and Improvements
Java Version
ADx 2.5 on-prem installation packages support Java 8 and 11. We recommend Java 11. Within a major Java version, it is fine to update to the latest release (for example 11.0.x) to receive latest available bug fixes and security patches.
The on-prem installation packages for this release have been tested with JDK JDK 11.0.9.1 (package zulu11.43.55-ca-jdk11.0.9.1-linux_x64)
General Features
Support for uploading video files and viewing them in WebReader.
Possibility to control which files are to be indexed by elasticsearch.
Possibility to limit the size of files getting indexed by elasticsearch.
Possibility to run sub-string fulltext queries.
Support for TLS 1.3 (requires Java version 11 or higher).
Possibility to disable legacy API endpoints.
New
ShrinkFactorfor thePdfToPdfconversion job.
REST
- Possibility to encrypt password when creating a new session.
- New Swagger endpoints for authenticating and session handling for ADx.
- Possibility to include session IDs in OpenApi requests.
- New endpoint
/v1/content/view-urlto open contents by URL.
UI Changes
- The Repositories view and the User& Groups view are now grouped by type.
- New login page.
- In Explorer, now the repository name shows on the top-left corner.
Documentation
- New topic on importing CMIS type definitions has been added.
- New topic on performing DHC has been added.
Performance
The loading of ADx landing page has been optimized and loading time has been reduced.
Runtime Properties and Configuration changes
The following runtime properties were added, changed or removed in this release.
ADx
No new runtime properties for ADx in this release.
Conversion
No new runtime properties for the Conversion service in this release.
Tribefire
These new Tribefire properties allow you to customize the ADx elasticsearch behaviour.
| Property | Description | Default Value |
|---|---|---|
| TRIBEFIRE_ELASTIC_FULLTEXT_ACCEPTLIST | List of mime types getting indexed by elasticsearch | See Elasticsearch Mime Types |
| TRIBEFIRE_ELASTIC_FULLTEXT_DENYLIST | List of mime types not indexed by elasticsearch | None. |
| TRIBEFIRE_ELASTIC_FULLTEXT_MAXSIZE | File size limit for elasticsearch indexing. | 100 Mb. |
Elasticsearch Mime Types
The following mime types are indexed by elasticsearch by default in ADx:
application/pdf
application/msword
application/vnd.openxmlformats-officedocument.wordprocessingml.document
text/plain
text/rtf
application/rtf
application/x-rtf
application/vnd.openxmlformats-officedocument.wordprocessingml.template
application/vnd.ms-word.template.macroEnabled.12
application/vnd.ms-word.document.macroEnabled.12
application/vnd.ms-word.template.macroenabled.12
application/vnd.ms-word.document.macroenabled.12
application/vnd.ms-excel
application/excel
application/x-excel
application/x-msexcel
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
text/csv
text/comma-separated-values
application/vnd.ms-excel.addin.macroEnabled.12
application/vnd.ms-excel.sheet.binary.macroEnabled.12
application/vnd.ms-excel.sheet.macroEnabled.12
application/vnd.ms-excel.template.macroEnabled.12
application/vnd.ms-excel.addin.macroenabled.12
application/vnd.ms-excel.sheet.binary.macroenabled.12
application/vnd.ms-excel.sheet.macroenabled.12
application/vnd.ms-excel.template.macroenabled.12
application/vnd.openxmlformats-officedocument.spreadsheetml.template
application/vnd.ms-powerpoint
application/mspowerpoint
application/x-mspowerpoint
application/powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.presentationml.slideshow
application/vnd.openxmlformats-officedocument.presentationml.template
application/vnd.ms-powerpoint.template.macroEnabled.12
application/vnd.ms-powerpoint.slideshow.macroEnabled.12
application/vnd.ms-powerpoint.addin.macroEnabled.12
application/vnd.ms-powerpoint.presentation.macroEnabled.12
application/vnd.ms-powerpoint.template.macroenabled.12
application/vnd.ms-powerpoint.slideshow.macroenabled.12
application/vnd.ms-powerpoint.addin.macroenabled.12
application/vnd.ms-powerpoint.presentation.macroenabled.12
application/vnd.visio
application/vnd.visio2013
application/x-visio
application/visio
application/visio.drawing
application/vsd
application/x-vsd
application/vnd.ms-visio.drawing
application/vnd.ms-visio.drawing.macroenabled.12
application/vnd.ms-visio.stencil
application/vnd.ms-visio.stencil.macroenabled.12
application/vnd.ms-visio.template
application/vnd.ms-visio.template.macroenabled.12
application/vnd.oasis.opendocument.presentation
application/vnd.oasis.opendocument.text
application/vnd.oasis.opendocument.spreadsheet
//HTML
text/html
application/vnd.wap.xhtml+xml
application/x-asp
application/xhtml+xml
//XML
text/xml
//Email
message/rfc822
application/vnd.ms-outlook
application/x-mimearchive
application/mbox
application/vnd.ms-outlook-pst
// Source code
text/x-c++src
text/x-groovy
text/x-java-source
// Ebook
application/x-ibooks+zip
application/epub+zip
// Feeds
application/atom+xml
application/rss+xml
// iWork
application/vnd.apple.keynote
application/vnd.apple.iwork
application/vnd.apple.numbers
application/vnd.apple.pages
// TNEF
application/vnd.ms-tnef
application/x-tnef
application/ms-tnef
// OpenDocument
application/x-vnd.oasis.opendocument.presentation
application/vnd.oasis.opendocument.chart
application/x-vnd.oasis.opendocument.text-web
application/x-vnd.oasis.opendocument.image
application/vnd.oasis.opendocument.graphics-template
application/vnd.oasis.opendocument.text-web
application/x-vnd.oasis.opendocument.spreadsheet-template
application/vnd.oasis.opendocument.spreadsheet-template
application/vnd.sun.xml.writer
application/x-vnd.oasis.opendocument.graphics-template
application/vnd.oasis.opendocument.graphics
application/vnd.oasis.opendocument.spreadsheet
application/x-vnd.oasis.opendocument.chart
application/x-vnd.oasis.opendocument.spreadsheet
application/vnd.oasis.opendocument.image
application/x-vnd.oasis.opendocument.text
application/x-vnd.oasis.opendocument.text-template
application/vnd.oasis.opendocument.formula-template
application/x-vnd.oasis.opendocument.formula
application/vnd.oasis.opendocument.image-template
application/x-vnd.oasis.opendocument.image-template
application/x-vnd.oasis.opendocument.presentation-template
application/vnd.oasis.opendocument.presentation-template
application/vnd.oasis.opendocument.text
application/vnd.oasis.opendocument.text-template
application/vnd.oasis.opendocument.chart-template
application/x-vnd.oasis.opendocument.chart-template
application/x-vnd.oasis.opendocument.formula-template
application/x-vnd.oasis.opendocument.text-master
application/vnd.oasis.opendocument.presentation
application/x-vnd.oasis.opendocument.graphics
application/vnd.oasis.opendocument.formula
application/vnd.oasis.opendocument.text-master
// Archives
application/zlib
application/x-gzip
application/x-bzip2
application/x-compress
application/x-java-pack200
application/gzip
application/x-bzip
application/x-xz
application/x-tar
application/java-archive
application/x-archive
application/zip
application/x-cpio
application/x-tika-unix-dump
application/x-7z-compressed
application/x-rar-compressed
List of New Features and Improvements
The following features are added in this release:
| Feature Number | Priority | Summary | Description |
|---|---|---|---|
| AD-1734 | Blocker | Allow nested Velocity templates and backlinking | See Nesting and Backlinking Velocity Templates |
| AD-1692 | Critical | Add feature to disable legacy endpoints | |
| AD-1565 | Critical | Add Swagger for session creating | New endpoints for authenticating to ADx have been introduced to replace the tribefire-services/api/v1/authenticate endpoint. See Authenticating to ADx |
| AD-1537 | Critical | Support for Audio/Video Files | ADx 2.5 supports audio and video files now. See Supported Audio and Video Files |
| AD-1653 | Critical | Limit size of files being indexed in Elastic | See TRIBEFIRE_ELASTIC_FULLTEXT_MAXSIZE in Runtime Properties |
| AD-1770 | Major | Enable sub-string fulltext query in ADx | See Fulltext Search |
| AD-1750 | Major | Support TLS 1.3 | ADx 2.5 supports TLS 1.3. This increases the security of the connection between browser and the server. Be aware that this requires Java version 11 or higher. |
| AD-1742 | Major | Improve speed of ADx Landing Page | N/A |
| AD-1680 | Major | Expose OpenContentURL as REST Endpoint | See Viewing Content in WebReader |
| AD-1667 | Major | Login dialog needs some refinement | N/A - The login page has been redesigned. |
| AD-1350 | Major | Encrypt password when creating a session | With ADx 2.5, you can create new sessions by passing encrypted passwords in the request. See Authenticate with Encrypted Passwords |
| AD-1571 | Minor | SessionId in OpenAPI | You can now enable the SessionID to be included in OpenAPI requests. see Including Session ID in Open API requests |
| AD-1635 | Major | Control what is indexed by Elastic | See Elasticsearch Mime Types |
| AD-1634 | Minor | Provide functionality to shrink PDFs | The PDFtoPDF conversion job has now the shrinkFactor box. This enables you to define the quality of the images that are replaced within the PDF file. The value has to be between 0 and 1 (both exclusive). Good values to reduces the size while still being able to read the PDF are between 0.1 and 0.3 (but that also always depend on the source quality). When the result is not smaller that the original, the original PDF will be returned. When shrinkFactor is not set, no shrinking is performed. |
| AD-1711 | Minor | Explorer: Move Repository name to headerbar | N/A - This is a UI change in ADx Explorer. |
Bug Fixes
| Issue | Priority | Summary | Description |
|---|---|---|---|
| AD-1733 | Critical | Wrong Ordering of Repositories and User/Groups | N/A |
| AD-1621 | Critical | Combined Conversion Job does not support several sub job types | N/A |
| AD-1834 | Improve legacy endpoint error message | Now, for the legacy delete and move API, when the list of entryIds is empty, an HTTP 500 is retrued. | |
| AD-1650 | Major | Document DHC usage | This is a documentation issue. A new topic has been added. See Running Repository Deep Health Checks |
| AD-1406 | Major | Type Definitions form in CMIS/DCTM repo config | This is a documentation issue. A new topic has been added. See Configuring Type Definitions on CMIS Repositories |
| AD-501 | Major | tf-conversion user has the admin role (Conversion) | N/A |
| AD-1766 | Minor | Fulltext-Searching for spaces causes an exception | N/A - An exception was displayed when searching for a blank string. This has been resolved. |
Updating Conversion and ADx
For information on how to update previously installed Conversion and ADx, see the following:
Known Issues
Below you can find a list of problems we're still working on.
Known Issues ADx
| Ticket | SEVERITY | Description |
|---|---|---|
| https://jira.braintribe.com/browse/AD-321 | CRITICAL | Add missing indices |
| https://jira.braintribe.com/browse/AD-348 | MAJOR | ADx Admin: Repository Modification-Status not updated on Update |
| https://jira.braintribe.com/browse/AD-1898 | MAJOR | Min and Max length metadata not respected on initial upload |
| https://jira.braintribe.com/browse/AD-342 | MINOR | Hibernate warnings in the log files |
| https://jira.braintribe.com/browse/AD-341 | MINOR | Java warnings during for Java 9 and later |
| https://jira.braintribe.com/browse/AD-311 | MINOR | Oracle - DbLockManager prints Oracle constraint message |
Reimporting an Existing Repository Requires UI Reload
In some cases, when reimporting an existing repository, repository properties are not rendered correctly. To make sure properties are rendered correctly, refresh your browser after each import.
Cannot migrate legacy contents simultaneously
Due to cache database being shared between repositories, it's not possible for now to run multiple migration jobs from a single legacy repository at the same time. You need to wait for the previous migration to finish before running a new one.
Min and Max length metadata not respected on initial upload
String length checks are only applied when values are updated but not on the initial upload.
Known Issues Conversion
| Ticket | SEVERITY | Description |
|---|---|---|
| https://jira.braintribe.com/browse/AD-338 | CRITICAL | Introduce roles for conversion |
| https://jira.braintribe.com/browse/AD-337 | MAJOR | Make TF Conversion workbench consistent to ADx |
| https://jira.braintribe.com/browse/EXTDOCS-71 | MINOR | Fix wrong encoding on opening resource in Browser |
Minor Warnings
StatusLogger Error
The following error currently appears in ADx console output. It doesn't affect ADx functionality or performance.
ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.
Set system property 'org.apache.logging.log4j.simplelog.StatusLogger.level' to TRACE to show Log4j2 internal initialization logging.
Tomcat Shutdown Warning
The following warning is sometimes thrown by Tomcat when stopping the service:
./tribefire-console-stop.sh
...
Tomcat did not stop in time.
PID file was not removed.
To aid diagnostics a thread dump has been written to standard out.
Tribefire Host stopped.
This happens when shutdown takes longer than Tomcat expects. Shutdown may take several minutes, which will result in this message being printed out. This warning could appear on both Conversion and ADx.
Java Warnings
When using Java 9 or later, the following warning may appear in application logs and also during installation procedure:
WARNING: An illegal reflective access operation has occurred
WARNING : Illegal reflective access by com.braintribe.model.processing.itw.asm.AsmClassLoaderWrapper$1 (file:/path/to/instant-type-weaving-1.0.28.jar) to method java.lang.ClassLoader.defineClass(java.lang.String,byte[],int,int)
WARNING: Please consider reporting this to the maintainers of com.braintribe.model.processing.itw.asm.AsmClassLoaderWrapper$1
WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
WARNING: All illegal access operations will be denied in a future release
Ticket: https://jira.braintribe.com/browse/AD-341
Hibernate Warnings
The log files may contain Hibernate-related warnings. They can be identified based on the fully qualified class which starts with org.hibernate, as in:
WARNING org.hibernate.tuple.entity.EntityMetamodel 'HHH000084: Entity [com.braintribe.model.user.User] is abstract-class/interface explicitly mapped as non-abstract; be sure to supply entity-names' [TribefireServices-2.0:tribefire-services#initialize,ApplicationLoader:/tribefire-services#initialize]
Ticket: https://jira.braintribe.com/browse/AD-342
These warnings do not affect the functionality of the application and can be ignored. We are working on a fix.