IBM Email Manager 4.0.2 Fix Pack Readme: 4.0.2.5-EM-FP005

© Copyright IBM Corporation 2009. All Rights Reserved.

Readme file for: IBM Email Manager
Product/Component Release: 4.0.2
Update Name: Fix Pack 5
Fix ID: 4.0.2.5-EM-FP005
Publication date: 16 September 2009
Last modified date:

Contents:

About this fix pack:
 Download location
 Required products needed before installation
 New in this fix pack
 Known Issues

Installation information:
  Prior to installation
  Installing
  Uninstalling if necessary

List of fixes
Additional Information
Copyright and trademark information
Document change history


Download location:

Download Email Manager Version 4.0.2 Fix Pack 5 (4.0.2.5-EM-FP005) from the following location:
http://www.ibm.com/eserver/support/fixes/

Below is a list of products/components names, platforms, and file name(s) that apply to this readme file.

Product/Component Name:

Platform:

File Name:

UFI Server

Windows

update_ufi_402.005.233.msp

EM Server

Windows

update_em_server_402.005.233.msp

EM Shortcut Client

Windows

update_em_shortcut_client_402.005.233.msp



Required products needed before installation:

Product/Component Name:

Platform:

Email Manager 4.0.2 GA and Fix Pack 1

Windows

 

 

New in this fix pack:

 

As of EM 4.0.2 Patch 4 (4.0.2.4-EM-FP004) the following component is now supported (for Exchange and Lotus Notes connectors only):

 

·         Windows 2008

 

As of EM 4.0.2 Patch 3 (4.0.2.3-EM-FP003) the following components are now supported:

 

·         IBM Lotus Notes/Domino 8.5

·         IBM FileNet P8 4.5

·         Microsoft SQL Server 2008

 

 

Known issues:

 

Defect No.

Description

784412

Creating a large number of active collectors or task routes can cause the Email Manager server to run out of available threads and stop processing emails.  IBM recommends using one collector per task route and configuring no more than 8 active task routes per Email Manager server.  This recommendation does not impact the number of locations that can be monitored as each collector can contain multiple monitored locations and the task route architecture can allow for multiple branches within a single task route.

784406

Email Manager does not support the use of a separate database for storing duplicate hash keys.  Duplicate hash keys must be stored in the same database as the Email Manager configuration data.

760083

Performance counters for Exchange emails are incorrect.

 

 

Installation information:

 

Prior to installation:
 

1.      Back up the EM database

2.      Back up the following EM registry keys:

·         HKLM\SOFTWARE\IBM\EMRC\* (all keys)

·         HKLM\SYSTEM\CurrentControlSet\Services\Eventlog\Application\ibm.ctms.* (all keys that begin with “ibm.ctms.”)

3.      Back up the following EM xml configuration files:

·         On the EM Server, back up all xml files in UFI_4.0.2 folder.  These may include but are not limited to: UFIConfig.xml, P8Config.xml, DominoConnector.xml

·         Back up all xml files for the EM Client on client machines. These may include but are not limited to: P8WSConnector.xml, ClientGUI.xml, Catalog.xml, ClientGUI.lang.en-US.xml

 

Installing this patch:
  

1.      Extract the fix pack zipped file to the local file system.

2.       Stop all UFI, Email Manager and Records Crawler services (if installed):

·         UFI Task Routing Engine

·         UFI File System Connector

·         UFI Filesystem Repository Connector

·         UFI FileNet P8 Content Engine 3.x Connector

·         UFI FileNet P8 Content Engine 4.x Connector

·         UFI Microsoft Exchange Connector

·         UFI PST Connector

·         UFI GroupWise Connector

·         UFI Lotus Notes Domino Connector

·         UFI Services Components

·         UFI FileNet IS Connector

·         UFI Utility Service

3.      Stop any other applications that are running, including the Configuration Manager.

4.      In the directory where the zip file was extracted access the folder "UFI Server" and run:  update_ufi_402.005.233.msp

·         Note: 4.0.2.5-EM-FP005 and 4.0.2.5-RC-FP005 contain the same update for “UFI Server”.  If both EM and RC are installed on the same system, this update only needs to be run once.

5.      Upgrade Options (Note: “EM Server” update is available in the 4.0.2.5-EM-FP005 fix pack, while “RC Server” is included in the 4.0.2.5-RC-FP005 fix pack.  If both EM and RC are installed on the same system, upgrade UFI Server first, and then the specific RC Server and EM Server upgrades)

·         To upgrade Email Manager - In the directory where the zip file was extracted access the folder "EM Server" and run:  update_em_server_402.005.233.msp

6.      Restart the server

7.      Start the UFI Task Routing Engine service which will start all other required services


    Installing the Email Manager Shortcut Client patch:

 

1.      On any system with the Email Manager Shortcut Client installed, run: update_em_shortcut_client_402.005.233.msp

2.      Copy back onto the client systems the client xml files that you previously backed up.

     

   Installing the Email Manager Shortcut Client silently:

 

There are two components of the Email Manager Shortcut Client: The Server Component and the Client Component.

 

The Server Component should only be installed on the Email Manager server after UFI and Email Manager have been installed.  Do not install the Server Component on client machines.

 

The Client Component should be installed on each client machine.

 

Specific ADDLOCAL parameters are used to customize the installation:

 

Component Required

ADDLOCAL Parameter

Outlook Server Component

OutlookServ

Lotus Notes Server Component

LotusNotesServ

Outlook Client Component

Outlook

Lotus Notes Client Component

LotusNotesManual

Lotus Notes Client Component Advanced Shortcut with P8 4.X Support

P84X

Lotus Notes Client Component Advanced Shortcut with P8 3.X Support

P83X

 

Installing the Server Component silently:

 

On the Email Manager server, run the “IBM Email Manager Client.msi” installer from the GA media with the specific ADDLOCAL parameters indicated in the table above.  Standard Msiexec options may be used. 

 

Examples:

Microsoft Outlook Environment:

 

msiexec /i "\\Server\EmailManagerInstall\EM Shortcut Client\IBM Email Manager Client.msi" ADDLOCAL=OutlookServ /qn

 

Lotus Notes Environment:

 

msiexec /i "\\Server\EmailManagerInstall\EM Shortcut Client\IBM Email Manager Client.msi" ADDLOCAL=LotusNotesServ /qn

 

Patching the Server Component silently:

 

On the Email Manager server, run the “update_em_shortcut_client_402.xxx.xxx.exe” (patch 1 and 2) or the “update_em_shortcut_client_402.xxx.xxx.msp” (patch 3 and later) installer. 

 

Examples:

Patch 1 and 2:

 

"\\Server\EM-4.0.2-001\EM Shortcut Client\update_em_shortcut_client_402.001.169.exe" /S /v /qn

 

Patch 3 and later:

 

msiexec /update "\\Server\EM-4.0.2-003\Patch\EM Shortcut Client\update_em_shortcut_client_402.003.199.msp" /quiet /norestart

 

Installing the Client Component silently:

 

On the client machines, run the “IBM Email Manager Client.msi” installer from the GA media with the specific ADDLOCAL parameters indicated in the table above.  Standard Msiexec options may be used. 

 

Examples:

Microsoft Outlook Environment:

 

msiexec /i "\\Server\EM Shortcut Client\IBM Email Manager Client.msi" ADDLOCAL=Outlook /qn

 

Lotus Notes Environment with P8 4.x:

 

msiexec /i "\\Server\EM Shortcut Client\IBM Email Manager Client.msi" ADDLOCAL=LotusNotesManual,P84X /qn

 

Lotus Notes Environment with P8 3.x:

 

msiexec /i "\\Server\EM Shortcut Client\IBM Email Manager Client.msi" ADDLOCAL=LotusNotesManual,P83X /qn

 

Patching the Client Component silently:

 

On the client machines, run the “update_em_shortcut_client_402.xxx.xxx.exe” (patch 1 and 2) or the “update_em_shortcut_client_402.xxx.xxx.msp” (patch 3 and later) installer. 

 

Examples:

Patch 1 and 2:

 

"\\Server\EM-4.0.2-001\EM Shortcut Client\update_em_shortcut_client_402.001.169.exe" /S /v /qn

 

Patch 3 and later:

 

msiexec /update "\\Server\EM-4.0.2-003\Patch\EM Shortcut Client\update_em_shortcut_client_402.003.199.msp" /quiet /norestart

 

   Uninstalling this patch:
  

1.      In Add/Remove Programs, remove IBM Email Manager

2.      In Add/Remove Programs, remove IBM UFI

3.      Restore the EM database from backup

4.      Install IBM UFI from Email Manager GA media

5.      Install IBM Email Manager from Email Manager GA media

6.      Install IBM UFI Patch 1

7.      Install IBM Email Manager Patch 1

8.      Restore EM xml configuration files to EM installation directory

9.      Restore EM registry entries from backup

10.  Install desired patch



List of fixes:

 

APAR No.

Defect No.

Severity

Abstract

PJ36482

ecmdb00821893

2

OUTLOOK SHORTCUT KEYS DO NOT WORK WITH THE OUTLOOK CALENDAR WHEN THE EMAIL MANAGER OUTLOOK CLIENT ADD-IN IS ENABLED.

PJ36578 

ecmdb00836704

1

EMAIL MANAGER NOT CAPTURING ATTACHED .MSG FILES CORRECTLY

PJ36108 

ecmdb00801588

2

OUTLOOK INTEGRATION BEHAVIOR CHANGES AFTER EMAILS PROCESSED WITH POST PROCESSING A SECOND TIME.

PJ36107 

ecmdb00801161

2

SOME STUBBED EMAILS HAVE THEIR BODIES MISSING OR HAVE PARTIALLY COMPLETED LINKS TO P8.

PJ36459

ecmdb00828620

3

EMM METADATA GENERATION FAILS ON MESSAGES SENT EARLY ON 1ST DAY OF THE MONTH WITH ERROR: 'BIAS HOURS MUST BETWEEN 0 AND 23'

PJ36793

ecmdb00822228

3

GW SCRIPTS - PRIMARY/SECONDAY DOMAIN ISSUE

 PJ36794 

ecmdb00830360

2

GROUPWISE CONNECTOR XML GENERATION FAILS WHEN ACCESSING ADDRESS PROPERTIES OF MESSAGE RECIPIENTS

PJ36795 

ecmdb00830378

2

GROUPWISE CONNECTOR ERRORS CAN CAUSE INVALID METADATA TO BE INJECTED INTO THE TASK ROUTE

 

 

Additional Information:

 

As of EM 4.0.2 Patch 4 (4.0.2.4-EM-FP004)

 

 

Items

Descriptions

SUPPORT FOR WINDOWS 2008

Edit the registry using the following steps:
1. Locate and navigate to the following registry
    HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Perflib
2. If a “Configurations Flags” value exists, right-click Configuration Flags, and then click Modify. If the     

    Configuration Flags value does not exist, create a new DWORD (32 bit) value called “Configuration Flags” and 

    then click Modify.
3. Type 10000, and then click OK.

FILES DO NOT INGEST IF THE VALUE SET FOR PROPERTY IS NOT FOUND IN P8 CHOICE LIST

To change functionality such that files are added successfully to P8 even when a property mapped to a P8 choice list contains a value not found in the list, add the following entry to the p8Config.xml file (typically located in C:\Program Files\IBM\UFI_4.0.2):

 
<p8Config>
...
<ignore_invalid_property_value value="true"/>
...
</p8Config>

Audit Log now includes column headers for greater readability

Note: Headers in audit log only available if the option “One log per context” is enabled in Configuration Manage

Registry Key to Enable Use of Alternative Lotus API during address book lookup

 

In some instances, the address book lookup function in Email Manager encounters a performance limitation in Lotus Notes. To change the Notes API call used by Email Manager for this function, add a registry entry to:

 

Path:

HKLM\Software\IBM\EMRC\4.0\ServiceDeclarations2\ibm.ctms.lotusconnector

 

Name:

AddressBookLookupMode

 

Type:

DWORD

 

Values:

0 = NotesView.GetAllEntriesByKey           (existing behaviour, default if no value set)

1 = NotesView.GetAllDocumentsByKey    (alternative method of looking up addresses to work-around Notes performance issue)

GROUPWISE EMAILS THAT ARE FORWARDED AS ATTACHMENTS ARE NOT CAPTURED BY EM AS ATTACHMENTS OR OTHERWISE.

Description

 

The GroupWise connector extract attachments task has been enhanced to provide optional support for processing attached messages.  This includes:

 

1. - Extracting attachments from attached messages.

2. - Rendering attached messages to .fngwEntity (xml) format and/or RFC822/MIME text. This functionality is shared with the existing create file task and offers the same options.

 

These options are enabled using specific registry keys.  If the registry keys are not set, the behaviour of the extract attachments task is unchanged from the previous version.

 

Registry Keys

 

All new registry keys for the extract attachments enhancement are configured in:

 

HKLM\Software\IBM\EMRC\4.0\Settings\ibm.ctms.groupwise.Connector\ibm.ctms.groupwise.extractAttachments

 

The extract attachments task recognises the following keys:

 

Key:                ExtractEmbeddedAttachments

Type:               DWORD

Values:            1 - enabled, 0 - disabled

Default:           Disabled

 

If enabled, the extract attachments task recursively scans attached messages for file attachments and extracts them.  Note that the extract attachments task makes no distinction between attachments of the original message and attachments of attached messages.

 

Key:                ExtractEmbeddedMessages

Type:               DWORD

Values:            1 - enabled, 0 - disabled

Default:           Disabled

 

If enabled, the extract attachments task extracts attached messages and uses the create file task functionality to create one or more files that represent the attached message.  GroupWise does not have a native file format for email messages, so messages are rendered in either .fngwEntity (xml) and/or RFC822/MIME text formats. Attached messages within attached messages are also extracted. 

 

Either the ExtractEmbeddedMsgToXML and/or the ExtractEmbeddedMsgToText registry entries must also be set for this option to have any effect.

 

Key:                ExtractEmbeddedMsgToXML

Type:               DWORD

Values:            1 - enabled, 0 - disabled

Default:           Disabled

 

If enabled, attached messages are rendered in .fngwEntity (xml) format.  ExtractEmbeddedMessages must also be enabled to use this option.

 

Key:                EmbeddedMsgIncludeAttachments

Type:               DWORD

Values:            1 - enabled, 0 - disabled

Default:           Disabled

 

If enabled, file attachments contained within attached messages will be rendered within the .fngwEntity (xml) file using Base64 encoding.  ExtractEmbeddedMsgToXML must also be set.

 

Key:                EmbeddedMsgIncludeEmbedded

Type:               DWORD

Values:            1 - enabled, 0 - disabled

Default:           Disabled

 

If enabled, attached messages within attached messages will be rendered as nested elements within the .fngwEntity (xml) file.  ExtractEmbeddedMsgToXML must also be set.

 

Key:                ExtractEmbeddedMsgToText

Type:               DWORD

Values:            1 - enabled, 0 - disabled

Default:           Disabled

 

If enabled, attached messages are rendered in  RFC822/MIME text format.  ExtractEmbeddedMessages must also be enabled to use this option.

 

Key:                EmbeddedMsgTextExtension

Type:               STRING

Default:           .fngwText

 

If set, specifies the file extension for attached messages rendered in  RFC822/MIME text format.  ExtractEmbeddedMsgToText must also be enabled for this option to have any effect.

 

Key:                MetadataHierarchy

Type:               DWORD

Values:            1 - enabled, 0 - disabled

Default:           Disabled

 

This setting controls how containment relationships are represented in the metadata.  This option only has an effect if both ExtractEmbeddedAttachments and ExtractEmbeddedMessages are enabled.  If enabled, attachments and attached messages are linked to the message that contains them and multiple levels of attached messages are represented as a hierarchy.  If not enabled, the hierarchy is flattened and all attachments and attached messages are linked directly to the main message.

Disable folder references on any Notes databases that have them enabled.  This can be achieved:

- From the Domino Administrator by running the convert task on the server using the -m switch

- By creating a LotusScript agents that sets the NotesDatabase.FolderReferencesEnabled property to false

The server commands would be:

 

tell router quit

load convert -m <mailbox path>

load convert -m <mailbox path>

load router

 

The -m switch toggles folder references on and off, so you will only want to run it against databases that have folder references enabled.

 

You can use the -f switch to provide a list of mailboxes from a text file.

 

 

The other option is to create a LotusScript or Java agent.  The code would be something like (in LotusScript):

 

 

Sub Initialize

 

Dim session as New NotesSession

Dim db as NotesDatabase

 

Set db = session.CurrentDatabase

 

If db.FolderReferencesEnabled Then

  db.FolderReferencesEnabled = False

  MessageBox "Folder references have been disabled."

Else

  db.FolderReferencesEnabled = True

  MessageBox "Folder references have been enabled."

End If

 

End Sub

 

 

As of EM 4.0.2 Patch 3 (4.0.2.3-EM-FP003)

 

Items

Descriptions

ADDED OPTION FOR "RUN ONCE" SCHEDULE TO RUN IMMEDIATELY UPON SERVICE START IF START DATE IS IN PAST

If the following registry key is created on the Email Manager server:

 

[HKEY_LOCAL_MACHINE\SOFTWARE\IBM\EMRC\4.0\Scheduler\RunOnceOption]

"RunOldDateTime"=dword:00000001

 

the “Run Once” schedule will run at service start if the date is set in the past. If the key is missing or if it is equal to 0 then it should not run at service start.

MIME MESSAGES CAPTURED IN DXL FORMAT CANNOT BE CONTENT INDEXED BY VERITY

P8’s Verity engine content-based indexing of DXL files uses a standard XML filter to extract the text from the file.  This works effectively with DXL files generated from Lotus Notes email messages in Notes Rich Text format (NRTF), but not for messages in MIME format, because the MIME body and headers are encoded in the DXL file in Base64 encoded elements.  The Lotus Connector can now convert MIME messages to Notes Rich Text format, resulting in a DXL file that can be content indexed and searched.

 

This feature is controlled by two new DWORD registry entries that need to be created in the following path:

 

HKLM\Software\IBM\EMRC\4.0\ServiceDeclarations2\ibm.ctms.lotusconnector\ibm.ctms.lotusconnector.rendertofile

 

ConvertMIMEToNRTF

- Set to a value of 1 to force MIME to NRTF conversion

- If missing or 0, no conversion occurs (current behaviour)

 

SaveConvertedMIME

- Only has an effect if ConvertMIMEToNRTF = 1

- Set to a value of 1 to force the converted MIME message to be saved in the original location in NRTF format.

- If set to 0 or missing, the conversion will be performed when exporting to DXL, but the original message will not be updated in the source mailbox.

 

The following caveats apply to this feature:

 

- Conversion is lossy.  Some embedded images and formatting may not be converted accurately.

- Using the conversion means the captured message is not exactly the same as the message the user received.

- The setting is global. You cannot enable MIME to NRTF conversion in some task routes and not in others.

- This setting is not compatible with the MIME export option 'Preserve MIME content' and export of MIME messages to text will result in a text file with reduced fidelity (e.g. no attachments, embedded images etc.).

GROUPWISE CONNECTOR IS UNABLE TO EXCLUDE "INBOX" AND "SENT ITEMS" FOLDERS IN MONITORED LOCATION

The GroupWise Connector has been updated to improve the handling of sub-locations (folders) within mailboxes.  Specifically, the GroupWise Collector now supports:

 

- Processing any system folders that may contain messages (e.g. Mailbox, Sent Items, Trash) as either include or exclude folders.

- Processing query folders (where the folder contents are dynamic, based on the results of a query) as either include or exclude folders.

- Using include folders in conjunction with the 'Collect from all accounts' option.  (Only messages in the specified folders are collected.)

- Using exclude folders in conjunction with the 'Collect from all accounts' option.  (All messages are collected except for those in the specified folders.)

- Using the folder depth setting with either include or exclude folders.

- Including or excluding the mailbox root. (Enter '/' as the folder name to refer to the mailbox root)

- Specifying folder paths without the leading slash (e.g. '/Clients/ACME' and 'Clients/ACME' are equivalent)

- Enhanced collector logging.

CE 4.0.1-002 fix for error when adding large documents to CE through the .NET API.

There was an issue in P8 Content Engine 4.0.1 related to adding large documents through the .NET API.  This issue was documented in APAR PJ32624 and resolved in CE 4.0.1 Fix Pack 2.  Note this fix also required a Microsoft fix for WSE described in KB943508.  After applying the Fix Pack to the CE server, the update must also be applied to Email Manager 4.x and Records Crawler 4.x servers.  Instructions for applying CE API updates on Email Manager and Records Crawler servers are below:

 

1. Install the CE Fix Pack on the CE server following instructions in the readme file.

2. Update any CE Client machines (for example, any machine with FileNet Enterprise Manager installed) by applying the CE Fix Pack following the instructions in the readme file.

3. On all Email Manager and Records Crawler 4.0.2 servers, back up the existing FileNet.API.dll in the UFI install directory.

4. Manually copy the FileNet.API.dll from one of the patched CE Client machines (for example: C:\Program Files\FileNet\ContentEngine) to the installation directory of Email Manager or Records Crawler (for example: C:\Program Files\IBM\UFI_4.0.2). 

Upgrading EM 4.0.1 to EM 4.0.2

If upgrading from EM 4.0.1 to 4.0.2 ensure that the following files in the installation folder C:\Program Files\IBM\UFI_4.0.2 are used from EM 4.0.2 Patch 1 or later:

 

  • UtilityConnectorMigration.sql
  • 401to402.exe

 

Contact IBM support for complete migration instructions.

Email Manager Shortcut Client Full Installer

Included in Email Manager 4.0.2 Fix Pack 3 is the full installer for Email Manager Shortcut Client. This full installer can be used if deploying the Client to new users without needing to install the GA and Fix Pack 2.

Installing the stand-alone DXL Viewer

Included in Email Manager 4.0.2 Fix Pack 3 is a stand-alone installer for the DXL Viewer application. Previously the DXL Viewer was only available on the Email Manager Server installation media.

 

 

 

Copyright and trademark information:

http://www.ibm.com/legal/copytrade.shtml

Notices:

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.

Microsoft, Windows, and Windows Server are trademarks of Microsoft Corporation in the United States, other countries, or both.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

Other company, product, or service names may be trademarks or service marks of others.

THIRD-PARTY LICENSE TERMS AND CONDITIONS, NOTICES AND INFORMATION

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:

  • The Excluded Components are provided on an "AS IS" basis
  • IBM DISCLAIMS ANY AND ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS WITH RESPECT TO THE EXCLUDED COMPONENTS, INCLUDING, BUT NOT LIMITED TO, THE WARRANTY OF NON-INFRINGEMENT OR INTERFERENCE AND THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  • IBM will not be liable to you or indemnify you for any claims related to the Excluded Components
  • IBM will not be liable for any direct, indirect, incidental, special, exemplary, punitive or consequential damages with respect to the Excluded Components.

 

Document change history: