IBM Production Imaging Edition Version 5.0 Installation Guide GC19-3242-00
IBM Production Imaging Edition Version 5.0 Installation Guide GC19-3242-00
Note Before using this information and the product it supports, read the information in Notices on page 1. This edition applies to version 5, release 0 of IBM Production Imaging Edition (product number 5725-B54) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation 2010. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
IBM Production Imaging Edition Viewer Pro Installation Guide Introduction... 3 Planning for IBM Production Imaging Edition... 4 Hardware and Software Requirements... 5 IBM Production Imaging Edition Viewer Pro client requirements... 5 IBM Production Imaging Edition Viewer Pro server requirements... 5 Installing IBM Production Imaging Edition Viewer Pro... 6 Prerequisites... 6 Installation... 6 Runtime... 6 Document Streaming Server Module... 6 Permanent Redaction Server Module... 7 Preinstallation steps... 7 High availability (HA) environments... 8 How to run the installer... 8 Running the installer... 8 Type of installation... 10 Location of viewer and other installation locations... 11 Installation progress indicators and log file locations... 11 How to use the installer silently... 12 Postinstallation steps... 13 Redeploy FileNet Workplace XT... 13 Ensure that the viewer has updated correctly... 14 Reinstallation... 19 Uninstallation... 20 Copyright IBM Corp. 2010 1
Automatic Uninstallation... 20 Manual Uninstallation... 21 Step 1: Edit the content_redir.properties configuration file... 21 Step 2: Edit the MenuActions.xml file... 22 Remove menu items called iviewpro_redaction... 23 Remove the actions associated with the redaction menu items... 23 Step 3: Edit the Actions.xml file... 24 Remove the redaction menu items... 24 Remove the actions associated with the redaction links... 24 Step 4: Edit the web.xml file... 25 Step 5: Remove Production Imaging Edition Viewer Pro files from FileNet Workplace XT... 26 Step 6: Redeploy the FileNet Workplace XT web application... 26 Appendix A... 27 Permanent Redaction Server Module: Supported Source and Output Formats... 27 2 IBM Production Imaging Edition Viewer Pro Installation Guide
Introduction IBM Production Imaging Edition Viewer Pro is a viewing solution that incorporates Daeja ViewONE Pro. This viewing solution is part of IBM Production Imaging Edition, a high-end, single-product solution to manage the complete life cycle of document imaging. Production Imaging Edition is the foundation that manages document workflow from capture, data extraction, advanced document routing, and document imaging, to image viewing, annotation, and redaction. Production Imaging Edition Viewer Pro provides advanced document imaging for common file formats, including TIFF, JPEG, GIF, PDF, Microsoft Office formats, and OpenOffice formats. Production Imaging Edition Viewer Pro provides the following benefits: Annotation markup on all document types Document redaction to completely remove sensitive information from documents Document streaming for TIFF and PDF documents to make significant savings in network bandwidth and reduce the user time-to-view Copyright IBM Corp. 2010 3
Planning for IBM Production Imaging Edition For information about the steps required to plan for and install Production Imaging Edition Viewer Pro, see the information in this guide. For more information about how to plan for and install the IBM FileNet P8 Platform, IBM FileNet Content Manager, and IBM FileNet Workplace XT, plus additional information about how to use and customize these products, see the IBM FileNet P8 Information Center: http://publib.boulder.ibm.com/infocenter/p8docs/v5r0m0/index.jsp For more information about how to plan for, install, and use IBM Datacap Taskmaster, see the publications available at the following website: http://www.ibm.com/support/docview.wss?uid=swg27020296 The Production Imaging Edition Viewer Pro viewer is a modified version of the Daeja ViewONE Pro viewer, and contains different features and functions. However, for supplemental information about Daeja ViewONE Pro including advanced configuration options, see the additional manuals in the Support section of the Daeja website, including the HTML and ViewONE Pro Installation manuals, Annotations Manual, JavaScript API Manual, Document Streaming Manual and Permanent Redaction Manual: http://www.daeja.com/manuals/ A Production Imaging Edition installation can be distributed across a variety of machines across your network. 4 IBM Production Imaging Edition Viewer Pro Installation Guide
Hardware and Software Requirements This section details the hardware and software requirements for Production Imaging Edition Viewer Pro, both for the client and for the server that hosts the Production Imaging Edition client and server side modules. IBM Production Imaging Edition Viewer Pro client requirements Any machine that is capable of running a web browser with an installed Java engine fulfils the hardware criteria required to run Production Imaging Edition Viewer Pro. Production Imaging Edition Viewer Pro is designed to operate with a Java environment of version 1.1.5 or later and with any browser that supports Java 1.1.5 or later. The following table shows the list of supported browsers. Table 1: List of supported browsers for IBM Production Imaging Edition Viewer Pro Browser Internet Explorer 6 or later Firefox 3 or later Platform Windows XP or later Windows XP or later Production Imaging Edition Viewer Pro uses native libraries for viewing of PDF documents and Microsoft Office documents. For these modules, the following restrictions apply: For PDF viewing, the client machine must have a Windows operating system and must be using a 32-bit Java engine. For Microsoft Office document viewing, the machine must have a Windows operating system and must run a 32-bit Java engine. IBM Production Imaging Edition Viewer Pro server requirements The only server requirement is that there is a full working installation of IBM FileNet Workplace XT. See Appendix A at the end of this document for restrictions that apply to the Permanent Redaction Server Module. Copyright IBM Corp. 2010 5
Installing IBM Production Imaging Edition Viewer Pro The following information provides general guidance for the tasks that must be completed to install the IBM Production Imaging Edition Viewer Pro software. Prerequisites Installation The installation process requires at least 200 MB of free space in the temporary directory of the operating system for unpacking the installer bootstrap files. A minimal installation requires approximately 170 MB of free space in the target location for the installation. Any other installation, including a full installation, requires approximately 200 MB of free space in the target location for the installation. Runtime In general, because the server-side modules are based on Java, memory usage is affected by garbage collection. Further information about garbage collection and general Java performance tuning is available from the following resource: http://www.oracle.com/technetwork/java/javase/tech/index-jsp-136373.html Document Streaming Server Module Predictions for runtime resource usage during document streaming vary significantly based on the types of documents that are being processed. For example, large PDF documents with 10 or more pages require more CPU and disk usage than two page TIFF files. The Document Streaming Server Module requires a minimum of 20 MB of memory for a single user. Per additional concurrent user, the memory requirement increases. The increase is dependent upon the type of documents that are being streamed. Typically, TIFF documents incur a 700 KB or more per-user increase and a complex PDF document could incur a 5 MB or more per-user increase. Real-world usage figures are likely to vary between, and occasionally greater than, these values. Concurrent user access can be limited by configuring some of the advanced options of the Document Streaming Server Module, options that are documented in the manual available at the Daeja website location specified at the end of this section. When you are sizing resources for streaming, remember that the Document Streaming Server Module does use caching. After a document's page is processed and is available from the cache of the Document Streaming Server Module, no additional CPU usage is required to serve the page to another client that requests the same cached page. Disk space requirements are dependent on the size of the streamer cache and expiry options. The default size is 100 MB. This is a soft limit and it is dependent on the cache expiry check time that has a default of 1 hour. These defaults can be changed by editing 6 IBM Production Imaging Edition Viewer Pro Installation Guide
the configuration files for the streamer. The configuration options are documented in the Document Streaming Manual available from at the following website: http://www.daeja.com/manuals/ Permanent Redaction Server Module Predictions for runtime resource usage during document redaction vary significantly based on the types of documents that are being processed. For example, full color TIFF images require more memory, CPU and disk resource than mono TIFF images. The application of several hundred redactions to a PDF file requires more memory and CPU usage than the application of a few redactions. The Permanent Redaction Server Module requires a minimum of 20 MB of memory for a single user. Per additional concurrent user, the memory requirement increases. The increase depends upon the type of documents that are being redacted. Typically, black and white TIFF documents incur a 500 KB or more per-user increase, a full color TIFF document incurs a 2 MB or more per-user increase and a PDF document could incur, in a worst-case scenario, up to two times the size of the PDF document per-user increase. Real-world usage figures are likely to vary between, and occasionally greater than, these values. Disk space requirements are related to the size and color depth of the documents that are being redacted and cannot be accurately predicted. Additional configuration options are documented in the Permanent Redaction Manual available from the following website: http://www.daeja.com/manuals/ Preinstallation steps Before you can install the IBM Production Imaging Edition Viewer Pro software, you must have installed and configured FileNet Workplace XT, including any applicable fix packs. Important: After you run the IBM Production Imaging Edition Viewer Pro installer, you might subsequently reinstall FileNet Workplace XT or a FileNet Workplace XT fix pack. If you do so, then you must run the IBM Production Imaging Edition Viewer Pro installer again. Ensure that your current FileNet Workplace XT installation is working correctly by doing the following steps: 1. Start the web application server that hosts FileNet Workplace XT if it is not already running. 2. Point your web browser to your FileNet Workplace XT home page. For example: http://hostname/workplacext 3. Browse the document repository and open an image document. Copyright IBM Corp. 2010 7
4. Right-click on the image displayed in the viewer and select Help > About. 5. Confirm that at the top of the screen that is shown, the text "FileNet Image Viewer" is displayed. High availability (HA) environments In high availability environments, you must run the installer on every node of the installed FileNet Workplace XT system. Part of the Document Streaming Server Module function is to cache documents. The module uses a runtime cache to do this. When you are installing the Document Streaming Server Module in a high availability environment, it is important to ensure that the Document Streaming Server Module runtime files are located on the same node as the FileNet Workplace XT installation. The configuration directory, however, can be centrally located. How to run the installer The Production Imaging Edition Viewer Pro installer must be run as the same user that installed IBM FileNet Workplace XT. Installing the viewer as the same user that installed FileNet Workplace XT ensures that the following requirements are met: The installer has access to the install registry of FileNet Workplace XT for locating FileNet Workplace XT configuration files. The installer has the correct permissions to modify the relevant FileNet Workplace XT files. The use of double-byte characters in any of the installation paths or filenames is not recommended because these characters can cause problems with uninstallation. Running the installer To run the installer and start the Production Imaging Edition Viewer Pro installation, do the following steps: 1. Log in to the server where you want to install Production Imaging Edition Viewer Pro. 2. Locate the Production Imaging Edition Viewer Pro installation software package. 3. Start the installation program by running the appropriate installation program for your operating system. Note that you might need to uncompress an installation archive before running the installation executable. 8 IBM Production Imaging Edition Viewer Pro Installation Guide
Table 2: Installer archive files for each platform Platform Installer archive Installer Executable AIX CZU4UML.tar.gz PIEView_1.1.194.2_AIX.bin HP-Integrity CZU7ZML.tar.gz PIEView_1.1.194.2_HPI.bin HP-UX CZU80ML.tar.gz PIEView_1.1.194.2_HPUX.bin Linux CZU81ML.tar.gz PIEView_1.1.194.2_LINUX.bin Solaris CZU82ML.tar.gz PIEView_1.1.194.2_SOL.bin Windows CZU83ML.zip PIEView_1.1.194.2_WIN.exe Copyright IBM Corp. 2010 9
You will then see a progress bar as the installation prepares to run. After the preparation is complete, the installer opens the following window with a welcome message: Follow the instructions on each window to complete the installation. The following information provides additional guidance for the choices that you make on some of the windows. Type of installation There are three feature sets for the installation: Complete Selecting this feature set means that all viewer components will be installed. This option includes not only the client side viewer, but also the server side streamer and permanent redaction server modules. Minimal Selecting this feature set means that only the IBM Production Imaging Edition Viewer Pro client software will be installed. Custom Selecting this feature set opens another window of features. From these features, you can select any of the possible IBM Production Imaging Edition Viewer Pro software components. You must always install IBM Production Imaging Edition Viewer Pro. The installation program does not allow you to continue unless you have selected this feature. 10 IBM Production Imaging Edition Viewer Pro Installation Guide
After you perform an installation with one of these feature sets, you cannot perform a reinstallation with a different installation feature set without first performing an uninstallation. See the reinstallation section for further details about this procedure. Location of viewer and other installation locations By default, the installation software locates your current installation of FileNet Workplace XT and displays a suitable location for the installation of the viewer. You can alter the default locations by clicking the Choose button throughout the installation program windows if you want. The installation locations are described in detail as follows: The main destination folder is where the IBM Production Imaging Edition Viewer Pro viewer files are installed. This folder is typically the root of the FileNet Workplace XT installation. The configuration files folder is used to store the IBM Production Imaging Edition Viewer Pro Permanent Redaction Server and Image Viewer Pro Document Streamer properties files. The IBM Production Imaging Edition Viewer Pro Document Streaming Server Module runtime files folder is also the location for the Document Streamer cache repository. The log file location is the location of the log files generated by the IBM Production Imaging Edition Viewer Pro Document Streaming Server Module and IBM Production Imaging Edition Viewer Pro Permanent Redaction Server Module. After you are satisfied that all the installation locations are correct, click the Install button to begin the installation. Installation progress indicators and log file locations As the installation completes, a progress bar shows the progress of the installation. If there are any problems that prevent a successful transaction, the installation software will roll back and any installed files up to the point of the installation failure will be removed. View the installation log file located in main destination folder (as designated in step 1 of the installation windows). Verify that no errors or failures were logged. In the log file, look for the ERROR designation at the start of a line. If corrective action cannot be taken based on the error text, you might need to contact IBM Software Support for additional remedial steps. Copyright IBM Corp. 2010 11
How to use the installer silently IBM Production Imaging Edition Viewer Pro can also be installed silently without invoking a graphical user interface by using a response file that you prepare before the installation. A sample silent install response file is provided in the installation archive. The valid responses are listed below: LICENSE_ACCEPTED=false Must be set to true for the install to complete USER_INSTALL_DIR=C:\\Program Files\\IBM\\FileNet\\ImageViewerPro Specifies the installation path CHOSEN_FEATURE_LIST=client,streamer,permredact A comma separated list of the features to be installed. Possible feature options are: client - Upgrades ViewONE Standard to ViewONE Pro. This parameter is mandatory. streamer - Installs the Document Streaming Server Module permredact - Installs the Permanent Redaction Server Module IVIEWPRO_CONFIG_PATH= C:\\Program Files\\IBM\\FileNet\\Config\\ImageViewerPro The Document Streaming Server Module and Permanent Redaction Server Module require properties files to set them up. This response contains the directory in which these configuration files are placed. STREAMER_RUNTIME_PATH=C:\\Program Files\\IBM\\FileNet\\ImageViewerPro\\streamer The Document Streaming Server Module requires an area on disc to store cached documents. This path should not be set to an area on disc that has less than 200MB free. LOGFILES_PATH=C:\\Program Files\\IBM\\FileNet\\ImageViewerPro\\LogFiles A path in which to store log files produced by the server modules. To start the installer in silent mode, use the following command line switches with the command: -i silent -f <full_path>/pieview_silent_install.txt For example, on Windows, the command would be similar to the following command: PIEView_1.1.194.0_WIN.exe -i silent -f C:\install\PIEView_silent_install.txt On a UNIX based environment, the command would be similar to the following command: PIEView_1.1.194.0_SOL.bin -i silent -f /tmp/install/pieview_silent_install.txt 12 IBM Production Imaging Edition Viewer Pro Installation Guide
Postinstallation steps Redeploy FileNet Workplace XT The IBM Production Imaging Edition Viewer Pro installer changes the FileNet Workplace XT installation by modifying configuration files and adding files to the directory structure. As a result of these changes, every time that you run the installer, FileNet Workplace XT must be redeployed. To redeploy FileNet Workplace XT: 1. Re-create the WAR and EAR files as required by your web application server installation by running the appropriate the scripts in the following folder: workplace_xt_install_path/ibm/filenet/webclient/deploy/ 2. Undeploy FileNet Workplace XT. 3. Stop the web application server that is currently running the FileNet Workplace XT web application. 4. Delete the temporary directories: WebSphere Application Server: a) Delete all folders from the following path: <WebSphere_HOME>/profiles/<profile_name>/wstemp b) Delete the WorkplaceXT folder from the following path: <WebSphere_HOME>/profiles/<profile_name>/temp/<node_name>/<server_name> Oracle WebLogic Server: a) Delete the temporary FileNet Workplace XT directory from the following path: <WL_HOME>/<domain>/servers/<instance>/tmp/_WL_usr JBoss Application Server: a) Delete all folders from the following path: <JBOSS_HOME>/server/<server_name>/tmp/deploy b) Delete all folders from the following path: <JBOSS_HOME>/server/<server_name>/work/jboss.web/localhost 5. Start the web application server that is used for running the FileNet Workplace XT web application. 6. Deploy the updated FileNet Workplace XT web application to your web application server. Copyright IBM Corp. 2010 13
For more comprehensive information about redeploying FileNet Workplace XT, see the IBM FileNet Workplace XT Installation and Upgrade Guide (GC19-2783-04) in the FileNet documentation. Ensure that the viewer has updated correctly 1. Log in to FileNet Workplace XT. 2. From the object store, select any folder that contains images. Open any image in the viewer and check that the image displays correctly. 3. If the image displays correctly, then right-click in the viewer, click Help > About, and ensure that the information displayed is for Production Imaging Edition Viewer Pro. The following window shows an example of the information: 14 IBM Production Imaging Edition Viewer Pro Installation Guide
If you installed the Production Imaging Edition Viewer Pro Document Streaming Server Module, then you will also need to check that this module is working as expected. Log in to FileNet Workplace XT and then edit the URL shown in the browser address bar. To edit the URL, remove all text that follows the WorkplaceXT/ text and add the text iviewpro/streamer to the path. For example, you might see the following URL after you log in: http://myinstall/workplacext/browse.jsf Change this URL to the following example to load the Document Streaming Server module. http://myinstall/workplacext/iviewpro/streamer Then press Enter. If the Document Streaming Server module is installed and running correctly, you should see the following screen, with a message that indicates that the streamer servlet is running: To see that files are being correctly split into their component pages, you should also perform the following check: 1. Add a multi-page PDF document to the object store. 2. Open the PDF document from within the object store. 3. After the document is open, click the blue i or Image properties button in the status bar of the viewer. This action opens a window that is similar to the following window: Copyright IBM Corp. 2010 15
4. Check that the Server property is set. This property represents the version number of the Document Streaming feature. 5. Search for two properties in this window to determine whether the streamer is working properly. If the individual pages of the document are being streamed instead of the whole document, then these two properties must be in the list. The first property, Source length, represents the size of the entire document cached by the streamer. 16 IBM Production Imaging Edition Viewer Pro Installation Guide
The second property, File length, shows the size of the page that is downloaded and is currently displayed by the viewer. The size displayed in the Source length property should be larger than the size displayed in the File length property. Note: These properties will not always be present. Some documents cannot be streamed by the streamer and in these cases the entire document will be sent to the client. If you installed the IBM Production Imaging Edition Viewer Pro Permanent Redaction Server Module, then you need to check that this module is working as expected. Log in to FileNet Workplace XT and then edit the URL shown in the browser address bar. To edit the URL, remove all text that follows the WorkplaceXT/ text and add the text iviewpro/redact to the path. For example, you might see the following URL after you log in: http://myinstall/workplacext/browse.jsf Change this URL to the following example to load the Permanent Redaction Server module. http://myinstall/workplacext/iviewpro/redact Then press Enter. If the redaction servlet is installed and running correctly, you should see the following screen, with a message that the burner servlet is running: This message indicates that the Permanent Redaction servlet is running as expected. To see that files can correctly have annotation data "burnt" into them, you should do the following steps: Copyright IBM Corp. 2010 17
1. Select any sample file of the supported formats as defined in Appendix A of this manual from the object store and right-click it. 2. Confirm that you now see in the menu of available actions the Redaction sub-menu option. Within this sub-menu you should find a Redact to File option. 3. Select this option and confirm that the image is correctly loaded into the viewer. Confirm that the interface shows an Annotation Redact button instead of the usual Annotation Save button. 18 IBM Production Imaging Edition Viewer Pro Installation Guide
Reinstallation Important: Reinstallation is necessary when an upgrade of FileNet Workplace XT (including fix packs) is performed. The reinstallation is needed because the FileNet Workplace XT installation can modify important files relevant to IBM Production Imaging Edition Viewer Pro. If you intend to reinstall so that you can select a different IBM Production Imaging Edition Viewer Pro feature set, then you must first perform an uninstallation as described in the Uninstallation section of this manual. During the uninstallation and reinstallation, existing configurations for currently installed Document Streaming or Permanent Redaction features are preserved. However, reinstallation removes the iviewpro/wcmjavaviewer.jsp file and modifies the following files: content_redir.properties Actions.xml MenuActions.xml Therefore, you must back up these files and the iviewpro/wcmjavaviewer.jsp file if you have made any custom changes that you want to keep. After reinstallation, you must redeploy FileNet Workplace XT in full by using the instructions in the Redeploy FileNet Workplace XT section. To reinstall IBM Production Imaging Edition Viewer Pro, follow the steps in the Installing IBM Production Imaging Edition Viewer Pro section of this guide. Copyright IBM Corp. 2010 19
Uninstallation Automatic Uninstallation To uninstall IBM Production Imaging Edition Viewer Pro: 1. Find the location where the software is installed. By default, this path contains the ImageViewerPro directory. 2. Browse to the _ivpuninst directory within that location. 3. Run the iviewpro_uninstaller.exe program. When the uninstaller program runs, the following files and folders are not removed because they can contain custom configurations. Note that the location of these files is dependent on your installation choices: <Image Viewer Pro Configuration directory>/iviewpro.streamer.properties <Image Viewer Pro Configuration directory>/iviewpro.redacttofile.properties <Image Viewer Pro Installation directory>/backup/ <Image Viewer Pro Document Streaming Server Run-time Files directory>/ <Image Viewer Pro Installation directory>/logfiles/ Important: Uninstallation removes the iviewpro/wcmjavaviewer.jsp file even if you modified this file. Therefore, you must back up this file before uninstallation if there are any custom changes to the file that you want to keep. After uninstallation, you must redeploy FileNet Workplace XT in full by using the instructions in the Redeploy FileNet Workplace XT section. 20 IBM Production Imaging Edition Viewer Pro Installation Guide
Manual Uninstallation In some cases, it might be necessary to perform a manual uninstallation. In the following scenarios, a manual uninstallation is required: If any of the IBM Production Imaging Edition Viewer Pro installation paths contain a double-byte character (for example, Japanese characters) If the uninstallation process fails and is rolled back The following procedure describes how to perform the necessary steps to uninstall the IBM Production Imaging Edition Viewer Pro software manually. Before you begin, you must know the location of the following folders: WebClient installation folder: If the default location was selected during the FileNet Workplace XT installation, then the platform-specific locations for this folder include the following paths: o Windows 32-bit platform: C:\Program Files\IBM\FileNet\WebClient o Windows 64-bit platform: C:\Program Files (x86)\ibm\filenet\webclient o UNIX based platform: /opt/ibm/filenet/webclient WebClient configuration folder: If the default location was selected during the FileNet Workplace XT installation, then the platform-specific locations for this folder include the following paths: o o o Windows 32-bit platform: C:\Program Files\IBM\FileNet\Config\WebClient Windows 64-bit platform: C:\Program Files (x86)\ibm\filenet\ Config\WebClient UNIX based platform: /opt/ibm/filenet/ Config/WebClient Production Imaging Edition Viewer Pro installation folder: If the default location was selected during the installation, then the platform-specific locations for this folder include the following paths: o o o Windows 32-bit platform: C:\Program Files\IBM\FileNet\ImageViewerPro Windows 64-bit platform: C:\Program Files (x86)\ibm\filenet\imageviewerpro UNIX based platform: /opt/ibm/filenet/imageviewerpro Step 1: Edit the content_redir.properties configuration file The file content_redir.properties is located in the WebClient configuration folder. This file contains the mapping between documents that were set with a particular MIME type and the client-side viewer that is used to display the documents. Production Imaging Edition Viewer Pro supports a larger number of additional MIME types than the standard Image Viewer that is supplied with FileNet Workplace XT. To remove the support for these additional MIME types, the content_redir.properties file must be edited as a text file. Copyright IBM Corp. 2010 21
Before changing the content_redir.properties file, you must first back up the file. The following paths are important information that you must know about IBM Production Imaging Edition Viewer Pro and the standard Image Viewer to make the changes to the content_redir.properties file: The mapping for Production Imaging Edition Viewer Pro contains the URL /iviewpro/wcmjavaviewer.jsp with a set of additional URL parameters. The mapping for the standard Image Viewer contains the complete URL /WcmJavaViewer.jsp?{JSP_QUERY_STRING}. The changes that need to be made to the content_redir.properties file are as follows: 1. Change the URLs of the following MIME types to /WcmJavaViewer.jsp/?{JSP_QUERY_STRING}. Make sure that there are no duplicate entries for each MIME type. image/pjpeg image/jpg image/jpeg image/bmp image/tiff image/tiff image/gif application/x-cold application/vnd.filenet.im-image application/vnd.filenet.im-cold application/vnd.filenet.im-form application/vnd.filenet.im-other For example, the following path shows the old path: image/tiff=/iviewpro/wcmjavaviewer.jsp?id={object_id}&streamer=true&{jsp_query_str ING} This path shows the change that you must make: image/tiff=/wcmjavaviewer.jsp?{jsp_query_string} 2. Delete all other MIME types in which the first part of the URL contains the path /iviewpro/wcmjavaviewer.jsp. 3. Save the content_redir.properties file. Step 2: Edit the MenuActions.xml file Skip this step if the Production Imaging Edition Viewer Pro Permanent Redaction Server Module was not installed. The MenuActions.xml file contains the menu items that are visible when the user rightclicks within the FileNet Workplace XT graphical user interface. 22 IBM Production Imaging Edition Viewer Pro Installation Guide
Before making any changes to the MenuActions.xml file, make a backup copy of the file. Remove menu items called iviewpro_redaction 1. Find the <array> element with the key attribute value specified as toplevelactions. 2. Remove the <value> element with the value specified as iviewpro_redaction as shown in the following example. <array key="toplevelactions">... <value>iviewpro_redaction</value>... 3. Find the <setting> element with the key attribute value specified as id. This element should have a child text node called iviewpro_redaction. 4. The parent element of the <setting>element is the <object> element. Remove the entire <object> parent element as shown in the following example. <object key="action"> <setting key="id">iviewpro_redaction</setting>... </object> Remove the actions associated with the redaction menu items 1. Find the <setting> element with the key attribute value specified as id. This element should have a child text node called iviewpro_redacttofile. 2. The parent element of the <setting> element is the <object> element. Remove the entire parent <object> element as shown in the following example. <object key="action"> <setting key="id">iviewpro_redacttofile</setting>... </object> 3. Find the <setting> element with the key attribute value specified as id. This element should have a child text node called iviewpro_redacttofilepdf. 4. The parent element of the <setting> element is the <object> element. Remove the entire parent <object> element as shown in the following example. <object key="action"> <setting key="id">iviewpro_redacttofilepdf</setting>... </object> Copyright IBM Corp. 2010 23
Step 3: Edit the Actions.xml file Skip this step if the Production Imaging Edition Viewer Pro Permanent Redaction Server Module was not installed. The Actions.xml file contains the links on the Document Properties display within the FileNet Workplace XT graphical user interface. Before making any changes to the Actions.xml file, make a backup copy of the file. Remove the redaction menu items 1. Find the <array> element with the key attribute specified as toplevelactions. 2. Remove the two <value> elements that have the text values iviewpro_redacttofile and iviewpro_redacttofilepdf as shown in the following example. <array key="toplevelactions">... <value>iviewpro_redacttofile</value> <value>iviewpro_redacttofilepdf</value>... Remove the actions associated with the redaction links 1. Find the <setting> element with the key attribute specified as id. This element should have a child text node called iviewpro_redacttofile. The parent element of the <setting> element is the <object> element. Remove the entire <object> parent element as shown in the following example. <object key="action"> <setting key="id">iviewpro_redacttofile</setting>... </object> 2. Find the <setting> element with the key attribute specified as id. This element should have a child text node called iviewpro_redacttofilepdf. The parent element of the <setting> element is the <object> element. Remove the entire <object> element as shown in the following example. <object key="action"> <setting key="id">iviewpro_redacttofilepdf</setting>... </object> 24 IBM Production Imaging Edition Viewer Pro Installation Guide
Step 4: Edit the web.xml file The web.xml file contains the definitions of the server-side components. The Production Imaging Edition Viewer Pro Document Streaming Server Module and the Production Imaging Edition Viewer Pro Permanent Redaction Server Module both add definitions to this file. Skip this step if you did not install either of these modules. Before making any changes to the web.xml file, make a backup copy of the file. 1. Find the <context-param> element with the parameter name specified as iviewproconfigurationdirectory. Delete the <context-param> element as shown in the following example. <context-param> <param-name>iviewproconfigurationdirectory</param-name> <param-value>c:/program Files/IBM/FileNet/Config/ImageViewerPro</paramvalue> </context-param> 2. Find the <listener> element with the listener class specified as ji.filenet.iviewprolocalisation. Delete the <listener> element as shown i in the following example. <listener> <listener-class>ji.filenet.iviewprolocalisation</listener-class> <listener> 3. Find the <servlet> element with the servlet name specified as iviewpro.streamer and also find the<servlet> element with the servlet name specified as iviewpro.redacttofile". Delete both of these <servlet> elements as shown in the following example. <servlet> <servlet-name>iviewpro.streamer</servlet-name> <servlet-class>ji.streamer.servlet.jidefaultstreamerservlet</servlet-class> <init-param> <param-name>configdircontextkey</param-name> <param-value>iviewproconfigurationdirectory</param-value> </init-param> </servlet> <servlet> <servlet-name>iviewpro.redacttofile</servlet-name> <servlet-class>ji.filenet.workplace.jifilenetredactionservlet</servlet-class> </servlet> 4. Find the <servlet-mapping> element with the servlet name specified as iviewpro.streamer and also find the <servlet-mapping> element with the servlet name specified as iviewpro.redacttofile". Delete both of these <servlet-mapping> elements as shown in the following example. <servlet-mapping> <servlet-name>iviewpro.streamer</servlet-name> <url-pattern>/iviewpro/streamer</url-pattern> Copyright IBM Corp. 2010 25
</servlet-mapping> <servlet-mapping> <servlet-name>iviewpro.redacttofile</servlet-name> <url-pattern>/iviewpro/redact</url-pattern> </servlet-mapping> Step 5: Remove Production Imaging Edition Viewer Pro files from FileNet Workplace XT All the files to be deleted are located within the WorkplaceXT subdirectory of the WebClient installation folder. 1. Delete the folder iviewpro and its contents. 2. Delete the folder UI-INF/jsp/ui/iviewpro and its contents. 3. Check that the following backup file exists: WEB-INF/xsl/Annot.bak. Delete the XSL file WEB-INF/xsl/Annot.xsl. Rename the backup file WEB-INF/xsl/Annot.bak to WEB-INF/xsl/Annot.xsl. 4. Delete the following files from the folder WEB-INF/lib: jiserver.jar jiserver-resources-linux.jar (only present on a Linux server) jiserver-resources-sunos.jar (only present on a Solaris server) 5. Delete the lic-server.v1 file from the folder WEB-INF. 6. Delete the ImageViewerPro installation folder. See the Manual Uninstallation section for the default location of this folder. 7. Delete the ImageViewerPro configuration folder that is a subfolder of the WebClient configuration folder. See the Manual Uninstallation section for the default location of this folder. Step 6: Redeploy the FileNet Workplace XT web application After uninstallation, you should ensure that you Redeploy FileNet Workplace XT in full. 26 IBM Production Imaging Edition Viewer Pro Installation Guide
Appendix A Permanent Redaction Server Module: Supported Source and Output Formats The following table shows the supported output formats for each of the supported input formats with respect to the server platform backend. Table 3: Supported output formats for each supported input format, by server platform Input format Windows 32 bit JRE Windows 64 bit JRE Solaris Linux AIX HP-UX TIFF TIFF TIFF TIFF TIFF TIFF TIFF JPEG TIFF TIFF TIFF TIFF TIFF TIFF GIF TIFF TIFF TIFF TIFF TIFF TIFF BMP TIFF TIFF TIFF TIFF TIFF TIFF PNG TIFF TIFF TIFF TIFF TIFF TIFF Microsoft Office formats Openoffice.org formats Email (.eml,.msg) TIFF - - - - - TIFF - - - - - - - - - - - A hyphen (-) means that the input format cannot be redacted on that particular server backend. Copyright IBM Corp. 2010 27
Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: 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 states 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. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. Copyright IBM Corp. 2010 1
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation Office 4360 One Rogers Street Cambridge, MA 02142 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Trademarks IBM, the IBM logo, ibm.com, Lotus, and Notes are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol ( or ), indicating US registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries. Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others. 2 Installation Guide
Program Number: 5725-B54 Printed in USA GC19-3242-00