Release notes IBM Daeja ViewONE, Version 5.0.6

Abstract

These release notes provide information about new features, fixes, and known problems for IBM Daeja ViewONE, Version 5.0.6.

Online version of the release note: https://www-01.ibm.com/support/docview.wss?uid=ibm10885270

Important: The most current version of the file can always be found online.

Release description

IBM Daeja ViewONE, Version 5.0.6, makes it easier for business and IT professionals to view large documents and images in their enterprise content management (ECM) solution or in other custom applications, websites, intranets, and extranets.

Download location

To download IBM Daeja ViewONE:

  1. Log in to Fix Central.

  2. In the Product Group list, select Enterprise Content Management.

  3. In the Select from Enterprise Content Management list, select the Daeja ViewONE edition that you want to download.

You must have a license to download this software. The file that you download is a product installer for IBM Daeja ViewONE Virtual. When you run the installer, indicate any add-on modules for which you have a license. The installer then enables only those modules you have purchased.

Prerequisites before installing IBM Daeja ViewONE, Version 5.0.6

You must run the installer as an administrative user.

Before you install IBM Daeja ViewONE, Version 5.0.6:

To generate a hardware and software requirements report, see System Requirements.

Installing IBM Daeja ViewONE, Version 5.0.6

You can run the installer interactively or silently.

To run the installer silently, update the sample response file that is provided with the image archive before you run the installer.

Windows

At a command prompt, change to the directory where you extracted the installation image.

To install the viewer interactively, enter the following command:

DAEJA_VIEWONE_5.0.6_WIN_ML.exe

Alternatively, double-click DAEJA_VIEWONE_5.0.6_WIN_ML.exe in Windows Explorer.

To install the viewer silently, enter the following command:

DAEJA_VIEWONE_5.0.6_WIN_ML.exe -f fully_qualified_path_of_the_response_file

From version 5.0, the default installation path on Windows is C:\Program Files\IBM\Daeja ViewONE_Virtual

UNIX

At a command prompt, change to the directory where you extracted the installation image.

To install the viewer interactively, enter the following command:

./DAEJA_VIEWONE_5.0.6_UNIX_ML.bin

To install the viewer silently, enter the following command:

./DAEJA_VIEWONE_5.0.6_UNIX_ML.bin -f fully_qualified_path_of_the_response_file

From version 5.0, the default installation path on Unix is /opt/IBM/Daeja ViewONE_Virtual

Configuring the Viewer

IBM Daeja ViewONE comes with a Toolkit rich in capabilities that enables advanced integration and customization of the viewer by using HTML parameters and JavaScript API methods. For more information on the developer’s guide refer to:

IBM Daeja ViewONE Virtual Developer's Guide

New features

IBM Daeja ViewONE, Version 5.0.6, provides the following new features:


PDF documents are rendered on the client by default

In version 5.0.5, the HTML parameter clientPDFTileGeneration needed to be set to true for the viewer to render PDF documents on the client.
From this release, rendering of PDF documents on the client (clientPDFTileGeneration=true) is the default.
The ability to render PDF documents on the server (clientPDFTileGeneration=false) has been deprecated and will be removed in a future release. It is now only supported as-is with no fixes or other changes made.
For more information on client rendering of PDF documents see : https://www-01.ibm.com/support/docview.wss?uid=ibm10885518

NOTE If clientPDFTileGeneration is set to false the following features will be unavailable:
- ER152961 Text searching in PDF documents
- PDF Text Selection Mode for client side rendered documents.
- PDF Text Copy for client side rendered documents.
- ER178608 Support for password protected PDF documents


Print Original Size Default

When printing a document, the option Print Original Size is now the default.


Text selection and copy ability for PDF documents.

This feature adds the ability to highlight and copy text in PDF documents.
To highlight and copy text, click the 'Toggle text selection' button on the main toolbar.
When this button is selected, annotations on the pages will be hidden and the annotations toolbar will be disabled.
Text can be highlighted using the mouse to click and drag across the text on the page.
To copy the highlighted text, press Ctrl+C (Windows) or Cmd+C (Mac) on the keyboard, or use the browser copy context menu by right clicking on the selected text.
To exit text selection, which will re-enable the annotations toolbar and redraw annotations on the page, click the 'Toggle text selection' button on the main toolbar.

Limitations:
Dragging the mouse across different ViewONE viewers to select text on multiple viewers is not supported.
This feature is not available when viewed in Internet Explorer and Edge.
This feature is not available if the viewer is configured to use the deprecated functionality to render PDF documents on the server.


The default tile size for documents has been set to 3000 by 3000 pixels

A document page displayed in ViewONE is composed of several smaller images (tiles). The default size of these tiles has been changed from 256 by 256 pixels to 3000 by 3000 pixels to reduce the number of network calls required to display a page.
A typical document will have a page pixel size of approximately 2000 by 2600 pixels and so will now be displayed as one tile per page. Very large or high resolution document pages and zooming in may increase the number of tiles required to display a page.
The size of a tile used may be overridden using tileXSize and tileYSize parameters.
The tileXSize and tileYSize parameters can be configured from a minimum of 100 to an unlimited size. Where no value is given the default value of 3000 is used. Where the maximum size is larger than the number of pixels represented by the page, the page width at the current zoom level in pixels is used. For example, if tileXSize and tileYSize are both set to 9000, but the page is represented by 100x100 pixels, the requested tile will only be 100x100 pixels. NOTE: This parameter has no effect on PDFs when the HTML parameter clientPDFTileGeneration is set to true, but is applicable to all other supported MIME types.


Optimized performance of printing PDF documents

When printing PDF documents with annotations, the annotations are now embedded into the downloaded PDF document as native PDF annotations. This greatly improves the time taken to print documents, especially large documents.
This process currently only applies to printing PDF documents when 'Print Original Size' is selected in the print settings. If this is not selected the print process will follow the previous behavior.

The time it takes to prepare a PDF with annotations for print, now depends on the total number of annotations. In most cases you need to have several hundreds of annotations in a single document before the time difference becomes noticeable.

When the print output is saved as PDF, any annotations created by ViewONE are now embedded into the document as native PDF annotations. Therefore they are recognized as active annotations when the PDF is viewed by tools that support editing of PDFs. If this document is subsequently viewed by ViewONE, any annotations will be treated as static content following previous behavior, where loading a document with pre-applied native annotations and cannot be edited in ViewONE. To prevent document or annotation modification appropriate security would need to be set via a tool that supports editing or via some PDF printers.

Sticky Notes
    Sticky Note annotations will appear on top of other annotations regardless of z-order
    Sticky Note's ID will appear next to the top left of the Sticky note, rather than on top of the Sticky Note icon.

Line Width
    The maximum line width of native annotations is 12pt and will be limited to this for print output.

Solid Text
    If a solid text annotation is set to be semi-transparent the fill background and the text will become semi-transparent, previous behavior left the text solid and only the fill became semi-transparent.

Limitations
    The above behavior does not apply to the following cases:

The following APARs are resolved by this feature:

 * IO25707 - DAEJA VIRTUAL VIEWONE PRINT BAND CUTS OFF PART OF TEXT.


Native PDF annotations now display in ViewONE

PDF Documents that contain native PDF annotations that were created outside of ViewONE now display in the viewer. Previous support for highlight and sticky note annotations has been extended to all standard native PDF annotations. Native annotations created as part of ViewONE's print process also display if the printed PDF is loaded into the viewer.


ER181959 Ability to render large images when embedded in an email

When viewing an email with embedded images wider than the text body, the images are scaled to avoid truncation of any of the content. All embedded images are now listed in the attachment tree from where they may be viewed full size.


ER186096 Ability to render large tables when embedded in an email

When viewing an email with embedded tables wider than the text body, the whole email now gets scaled to avoid truncating any content of the table, while the text in the body remains at the same size.


ABILITY TO DISABLE PAGE NOTIFICATION

The page notification pop-up, that appears when a page is changed, can be turned on/off using the pageNotification HTML parameter. The default value is true, which displays the page notification pop-up.


ER181436 Support filenetZOrderEnabled parameter in ViewONE Virtual

When saving and loading annotations with a P8 Content Engine back end via ViewONE Virtual the layering of the annotations in the user interface is maintained. Existing annotations are ordered in the interface from the item with the lowest F_ORDINAL value to the highest, with the highest value overlaying the other annotations.


ER181785 Reset the page selection to 'all Pages' when a user prints a new document

After changing the document, the page selection will be set to 'All Pages'. The viewer no longer stores previous selections from prior documents.


ER172427 RETAINING THE MAGNIFIER PREFERENCES

When the users move from one page to another within the viewer, the magnifier preferences such as the magnification factor, magnification size, and the location of the magnifier will be retained across all the pages within a document.
Note:


ER178608 Support for password protected PDF documents

Password-protected PDF documents can be opened and viewed when the viewer is configured to render PDF documents on the client: A dialog prompt will appear allowing for the password to be input. The viewing of password-protected PDF documents is not supported in PageN mode. A password dialog prompt is open for each page that uses a password protected PDF. If there is more than one page that uses a password-protected PDF document, there is no way to determine which document's password the viewer is asking for. The printing, redacting, and document-building of password-protected PDF documents are not supported.


Introduction of INVERT feature for Client Side PDF rendering

When the option to render PDF documents on the client is enabled, the ability to invert the colors of pages in the viewer is now supported. The state of the invert is retained when changing the edit modes. For more information on client rendering of PDF documents see : https://www-01.ibm.com/support/docview.wss?uid=ibm10885518.
Limitations: This feature is unavailable in browsers that do not support image filters.
Internet Explorer from version 9 through version 11 has no support for image filters.


ER152961 Text searching in PDF documents

This feature adds the ability to search PDF document text and display the search results visually. Search is only available when the PDF document is rendered on the client. The search feature is not available in PageN, Document Builder mode, or when viewed in Internet Explorer and Edge. Limitations: If a word is split across different div elements then it is not regarded as a single word, and will not be in the search result. For more information on client rendering of PDF documents see : https://www-01.ibm.com/support/docview.wss?uid=ibm10885518


ER175184 Copy and Paste ability on Text Annotation

When user double right clicks on a text annotation the text edit dialog comes up allowing the user to copy the text. Pressing a CTRL+V on an active text annotation allows the text edit dialog to come up and also pastes the content that is copied.


ER185575 Annotation sticky mode has been extended to persist across pages of a document

When annotation sticky mode is enabled (via right-clicking an annotation in the annotation toolbar), this sticky mode is now persisted across pages in a document. The sticky mode is not persisted when a new document is opened.


ER185831 Enabled eSignatures on PDFs

When the option to render PDF documents on the client is enabled, electronic signatures included in PDFs are now displayed. For more information on client rendering of PDF documents see : https://www-01.ibm.com/support/docview.wss?uid=ibm10885518


ER170411 Add support for startAnnotation(type)

This javascript method will allow users to activate an annotation type to be used. The type of annotation is determined by the 'type' parameter. The following values can be used for the 'type' parameter:


* STAMP annotations are not currently supported for this feature.
Search functionality for PDF documents is enabled for the Virtual viewer integrated into IBM Content Navigator

The text search functionality for PDF documents has been enabled for the Virtual viewer integrated within IBM Content Navigator


JavaScript API to get Annotations based on status

A javaScript API has been added to get annotations from the viewer based upon their status.
getAnnotations(String json) - gets the annotations based on the status specified in the 'json' string provided. If the json entry is empty or null, all annotations present in the document will be returned. Deleted annotations will not be included

The Json format is as follows:
{"status":""} - where ' can be replaced with one of the following 3 values:
'all' - gets all annotations currently present in the document. Deleted annotations will not be included
'new' - gets any annotations that have been newly added to the document since a save/load of annotations last occurred.
'modified' - gets any annotations that have been modified in the document since a save/load of annotations last occurred.
'deleted' - gets any annotations that have deleted in the document since a save/load of annotations last occurred.
'unchanged' - gets all annotations that are not new, modified, or deleted.
Should status be null or empty, this method will return all annotations currently present in the document. Deleted annotations will not be included.
Should status be an invalid entry, an exception will be logged (if the traceException parameter is set to true) and this method will return undefined.


Add support for disabling Individual Document Builder buttons

Users can now have more control over the north toolbar. The following new HTML parameters enable users to be able to individually disable specific Document Builder buttons:


When these parameters are set to false the viewer will hide the individual button. By default, these parameters will be set to true.
* The HTML Parameter 'docBuilderButtons' (when set to false) will override these parameters and will disable all Document Builder buttons
Add support for disabling Document Builder buttons

The new HTML parameter docBuilderButtons can be used to determine whether the toolbar includes Document Builder buttons or not when the edit mode is set to 'docbuilder'. When set to false the viewer will hide the Document Builder buttons. By default it is set to true.


Removed the Permanent Redaction Java API

The Permanent Redaction Java API (also known as the jiBurner API) has been removed. This was deprecated at IBM Daeja ViewONE Virtual Version 5.0.4.


ER179490 Introduce event to indicate when viewer JS library has finished loading

When all the JavaScript Libraries required for ViewONE are finished loading, VIEWONE_JSLIB_LOADCOMPLETE event is thrown. Customers can listen to this event by adding a listener as below :
window.addEventListener("VIEWONE_JSLIB_LOADCOMPLETE", myViewoneLibraryListener); where myViewoneLibraryListener would be the implementation of the listener. Using the event listener will prevent errors caused by calling viewer functionality before the libraries have completed loading.


For online documentation, see the IBM Daeja ViewONE knowledge center.

Fixes

IBM Daeja ViewONE Virtual, Version 5.0.6, includes all fixes and features up to and including IBM Deaja ViewONE Virtual Version 5.0.5 iFix 11.

Additional Release Notes

Daeja ViewONE as an integrated solution

When running Daeja ViewONE 5.0.6 as a component inside IBM Content Navigator, the minimum supported version of ICN is 3.0.6, unless stated otherwise by the specific ICN release.

System requirements

Go to the page at Software Product Compatibility Reports to create a high-level report for operating systems, hypervisors and prerequisites.

Linux specific jar file size

The size of the Linux specific resource jar, jiserver-resource-linux.jar, has reduced by approximately 50MB.

Security Bulletin: ViewONE is vulnerable to XXE attack when opening PDF documents

Published Technote: http://www.ibm.com/support/docview.wss?uid=ibm10733815

Resolved in release: IBM Daeja ViewONE Virtual 5.0.4 iFix 6, all future iFixes on 5.0.4 and IBM Daeja ViewONE Virtual 5.0.5

Deprecation of Annotation Types

As of IBM Daeja ViewONE Virtual Version 5.0.6 the following annotation types are deprecated:

*Ruler
*Angle
*Transparent Highlight

These annotation types will be removed in a future version of the product.

Deprecation of Email Render = 1

As of IBM Daeja ViewONE Virtual Version 5.0.3, the default value for parameter emailRenderer is set to '2' which represents the email module that allows for paginated output. See more details for this module below. As of IBM Daeja ViewONE Virtual Version 5.0.6, the ability to switch the email module to the alternative value "1" has been deprecated. The value will be removed as a valid setting for the parameter in a future release.

The email module that produces paginated output is now the default setting for the standalone product. This email module supports the display of EML (MIME RFC 822) and MSG (Microsoft Outlook and Exchange) formats as paginated content, and allows for streaming and redaction of emails. It requires the IBM ViewONE Office Module to be licensed. To redact emails, the IBM ViewONE Permanent Redaction module is also required. When opening emails that have annotations saved using the older email rendering mechanism, the HTML parameter 'emailUseAnnotationDefinedModule' defines the behavior.

The 'emailUseAnnotationDefinedModule' parameter can have the following values:

*always: The default behavior is to always attempt to use the renderer that is defined in the annotation.

*never: The renderer that is defined in the annotation is never used. Instead, the email is opened using the renderer specified in the viewer. This may cause the annotations to move. The user will be notified that 'The annotations on this document were saved with a different version of the viewer. Annotation may have moved and will need checking'. The annotation save button will be enabled and user will be prompted to save before they leave the document unless the 'annotationAutoPrompt' HTML parameter has been set. The 'annotationAutoSave' HTML parameter does not work for this annotation change.

*prompt: The user receives a prompt when annotations were created using a different renderer, giving them the option to open using the renderer defined for the viewer (Yes) or attempt to open with the renderer that is specified in the annotation (No). If the user click Yes they will then be notified that 'The annotations on this document were saved with a different version of the viewer. Annotation may have moved and will need checking'. The annotation save button will be enabled and user will be prompted to save before they leave the document, unless the 'annotationAutoPrompt' HTML parameter has been set. The 'annotationAutoSave' HTML parameter does not work for this annotation change.

Document Builder

Document Builder uses repository-document and repository-annotations when the document is created

The document will be built with the source document as it is saved in the repository. The document is also built by using the annotations that are saved in the repository, unless annotations have been edited. The following scenarios explain the effects of this behavior:

Scenario 1:
  1. Two instances of the viewer are opened in document builder mode
  2. A document is loaded from a repository into each viewer window
  3. The document builder user copies a page from the document in viewer window 1 and pastes the page into the document in viewer window 2
  4. While the document builder user is working on the documents, another user or system process alters one or both of the master documents
  5. The document builder user builds the modified document
  6. Because one or both of the master documents were altered during the document builder session, the built document contains the pages from the latest saved version of the master documents

Result: The document currently displayed in the viewer differs from the newly built document in the system. To prevent this issue occurring, the master document should be locked or checked out when it is retrieved for document builder.

Note Versioned documents will not be affected by this issue. This will only affect situations where the document that a URL refers to has changed.

Scenario 2:
  1. Two instances of the viewer are opened in document builder mode
  2. A document with annotations is loaded from a repository into each viewer window
  3. The document builder user copies a page from the document in viewer window 1 and pastes the page into the document in viewer window 2
  4. While the document builder user is working on the document, another user or system process alters one or more of the annotations used in one or both master documents
  5. The document builder user builds the modified document
  6. The built document contains the pages from the latest saved version of the master documents. For pages where the document builder user has not modified annotations in the viewer, the annotations for those pages come from the latest saved annotations version. For pages that the user has modified the annotations in the viewer, those pages will contain annotations as seen in the viewer which may not contain the latest changes

Result: The document currently displayed in the viewer differs from the newly built document in the system. To prevent this issue occurring, the master document should be locked or checked out when it is retrieved for document builder.

Restore annotations is not supported in document builder mode

When in document builder mode, the option to restore annotations is not supported. The following scenario explains the effects of this behavior:

Scenario 1:

  1. Viewer is loaded in document builder mode
  2. A document is loaded from a repository
  3. Annotations are created by the user
  4. Restore annotations button is disabled
  5. Javascript API reloadAnnotations() is disabled

Result: The user cannot reload the annotations from the server. Newly created annotations and edited annotation edits remain.

To restore any newly created annotations, the user must take the following steps:

  1. Remove the page on which annotations are present that you want to restore
  2. Put the page with the original annotations on the clipboard (cut/copy)
  3. Paste the page into the new document location

Known problems, issues, and limitations

As problems are discovered and resolved, the IBM Support team updates the Support site. By searching the Support site, you can quickly find workarounds or solutions to problems.

The following links open queries for IBM Daeja ViewONE documents on the IBM Support site:

Supported File Formats in ViewONE Virtual

For information on the supported file formats refer to the tech note below. Please note that this is a live document and might get updated frequently. https://www-01.ibm.com/support/docview.wss?uid=ibm10730429

Comparison with native renderers

IBM Daeja ViewONE Virtual is designed to support as many file types as possible. However, the product is not able to render every type of file with the same accuracy as native applications, such as Microsoft Word. The flexibility of the viewer can lead to differences in the way that the documents are displayed between the native application and the viewer. The severity of the differences varies depending on the complexity of the file type. In particular, PDF files and Microsoft Office files are difficult to render with complete accuracy in a universal viewer.

Microsoft browser limitation

For additional information on IE/Edge limitations, refer to the following tech notes:

Excel spreadsheet load times

Excel spreadsheet load times are impacted based on the size and complexity of the Excel document. In order to improve load times, IBM Daeja ViewONE does support tuning capabilities, such as breaking up the Excel document presentation into multiple pages. Please be aware, as this behavior may not be optimal for your end user viewing experience.

Prompt to save redacted documents uses hexadecimal filename

After a document is permanently redacted and the user selects Download, they are normally prompted to save the document with a file name based on the original un-redacted document. For instance, mypresentation.ppt will default to mypresentation.tif. In this version the user might be prompted with a filename such as 41f96b20b97f431ebd4efd85245f1f72.tif instead. The user can still change the name to something more meaningful.

No pageN support in document builder mode

If a pageN document is open in the viewer, the user cannot switch to document builder mode. The user remains in the edit mode in which the document was opened. The following scenario explains the effects of this behavior:

Scenario 1:

  1. Viewer is loaded in either annotation or redaction mode
  2. A pageN document is loaded from a repository
  3. A user attempts to switch to document builder mode
  4. The user receives a message and remains in annotation or redaction mode

Result: This switch is not permitted and the user will stay in their current mode.

To enter document builder mode, the user must close the pageN document and then switch to document builder mode.

No docN support in document builder mode

DocN documents are not supported in conjunction with document builder mode. The combination of these features may result in unusual and/or unexpected behavior.

Document Builder supported file type limitations

Document builder is able to support TIFF and PDF files with the exception of email attachments. TIFF and PDF files that are attached to emails cannot be used as source files for a new document.

PDF files with access control flags set by the owner of the document cannot be used as a source document for document building where they require a password to view the document or where the owner has indicated that the content may not be copied.

Rendering of the semi transparency appears to blend between the outline and the fill

Annotations that have the semi-transparent property set to true, the transparent property set to true and a fill color set can appear to blend the line and fill colors near the edges.

Annotation with fill color set to black and set to transparent are not printed transparent

Annotations that have the transparent property set to true and a fill color set to black are not printed transparent for non PDF documents. When printing PDF documents, with 'Print Original Size' selected, these annotations are printed with transparency applied.

Print preview in Firefox does not display

If 'Preview in Firefox' is selected as the application that handles PDF file types in Firefox's options, the print dialog may not display once the PDF has downloaded.

To circumvent this, change the application that handles PDF file types to 'Save File' or open with a PDF viewing application installed on the local machine. These settings can be found by opening the menu in Firefox and selecting Options -> General -> Applications and searching for 'PDF'. Select the drop down box to select the action.

Copyright and trademark information

http://www.ibm.com/legal/copytrade.shtml

Notices

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Other company, product, or service names may be trademarks or service marks of others.

THIRD-PARTY LICENSE TERMS AND CONDITIONS, NOTICES AND INFORMATION

The license agreement for this product refers you to this file for details concerning terms and conditions applicable to third party software code included in this product, and for certain notices and other information IBM must provide to you under its license to certain software code. The relevant terms and conditions, notices and other information are provided or referenced below. Please note that any non-English version of the licenses below is unofficial and is provided to you for your convenience only. The English version of the licenses below, provided as part of the English version of this file, is the official version.

Notwithstanding the terms and conditions of any other agreement you may have with IBM or any of its related or affiliated entities (collectively "IBM"), the third party software code identified below are "Excluded Components" and are subject to the following terms and conditions: