ADx 2.6 (30/4/2021) Release Notes
This release introduces the following key features and fixes:
For more details on each feature, see List of New Features and Improvements.
Java Version
The on-prem installation packages for this release have been tested with JDK 11, package zulu11.48.21-ca-jdk11.0.11-linux_x64.
General Features
Here is an overview of general features introduced with ADx 2.6.
ACL Support
ACL support has been enhanced and more operations are now supported. This includes ACL on repository level and on content level. New operations supported now include:
- Content download
- Content conversion
- Security operations related to working with repositories
CMIS and Documentum Security
From now on all ACL settings are applied on CMIS/DCTM repositories as well. If the Respect Owner box is checked in repository settings, only the technical user can perform operations on contents. To allow other users to perform operations, ACL must be set explicitly to allow the corresponding operations. An alternative is to log ing with the same user name as the technical user in ADx. In this case, the ADx user is implicitly the owner and everything is allowed. Another alternative is deactivating the new Respect Owner flag which makes all entries accessible for all users because then no owner is set. See See Ignoring the Owner in CMIS and Documentum Repositories.
Here is a table that explains the different possibilities:
| Scenario | Result |
|---|---|
| ADx user is different from technical user and no ACL permissions explicitly set( e.g. ADx user=A; technical user=B) | A has no permissions to perform any operations on contents. |
| ADx user is the same as technical user and no ACL permissions explicitly set(e.g. ADx user=A; technical user=A) | A has full access to contents |
| ADx user is different from technical user and ACL is accordingly set (grant)(e.g. ADx user=A; technical user=B;ACL granted 'everything' to A | A has permissions to perform only the granted operations. |
| ADx user is different from technical user and ACL is accordingly set (deny)(e.g. ADx user=A; technical user=B;ACL denied 'everything' to A | A has no access to contents. |
| ADx user is the same as technical user and ACL is accordingly set (grant)(e.g. ADx user=A; technical user=A ACL granted 'everything' to A | A has full access to contents. |
| ADx user is the same as technical user and ACL is accordingly set (deny)(e.g. ADx user=A; technical user=A;ACL denied 'everything' to A | A has no access to contents. |
Read more on ACL here:
Ignoring the Owner in CMIS and Documentum Repositories
You can configure CMIS and Documentum repositories in a way that makes cotents accessible to all users (unless there are ACL rules set on the repository). This enables you to avoid a situation where every user must be explicitly granted permissions to perform operations on contens.
To ignore the owner of a CMIS or Documentum repository, select the repository, and then go to Details and clear the Respect Owner box.
Custom Types
Working with Custom Types in ADx has been improved. The New and Make a Copy actions now provide more options to easily create and copy custom types, and to copy contents as other custom types. For more on ADx Custom Types, see Configuring Custom Types.
When you click New, a list of custom types available in your repository shows. See the figure below.
When you click Make a Copy, you can copy a content as is or as any other custom type. In this case, properties of the new custom type show in the copy dialog and common properties also show and are populated with original values but you can still edit them.
If you click the Make a Copy option directly, ADx always copies the content as is.
Preserving Content Name on File Update
With ADx 2.6, you can choose to keep the original content name when you update the file (resource) associated with this content. To do so, select a content and go to Update File, and then check the Keep Content Name box.
Renditions Download
ADx now enables you to view and download renditions for CMIS and Documentum repository contents. See Viewing Renditions for CMIS and Documentum Repositories
Converting to a Specific PDF Format
A new option for choosing the exact PDF format when converting contents to PDF. Also, now you can flatten PDF pages into images that are then merged into one PDF file.
Recycle Bin View
The ADx explorer now by default offers a new view - Recycle Bin. This enables you to list and search through deleted entries (folders or contents). This is only possible as long as the entry is not physically deleted in the background (specified by the configured TTL setting on the repository) . Also, a user with the right permission is able to either Restore (recursively) or Delete permanently one or multiple of theses contents.
Search and Replace
Now you can easily search and replace in one or multiple documents with the Search and Replace option. Supported formats are HTML and DOCX. This allows you to replace certain details in your documents with one click. To do this, go to More > Merge & Apply > Search And Replace.
Creating Content Representations in Bulk
Soetimes a repository is configures in a way that does not allow creating representations automatically once contents are uploaded (The Create Representations Automatically option in repository details is disabled.). ADx 2.6 enables you to create representations in bulk. To do so, place all contents in one folder, and then go to Actions > Prepare for Viewer. For more information, see Creating Content Representations in Bulk.
Define Root Folder for CMIS and Documentum
Now you can define the Root Folder Id for CMIS and Documentum repositories. This folder doesn't have to be a cabinet. When you synchronize and activate your repository, and then you click on Browse, ADx shows folders and contents of that particular root folder, and if you now create new Folder or Content, ADx places this content inside that root folder that you have previously defined.
REST
New Endpoints
The following endpoints have been added:
| Endpoint | Description |
|---|---|
/access.adx.content.{your-repository-name}/v1/entry/restore (Restore Entry By Id) | See Restoring Contents with REST. |
/access.adx.content.{your-repository-name}/v1/entries/restore (Restore Entries By Id) | See Restoring Contents with REST. |
/access.adx.content.{your-repository-name}/v1/entry/physcially (Delete Entry Physically By Id) | See Deleting Contents Permanently with REST. |
/access.adx.content.{your-repository-name}/v1/entries/physically (Delete Entries Physically By Id) | See Deleting Contents Permanently with REST. |
/access.adx.content.{your-repository-name}/v1/convert/search-replace/by-single-search (Search And Replace By Id Single Search) | Enables you to search and replace text within one content. See Searching and Replacing in HTML and DOCX Files with REST. |
/access.adx.content.{your-repository-name}/v1/convert/search-replace (Search And Replace By Id) | Enables you to search and replace text across multiple contents by specifying content IDs inside a JSON body. Searching and Replacing in HTML and DOCX Files with REST. |
Updated Endpoints
The following endpoint has been updated:
/access.adx.content.ggr/v1/content/update (Update Content By Id)
The keepContentName parameter has been added. Setting keepContentName to true preserves the original content name when updating the file associated with a content.
UI Changes
- Global actions menu has been moved to the top bar.
Possibility to display files in JSON, XML, YAML, and others in WebReader with syntax highlighting.
Previously, when you clicked on Browse in Cmis/Dctm repo it showed all entries without a parent. Also when you added a new folder without parent, Cmis would create new cabinet but Dctm would create a folder under My Home Cabinet, which is in fact the cabinet of the current Documentum user. Now, Documentum creates new cabinet, so we have the same behaviour in CMIS and Documentum.
The Structured menu option of the left side on Explorer has been deprecated in ADx 2.6.
The loading screens for the Administrator and Explorer have been improved.
WebReader
Split View
ADx 2.6 enables you to view documents in WebReader side by side. For example, if you want to compare different parts of the same document or if you want to view two documents side by side. To view documents side by side, select the documents, right-click, and then select View > Split View.
Opening Multiple Documents in WebReader
With ADx 2.6, you can select multiple documents and open them in WebReader. See the video below.
Viewing Emails with Their Attachments
With ADx 2.6, you can view emails and their attachments in WebReader. When you upload content of the EML type, WebReader displays these contents as separate documents if these emails contain attachments.
Comments on Document Level
Now you can add comments on the document level. These are general comments that are not bound to a specific part in the document. To enable document-level, comments, you must edit the UI Configuration in the repository settings.
Documentation
- A new topic about additional ways to monitor ADx status and get deeper information on ADx internal status has been added. See Additional Endpoints for Monitoring ADx Status.
- The access control (ACL) topics have been improved, and new topics have been added. See Understanding Access Control in ADx.
- A new topic on how to report issues to ADx support. See Reporting Issues to ADx Support Team.
Runtime Properties and Configuration changes
ADx
No new runtime properties for ADx in this release.
Conversion
No new runtime properties for the Conversion service in this release.
Tribefire
List of New Features and Improvements
The following features are added in this release:
| Feature Number | Priority | Summary | Description |
|---|---|---|---|
| AD-1095 | Critical | Full ACL Support (RepositoryLevel, Explorer, All Services, ...) | See See Understanding Access Control in ADx. |
| AD-2027 | Minor | Add flatten pdf feature / add pdfToPdf conversion option | A new option when converting to PDF. This option enables you to choose what PDF format to use. You can also flatten the PDF pages as images. |
| AD-1795 | Critical | Add replace feature in html/docx | See General Features. |
| AD-1751 | Critical | Add compare mode to WebReader | See WebReader Updates. |
| AD-1685 | Critical | Add annotations per document | |
| AD-2144 | Major | Add flag for keeping the name of content on update content | |
| AD-2029 | Major | Add rootFolderId in CMIS/Dctm repository connection configuration | Now you can define the Root Folder Id for CMIS and Documentum repositories. See Specifying Root Folder for CMIS or Documentum Repositories. |
| AD-1994 | Major | Support showing renditions for Cmis/Dctm repository | |
| AD-1919 | Major | Find MIME Type of mail attachment if only application/octet-stream is available | |
| AD-1909 | Major | DHC should always create new report whether it is in temp folder or not | |
| AD-1891 | Major | Explorer should reload single content on notification | |
| AD-1768 | Major | Add recycle bin to users view | |
| AD-1746 | Major | Support download renditions for Cmis/Dctm repository | |
| AD-1578 | Major | Rework Explorer Actions | See UI Changes. |
| AD-1974 | Minor | Support textual files (with highlighting) | Now it is possible to view formats like JSON and XML in WebReader including the appropriate highlighting. |
| AD-1787 | Minor | Allow to navigate through files in all directions | Previously, the arrow keys could be used to open the previous or next Content in the preview. Now, it is possible to get to the Content below (or above) the currently selected Content. |
Bug Fixes
| Issue | Priority | Summary |
|---|---|---|
| AD-2054 | Blocker | AutoCommit Issue. Sometimes the Auto commiting is not working. Save notification is not sent. |
| AD-1788 | Critical | Metadata mandatory check not working on custom types |
| AD-1945 | Critical | Standard Content Icons are lost after tmp Cleanup |
| AD-1831 | Critical | Delete file error in conversion |
| AD-1821 | Critical | Buttons are missing for CMIS/Documentum repository in UI. This issue arrised due to the new enhancements to ACL on repository level. Do be able to view all buttons and actions for contents, you must now log in to ADx with the same username and password that you use to log in to your CMIS or Documentum system. |
| AD-1816 | Critical | Uploading an empty file to S3 causes an Exception |
| AD-1484 | Critical | Export conversion job is really slow |
| AD-1361 | Critical | Problem in WebReader with compound documents after print |
| AD-1778 | Critical | Folder can be its own parent. |
| AD-1898 | Major | Min and Max length metadata not respected on initial upload |
| AD-1820 | Major | Structure not presenting root (parentless) content for Standard repository |
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.