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 4
Readme for: IBM Daeja ViewONE
Product or component release: Version 5.0.8
Update name: iFix 4
You must have IBM Daeja ViewONE, Version 5.0.8 installed.
Before you install IBM Daeja ViewONE, Version 5.0.8 iFix 4:
IBM Daeja ViewONE, 5.0.8 iFix 4 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:
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.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.
Note: To upgrade to iFix 4, please ensure that both the client and the server are updated.
If you want to remove the iFix 4 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 4 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.8 Virtual Developer's Guide
IBM Daeja ViewONE, Version 5.0.8, provides the following new features:
New Progress Bar When Loading
The progess bar used to show the application is being loaded has been updated.
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.
Latest iFixes and readmes for this release: https://www.ibm.com/support/fixcentral/swg/selectFixes?parent=Enterprise%20Content%20Management&product=ibm/Other+software/Daeja+ViewONE+Virtual&release=5.0.8&platform=All&function=all
The use of the no-fill color option leads to the transparent behaviour to act unreliably.
The no-fill color option in the color picker may lead to unexpected transparency behaviour which would mean the transparency check box would become out of sync with the annotation.
Affected users: IBM Daeja ViewONE Virtual users
Resolve client-side UmbrellaException that occurs on application close
In Firefox, refreshing the web page results in UmbrellaExceptions being output in the browser console.
Affected users: IBM Daeja ViewONE Virtual users
Performing a conversion download twice gives the original file extension
When the file conversion API is called multiple times for the same file, only the first download has the correct file extension. Subsequent calls provide the original file extension instead of the extension of the file-type converted to.
Affected users: IBM Daeja ViewONE Virtual users
Setting the docBuilderUnsavedPromptOnClose parameter to false does not prevent a browser alert dialog from being displayed.
If page level edits were made to a document and the viewer is closed, a browser alert dialog is always displayed stating that changes will be lost.
Setting the parameter docBuilderUnsavedPromptOnClose to false does not prevent the alert from being displayed. The problem is fixed in this release.
Affected users: IBM Daeja ViewONE Virtual users
HIGH CONTRAST COLORS USED IN HIDDEN IFRAME
When using Firefox and the Viewer is started in a hidden iframe, the wrong color scheme can be used. When the Viewer is then displayed, a high contrast color scheme can appear where the background is darker.
Affected users: IBM Daeja ViewONE Virtual users
Performing copy and paste on multiple selected pages in Document Builder results in incorrect page selection
When performing cut/copy and paste on mutiple page selections in Document Builder, the resultant pages were not selected as expected. Subsequent actions were then applied to unexpected pages. This has now been resolved.
Affected users: IBM Daeja ViewONE Virtual users
IO27973 TEXT IS MISSING FROM PDF DOCUMENT WHEN RENDERED IN THE VIEWER USING IE11
The text layer in a PDF document is not rendered (any embedded images are not affected) when viewed.
Affected users: IBM Daeja ViewONE Virtual users
IO28006 SAVING BMP AND PNG FILES USING SAVE BUTTON DOES NOT SET THE FILE EXTENSION
Saving BMP and PNG files using the save button does not set the file extension. The file extension comes up as 'Undefined' for these two MIME types.
Affected users: IBM Daeja ViewONE Virtual users
IO28028 VIETNAMESE CHARACTERS IN AN MSG FILE ARE RENDERED INCORRECTLY
Vietnamese multi-byte characters followed by unicode character are rendered incorrectly, unicode character is rendered before Vietnamese multi-byte character.
Affected users: IBM Daeja ViewONE Virtual users
IO28034 SOME EMAIL MSG DOCUMENTS FAIL TO RENDER DUE TO !IMPORTANT RULE IN STYLE SHEETS
Email MSG documents fail to render when style sheet includes !important rule. For example, padding-left:0!important;.
Affected users: IBM Daeja ViewONE Virtual users
IO28036 EMAIL MSG DOCUMENT FAILS TO RENDER DUE TO DECIMAL POINT VALUES FOR WIDTH AND HEIGHT IN IMAGE TAG
When viewing an msg email with image that has width and height values defined as decimal point value, an email header is displayed, but the email body is missing.
Affected users: IBM Daeja ViewONE Virtual users
The no-fill color option has been removed from some annotation types.
The no-fill option has been removed from the line and fill color pickers for the following annotation types in the Carbon Design Package:
Affected users: IBM Daeja ViewONE Virtual users
Performing Document Builder actions before a document has loaded causes unexpected behavior
Clicking Document Builder buttons such as cut, copy, paste and build document whilst the document is still loading may cause unexpected viewer behavior
Affected users: IBM Daeja ViewONE Virtual users
Resolve client-side exceptions that occur on application close
In Firefox, refreshing the web page results in exceptions being output in the browser console.
Affected users: IBM Daeja ViewONE Virtual users
IO27528 ANNOTATIONS WITH A MIX OF TEXT AND SYMBOL BLOCKS ALL OTHER ANNOTATIONS FROM DISPLAYING
When an annotation with a mixed content of text and symbols is added to a document stored in an IBM FileNet P8 repository,
it causes future annotation requests to fail by providing no content.
The application server error log will contain an error similar to the following where this has occurred Character reference '�' is an invalid XML character.
Limitations: the support of emojis, and other surrogate pair characters, is restricted to viewing only - printed and redacted documents will not display the characters correctly, but as a rectangular character.
Affected users: IBM Daeja ViewONE Virtual users
IO27734 KOREAN CHARACTERS IN AN MSG FILE ARE RENDERED IN WRONG LOCATIONS
Korean multi-byte characters are rendered either in the wrong locations or additional characters displayed in the body of the email.
Affected users: IBM Daeja ViewONE Virtual users
IO27976 UNABLE TO SAVE TRANSPARENCY ON REDACTION ANNOTATIONS
Filled rectangle and filled polygon have the no colour option even though it is not supported.
Affected users: IBM Daeja ViewONE Virtual users
IO27993 USING DAEJA VIRTUAL VIEWONE PRINT SERVICE WITH SERVER SIDE PRINTING, THE PRINT PROCESS CONTINUES TO USE CPU EVEN WHEN CANCELLED.
When Print Cancel is clicked, the server continues to use CPU and memory resources for document preparation instead of abandoning the process.
Affected users: IBM Daeja ViewONE Virtual users
IO27997 EMAIL MSG DOCUMENT FAILS TO RENDER DUE TO MISSING VALUES FOR PX UNIT IN THE STYLE TAGS
Email MSG document fails to render due to some of the style tags having a 'px' unit without a value.
Affected users: IBM Daeja ViewONE Virtual users
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:
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:
Affected users: IBM Daeja ViewONE Virtual users
| Parameter name | Description |
|---|---|
| backgroundImage | This parameter is used to allow viewing of two TIF format pages simultaneously with one overlaid on the other.
The URL associated with the parameter defines the source file to be used as a background image and
this source file must be in the TIF format.
The foreground image URL is defined by one of the 'filename' 'page' or doc' parameters and must also be in the TIF format. Use of Redaction and/or DocBuilder modules is not supported with documents that are made up of more than one image
|
| backgroundImagePageNumber | This parameter allows you force ViewONE to use a specific page from the source background TIF file
(as defined by the 'backgroundImage' parameter) for the background template.
|
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'.
| Value | Description |
|---|---|
| true | The Search button is visible (default). |
| false | The Search button is not visible. |
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'.
| Value | Description |
|---|---|
| true | The Image Enhance options button is visible (default). |
| false | The Image Enhance options button is not visible. |
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.
| Viewmode | Zoom +/- Button Behavior |
|---|---|
| Thumbs Only | Left Click: Applies the zoom level to the thumbnails only Right Click: Applies the zoom level to the thumbnails only |
| Full Page | Left Click: Applies the zoom level to the page view only Right Click: Has no effect on the page view. |
| Thumbs Left Thumbs Right Thumbs Top Thumbs Bottom | Left Click: Applies the zoom level to the page view only Right Click: Applies the zoom level to the thumbnails only |
A number of changes have taken place to the Carbon Design Package. These are listed here:
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.
printHeaderFont 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:
Carbon Design Package Updates
A number of changes have taken place to the Carbon Design Package. These are listed here:
UI Presentation Customization Options
Usability Enhancements
Globalization
Dynamic UI controls & more responsive UI
Page Editing
Improved Consistency
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
| shortcutKey | This controls the enablement of keyboard shortcuts
for operations identified by 'actionType'. This is currently the only value available for 'controlType' parameters at this time |
| printKeys imageKeys viewKeys pageKeys fileKeys selectKeys allKeys |
To export a specific document other than the one open
in the viewer. For more information on the actionTypes see 'Accessibility features of IBM Daeja ViewONE' page in the IBM Knowledge Center |
| true | Enables the shortcut keys for the group defined in 'controlType' (Default) |
| false | Disables the shortcut keys for the group defined in '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
| shortcutKey | This controls the enablement of keyboard shortcuts
for operations identified by 'actionType'. This is currently the only value available for 'controlType' parameters at this time |
| printKeys imageKeys viewKeys pageKeys fileKeys selectKeys allKeys |
To export a specific document other than the one open
in the viewer. For more information on the actionTypes see 'Accessibility features of IBM Daeja ViewONE' page in the IBM Knowledge Center. |
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
| full URL string to the document | Exports a specific document other than the one open in the viewer |
| null | Exports the current open document. |
| any value | annotationURL is ignored when documentURL is null the annotationURL value is ignored and the annotations currently displayed are exported. |
| full URL string to the annotations | the annotations on the URL are exported. |
| null | No annotations are exported |
| onSuccess(downloadLocation) | The export process will call this method on export success, passing the downloadURL string to the exported document. | |||
| onError(errorMsg) | This export process will call this method if it finished with an error, and will pass the error message. | |||
| onStatusUpdate(message, error, pagesProcessed) | The export process will call this method periodically as it checks for export status.
|
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:
{"id":1, "text":""}.{"id":1, "text":"test 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.
| Parameter | Description |
| pageNumber | Specifies the page to use as an offset. Page Numbers start from 1. Setting the other parameters to 0, 0 will set the scroll position to the top left of this page. An example is presented in the table below |
| xScroll | Specifies the value in pixels to position the horizontal scroll bar. |
| yScroll | Specifies the value in pixels to position the vertical scroll bar. |
| Example Usage | Description |
| setPageXYScroll(1, 0, 0) | This will set the vertical scroll position to the very top of page 1, and the horizontal scroll position to the far left of page 1. |
| setPageXYScroll(20, 0, 0) | This will set the vertical scroll position to the very top of page 20, and the horizontal scroll position to the far left of page 20. |
| setPageXYScroll(5, 500, 350) | This will set the vertical scroll position to 350 pixels down from the top of page 5, and the horizontal scroll position to 500 pixels to the right of the left edge of page 5. |
setPageXYScroll(2, 0, 150) is called, the vertical scroll position will be 50 pixels down page 2.setPageXYScroll(2, 50, 50) will scroll to different areas of a document depending on the Viewone Virtual zoom level.
The option to resize image stamps is now available. The feature is controlled by the new HTML parameter
'imageStampAnnotationResize'.
| Value | Description |
|---|---|
| true | Image Stamp Annotations can be resized(default). |
| false | Image Stamp Annotation can not be resized. |
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
| Value | Description |
|---|---|
| true | The sticky annotation mode is ON. |
| false | The sticky annotation mode is OFF (default). |
Go to the page at Software Product Compatibility Reports to create a high-level report for operating systems, hypervisors and prerequisites.
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.
The optimized PDF print does not occur in the following circumstances:
As of IBM Daeja ViewONE Virtual Version 5.0.6 the following annotation types are deprecated:
These annotation types will be removed in a future version of the product.
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.
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.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.
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.
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
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.
For additional information on IE/Edge limitations, refer to the following tech notes:
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.
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.
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 for non PDF documents. When printing PDF documents, with 'Print Original Size' selected, these annotations are printed with transparency applied.
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: