IBM FileNet Image Services Connector introduces support for IBM Content Navigator 3.0

Content

The FileNet Image Services Connector for IBM Content Navigator deployment document is available on the Image Services documentation web site.

• FileNet Image Services Connector 1.4.0.2 Interim Fix APAR PJ44379. For FileNet Image Services 4.1.2 customers, upgrading to 4.1.2 FP25 is another option to obtain the IS Connector 1.4.0.2 software.
• IBM Content Navigator 3.0 (or higher)
• IBM WebSphere 8.5.5.9 (or higher) or Oracle WebLogic 12cR1 (or higher) (The deployment procedures with WebLogic can be found in the IS Connector 1.4.0 announcement TechNote.)

• Daeja ViewONE Professional 4.1.5 Fix Pack iFix 1
• Daeja ViewONE Virtual 5.0

Deployment

• The ImageServicesRPC.jar is no longer deployed separately. The ImageServicesRPC.jar file has been bundled into the other WAR and JAR files. The installation procedure contained in the Image Services connector 1.1.0 for IBM Content Navigator document for the ImageServicesRPC.jar file in no longer necessary.

Important: If the ImageServicesRPC.jar file exists on the server from a previous release, the file must be deleted.

• Starting with the Image Services Connector 1.3.0 for IBM Content Navigator release contains two new files, stamp.sh (UNIX) and stamp.bat (Windows) that are used to display the release version of the WAR and JAR files. Before running the stamp command, the Java directory path must be included in the PATH environmental variable and the version of Java must be at least 1.6.0.

It is recommended to install the stamp.sh or stamp.bat file in the same directory where the JAR file has been installed.
The syntax to run the command is: stamp.sh (JAR or WAR file name)
On UNIX servers, verify stamp.sh is executable. If stamp.sh is not executable, run the following command after changing your working directory to where stamp.sh has been installed:
chmod +x stamp.sh
Example:
stamp.sh ImageServicesPlugin.jar
Implementation Version: 1.3.0-067
Build Date: 2015-07-30 07:02:18
Built By: lib
stamp.sh Image_Services_connector_for_ICN.war
Implementation Version: 1.3.0-067
Build Date: 2015-07-30 07:02:22
Built By: lib
If the user wants to run the stamp command on the FileNet Image Services server and Java has not been installed on the FileNet Image Services server, a JRE can be found in the following locations:
UNIX:
/fnsw/jre/jre
/fnsw/IS_jre/jre
/fnsw/hfp_IS_jre/jre
Windows:
DRIVE:\fnsw\jre\jre
DRIVE:\fnsw\IS_jre\jre
DRIVE:\fnsw\hfp_IS_jre\jre
• The software version number is no longer contained in the WAR file name. Use the new stamp program to determine the software version of the file.

• If the installation of the ImageServicesPlugin.jar fails because a 'busy file' error or a message is reported that the file can not be overwritten, perform the following procedure.
1. Shutdown WAS.
2. Repeat the installation.
3. Start WAS.
• The FileNet Image Services Connector for IBM Content Navigator ping page can be accessed to determine version number, build number, build date and the repository properties configuration settings after it has been deployed on WebSphere. The format of the FileNet Image Services Connector for IBM Content Navigator ping page URL is:www.<CMIS_hostname>:<port>/is-cmis-server/

An example of the URL is: cmishostname.companyname.com:9080/is-cmis-server/

• While using FileNet Image Services Connector for IBM Content Navigator, it may become necessary to clear the cache on your web browser if updates do not appear as expected. The updates to the configuration include changing the localization setting, adding a new folder, document, or other items that are cached in the client browser setting.
• Viewing documents may fail with the following error if the WebSphere server where the IBM Content Navigator is deployed does not have the HTTPOnly setting disabled on the JSESSIONID cookie. When the flag is enabled, it prevents the Applet from having access to the user session:

"Annotations failed to load. Annotation data is not in the required format".


The following entries might show up in the Java Console log for the Daeja viewer:
{}&&{"errors":[{"adminResponse":null,"moreInformation":null,"explanation":"Your session expired because of inactivity.","number":"1003","userResponse":"Log in again.","text":"Your session expired."}]}
......
Annotation data is not in the required format.
*** ANNOTATION VERSION ERROR: Incorrect XSL version: 0
*** ANNOTATION VERSION ERROR: Require as least version: 400002
*** ANNOTATION VERSION ERROR: Annotations may not display correctly.
false: Closing document due to annotations error: Annotation data is not in the required format.
Follow the instructions documented by the IBM Knowledge Center for IBM Content Navigator version 2.0.3 (or higher) to complete the steps for disabling the HTTPOnly setting.
• When opening a large document using the Image Services Plugin for IBM Content Navigator a Java heap space error may be reported indicating that the size of the heap space needs to be increased on the WebSphere server. The error message will be similar to the following message:

[2/16/15 17:11:57:083 PST] 000000cb webapp E com.ibm.ws.webcontainer.webapp.WebApp logServletError SRVE0293E: [Servlet Error]-[JAX-RS Servlet]: com.ibm.ws.webcontainer.webapp.WebAppErrorReport: Java heap space at com.ibm.ws.webcontainer.webapp.WebAppDispatcherContext.sendError(WebAppDispatcherContext.java:626)
Refer to the IBM WebSphere documentation on how to increase the heap space.
http://www.ibm.com/software/webservers/appserv/was/library/

• IBM Content Navigator (ICN) 2.0.3 FP5 integrating with Daeja ViewONE 4.1.4 introduced a new feature, Image (or Custom) Stamp. Customers, therefore, are allowed to add their own custom stamps when annotating documents. However, when this system-wide feature is enabled, the default stamps previously supported by the Daeja ViewONE become unavailable and cause an inconvenience to the users. This problem applies to both Daeja ViewONE Professional and Virtual viewers.
• There are eight (8) default stamps that are commonly used by FileNet Image Services customers.
1. <user> <date>
2. Approved <user> <date>
3. DRAFT
4. Filed <date>
5. Received <date>
6. Rejected
7. Reviewed <user> <date>
8. Urgent!
There are two options to workaround the problem.
1. Do not enable the Image Stamp feature. If this fits your business requirement, the default stamps will be automatically available to the users.
2. Implement the following steps to restore the default stamps if you have to set up the Image Stamp on your ICN server. A typical scenario will be when the Image Services Connector for ICN is one of the multiple repositories deployed on the ICN. Business operations connected to other repositories require the usage of Image Stamps. Once this system-wide setting is configured, default stamps become unavailable to users to all deployed repositories on the single ICN server.

1. Open the ICN administrator tool, click Settings > Daeja ViewONE, and then click the Professional or Virtual tab.
2. For Image stamp resource context, enter the value: /navigator/${originalStampURL.query.path}.
3. For Additional settings, add the following parameter name and value pairs by incrementing the index number N for annotationStampN and annotationStampPropertiesN.

	Default Stamp	Parameter Name	Parameter Value
1	'user' date'	annotationStamp1 annotationStampProperties1	<user> <date> <menu ='user' 'date'>
2	Approved 'user' date'	annotationStamp2 annotationStampProperties2	Approved <user> <date> <menu = Approved 'user' 'date'>
3	DRAFT	annotationStamp3 annotationStampProperties3	DRAFT <menu=DRAFT>
4	Filed 'date'	annotationStamp4 annotationStampProperties4	Filed <date> <menu=Filed 'date'>
5	Received 'date'	annotationStamp5 annotationStampProperties5	Received <date> <menu=Received 'date'>
6	Rejected	annotationStamp6 annotationStampProperties6	Rejected <menu=Rejected>
7	Reviewed 'user' 'date'	annotationStamp7 annotationStampProperties7	Reviewed <user> <date> <menu = Reviewed 'user' 'date'>
8	Urgent!	annotationStamp8 annotationStampProperties8	Urgent! <menu=Urgent!>

Warnings
1. Brackets '<' and '>' do not work well with the annotationStampProperties <menu=...> setting so replace them with single quotes.
2. The default stamps look-n-feel from the manual configuration are not necessary matching the ones from the out-of-the-box (meaning, when the Image Stamp is NOT configured). Consequently, extra adjustments of the font size, color, rotation, etc of the specific default stamp may be required.
• The retention status settings are ignored when a new folder is created within IBM Content Navigator. The retention settings can be updated after the initial creation of the folder.
• The retention status and security settings are ignored when adding a new document within IBM Content Navigator. The settings can be updated after the initial creation of the document.
• When date properties of a document in IBM Content Navigator are displayed, a time value needs to be added, since FileNet Image Services does not store the time, only the date. It is set to 12 PM (Noon) UTC so that the same date is always displayed in all time zones. So for instance, the time will be shown as 4:00 AM or 5:00 AM in Pacific Time, and 7:00 AM or 8:00 AM in Eastern Time. The date properties include Creation Date, F_ENTRYDATE and F_ARCHIVEDATE.
• In the prior release, we recommended that customers use Daeja ViewONE Professional as the preferred viewer. This viewer is a Java applet viewer, which required the installation of Java on the client. By upgrading to use IBM Content Navigator 2.0.3 FP3 (or higher), customers are also able to configure Daeja Virtual viewer, which uses HTML5 technology and requires no installation of Java, as their preferred viewer to view documents archived in the Image Services repository.

All Image Services supported MIME types, with the exception of COLD documents, are viewable by Daeja Virtual viewer. Support for annotations is also included, although annotations are intermittently missing. This is a known issue. Try closing the viewer and reopening the document to view the annotations.
Steps to configure Viewer Maps using Daeja ViewONE Virtual viewer are similar to the steps documented for using the Daeja ViewONE Professional viewer, with the main difference to select Daeja ViewONE Virtual in step 7 below.
1. Select Viewer Maps -> New Viewer Map
2. Enter the Name, ID and Description. For example, ImageServicesViewmap.
3. Under the Repository Type box click on the first entry and then hold down the Shift key to select all items.
4. Select Delete to remove the default viewer maps.
5. Select New Mapping.
6. Select Content Management Interoperability Services (CMIS) for the Repository Type.
7. Select Daeja ViewONE Virtual for Viewer.
8. Enter application/octet-stream in the New MIME Types box and then select Add.
9. Select the first entry in the Available MIME Types box.
10. Enter Control-A to select all mime types then select the right arrow to move the selections to the Selected Mime Types window.
11. Select OK in the bottom right hand corner of the screen.
12. Select Save to save the new Viewer Map.
• If you select multiple folders and try to update the Name property an error is generated. The error message is, "The changes to the property cannot be saved". The reason the message is displayed is because you cannot have two folders with the same name.
• In order to work with redaction for FileNet Image Services documents, Daeja ViewONE is required to be upgraded to the 4.1.3 release (minimal 4.1.3.0.0.2417 build).

You must have a license for the IBM Daeja ViewONE Professional Permanent Redaction Server Module to permanently redact content in a document. Please contact your system administrator for further information.

Supported input formats:

TIFF, JPEG, GIF, BMP, and PNG will redact to TIFF


Searchable PDF will redact to searchable PDF
Additional parameters are required to set in order to allow creating and saving redaction to work successfully.
For Daeja ViewONE Virtual viewer:
• From ICN Admin desktop page, click ‘Daeja ViewONE’ option from the left, then click the ‘Virtual’ tab, and go down to the ‘Additional Settings’ area.
• Click ‘New’ and enter ‘annotationsToggleBurn’ as the ‘Name’ and enter‘true’ as the ‘Value’. Save the changes.
• Click ‘New’ and enter ‘extendedISredaction’ as the ‘Name’ and enter ‘true’ as the ‘Value’. Save the changes.
• Click ‘Save and ‘Close’ or ‘Save’ the changes for the ‘Virtual’ tab.
• Refresh the ICN Admin to allow changes to take effect.
For Daeja ViewONE Professional viewer:
• From ICN Admin desktop page, click ‘Daeja ViewONE’ option from the left, then click the ‘Professional’ tab, and go down to the ‘Additional Settings’ area.
• Click ‘New’ and enter ‘extendedISredaction’ as the ‘Name’ and enter ‘true’ as the ‘Value’. Save the changes.
• Click ‘Save and ‘Close’ or ‘Save’ the changes for the ‘Professional’ tab.
• Refresh the ICN Admin to allow changes to take effect.
There is another known issue where saving redaction may fail with parse error exception. The workaround is to recycle the Application Server and try redaction again. The IBM Daeja ViewONE development team is currently working to resolve the issue.
• Encounter ‘Annotations save’ failure when using Daeja ViewONE Virtual Viewer to create, update, delete, or view annotations with the following sequences:
1. Open a document, create annotation A, save annotation A.
2. Close document or viewer. [Open the same document. Delete annotation A. Save the change. (but do NOT close the viewer)]
3. Create annotation B. Save the change, then get the error stating 'Annotations save failed (Exception message: Annotations could not be saved. Either annotation is deleted or user does not have required permissions.)
The workaround is to close the Virtual viewer at the end of the step 2 before proceeding step 3.