This Readme document contains information about the installation of this package and about restrictions in support of IBM Daeja ViewONE, Version 5.0.5 iFix 1
Readme for: IBM Daeja ViewONE
Product or component release: Version 5.0.5
Update name: iFix 1
You must have IBM Daeja ViewONE, Version 5.0.5 installed.
Before you install IBM Daeja ViewONE, Version 5.0.5 iFix 1:
IBM Daeja ViewONE, 5.0.5 iFix 1 is provided as a compressed file containing the files that are needed to update Version 5.0.5 for all supported platforms.
To install this package:
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:
Make a backup of the Daeja ViewONE 5.0.5 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.
Note: To upgrade to iFix 1, please ensure that both the client and the server are updated.
If you want to remove the iFix 1 from your installation and revert back to the original 5.0.5 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.5 uninstallation program to remove IBM Daeja ViewONE 5.0.5 and the iFix 1 from your system, then some of the files may be left on your file system and you will need to remove them manually.
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.5 Virtual Developer's Guide
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.
IBM Daeja ViewONE, Version 5.0.5, provides the following new features:
See release notes for more information:
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.
For online documentation, see the IBM Daeja ViewONE knowledge center.
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:
IO25864 INITIAL GRAY CIRCLE IN THE MAGNIFIER STAYS INSTEAD OF SHOWING THE DETAILS OF THE PAGE
When using Magnifier functionality, the gray circle which comes up as part of the initialization stays instead of showing the details of the page being magnified.
Affected users: IBM Daeja ViewONE Virtual users
IO26372 ON BUILDING A DOCUMENT THE WEIGHT OF THE ANNOTATIONS CHANGES
On building a document the weight of annotation changes and is presented as thicker annotation borders and larger arrow heads which may cover adjacent text that was not covered on the original source document
Affected users: IBM Daeja ViewONE Virtual users
IO26579 THE MAGNIFIER DOESN'T SCALE ACCORDING TO FIT-TO-WIDTH, FIT-TO-HEIGHT, OR BEST-FIT CHANGE
The Magnifier doesn't scale accordingly when switching between fit-to-height, fit-to-width or best-fit. The magnifier would retain its previous setting. As a result the magnifier would show what it seems a different part of the document which the magnifier is not directly over.
Affected users: IBM Daeja ViewONE Virtual users
IO26604 POWERPOINT DOCUMENT CONTAINING INVISIBLE TABLE RENDERS WITH BORDERS IN THE TABLE
No error is shown on screen or in log files but elements with invisible borders are shown with visible borders - not seen when viewed in native Powerpoint application.
Affected users: IBM Daeja ViewONE Virtual users
IO26628 STICKY NOTE COLOR CONTEXT BUTTON NOT REMOVED WHEN USING AN IMAGE SERVICES BACKEND
When selecting a sticky note annotation, a context toolbar is shown to allow alteration of fonts, borders and colors. Sticky note color modification is not supported with an Image Servies(IS) backend so the context button should be removed.
Affected users: IBM Daeja ViewONE Virtual users
IO26648 MOVE BEHIND ANNOTATION CONTEXT BUTTON DOES NOT WORK
When there are overlapping annotations in the document, clicking the move behind annotation context button, in the Annotation editor tool bar, has no effect.
Affected users: IBM Daeja ViewONE Virtual users
IO26707 SPECIFIC EMAIL DOCUMENT RENDERS AS GREY SCREEN AND CAN CAUSE A SERVER OUTAGE DUE TO AN INFINITE LOOP
No error is shown in the virtual log file as the process gets stuck in an infinite loop
A thread dump from the web application server at the point the server is not responding will
show the following:
java.lang.Thread.State: RUNNABLE
at com.sanatech.ooxml.layoutengine.ParagraphProcessor.getAllTabStops(Unknown Source)
at com.sanatech.ooxml.layoutengine.ParagraphProcessor.process(Unknown Source)
at com.sanatech.ooxml.layoutengine.StroyProcessor.doProcess(UnknownSource)
at com.sanatech.ooxml.layoutengine.StroyProcessor.process(UnknownSource)
at com.sanatech.ooxml.layoutengine.table.TableCellProcessor.process(Unknown Source)
at com.sanatech.ooxml.layoutengine.table.TableProcessor.process(Unknown Source).
Affected users: IBM Daeja ViewONE Virtual users
IO26713 CHROME BROWSER RELEASE 71 AND LATER CRASHES ON ANY VIEWER ACTION AFTER THE VIEWER HAS LOADED
After the viewer has loaded, any viewer actions that requires painting the page image will crash the Chrome browser. This occurs on Chrome browser release 71 and later.
Affected users: IBM Daeja ViewONE Virtual users using Chrome browser release 71 and later
PDF documents that contain very large image masks are slow to display
Some PDF documents that contain very large invalid stencil image masks are slow to display.
The delay in displaying is due to the mask (invalid) being applied to every pixel reulting in no
change to the original image, for large images the processing may be performed on tens of millions
of pixels when it is not needed.
NOTE - Change in behaviour. Careful consideration is required before enabling this parameter.
This fix is now only enabled when the following parameter is set:
ignoreClearPdfMasks = true
If this parameter is set, then some PDF documents with transparent masks may display with missing content.
Affected users: IBM Daeja ViewONE Virtual users
MERGE AND SPLIT DOCUMENT BUILDING FAILS FROM EMPTY VIEWER
With the parameter 'clientPDFTileGeneration' set to true, docbuilding fails when building a document from an empty viewer.
Affected users: IBM Daeja ViewONE Virtual users
IO26709 SOME PDF DOCUMENTS WITH FULLY TRANSPARENT IMAGE MASKS DISPLAYED AS SOLID IMAGES
Some PDF documents that contain fully transparent image masks on top of other content, may display as solid images resulting in missing document content.
Affected users: IBM Daeja ViewONE Virtual users
IO26660 WHEN OPENING A NEW DOCUMENT IN THE SAME INSTANCE OF THE VIEWER THE FIT TO MODE IS NOT MAINTAINED BETWEEN DOCUMENTS IF KEEP SCROLL IS ON
When KeepScroll is turned on, opening a new document of different page orientations causes the Scale (including FITTOWIDTH, FITTOHEIGHT, and BEST_FIT) to be miscalculated.
Affected users: IBM Daeja ViewONE Virtual users
IO26638 SOME SPECIAL CHARACTERS IN STICKY NOTE ANNOTATIONS PRINTS INCORRECTLY
Some special characters like '<', '>', '&', and ' ' (new line) in sticky note annotations are character encoded in the print summary page.
Affected users: IBM Daeja ViewONE Virtual users
IO26639 PAGES IN SOME PDF DOCUMENTS APPEAR BLACK WITH COLORS INVERTED
Pages in some PDF documents appear black with colours inverted.
Affected users: IBM Daeja ViewONE Virtual users
IO26670 SOME PDF DOCUMENTS ONLY DISPLAY THE FIRST PAGE
In some PDF documents only the first page is displayed, subsequent pages only display with random characters.
Affected users: IBM Daeja ViewONE Virtual users
This feature provides the ability to control the brightness, illumination and contrast of the selected page for better readability.
This feature can be invoked through a button from the toolbar. This button will be visible by default, and can be hidden by setting the parameter 'visualEffectButton' to 'false'.
These settings can also be controlled by the following Javascript API methods:
Methods to return the brightness, contrast or luminance value of the selected page.
getBrightness()
getContrast()
getLuminance()
Methods to set the brightness, contrast or luminance value of the selected page.
Valid values for setting brightness, contrast and luminance must be in the range '0' to '255'.
setBrightness(String value)
setContrast(String value)
setLuminance(String value)
Methods to reset the brightness, contrast or luminance of the selected page to the default value of '100'.
resetContrast()
resetBrightness()
resetLuminance()
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.
The viewer honors the Orientation tag set in a TIFF document and applies the designated rotation when rendering the image on screen. When annotations are added and saved on such a document, they maintain their positions and rotations relative to the rotated document.
Added HTML parameter, prefetchSize. This parameter can be used to reduce the number of pages that will be retrieved in the background.
The actual number of pages retrieved is calculated based on the zoom level.
See https://www-01.ibm.com/support/docview.wss?uid=ibm10737269 for more details.
The valid values for this parameter are the numbers zero (0) to seven (7), where a value of 0 means no pages are retrieved in the background. The default is 7.
This parameter has no effect when the HTML parameter clientPDFTileGeneration is set to true and the document being displayed is a PDF.
The document tile size is now configurable via the parameters tileXSize
and tileYSize
.
The default main document display is composed of image tiles that are up to 256 by 256 pixels.
Using the tileXSize
and tileYSize
, this is now configurable from a minimum of 100 to an unlimited size.
Where no value is given the default value of 256 is used.
Where the maximum size is larger than the amount 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 when the HTML parameter clientPDFTileGeneration is set to true.
In IBM Daeja ViewONE Virtual, the default main document display is composed of image tiles. Documents are rendered on the server and image tiles are generated for each page. The Viewer fetches these images from the server across the network which could produce many network requests. The page displaying speed is bounded by the performance of the network between the client and server, and the available resources on the server. A new option is now available which enables rendering PDF documents and generating the image tiles directly on the client inside the browser. The PDF document is cached on the ViewONE server and then the entire document is delivered to the client where the individual pages are rendered on demand. Moving the rendering process to the client provides a number of advantages:
Differences with server side rendering:
Limitations:
Enabling client rendering of PDF documents: There is a new clientPDFTileGeneration HTML parameter to render PDF documents on the client. Setting this to 'true' will render the document on the client. The default is false. When the clientPDFTileGeneration parameter is enabled, the following APARs are resolved when viewing the documents:
Improved the rendering of some PDF documents that contain text that is drawn in a certain way that may result in failure to render with a NullPointerException output in the log.
Print performance has been greatly improved for PDF documents, when the following criteria are met;
* The document to be printed is a PDF document
* No annotations have been applied to the document OR
* The annotations are hidden using the annotation show/hide button
* "Print Original Size" is selected
When printing a PDF document with no or hidden annotations, "Print Original Size" is selected as default.
NOTE: Print output for the above criteria may have slight visual differences to the document displayed in the viewer.
The Annotation sticky mode allows the application of a selected annotation multiple times,
without the need to click on the annotation button again.
Sticky annotation mode is enabled either by the annotationsSticky
HTML parameter, or
when the user right-clicks on an annotation button. The sticky mode will remain active,
even after a page change, until the user deactivates it by clicking on the active annotation button.
A new option is now available to exit the sticky mode.
During the process of adding multiple annotations of the same kind a user can now end the sticky mode by
right-clicking on any existing annotation. This will end the sticky mode, select the clicked annotation, and
activate the edit tools for that annotation.
Documents that are opened at a specific page number are now scrolled in to the view at their correct scroll location. This means that when in fit to width/height view mode, the page will be scrolled to be at the top of the view.
The number of calculations taking place as we scroll a document has been decreased, allowing for a smoother scroll experience. This is most noticeable when scrolling the scroll bar via click-drag.
When using a large amount of documents for PageN, performance has been improved significantly on inital load and page to page navigation.
The number of requests being made as a document is scrolled has been reduced, resulting in an improvement in rendering time once scrolling is stopped.
Event 34, Page Rendered, fires each time a page is retrieved, this can be when a page is displayed
or when a page that has been pre-fetched. This prevents
a user from knowing whether a page they have just changed to, has been displayed or not.
EVENT 9 now contains a JSON payload that contains the page number of the page changed to as well as a flag,
that indicates whether the page has already been retrieved and is available in the DOM. If this flag is true
then the user knows this page has been retrieved and displayed, if the flag is false the user will have to
wait for event 34 to know when the page is displayed.
The JSON payload, contained within event 9, takes the form of the following example:
{"page":10, "isPageInDOM":true}
Parameter support has been added to pick and choose what keyboard shortcuts will be enabled in the viewer. These parameters also allow the disabling of keyboard shortcuts altogether. Setting the parameters allKeys, printKeys, fileKeys or viewKeys to false will disable those categories of shortcuts in the viewer.
When many trace parameters are enabled, the server slows down and may become unusable. A performance improvement has been made that reduces the time taken to log messages when the system is heavily loaded.
Performance decreases and the viewer potentially hangs when scrolling through pages of large documents in Document Builder mode.
When using keyboard shortcuts event 37 was not fired. With this fix users will be able to track shortcut keypresses via the javascript bridge output. This feature allows users to track and extract data from use of the system regarding keypresses. Users can track when keyboard shortcuts are activated and how frequently they are activated. An example of usage could be an office wanting to track usage of the print shortcut to be audited and reported on. This event output will allow users to dynamically configure the viewer to operate under a set of key presses.
There is missing functionality with shortcuts to navigate around on a zoomed page.
This functionality was missing because the viewer does not use scrollbars
for each part of the page unless you are zoomed in to an extent that the browser
generates them for the user. The missing shortcuts were
to navigate to the top, bottom, left, right and middle of a page either vertically or
horizontally. Below are the newly added keyboard shortcuts:
Go to top of current page: CTRL + HOME
Go to end of current page: CTRL + END
Go to far left of current page: SHIFT + HOME
Go to far right of current page: SHIFT + END
Go to vertical center of current page: CTRL + SHIFT + HOME
Go to horizontal center of current page: CTRL + SHIFT + END
It is now possible to print a range of pages using a keyboard shortcut. Press 'CTRL+P' to open the Print Dialog with the Print Range Option selected.
New API call, setPageSelection allows for the ability to select multiple pages via JavaScript Call.
setPageSelection(activePage, pageSelection)
will select the pages specified by pageSelection
and will set the active page to activePage
.
pageSelection
is a JSON input in the form;
{"selectedPages":[1,3,5,10]}
For example;
setPageSelection(3,{"selectedPages":[1,3,5,10]})
will result in pages 1,3,5 and 10 being selected with page 3 being the active page.
If setPageSelection(3,{"selectedPages":[1,3,"5-10"]})
is called then;
pages 1,3,5,6,7,8,9 and 10 would be selected with page 3 being the active page.
New API call that allows multipage deletions in one operation.
deleteDocumentPages(firstPageToBeDeleted, lastPageToBeDeleted)
will delete the pages between and including, those specified by firstPageToBeDeleted
lastPageToBeDeleted
.
The page selection updated event (87) fires when the selection stops being edited.
It contains a JSON payload listing the pages
currently selected and whether the pipe is selected. If the pipe is true then any
insertions will occur prior to the page number of the selection.
For example, if pages 1,3 and 10 are selected in the viewer, event 87 would contain the following JSON;
{"selectedPages":[{"page":{"pageNumber":1, "pipe":false}},{"page":{"pageNumber":3, "pipe":false}},{"page":{"pageNumber":10, "pipe":false}}]}
If the pipe before page 1 is selected in the viewer, the event payload would be:
{"selectedPages":[{"page":{"pageNumber":1, "pipe":true}}]}
If a page was added with this selection, the new page would be number 1, if the pipe was false, it would be page number 2.
Extra page selection updated events are fired when in Document Builder mode.
At high zoom levels, the performance when scrolling through a document is slow and memory usage increases noticeably.
Performance optimizations have been applied to resolve the above.
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
Invert is not supported for PDF documents rendered on the client; see "OPTION TO RENDER PDF DOCUMENTS ON THE CLIENT" for more information. The Invert feature is to be deprecated from the next release. This includes all associated parameters, GUI features and API methods. The invert feature is defined in the following articles: https://www.ibm.com/support/knowledgecenter/en/search/invert?scope=SSTPHR_5.0.4
As of IBM Daeja ViewONE Virtual Version 5.0.4, the jiburner API has been deprecated. Details of the API can be found in: https://www.ibm.com/support/knowledgecenter/SSTPHR_5.0.4/com.ibm.viewone.developing/dvodv000.htm and https://www.ibm.com/support/knowledgecenter/SSTPHR_5.0.4/com.ibm.viewone.developing/permredact/ji/burn/package-summary.html
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:
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.
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.
When in document builder mode, the option to restore annotations is not supported. The following scenario explains the effects of this behavior:
Scenario 1:
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:
When running Daeja ViewONE 5.0.5 as a component inside IBM Content Navigator, the minimum supported version of ICN is 3.0.5, unless stated otherwise by the specific ICN release.
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:
Any restrictions and/or limitations of the base or fix pack release and any subsequent ifixes, still apply to this release unless stated otherwise.
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.
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 behaviour may not be optimal for your end user viewing experience.
After a document is permenantly 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.
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:
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.
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 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.
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.
Annotations that have the transparent property set to true and a fill color set to black are not printed transparent .
http://www.ibm.com/legal/copytrade.shtml
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.
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: