IBM Daeja ViewONE, 5.0.8 iFix 2 Readme

This Readme document contains information about the installation of this package and about restrictions in support of IBM Daeja ViewONE, Version 5.0.8 iFix 2

Readme for: IBM Daeja ViewONE

Product or component release: Version 5.0.8

Update name: iFix 2

Prerequisites before installing IBM Daeja ViewONE, Version 5.0.8 iFix 2

You must have IBM Daeja ViewONE, Version 5.0.8 installed.

Before you install IBM Daeja ViewONE, Version 5.0.8 iFix 2:

• Install IBM Daeja ViewONE, Version 5.0.8.

• Take a backup copy all the files in the client and server directories under the Daeja ViewONE Installation directory.

Installing IBM Daeja ViewONE, 5.0.8 iFix 2

IBM Daeja ViewONE, 5.0.8 iFix 2 is provided as a compressed file containing the files that are needed to update Version 5.0.8 for all supported platforms.

To install this package:

1. Unzip the compressed file into the directory where IBM Daeja ViewONE, Version 5.0.8 was installed. This action overwrites all the files that need updates in the client/v1files directory and the server/WEB-INF/lib directory.

2. As this package contains all the files required for all platforms, you can remove the files that are included for platforms that are not relevant to your environment. Change to the server/WEB-INF/lib directory under the Daeja ViewONE installation directory and delete the platform specific jars that are not relevant.

   There are platform specific jar files:

   • jiserver-resources-aix.jar - used for all supported AIX platforms
   • jiserver-resources-linux.jar - used for all supported Linux platforms (RHEL)
   • jiserver-resources-win32.jar - used for all supported Microsoft Windows platforms

3. Make a backup of the Daeja ViewONE 5.0.8 files in the relevant locations in your web application server. For the server files that will be the web application's WEB-INF/lib directory. For the client, it will be where the package client files were copied to. For example v1files directory in the web application.

4. Copy the client and server files into the relevant places in your web application and ensure that the application is deployed as per your web app server specific requirements.
5. Verify that the correct version of IBM Daeja ViewONE is deployed to the web application server. This can be done by displaying the About Box in Daeja ViewONE Virtual by clicking on the ViewONE logo in the bottom right corner. Verify that the version number 5.0.8 iFix 2 is listed at the bottom of the About Box.

Note: To upgrade to iFix 2, please ensure that both the client and the server are updated.

Removing IBM Daeja ViewONE, 5.0.8 iFix 2

If you want to remove the iFix 2 from your installation and revert back to the original 5.0.8 version, you need to replace the files in you installation directories with the backed up files, then copy the files into the correct places in your web application server.

If you use the IBM Daeja ViewONE Version 5.0.8 uninstallation program to remove IBM Daeja ViewONE 5.0.8 and the iFix 2 from your system, then some of the files may be left on your file system and you will need to remove them manually.

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 5.0.8 Virtual Developer's Guide

New features in IBM Daeja ViewONE, 5.0.8 iFix 2

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

See release notes for more information:

• Main release
• Interim releases on Fix Central

SUPPORT FOR FOREGROUND/ BACKGROUND IMAGE RENDERING

The option to control whether the Search button is visible is now available.

The Search button is visible by default and is controlled by the new HTML parameter 'enableSearch'.

The option to control whether the Image Enhance options button is visible is now available.

The Image Enhance options button is visible by default and is controlled by the new HTML parameter 'enhanceOptionsButton'.

When a document with unsaved document builder changes is closed, a dialog prompt is displayed to allow the user to save or ignore changes.

This dialog prompt is now managed by the HTML Parameter 'docBuilderUnsavedPromptOnClose'.

NOTE: The HTML parameter 'annotationAutoBurnPromptOnClose' no longer has any effect on docbuilder unsaved changes dialog.

The option to view the Log Console is now removed from the Trace Dialog panel. The trace logs are now outputted to the browser console.

When in Thumbs Only Viewmode, left and right clicking the zoom +/- buttons applies the zoom to the thumbnails.

A number of changes have taken place to the Carbon Design Package. These are listed here:

• The HTML parameter 'hideThumbnailCloseIcon' is now honoured when the viewer is in Document Builder Mode. If the parameter is set to true, the close icon will now not be visible in Document Builder Mode.
• Relevant buttons in the north toolbar are now disabled when no document is open.

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

Fixes in IBM Daeja ViewONE, 5.0.8 iFix 2

The following APARs are fixed in this product release for customers who have direct entitlement to IBM Daeja ViewONE. If you are using IBM Daeja ViewONE made available to you as part of another IBM product, these fixes might not be available immediately. Contact IBM Support for information about IBM products that integrate IBM Daeja ViewONE.

See release notes for more information:

• Main release
• Interim releases on Fix Central

MS OFFICE PPTX DOCUMENT IS DISPLAYED WITH A BLANK PAGE

MS Office PPTX document with embedded images is not displayed correctly and shows a blank page.

Affected users: IBM Daeja ViewONE Virtual users

Security: Apache commons codec

Apache codec included in the product has been upgraded.

Affected users: IBM Daeja ViewONE Virtual users

Security: potential vulnerability that allows viewing inaccessible documents

Additional security checking made on repository responses when requesting document meta-data.

Affected users: IBM Daeja ViewONE Virtual users

IO27750 EML FILES FAILS TO DISPLAY WITH ERROR 'Unrecognized file type: message/rfc822'

EML files with missing 'content-type' can fail to display with the error message 'Unrecognized file type: message/rfc822'.

Affected users: IBM Daeja ViewONE Virtual users

Some annotations do not allow the fill color to be changed to white and black

When changing the fill colour of some annotation types certain colors would not be applied when selected;
When changing the fill colour of an unfilled annotation, selecting the color white would have no effect.
When changing the fill colour of a filled annotation, the initial fill color could not be applied once it had been changed to another color.
This has now been resolved

Affected users: IBM Daeja ViewONE Virtual users

Rotations and invert are applied to multiple pages of the document when the Magnifier Tool is active

When applying invert or a page rotation to a page, after enabling 'Show Magnifier', all pages in the document have the rotation or invert applied to them.
This is now resolved and invert and rotation actions will only act upon those pages that are selected.

Affected users: IBM Daeja ViewONE Virtual users

IO27527 WORD 97 DOCUMENT DISPLAYING INCORRECTLY IN THE VIEWER

Word 97 document displays incorrectly as table formatting used in the document is not handled correctly by the viewer.

Affected users: IBM Daeja ViewONE Virtual users

IO27540 DOCX IS NOT CORRECTLY DISPLAYED AS TEXT OVERLAPS

Some docx files fail to render correctly in viewer with overlapping text and misplaced text alignment.

Affected users: IBM Daeja ViewONE Virtual users

IO27621 EMAIL DOCUMENT FAILS TO RENDER DUE TO INVALID CHARACTERS IN COMMENTS

Email EML document failing to render due to invalid characters in the comments section.

Affected users: IBM Daeja ViewONE Virtual users

IO27751 ANNOTATIONS PROPAGATION FAILS DURING THE DOCUMENT BUILDER OPERATION

The Document Builder operation does not retain the annotations on the built document when 'filenetZorderEnabled' parameter is set to 'true'.

Affected users: IBM Daeja ViewONE Virtual users

IO27761 RTF WRAPPED HTML FORMATTING IN AN MSG FILE IS NOT RENDERED CORRECTLY

RTF wrapped HTML formatting in an msg file is not rendered as expected. Formatting like tables and background colors do not render.

Affected users: IBM Daeja ViewONE Virtual users

IO27700 EMAILS CONTAINING INVALID HTML CANNOT BE DISPLAYED

Some emails containing invalid HTML cannot be displayed.

Examples of issues that have been found are:

1. Invalid character in h6 tag AbbVieDeutschlandGmbH&Co.KG<br=
2. Invalid < in image tag <img src= <width=600 height=125>
3. Invalid character ? in font tag Arial?,sans-serif.

Affected users: IBM Daeja ViewONE Virtual users

IO27778 OPENING EMAIL ATTACHMENT OF TYPE EML FAILS

Email attachment of type EML fails to load due to a recursive loop causing stack overflow.

Affected users: IBM Daeja ViewONE Virtual users

IO27783 WORD DOCUMENT RENDERED WITH ONLY THE HEADER AND NOT THE CONTENT

A Word document displayed in the viewer is shown with only the header and none of the main content.

Affected users: IBM Daeja ViewONE Virtual users

IO27789 5.0.7 CLASSIC LOCKING UP WITH FIREFOX AND CHROME

The browser becomes unresponsive when the viewer is stopped using JavaScript method com.ibm.dv.client.Viewer.stop(viewerId) making any further interaction with that browser window impossible.

This only occurs when using the viewer in classic mode.

Affected users: IBM Daeja ViewONE Virtual users

IO27839 EVENT PRINT_PAGE [3] IS NOT BEING TRIGGERED FOR PAGEN

Event PRINT_PAGE [3] is not being triggered with page details when a print is performed for a PageN document.
With this fix, printing pages 1,3-5,10 of a 10 page document for example, will produce the following PRINT_PAGE events:
printpage: Page 1 of 10
printpage: Pages 3-5 of 10
printpage: Page 10 of 10

Affected users: IBM Daeja ViewONE Virtual users

IO27859 EMAIL TEXT IS CUT OFF WHEN MULTIPLE HTML MESSAGE PARTS ARE PRESENT AS MESSAGE CONTENT

Email text is cut off when multipart mime message file contains the message content in more than one HTML Message parts.

Note: The additional HTML Message parts are presented as attachments of the email titled untitledN, where N is the attachment number.

Affected users: IBM Daeja ViewONE Virtual users

IO27862 AN ERROR OCCURRED WHILE OPENING EML FILE

EML files with commented out HTML meta tags fail to display. jiSplitPageGenerationException occurred for this case and found in server log.

Affected users: IBM Daeja ViewONE Virtual users

IO27888 CANNOT USE HTML PRINT SERVICE TO PRINT A PPTX FILE

Print service does not work for PPTX presentations with multiple slides, the document gets truncated and only prints first page.

Affected users: IBM Daeja ViewONE Virtual users

IO27925 FORMATTING OF LARGE TABLES IN EML FILE IS INCORRECT

Large tables containing text embedded in EML files can be rendered such that the characters auto-wrap into a single column which is only a few characters wide.
This means what should be a small paragraph of text spans multiple pages making it difficult\impossible to read.

Affected users: IBM Daeja ViewONE Virtual users

IO27961 DOCUMENTS DO NOT RENDER IN VIEWER WITH JAVA.LANG.NUMBERFORMATEXCEPTION: FOR INPUT STRING: "" ERROR SHOWN IN CLIENT CONSOLE

An empty X-Server-Error header value was handled as a tile retrieval error.

Defensive code updated to prevent incorrect values from blocking document image display.

Affected users: IBM Daeja ViewONE Virtual users

IO27970 INVALID TIF FILE CAN CAUSE JVM OOM ERROR WITH MANY INSTANCES OF JI.FILTER.TIFF.JITIFFIFD SHOWING IN CORE DUMP LOGGING

An incorrectly generated TIFF image that contains a circular reference causes the server to get into an infinite loop and eventually the JVM will experience an Out of Memory condition.

Examination of the core dump log files generated by the web application server indicates it is processing of TIFF file that is the root cause with references to many instances of ji.filter.tiff.jiTIFFIFD occupying most of the available JVM

Affected users: IBM Daeja ViewONE Virtual users

IO27971 ARABIC TEXT GETTING OVERLAPPED AND WHITE SPACES BETWEEN LETTERS IN A WORD

When Arabic text is displayed using Simplified Arabic font in Microsoft Word documents, some characters appear overlapped and the spaces do not space the characters correctly. Part of the issue is due to a character rendering in some versions of Java using the Simplified Arabic font.

The solution has resulted in Simplified Arabic font always being replaced with Arial Unicode MS if it has been installed on the server or Arial if Arial Unicode MS has not been installed.

Affected users: IBM Daeja ViewONE Virtual users

IO27977 EMAIL DOCUMENT FAILS TO RENDER DUE TO DUPLICATE STYLE ATTRIBUTES

Email EML document failing to render due to duplicate style attribute values within HTML attribute.

Affected users: IBM Daeja ViewONE Virtual users

IO28005 ATTACHMENT MISSING WHEN THE MULTIPART CONTENT HEADER CONTAINS FILENAME PARAMETER ENDING WITH ASTERISK(*)

When multipart content header contains extended parameter wherein the filename parameter name ends with asterisk(*) symbol, the attachment is not included in the attachment list and is missed.

Affected users: IBM Daeja ViewONE Virtual users

IO28012 CARBON THEME OVERRIDES DEFAULT BROWSER FOCUS STYLING

When adding the Daeja ViewONE control to a website with numerous other controls the default focus style is overridden. When ViewONE initializes it updates the focus feedback CSS default causing all other standard focus highlighting to stop working.

Affected users: IBM Daeja ViewONE Virtual users

Resolve NotSerializableException log messages

After viewing Microsoft Excel Spreahsheets, extra exceptions can appear in the server-side log file. The first line of these exceptions will be one or both of the following:

• java.io.NotSerializableException: ji.image.jiImageHeader
• java.io.NotSerializableException: ji.server.util.ExcelSheetHelper

Affected users: IBM Daeja ViewONE Virtual users

Fixes and Features released in previous iFixes and Fix Packs

IBM Daeja ViewONE 5.0.8 iFix 1

ZOOM AREA TOOL CANCELS ANNOTATION DRAWING TOOL

When the Zoom Area tool is used whilst the annotation drawing tool is active, the annotation drawing tool is cancelled after the zoom has completed.

Affected users: IBM Daeja ViewONE Virtual users

STICKY MODE ONLY HONOURED FOR FIRST STARTANNOTATION() JS API CALL

Calls made to start an annotation draw while the viewer is still in draw mode does not honour the sticky setting.

Affected users: IBM Daeja ViewONE Virtual users

IO27314 PDF printing is slow and may have incorrect characters when using multi-byte print header content

PDF printing is slow and may have incorrect characters when using multi-byte print header content.

• Optional parameter: printHeaderFont
• Default value: arial unicode

The font used in the print header content may be specified using the HTML parameter printHeaderFont. The font value provided will be loaded from the System Font Location.

Affected users: IBM Daeja ViewONE Virtual users

IO27623 TEXT BOXES IN A POWERPOINT ARE ROTATED BY 180 DEGREES AND TEXT APPEARS UPSIDE DOWN

An MS Office Powerpoint document renders in the viewer but on slides where there are text boxes, these are displayed rotated by 180 degrees so that the text appears upside down.

Note: this specific issue is seen where the text box object and the text content are both rotated.

Affected users: IBM Daeja ViewONE Virtual users

IO27686 DOCUMENTS WITH THE FORMAT .DOC ARE NOT DISPLAYED CORRECTLY

Word document letter formatting template overlaying the body of the letter.

Affected users: IBM Daeja ViewONE Virtual users

IO27771 WORD DOCUMENT CAUSES JAVA HEAP SPACE AND JVM CRASH WHILE RENDERING ON DAEJA

A Word document rendering causes JVM crash and java heap space error is logged in server console log.

Affected users: IBM Daeja ViewONE Virtual users

IO27776 A BOX AREA USED AS A HYPERLINK IN AN MSG FILE CHANGES THE ALIGNMENT

When displaying an MSG document, the text alignment changes if a rectangular area is used as a hyperlink.

Affected users: IBM Daeja ViewONE Virtual users

IO27815 'VIEW ATTACHMENTS' BUTTON PRODUCES NO RESPONSE IN THE NEW CARBON UI

When viewing emails with attachments using the new Carbon UI, clicking the 'View attachments' button (i.e. the paper clip) produces no response. This behavior can be seen if one sets annToolbarMode parameter to 'left'.

Affected users: IBM Daeja ViewONE Virtual users

IO27831 SOME MICROSOFT POWERPOINT (.PPTX) DOCUMENTS HAVE ISSUE OPENING

An error occurs when opening certain Microsoft Powerpoint (.PPTX) documents :

'This document has been truncated because the of an error that occurred while retrieving the requested page'.

Affected users: IBM Daeja ViewONE Virtual users

IO27840 EMAIL (EML) DOCUMENT CAUSES STACKOVERFLOWERROR

An email (EML) document attachment opening causes a stack overflow due to a recursive loop.

Affected users: IBM Daeja ViewONE Virtual users

IO27850 UNABLE TO OPEN DOCUMENT WHEN LARGE NUMBER OF PAGELABEL PARAMETERS ARE SET

If a combination of the parameters, 'pageLabel', 'pageLabelColor,' 'thumbLabel' and 'thumbLabelColor' is set in large numbers, the document's load time is too high and sometimes the browser crashes.

Affected users: IBM Daeja ViewONE Virtual users

IO27864 INACTIVE WAIT TIME IS SEEN IN BROWSER WHEN DOCUMENT NEXT PAGE GETS RENDERED

Using the performance monitoring functionality of a browsers development tools console, the browser is seen as inactive for periods of time in-between server calls while rendering the next page of a document.

Affected users: IBM Daeja ViewONE Virtual Users

Cancel Annotation Keyboard Shortcut Change

The keyboard shortcut to cancel an annotation draw has been changed from Ctrl + U to the Escape key.

Affected users: IBM Daeja ViewONE Virtual users

JS API Call cancelAnnotation() did not cancel the current annotation

When calling JavaScript API call 'cancelAnnotation()' midway through drawing an annotation. The annotation tool is cancelled, but the annotation drawn up until it was cancelled is not removed, leaving a part-drawn annotation on the screen.

Affected users: IBM Daeja ViewONE Virtual users

Client document build process continues to request status updates after a server error

When the document build process fails on the server, whilst generating a TIFF output document, the client is not updated with the failed status and continues to poll for results. This leaves the document build dialog open indefinitely.

Affected users: IBM Daeja ViewONE Virtual users

Client print process continues to request status updates after server error

When printing is in progress and the server node producing the print document fails, the client is redirected to another server where the print job is not recognised. This results in an error on the server that is sent back to the client, but the client does not stop requesting status updates for that print job.

Affected users: IBM Daeja ViewONE Virtual users

A number of changes have taken place to the Carbon Design Package. These are listed here:

• The 'View Attachments' button is no longer visible when there is no document loaded.

• The Viewer now tabs out to other browser elements once the tabbing sequence is exhausted. As part of this change, the page selection field is no longer included in the tabbing sequence, but can still be accessed by pressing 'g'.

• Parameters 'thumbnailDefaultWidth' and 'thumbnailDefaultHeight' are now supported.

IBM Daeja ViewONE 5.0.8

Carbon Design Package Updates

A number of changes have taken place to the Carbon Design Package. These are listed here:

UI Presentation Customization Options

• The visibility of the north toolbar is controlled by the parameter showNorthToolbar which can take the value true or false. The default value is true.
• HTML parameter pageButtons is not supported in Carbon UI.
• When HTML parameter allButtons is set to false, the south toolbar is now also hidden.

Usability Enhancements

• The zoom area tool is no longer sticky. After a zoom area is applied, the zoom area button is deselected.
• Dialogs with ok and cancel buttons are now draggable. The dialogs can no longer be dragged outside of the browser window.
• The draggable area (used to move dialogs) at the top of moveable dialogs has been enlarged.
• The Color Picker dialog is now moveable allowing users to place in where it doesn’t cover critical information.
• Holding the Shift key whilst drawing a filled rectangle or highlight rectangle will now force a square aspect ratio.

Globalization

• Popup menus are now correctly aligned according to script direction of the language.

Dynamic UI controls & more responsive UI

• When in thumbs only view, the magnify, fit-to-X button group and zoom area buttons are no longer present on the south toolbar.
• When reducing the width of the viewer, the south toolbar wraps instead of removing elements
• The overflow menu was not appearing when the parent dots (...) button is shifted to the left side. This has been corrected.
• The annotation context toolbar remains visible even when the annotations is dragged outside the visible end of the page on the right.

Page Editing

• It is now possible to drag and drop pages from a document in one viewer into an empty document in another viewer.
• If the viewer is configured to start in Document Builder mode with no document opened, the viewer now displays the correct view after setView and openFile API methods are called.
• Added a close button to the thumbs panel toolbar when the viewer is in Document Builder mode. This button closes the thumbs panel.
• When loading the viewer in Document Builder mode with HTML parameter allButtons set to true, the Build button is now shown, whereas the Print and Invert buttons are no longer visible.

Improved Consistency

• A limited color picker is displayed for PDF documents when the HTML parameter burnPDFtoPDF is set to true. This limited color picker only displays 8 main colors to match the PDF output of the burned version.
• The transparent color option in the color picker has been removed for the text annotations and sticky note annotations.
• The color fill option has been removed from the transparent text annotation edit toolbar.
• The thumbnail size of the current page no longer increases when adding annotations on a rotated page.
• When the annotation toolbar mode is set to left, then the search panel will appear on the right side when search button is clicked. The search panel was not appearing prior to this fix.
• Right click to select non-grouped annotations or stamp annotations makes them sticky. Fixed so that annotations are not sticky unless annotationsSticky parameter is true.
• The thumbs left and thumbs right shortcut keys (F5 and F7) are now disabled for the respective side of the annotation toolbar.
• Replace 'Save' with 'Update' in the textEntry box when editing text annotations.
• Change the 'save' button on the annotations edit toolbar to an 'accept' check mark icon.
• When selecting 'hide annotations' from the north toolbar and a sticky annotation is active, the annotation would still be active when selecting 'show annotations'. This has now been changed so that all active annotation are selected when hiding annotations.
• When the 'allbuttons' parameter is false, it takes priority over other buttons settings. i.e. buttons made available from setting 'filebuttonsave' to true, 'initialeditmode' to redact or docbuilder, and 'editmodetoggle' set to annotate, redact, or docbuilder are also hidden.
• The view attachments icon no longer appears erroneously when a document with no attachments is open. This error would only occur when the HTML parameter allButtons is set to true.
• After the viewer is started, if the setView method is called followed by the openFile method, the view is not changed to the value set by the setView API call. This is now fixed.
• Manage notifications such that they are closed when the document is closed, and only one notification is shown at a time.

A new API method setEnabled is available which controls the enablement of the shortcut keys for certain actions within the viewer. This feature compliments the pre-existing feature of controlling visibility of capabilities in the UI via action button groups. Now actions buttons and their corresponding shortcut keys are controlled independently to each other. By default all shortcut keys are enabled.

The following new JavaScript APIs are added:

Syntax
ViewONE.setEnabled(String controlType, String actionType, Boolean value)

Property name Description and value options:

controlType

A new API method isEnabled is available to allow decisions to be driven by the enablement/disablement of shortcut keys for certain actions.

The following new JavaScript APIs are added:

Syntax
ViewONE.isEnabled(String controlType, String actionType)

Property name Description and value options:

controlType

This new API allows users to export any document as a PDF including all annotations applied to it.

Syntax:
exportDocument(documentURL, annotationURL, callback)

Property name Description and value options:

documentURL

Previously, when the edit mode was changed while an annotation was active, the annotation remained active in the new edit mode. As a result of this improvement, when the edit mode is changed, the active annotation will be deactivated, with any changes made to the annotation being preserved.

Selection of an existing annotation for editing fires the annotationActivated(65) event. Moving focus away from that annotation or completion of the annotation via the confirm button, fires the annotationDeactivated(66) event. The event for annotation activation and deactivation contains the annotation id and any text content of the annotation. The text and note annotation types have an automatic activation for editing when created - new annotations provide the annotation id and empty text.

The following code provides an example of a JavaScript event handler for activated and deactivated events:

function myEventHandler(eventId, annotationType, responseJson)
{
 var response = JSON.parse(responseJson);
 alert("Event received, eventId="+eventId+", type="+annotationType+ ", annotation id="+response.id + ", text="+response.text);
}

You need to enable event handling by using the eventHandler HTML parameter and eventInterest HTML parameter. The eventHandler parameter sets the name of the JavaScript method that gets called.

JSON Examples:

• Newly created text annotation - {"id":1, "text":""}.
• Select existing text annotation - {"id":1, "text":"test annotation"}.
• Select or complete a non text annotation - {"id":6}.

There is a new API method setPageXYScroll(pageNumber, xScroll, yScroll) to set the positions of each scroll bar in the main document viewing area. This method takes three arguments: pageNumber, xScroll and yScroll.

The option to resize image stamps is now available. The feature is controlled by the new HTML parameter 'imageStampAnnotationResize'.

Annotation Drawing could be cancelled via the new JavaScript API Method cancelAnnotation or keyboard shortcut.

The following new JavaScript API has been added:

cancelAnnotation()

This method allows the user to cancel the drawing of an annotation.

If the user initiates an annotation draw, by mistake, using the existing API call:

startAnnotation(String annotationType, Boolean isSticky)

The user can use the new call 'cancelAnnotation()' to undo the action.

The user can also cancel an annotation draw by using the keyboard shortcut 'Ctrl + u'.

As a user selects an annotation from the toolbar but changes page before they apply it, the selection of an annotation remains active, with the cursor still appearing in annotation draw mode. This new behavior allows the user to navigate through the pages of the document in display while retaining the selection of the annotation.

The same behavior applies when the users physically press an annotation button from the toolbar, as well as, when they initiate the draw of an annotation using the Javascript method startAnnotation.

Any selected annotation is, by default, only available to be applied once in the document, unless reselected. The viewer offers the option for the annotation to remain selected and be applied multiple times without the need to click on the annotation button again. This is known as sticky annotation mode. The feature is now extended to be available when annotations are drawn via the startAnnotation JavaScript method.

The startAnnotation JavaScript method in addition to the string property 'annotationType' has a new boolean property 'isSticky'.

Syntax:

ViewONE.startAnnotation(String annotationType, Boolean isSticky)

isSticky

Additional Release Notes

System requirements

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

Optimized performance of printing PDF documents

When printing PDF documents with annotations, the annotations are embedded in the downloaded PDF document as native PDF annotations. This reduces 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 or the printed document contains other file formats, the print process completely flattens the content of each page.

The time it takes to prepare a PDF with annotations for print using the optimized print 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.

With the optimized print any annotations created in IBM Daeja ViewONE Virtual are 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 PDF documents. If this document is subsequently viewed by IBM Daeja ViewONE Virtual, any annotations will be treated as static content where loading a document with pre-applied native annotations cannot be edited. 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.

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.

Image Stamps
Image stamp annotations will appear underneath any other annotation types regardless of the z-order. This is due to the fact that they added to the content of the PDF and not as separate native PDF annotations.

Limitations

The optimized PDF print does not occur in the following circumstances:

• PDF documents with digital signatures.
• PDF documents with password encryption and edit protection.
• PDF Documents with any ruler or angle annotations.

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

Daeja ViewONE as an Integrated solution

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

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:

• IBM Daeja ViewONE, Version 5.0.8 known problems
• IBM Daeja ViewONE, Version 5.0.8 known problems and documentation updates
• All IBM Daeja ViewONE, Version 5.0.8 documents on the IBM Support site

Any restrictions and/or limitations of the base or fix pack release and any subsequent ifixes, still apply to this release unless stated otherwise.

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:

• https://www.ibm.com/support/pages/node/876592
• https://www.ibm.com/support/pages/node/875492

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.

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:

• The Excluded Components are provided on an "AS IS" basis
• IBM DISCLAIMS ANY AND ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS WITH RESPECT TO THE EXCLUDED COMPONENTS, INCLUDING, BUT NOT LIMITED TO, THE WARRANTY OF NON-INFRINGEMENT OR INTERFERENCE AND THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
• IBM will not be liable to you or indemnify you for any claims related to the Excluded Components
• IBM will not be liable for any direct, indirect, incidental, special, exemplary, punitive or consequential damages with respect to the Excluded Components.