These release notes provide information about new features, fixes, and known problems for IBM Daeja ViewONE, Version 5.0.8.
Online version of the release note: https://www.ibm.com/support/pages/node/6220494
Important: The most current version of the file can always be found online.
IBM Daeja ViewONE, Version 5.0.8, makes it easier for business and IT professionals to view large documents and images in their enterprise content management (ECM) solution or in other custom applications, websites, intranets, and extranets.
To download IBM Daeja ViewONE:
Log in to Fix Central.
In the Product Group list, select Enterprise Content Management.
In the Select from Enterprise Content Management list, select the Daeja ViewONE edition that you want to download.
You must have a license to download this software. The file that you download is a product installer for IBM Daeja ViewONE Virtual. When you run the installer, indicate any add-on modules for which you have a license. The installer then enables only those modules you have purchased.
You must run the installer as an administrative user.
Before you install IBM Daeja ViewONE, Version 5.0.8:
To generate a hardware and software requirements report, see System Requirements.
You can run the installer interactively or silently.
To run the installer silently, update the sample response file that is provided with the image archive before you run the installer.
At a command prompt, change to the directory where you extracted the installation image.
To install the viewer interactively, enter the following command:
DAEJA_VIEWONE_5.0.8_WIN_ML.exe
Alternatively, double-click DAEJA_VIEWONE_5.0.8_WIN_ML.exe in
Windows Explorer.
To install the viewer silently, enter the following command:
DAEJA_VIEWONE_5.0.8_WIN_ML.exe -f fully_qualified_path_of_the_response_file
From version 5.0, the default installation path on Windows is
C:\Program Files\IBM\Daeja ViewONE_Virtual
At a command prompt, change to the directory where you extracted the installation image.
To install the viewer interactively, enter the following command:
./DAEJA_VIEWONE_5.0.8_UNIX_ML.bin
To install the viewer silently, enter the following command:
./DAEJA_VIEWONE_5.0.8_UNIX_ML.bin -f fully_qualified_path_of_the_response_file
From version 5.0, the default installation path on Unix is
/opt/IBM/Daeja ViewONE_Virtual
IBM Daeja ViewONE comes with a Toolkit rich in capabilities that enables advanced integration and customization of the viewer by using HTML parameters and JavaScript API methods. For more information on the developer’s guide refer to:
IBM Daeja ViewONE Virtual Developer's Guide
IBM Daeja ViewONE, Version 5.0.8, provides the following new features:
The sheet names of the excel document and the page numbers which belong to them are now presented in the index view as a tree structure for easy navigation. This feature is available only in the Carbon UI Design Package.
The actions available within the thumbnail panel are
now configurable. Thumbnails, Index and Search buttons
appear by default. The viewer integrator could now
hide the search and/or the Index view buttons from the
thumbnail panel toolbar using the new HTML parameter
called thumbsActionsHideButtons. The option is
available for both Design Packages Carbon and Classic.
| Value | Description |
|---|---|
| index | The Index button will not appear in the thumbnail panel toolbar |
| search | The Search button will not appear in the thumbnail panel toolbar |
| index,search | The Search and the Index buttons will not appear in the thumbnail panel toolbar |
Note: When combined with the pre-existing
hideThumbnailCloseIcon HTML parameter provides full
flexibility within the thumbnail toolbar to control
visibility of available capabilities and/or produce a
simplified UI.
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(page, x, y) to scroll a section of the page into view. This method takes as arguments, the page number, x-coordinate and y-coordinate of the X and Y scroll bars respectively, relative to the page.
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). |
For online documentation, see the IBM Daeja ViewONE knowledge center.
IBM Daeja ViewONE Virtual, Version 5.0.8, includes all fixes and features up to and including IBM Deaja ViewONE Virtual Version 5.0.7 iFix 8.
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.
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:
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:
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: