The focus on this release upgrades is to describe how to adapt your application to changes introduced for customization of navigation.
Customization of navigation
Because of the new navigation service implementation, rest endpoints /PRC/{processId}/next
and /TSK/{taskId}/next
were deprecated. The functionality to provide next action
based on the previous action is supported on the rest point /v1/navigation
, which accepts POST
requests. Request’s message body and response are type of NavigationAction
.
(e.g:
{
"id":"GEAR-2b09489d-bb27-4b2a-9c6f-894c0c6e6b34",
"type":"TSK",
"context":"complete"
}
The source action context is ActionName
. The target action context is View
.
Document preview performance enhancement
The performance enhancement is due to the use of a new cache for the content retrieved from the content manager. The new cache complements the existing ones for content references, content metadata, etc. The default cache configuration will use the JVM heap memory to cache the objects for a limited time (between one and fifteen minutes) .
The maximum amount of memory used to cache the content is configured to 100 MB. Hence, check your JVM memory settings to avoid "Out of memory" exceptions. |
The configuration of the memory cache is done with a new parameter (content.cache.size) in the one.properties file. If you want to change the default configuration, please, bear in mind that the cache needs a minimum quantity of available memory to work properly. The memory requirements can be estimated by calculating the amount of concurrent users concurrently previewing documents per the average document file size. For instance, if you think that there can be 20 different users opening documents at the same time and the average size of the documents is 40 MB, you can configure cache to 800 MB (or 1 GB to be sure).
If you run edoras one with the cache-redis spring profile, the content cache will be managed by redis.
Renamed cacheDir
configuration property
Previous release documentation refers to a cacheDir
property that can be used to set the location of the on-disk content conversion cache.
To improve readability and avoid potential property clashes, this property has been renamed to content.conversionCacheDir
.
Please update any local property files that use the cacheDir
property accordingly.
Miscellaneous
TIFF support for the Document Viewer
The documents shown by the Document Viewer are always converted to PDF before being displayed. Now, the Document Viewer will be able to display multi-page TIFF documents. A new image library has been added to the project to provide enhanced TIFF support. This library is registered in the Java ImageIO component by means of a Tomcat context event listener. This is the code snippet that has been added to the web.xml file of the project:
<!-- edoras one listener to load all the ImageIO plugins -->
<listener>
<display-name>ImageIO service provider loader/unloader</display-name>
<listener-class>com.twelvemonkeys.servlet.image.IIOProviderContextListener</listener-class>
</listener>
The bootstrap project has been modified accordingly. If you need TIFF support in your project, please, review the changes done in the web.xml file.
Bootstrap project
Here you will find a list of files which have changed since the last release. This helps you check the difference between your bootstrap project version and the current one:
src/main/webapp/WEB-INF/web.xml
: Servlet listener to register ImageIO plugins and changes to allow conversion cache to be overwritten
src/edoras-one-bootstrap/src/main/resources/com/edorasware/bootstrap/config/one.properties
: added content.cache.size property