This Readme document contains information about the installation of this package and about restrictions in support of IBM Daeja ViewONE, Version 5.0.9 iFix 2
Readme for: IBM Daeja ViewONE
Product or component release: Version 5.0.9
Update name: iFix 2
You must have IBM Daeja ViewONE, Version 5.0.9 installed.
Before you install IBM Daeja ViewONE, Version 5.0.9 iFix 2:
IBM Daeja ViewONE, 5.0.9 iFix 2 is provided as a compressed file containing the files that are needed to update Version 5.0.9 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.9 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 2, please ensure that both the client and the server are updated.
If you want to remove the iFix 2 from your installation and revert back to the original 5.0.9 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.9 uninstallation program to remove IBM Daeja ViewONE 5.0.9 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.
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.9 Virtual Developer's Guide
IO27747 CERTAIN MICROSOFT OFFICE WORD DOCUMENTS RENDERED WITH MIS-ALIGNED CONTENT
Tables that should appear on the first page of a Microsoft Word document getting displayed on a subsequent page and all other subsequent pages content is mis-aligned.
Affected users: IBM Daeja ViewONE Virtual users
ArrayIndexOutOfBoundsException with some documents
Some text documents, and unrecognised document types handled as a text, throw ArrayIndexOutOfBoundsException. Documents that cause this issue will have single lines of content that are very long.
Affected users: IBM Daeja ViewONE Virtual users
Network logging revised
The logging provided under traceNet has been reduced and updated to provide clearer Information about what the viewer is accessing. Extended logging that was previously output is now available by using the traceNetDebug property.
Affected users: IBM Daeja ViewONE Virtual users
The annotateEdit parameter should only control the UI annotation edit features, and not influence the enablement of JavaScript API methods.
The enablement of some annotation JavaScript API methods are dependent on the annotateEdit parameter being set to true.
For example, the startAnnotation function will only be actioned if annotateEdit=true.
This has been updated such that the annotateEdit parameter only controls whether users can manipulate annotations in the UI.
When the annotationJavascriptExtensions parameter is set to true, all annotation API functions will now be actionable.
Affected users: IBM Daeja ViewONE Virtual users
IO28165 VIEWER RENDERS ONLY A FEW OR NO SLIDES OF POWER POINT DOCUMENTS ON LINUX
When opening any PowerPoint documents, with the viewer deployed on a Linux server, only a few or no slides are rendered and the page count shows an incorrect value.
Affected users: IBM Daeja ViewONE Virtual users
IO28106 UNABLE TO PRINT LABELS USING JAPANESE CHARACTERS
Labels set using HTML parameter pageLabel, that include Japanese characters, are not printed correctly.
Affected users: IBM Daeja ViewONE Virtual users
The JavaScript method startAnnotation now uses a new argument for preselecting the properties of the annotation being drawn. startAnnotation's new paramater takes in an input string of JSON properties used to set the annotation's properties.
The JSON allowable property names and their value types for an input JSON string are:
Invalid property name entries will be rejected causing startAnnotation to return false.
Allowable values of Color type properties:
red, green, blue (where each rgb value is between 0 and 255).The following provides an example of valid JSON strings for the color type:
{
"color":"cyan"
}
and
{
"color":"70, 60, 160"
}
Allowable values of type String for alignment property:
The following provides an example of a valid JSON string for the string type:
{
"alignment":"right"
}
The following code provides an example of an input JSON string for startAnnotation(annType, isSticky, inputJSON):
{
"color": "blue",
"linewidth": 15
}
The properties available to each annotation type are:
The following is an example of the startAnnotation method usage with the properties argument:
viewone.startAnnotation('RECTANGLE', false, '{"color":"blue", "linewidth":15}')
getStates and setStates to get and set Zoom, Rotate, View, and Scroll Position
You can now use the new JavaScript method getStates to retrieve the current viewing states (zoom, rotate, view mode, and scroll position) of a document. This can be used to restore the viewing states of that document later on when the document is reopened. getStates takes in an input string of JSON states to populate as input and returns the JSON with the viewing states filled.
The JSON allowable property values for our input JSON are:
The following code provides an example of an input JSON string for getStates(inputJSON):
{
"viewMode": null,
"zoom": null,
"rotate": null,
"horizontalScrollPosition": null,
"verticalScrollPosition": null
}
The caller provides the parameters they would like to retrieve for viewing states. Any of the above parameters can be added or omitted.
The following code provides an example of a response JSON string from getStates:
{
"viewMode": "thumbsleft",
"zoom": "0.37",
"rotate": "90deg",
"horizontalScrollPosition": "0",
"verticalScrollPosition": "0.0078044235861488296"
}
Similarly, you can use getStates to set the current viewing states (zoom, rotate, view mode, and scroll position) of a document. setStates takes in an input string of JSON states to set and applies those states to the document.
The following code provides an example of an input JSON string for setStates(inputJSON):
{
"viewMode": "thumbsleft",
"zoom": "0.37",
"rotate": "90deg",
"horizontalScrollPosition": "0",
"verticalScrollPosition": "0.0078044235861488296"
}
Some of the pop-ups and dialogs in the Carbon UI design package have an outline around them when they are in focus.
In the Carbon UI design package, some of the pop-ups and dialogs have an outline around them when they are in focus. They have been updated to remove the outline.
Affected users: IBM Daeja ViewONE Virtual users
Viewer does not throw OPEN_DOC_FAILED(61) while opening unsupported document in docbuilder.
When MODE_CHANGE_CANCELLED(86) is in the event interest list, changing to docbuilder mode while
viewing a protected document, does not throw an OPEN_DOC_FAILED(61) event or notify the user.
Affected users: IBM Daeja ViewONE Virtual users
Opening a document with role-based redaction fails
Opening a document that is required to have a role-based redaction applied to it fails. The client shows an error message 'Unable to display document: Failed to load document, status: Open document failed: Failed to load PDF render' and the server log shows a '403 Forbidden' message.
Affected users: IBM Daeja ViewONE Virtual users
Closing a document or opening a document before a Document Builder action has completed may lead to error dialogs .
Closing the current document or opening a new document before a Document Builder action has completed can lead to an 'Unable to display document' error message. The closing and opening documents process now waits until all Document Builder actions have completed before closing or opening a new document.
Affected users: IBM Daeja ViewONE Virtual users
Selecting a page via the page number editor may not be reflected in main view.
When selecting a page in a document by using the page number editor. The selected page may not be reflected in the main view.
Affected users: IBM Daeja ViewONE Virtual users
Switching to Thumbs Only View Mode may cause JavaScriptExceptions in the logs.
Switching to Thumsb Only View Mode, when the annotations toolbar is not visible, may cause JavaScriptExceptions in the logs.
Affected users: IBM Daeja ViewONE Virtual users
PDF WORKER SCRIPT IS NOT ALWAYS CACHED
In some environments, the PDF worker script is not cached per session. This can lead to additional PDF worker script requests being made each time a PDF is opened within that session.
Affected users: IBM Daeja ViewONE Virtual users
The no-fill option has been removed from the line and fill color pickers for the following annotation types in the Carbon Design Package:
The zoom in and zoom out buttons on the south toolbar of the Carbon UI design package are disabled when the magnifier is in use.
The keyboard shortcut to allow the cancelling of an annotation draw has been changed from 'Ctrl + U' to the Escape key.
A number of changes have taken place to the Carbon Design Package. These are listed here:
Three new Javascript methods have been added cutSelectedPages(), copySelectedPages()
and pasteDocumentPages. These three method replicate the bahavior of the Cut, Copy
and Paste buttons in the UI when in Document Builder Edit Mode.
With different deployment options available for ViewONE,
there are different ways that server properties can be set;
This has now been extended so that properties can be set via Operating System Environment Variables.
The precedence order for setting properties is
A new Javascript method has been added, hasUnsavedDocbuilderChanges(), that allows a caller to know if there are any unsaved Document Builder changes before the document is built.
A new method checks whether there are any unsaved page edits or annotation edits for the current document.
This method could be used to check whether a document that is about to be closed requires building beforehand.
| Returned Value | Description |
|---|---|
| true | The current document contains unsaved page edits or annotation edits |
| false | The current document does NOT contain unsaved page edits or annotation edits |
The visibility of the 'more items' toolbar button on the North Toolbar is controlled by the new HTML parameter 'overflowMenu'.
| Value | Description |
|---|---|
| true | The 'more items' button is visible. (Default) |
| false | The 'more items' button is NOT visible. |
NOTE: This feature is only available in the Carbon Design Package.
A new Javascript method has been added, setEditable(isEditable), which allows documents to be
opened in Document Builder mode as read-only.
With setEditable(false), the following Document Builder actions will not be availble;
NOTE: Calling setEditable(false) will have no effect if the document already has unsaved document builder actions applied.
A Javascript event has been added for when the displayed view mode has changed. This new event, 90,
is fired after the viewmode has switched. The event text will contain the name of the new view mode as
defined by the viewmode HTML Parameter, which can be the following values:
A Javascript event, 30, has been added that is fired when a new annotation is added to the current document.
You can now use the new JavaScript method getPageSelection() to retrieve information on a multi-page selection. When a range of pages is selected in the Thumbnails view, by using SHIFT+CLICK, CTRL+CLICK or CTRL+A, a JSON string can be retrieved with the number of selected pages and the total range of all selected pages.
The following code provides an example of a response JSON from getPageSelection():
{
"pageSelectionInfo": [
{
"name": "PagesSelected",
"value": "232"
},
{
"name": "Pages",
"value": "[1-228, 230, 233-235]"
}
]
}
PagesSelected returns the total number of pages that are selected and Pages returns a comma-separated array of page ranges that are selected.
When multiple thumbnails are selected, you can use the Rotate action only, which applies to all selected pages.
The Invert, Visual Effects Filter, and Enhance actions are disabled.
To select multiple thumbnails, press and hold the CTRL key and click each thumbnail that you want to select,
or press and hold the SHIFT key and select the first and last thumbnail to select all thumbnails in that range
or press and hold the CTRL key and press the A key to select all thumbnails.
The Rotate action applies to all pages that you selected.
Note: this feature is only available in the new Carbon User Interface. To use the Carbon GUI and enable this feature,
configure the viewer as described here:
Switch between Classic and Carbon UI
thumbnailDefaultHeight and thumbnailDefaultWidth in the Carbon Design Package
These parameters set the default height and width of thumbnails in the viewer. You can change the default height and width to fit more or less thumbnails in the visible area.
The thumbnailDefaultHeight parameter and the thumbnailDefaultWidth parameter set the size of each thumbnail display area, including the measurement of any borders defined by the theme.
The value for this parameter is in pixels. By default, the width is 184 pixels.
The minimum value for these parameters is 93 pixels.
The maximum value for these parameters is 400 pixels.
Example
<param name="thumbnailDefaultWidth" value="93" />
<param name="thumbnailDefaultHeight" value="100" />
| 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 |
The progess bar used to show the application is being loaded has been updated.
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.9 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: