edm RIE Export Plugin

Transcription

1 edm RIE Export Plugin Installation and User Guide INTRODUCTION This guide provides information to help you set up the Redact-It export plugin for IBM ediscovery Manager in order to export files to Redact-It Enterprise for the purpose of redaction processing. Redact-It Enterprise v6.2 IBM ediscovery Manager 2.1 PRODUCT VERSION INFORMATION If you need information on integrating and customizing the Redact-It export plugin, or if you experience any problems or have general inquiries, please feel free to contact us. Informative Graphics Corp 4835 E. Cactus Road, Suite 445 Scottsdale, Arizona Phone: (602) Web: AUDIENCE This guide is designed for individuals installing, configuring, and maintaining the Redact-It product used in conjunction with IBM ediscovery Manager. Those individuals are typically system administrators, integrators, and other IT professionals. A certain amount of advanced technical knowledge is needed to effectively use this information guide. Copyright 2010 Informative Graphics Corporation Page: 1

2 TABLE OF CONTENTS Introduction... 1 Product Version Information... 1 Audience... 1 Table of Contents edm Export Plugin for Redact-It Requirements RIE plugin Overview... 3 Key Features Installation Plugin Configuration RIEPluginconfig.xml Custom Properties Custom Extract Properties Custom Batch Complete Properties Redact-It Output Copyright 2010 Informative Graphics Corporation Page: 2

3 1.0 EDM EXPORT PLUGIN FOR REDACT-IT The Redact-It edm export plugin is a seamless integration of Redact-It Enterprise to IBM ediscovery Manager. The plugin allows users to select a group of files in ediscovery Manager and quickly process them for redaction through Redact-It Enterprise. The redacted files are exported into an output location on the file system for later distribution as secure versions of the original files. 1.1 REQUIREMENTS Hardware Requirements - identical to the ediscovery Manager requirements. Please see the IBM documentation for specifications and additional configuration requirements. Software requirements: IBM ediscovery Manger v.2.1 installed Redact-It Enterprise installed (version 6.2) Certified Java version: Java 1.5 (Java Note: The plugin will run in the Java Virtual Machine (JVM) that WebSphere uses to run ediscovery Manager. The certified Java version, 1.5, pertains to this JVM, not to any other Java that may be on the machine.) 1.2 RIE PLUGIN OVERVIEW The Redact-It plugin adds a new Export format called Redact-It to the list of available document export formats in an existing IBM ediscovery Manager installation. This plugin allows users to be able to export files to be redacted by Redact-It Enterprise. When a document is exported from ediscovery Manager to Redact-It Enterprise for processing, the original document is deposited in the output directory that is configured in ediscovery Manager, and the redacted document is deposited in the RIEOUT subdirectory of this output directory. Copyright 2010 Informative Graphics Corporation Page: 3

4 KEY FEATURES Redact-It for IBM ediscovery Manager Plugin adds the following key features to ediscovery: Redact-It Enterprise export format allows export of files directly from ediscovery Manager to be processed and redacted by Redact-It Enterprise. Redaction job properties are configurable from within the custom properties dialog box. Files in a batch that are not identified as being supported file formats are not sent to Redact-It Enterprise for processing. Information from the Redact-It Enterprise status page, logs, and heartbeat file update the ediscovery Manager status page for the batch or file being processed. CSN file handling: ediscovery Manager 2.1 includes an converter API, which converts CSN files to TXT files. ediscovery Manager 2.2 will include an converter API, which will convert CSN files to HTML files. With both versions, the plugin will use the IBM converter API to convert CSN files for redaction processing. With ediscovery Manager 2.1, the plugin converts the CSN files to TXT files, which are sent to Redact-It Enterprise for processing. With ediscovery Manager 2.2, the plugin will convert CSN files to HTML files, which will be sent to Redact-It Enterprise for processing. Copyright 2010 Informative Graphics Corporation Page: 4

5 2.0 INSTALLATION The following installation is specific to the installation and configuration of the Redact-It plugin for ediscovery Manger on WebSphere. Users should be familiar with ediscovery Manager and WebSphere before continuing. The Redact-It plugin installation files that you received from Informative Graphics contain the following two JAR files and one configuration XML file: rieplugin.jar simple jar RIEpluginConfig.xml 1. Deploy the rieplugin.jar and simple jar files into the EDMWorkMgrServer WebSphere web application. How this is done will depend on your WebSphere installation. Both JAR files must be deployed into the WEB-INF\lib folder of the WAR file that is part of the EAR file of the EDMWorkMgrServer WebSphere web app (as opposed to the EDMClient web app). Note: The simple jar file is provided under the Apache License. Please visit for additional information about this file and its usage. 2. Import the RIEpluginConfig.xml file through the ediscovery Manager Import a new document export format button. Browse to the directory where you placed the IGC plugin files and select RIEpluginConfig.xml. After you click OK, Redact-It Enterprise will appear in the format list. The custom properties can be configured in the Extract tab as described in the next section. Redact-It Enterprise will now appear as an option in the drop-down list of available export formats when you choose to export documents from ediscovery Manager. ediscovery Manager Export is designed to work in batches. When an export task is submitted, the documents are grouped into batches. For each file in each batch, the file is extracted to the file system into the export directory. Copyright 2010 Informative Graphics Corporation Page: 5

6 The Redact-It Enterprise format is added to the export format types available. Like the other export formats, the Redact-It Enterprise format has two tabs in ediscovery Manager: Extract and Batch Complete. As explained in Section 3.2 below, you can configure custom properties for Extract. 3.0 PLUGIN CONFIGURATION The custom properties of the Redact-It Enterprise export format can be configured in two ways: Before the Redact-It Enterprise export format is defined, its custom properties can be edited in RIEpluginConfig.xml. When the Redact-It Enterprise export format is created, its custom properties are initially set from the values in RIEpluginConfig.xml. This is described in section 3.1. After the Redact-It Enterprise export format is defined, its custom properties can be edited in ediscovery Manager s Custom Properties dialog. This is described in section RIEPLUGINCONFIG.XML Before the Redact-It Enterprise export format is defined, its custom properties can be edited in RIEpluginConfig.xml. An example RIEpluginConfig.xml is below: <?xml version="1.0" encoding="utf-8"?> <format default="false"> <formatname>redact-it Enterprise</formatname> <extract> <plugin class="com.infograph.edmplugin.rieextractplugin"> <properties> <name>redactiturl</name> <value> <name>callbackhost</name> <value>ibmp8support</value> <name>callbackport</name> <value>9876</value> <name>redactionscript</name> <value></value> <name>outputformat</name> <value>pdf</value> <name>outputdirectory</name> <value>c:\program Files\IGC\Redact-It Enterprise\JobProcessor\eDM</value> Copyright 2010 Informative Graphics Corporation Page: 6

7 <name>auditlog</name> <value>true</value> <name>redactionsummary</name> <value>true</value> <name>extractedtextfile</name> <value>false</value> <name>useritem1</name> <value>test1</value> <name>useritem2</name> <value>test2</value> </properties> </plugin> </extract> <batchcomplete> <plugin class="com.infograph.edmplugin.riebatchcompleteplugin"> <properties> <name>outputdirectory</name> <value>c:\program Files\IGC\Redact-It Enterprise\JobProcessor\eDM</value> </properties> </plugin> </batchcomplete> </format> 3.2 CUSTOM PROPERTIES CUSTOM EXTRACT PROPERTIES After the Redact-It Enterprise export format is defined, its custom properties can be edited in ediscovery Manager s Custom Properties dialog, as follows: 1. From the edm Export Administration panel, import the RIEpluginConfig.xml file as directed in section 2.0 if you have not already done so. 2. Click on the Redact-It Enterprise item that appears in the list of document export formats to display the configurable properties for this format. 3. On the Extract tab, click the Custom Properties icon to bring up the properties dialog. Copyright 2010 Informative Graphics Corporation Page: 7

8 4. You can edit the values of any of the Redact-It properties. The following table lists the description of each property. Property RedactItUrl CallbackHost CallbackPort OutputFormat OutputDirectory RedactionScript AuditLog RedactionSummary ExtractedTextFile Description The URL of the Redact-It Enterprise web service. The host machine of the internal callback from Redact-It Enterprise back to the plugin. The port number of the internal callback from Redact-It Enterprise back to the plugin. The format of the output file. Valid values are either CSF, PDF, DWF, or TIFF. The top level output directory for processed files. There will be subdirectories for each batch. Full path to a redaction script file. If set, the redaction script will be sent to Redact-It Enterprise and applied to the output file when the OutputFormat is CSF, PDF, or TIFF. True or false value determines if an audit log will be created by Redact-It Enterprise as an additional page. True or false value determines if a redaction summary page will be created by Redact-It Enterprise as an additional page. True or false value determines if an extracted text file will be created by Redact-It Enterprise as an additional page. 5. If you have made changes to the property values, click Apply to close the dialog and apply your updates. 6. Click the SAVE button to save your changes. Note that ediscovery Manager requires you to click both Apply and Save to fully-propagate changes to the properties of any ediscovery Manager plug-in. Copyright 2010 Informative Graphics Corporation Page: 8

9 3.2.2 CUSTOM BATCH COMPLETE PROPERTIES After the Redact-It Enterprise Export format is defined and custom properties set (see previous section) the Batch Complete custom properties must be edited as follows: 1. On the Batch Complete tab, click the Custom Properties icon to bring up the properties dialog. 2. The only property available is OutputDirectory. This directory must exist on the server and has to be configured to correspond with the OutputDirectory property on the "Extract" plugin configuration. In other words, the value set for OutputDirectory must be the same value as was set in the Export tab. Copyright 2010 Informative Graphics Corporation Page: 9

10 4.0 REDACT-IT OUTPUT The conventions for files output by the plugin are basically the same as the conventions for files output by any ediscovery Manager plugin. The only difference is that the Redact-It Enterprise plugin adds a folder named RIEOUT, which contains the CSF, PDF, or TIFF files output by Redact-It Enterprise. The following examples show an original, unredacted PDF document, and that same document published as a redacted TIFF rendition. All confidential information has been completely removed from the document according to the redaction definitions applied, and cannot be selected, copied, or printed. Original PDF before exportation through the Redact-It Plugin: Redacted TIFF output after processing with Redact-It Enterprise: In this case, the redaction script that was run identified and redacted all instances of addresses, phone numbers, social security numbers, and date of birth. Copyright 2010 Informative Graphics Corporation Page: 10

11 Copyright 2010 Informative Graphics Corporation Page: 11