IBM Support

Additional product information for IBM eDiscovery Manager Version 2.2 Fix Pack 1

News


Abstract

This technote contains information about IBM eDiscovery Manager Version 2.2 Fix Pack 1 that was not available when the help system was incorporated into the product and when the product information was published in the IBM Archive and eDiscovery Solution Information Center on ibm.com.

Content

The information in this technote is a supplement to the following product information:


These release notes include additional and updated information about:

  • Upgrade and installation of eDiscovery Manager
  • Migration
  • Configuration
  • Using eDiscovery Manager
  • Developing

1. Upgrade and installation of eDiscovery Manager

1.1 Installation and upgrade scenarios

You can install eDiscovery Manager Version 2.2 Fix Pack 1 only on systems that are already running version 2.2. Version 2.2 of eDiscovery Manager is a prerequisite for version 2.2 Fix Pack 1.

1.2 Before you upgrade to eDiscovery Manager Version 2.2 Fix Pack 1

Before you upgrade to eDiscovery Manager Version 2.2 Fix Pack 1:

  • Verify that your system meets the minimum hardware and software requirements that are listed in System requirements for IBM eDiscovery Manager Version 2.2 Fix Pack 1.
  • Temporarily disable the following features, if relevant:

    • The following information is specific to IBM Content Manager. If the deferred DDL execution feature of Content Manager EE is enabled, temporarily disable it. You can re-enable this feature after installing eDiscovery Manager.

      The following information is specific to IBM FileNet P8. If the object store is configured to use date partitioning during content-based retrieval, temporarily disable date partitioning by using FileNet Enterprise Manager. You can re-enable this feature after installing eDiscovery Manager.

1.3 Locales for multi-byte languages must support Unicode

The following information is specific to AIX When the locale of the user ID for the eDiscovery Manager application server is set to a multi-byte language, such as Japanese or Chinese, it is important that the locale supports Unicode (UTF-8). Otherwise, you might encounter problems when exporting email to Lotus Domino.

For example, to enable Unicode support for Japanese, set export LANG=jp_JP.UTF-8 in the .profile file for the user ID.

1.4 Installation program supports HTTPS

The following information is specific to IBM FileNet P8. Beginning in eDiscovery Manager Version 2.2 Fix Pack 1, the installation program supports the HTTPS protocol.

When the installation program prompts you for the web address of the IBM FileNet Content Engine, the text on the screen indicates that HTTPS is not supported. However, you can enter a web address that uses the HTTPS protocol if you choose.

1.5 Security update for Microsoft Visual C++ 2005 Service Pack 1 Redistributable Package required for sites with Lotus Notes email archives

An MFC security update for the Microsoft Visual C++ 2005 Service Pack 1 Redistributable Package is free and available from Microsoft Support (KB article 2538242). See the following web page for details and download instructions, and be sure to download the vcredist_x86.EXE file, even if you have a 64-bit operating system.

www.microsoft.com/download/en/details.aspx?id=26347

If your site has one or more Lotus Notes email archives, install this update at your earliest convenience; it is required for the proper functioning of the Lotus Notes native viewing and export features.

2. Migration

2.1 Supported migration path from IBM eMail Search

If you are migrating from IBM eMail Search, you must:

  1. Install eDiscovery Manager Version 2.1.
  2. Migrate from IBM eMail Search.
  3. Upgrade to eDiscovery Manager Version 2.1.1.
  4. Upgrade to eDiscovery Manager Version 2.2.
  5. Upgrade to eDiscovery Manager Version 2.2 Fix Pack 1.

    3. Configuration

    3.1 Database tuning to improve performance (FileNet P8)

    The following information is specific to IBM FileNet P8. The following information is specific to IBM Content Collector. If you created any of the indexes in the "Improving searching and task setup" section of the topic Database tuning to improve performance (FileNet P8), delete those indexes. Several of the indexes were incorrect and others are duplicates of FileNet P8 system indexes. Re-create only those indexes that are mentioned in the "Database tuning to improve performance (FileNet P8)" section of the Documentation updates for IBM eDiscovery Manager Version 2.2 technote.

    4. Using eDiscovery Manager

    4.1 Selecting the Sort option when searching impacts performance

    The following information is specific to IBM FileNet P8. When a user selects the Sort option for a search across a broad date range, search response time slows down significantly.



    For optimal performance of searches across a broad range of dates when the Sort option is selected, set the FullTextRowDefault property of the IBM FileNet P8 object store.

    4.2 Changes in scheduled search behavior

    The following changes have been made to scheduled search behavior in eDiscovery Manager Version 2.2 Fix Pack 1:

    • By default, scheduled searches will continue to return only the content that is not already saved in folders in the case. But beginning in this release, you can now disable this behavior by clearing the Show only results not already in the case option in the Schedule Search window.
    • You can now specify a start date and time in the past. For example, if today is 2/1/2011 and the time is 13:42, you could specify a start date of 1/31/2011 and a start time of 12:01. Searches with a start date and time in the past run as soon as possible after being saved.
    • The default start time is the current time plus 15 minutes, and then the time is rounded up to the next 15 minute interval as necessary. For example, if you begin creating a scheduled search at 9:32, the default start time is 10:00. If you begin creating a scheduled search at 9:44, the default start time is also 10:00.
    • In the Repeat interval field, you can specify a number of days between 1 and 366.

    4.3 The View report as XML icon downloads an audit report

    Clicking the View report as XML icon now downloads audit reports that are larger than 10 MB. Audit reports that are smaller than 10 MB are still displayed in a new browser window.


    4.4 Searching for audit records by user

    The following information is specific to IBM FileNet P8. Searching audit records by specifying user names can produce incorrect search results. This procedure should be completed only after the eDiscovery Manager installation is complete.



    To prevent this issue:
    1. Navigate to the scripts subdirectory in the eDiscovery Manager installation directory.
    2. Run the updateAuditRecords script with the appropriate syntax for the eDiscovery Manager system:

      The following information is specific to Windows.
        updateAuditRecords.bat WAS_HOME P8_ADMINISTRATOR_USER_ID P8_ADMINISTRATOR_PASSWORD P8_PROTOCOL WAS_PROFILE_NAME WAS_CELL_NAME

      The following information is specific to AIX
        updateAuditRecords.sh WAS_HOME P8_ADMINISTRATOR_USER_ID P8_ADMINISTRATOR_PASSWORD P8_PROTOCOL WAS_PROFILE_NAME WAS_CELL_NAME

      Where:
      • P8_PROTOCOL is WSI_HTTP, WSI_HTTPS, or IIOP depending on the protocol you are using to connect to IBM FileNet P8
      • WAS_PROFILE_NAMEis the name of the WebSphere Application Server profile. For example, if the profile is called Appsrv02 , then Appsrv02 would be specified in place of this variable. The profile name is case-sensitive. For example, if the profile name is Appsrv02, then APPsrv02 will not work.
      • WAS_CELL_NAME is the name of the WebSphere Application Server cell where eDiscovery Manager is deployed. To find the cell name, look in the directory, edmhome>/scriptsWAS/appdeploy.properties. The cell name is listed at the bottom of the directory. For example, cellname=worldcomCell01. In this instance, the cell name is worldcomCell01.

      Note: If you encounter the following error when you run the script, the case for one or both of the variables WAS_HOME and WAS_PROFILE_NAME might be incorrect:

      java.lang.NoClassDefFoundError: com.filenet.api.core.InstantiatingScope
      The following information is specific to Windows. Note: When running the updateAuditRecords script, ensure that the paths do not contain any spaces. For paths that contain spaces, use the Windows short names instead, for example, C:\Progra~1\IBM.

      For example, if the WAS_HOME directory is C:\Program Files\IBM\WebSphere\AppServer, use the windows short name, C:\PROGRA˜1\IBM\WebSphere\AppServer, instead.

      Important: The C:\PROGRA˜1 short name is case sensitive, so if you typed the short name in lowercase, c:\progra˜1, the command will fail.

      To determine the short name for c:\Program Files:
      1. cd c:
      2. dir * /x

      The following information is specific to Windows. Example 1

      updateAuditRecords.bat c:\PROGRA˜1\IBM\WebSphere\AppServer administrator th2nkp0d WSI_HTTP Appsrv02 edisp21Node02Cell



      The following information is specific to AIX Example 2

      ./updateAuditRecords.sh /usr/IBM/WebSphere/AppServer admnistrator passwrd8 WSI_HTTP Appsrv02 edisp21Node02Cell



    4.5 Special characters in attachment names are replaced with underscores when attachments are exported

    Beginning in this release, if any of the following special characters are used in attachment names, they are replaced with an underscore ( _ ) when the attachments are exported.

    The following information is specific to Windows.

    & (ampersand)> (less than)
    * (asterisk)| (pipe)
    \ (back slash)? (question mark)
    : (colon)" (quotation mark)
    / (forward slash)\t (tab character)
    < (greater than)

    The following information is specific to AIX
    • & (ampersand)
    • / (forward slash)


    5. Developing

    5.1 CreateScheduledSearch

    The Query parameter of the CreateScheduledSearch REST API can contain only terms that correspond to the fields in the template that is specified in the SearchTemplateName parameter. Otherwise, an error message with the code DYRS2105E is returned.


    5.2 Extending export format plug-in classes

    The first step in creating your own export format plug-in is to give your plug-in its own class name and specify the signatures of the plug-in that you want to extend. Your plug-in must extend one or both of the following classes:
    • ExtractPlugin.java

      A plug-in that extends the ExtractPlugin class can only call methods in ExtractPlugin.java. It cannot call methods in BatchCompletePlugin.java and it cannot call methods inherited from the BaseExportPluginImpl class that the ExtractPlugin class extends.

    • BatchCompletePlugin.java

      A plug-in that extends the BatchCompletePlugin class can only call methods in BatchCompletePlugin.java. It cannot call methods in ExtractPlugin.java and it cannot call methods inherited from the BaseExportPluginImpl class that the BatchCompletePlugin class extends.

      Your plug-in can also call methods in these additional classes:
      • ExtractedDocumentInfo.java
      • PluginException.java
      *********************************

      Updates to the product information

      To view updates to the eDiscovery Manager product information, see Documentation updates for IBM eDiscovery Manager Version 2.2.

      Change history

      HistoryDateChange
      Updated section 4.4April 2012Updated the syntax and examples, and added information about how to determine a Windows short name for a directory. Also updated descriptions of parameters and added procedure for finding WAS cell names.
      Updated section 1.5July 2011Updated URL and added KB article number.
      Added section 1.5June 2011Added security update requirement for sites with Lotus Notes email archives.
      Updated section 4.4May 2011Corrected the P8 protocol in the examples.
      Clarified the value of eDM_WAS_Profile.
      ReleasedApril 2011

      [{"Product":{"code":"SS8JHU","label":"eDiscovery Manager"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"--","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF033","label":"Windows"}],"Version":"2.2.0.1","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

      Document Information

      Modified date:
      17 June 2018

      UID

      swg21457008