You are on page 1of 127

Open Text® Email

Archiving/Management for Lotus Notes®

Installation Guide

This guide describes the installation and configuration of the


Open Text Email Archiving Bridge for Lotus Notes, the Livelink
ECM – Explorer Professional (as part of Email Management),
Livelink ECM – Explorer E-mail (as part of Email Archiving),
Open Text Email Managed Folders for Lotus Notes, Livelink
ECM – Records Management, the Livelink ECM – Email
Management Services, and Livelink ECM – Billing and Quota
Management, which are part of Livelink ECM - Email
Archiving/Management for Lotus Notes 9.7.5.

NA090705-IGD-EN-2
Open Text® Email Archiving/Management for Lotus Notes®
Installation Guide
NA090705-IGD-EN-2
Rev.: 2010-June-18
This documentation has been created for software version Version 9.7.5.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
E-mail: support@opentext.com
FTP: ftp://ftp.opentext.com
For more information, visit http://www.opentext.com

Copyright © by Open Text Corporation, Open Text Inc.


Open Text Corporation is the owner of the trademarks Open Text, The Content Experts, Great Minds Working Together,
Livelink, Livelink ECM, Livelink ECM-eDOCS, Livelink MeetingZone, MeetingZone, B2BScene, B2BScene.com, Client/Surfer,
Collaboration, Creative Desktop, Further Faster, Hyperinnovation, Internet Anywhere ,Livelink IRIMS, IRIMS, IXOS, Livelink
OnTime, OnTime, Livelink Remote Cache, Microstar, MyLivelink, O & Design, Odesta, Odesta Helix, Odesta Livelink, Open
Text Intranet, Open Text Web Index, Personality +, Putting Knowledge To Work, Techlib, The Hyperlinked Organization, The
Source For Business Knowledge, Worksmart, and World Of E among others. This list is not exhaustive.
ACKNOWLEDGEMENTS
SAP®, R/3® and SAP ArchiveLink® are registered trademarks of SAP AG.
Adobe® is a trademark of Adobe Systems Incorporated.
Lotus® and Lotus Notes® are registered trademarks of Lotus Development Corporation. Domino is a trademark of Lotus
Development Corporation.
Microsoft®, Microsoft SQL®, and Microsoft SharePoint® are either registered trademarks or trademarks of Microsoft
Corporation in the United States and/or other countries.
Oracle® is a registered trademark of Oracle Corporation.
Netscape and the Netscape N and Ship's Wheel logos are registered trademarks of Netscape Communications Corporation in
the U.S. and other countries.
Firefox® is a registered trademark of the Mozilla Foundation.
Sentry Spelling-Checker Engine Copyright © 2000 Wintertree Software Inc.
WordNet 2.0 Copyright © 2003 by Princeton University. All rights reserved.
Outside In® Viewing Technology © 1992-2002 Stellent Chicago, Inc. All rights reserved. Outside In® HTML Export © 2002
Stellent Chicago, Inc. All rights reserved.
Portions of eDOCS DM are copyrighted by DataDirect Technologies, 1991-2002.
All other products or company names are used for identification purposes only, and are trademarks of their respective own-
ers. All rights reserved.
Table of Contents

PRE Introduction ............................................................................... 7


i Structure of the Documentation ............................................................... 7
ii Conventions ............................................................................................. 8
iii Abbreviations, Acronyms and Terms ..................................................... 10
iv Contact Information................................................................................ 10

1 About Open Text Email Archiving/Management for Lotus


Notes ........................................................................................ 13
1.1 Architectural Overview ........................................................................... 15
1.2 Components........................................................................................... 15
1.3 Order of installation ................................................................................ 18

2 Installing Open Text Email Managed Folders for Lotus


Notes on Livelink..................................................................... 19
3 Installing and Administering Email Management Services
on Livelink ............................................................................... 21
3.1 Installing Email Management Services .................................................. 21
3.2 Configuring Livelink ECM – Email Services........................................... 21
3.3 Configuring Livelink ECM – Email Management Settings ..................... 25

4 Installing and Administering Livelink ECM – Explorer


Professional and Livelink ECM – Explorer E-mail on
Livelink..................................................................................... 29
4.1 Installing the Modules on Windows........................................................ 29
4.2 Installing the Modules on UNIX.............................................................. 30
4.3 Adding the Modules to Livelink .............................................................. 30
4.4 Uninstalling Livelink Explorer ................................................................. 31
4.5 Distributing the Clients Using the MSI Package .................................... 32
4.6 Completing the Client Installation .......................................................... 34
4.7 Uninstalling the Client Using the MSI Package ..................................... 36

5 Installing and Administering Livelink ECM – Billing and


Quota Management on Livelink.............................................. 37
5.1 Verifying Installation Requirements ....................................................... 37
5.2 Installing the Email Billing & Quota Management Module ..................... 37

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes iii


Table of Contents

5.3 Uninstalling Email Billing & Quota Management ................................... 38


5.4 Enabling the Quota Management Agent................................................ 38
5.5 Configuring Settings............................................................................... 39

6 Installing or Upgrading the Livelink ECM – Records


Management Module ...............................................................43
6.1 Verifying Installation Requirements ....................................................... 43
6.2 Installing the Records Management Module ......................................... 44
6.3 Upgrading the Records Management Module ....................................... 44
6.4 Uninstalling Records Management ........................................................ 44

7 Creating and Testing an RSI, a Retention Schedule, and a


Classification ...........................................................................45
7.1 Configuring Managed Objects ............................................................... 45
7.2 Populating Code Tables......................................................................... 47
7.3 Creating Record Series Identifiers ......................................................... 48
7.4 Creating Retention Schedules ............................................................... 49
7.5 Creating RM Classifications................................................................... 52
7.6 Testing the System ................................................................................ 54

8 Installing Open Text Email Composer for Lotus Notes on


Archive Server .........................................................................59
8.1 First-Time Installation of Email Composer on Archive Server ............... 61
8.2 Upgrading Email Composer on Archive Server 9.6.1 ............................ 65
8.3 Checking the Installation........................................................................ 66
8.4 Configuration Parameters ...................................................................... 66

9 Prerequisites for Installing the Email Archiving Bridge for


Lotus Notes..............................................................................71
9.1 Platform Requirements .......................................................................... 71
9.2 Archive Server Prerequisites ................................................................. 73
9.3 Email Archiving Bridge for Lotus Notes Prerequisites ........................... 73
9.4 Synchronization Service ........................................................................ 74
9.5 Users and Permissions .......................................................................... 74

10 Installing the Email Archiving Bridge for Lotus Notes..........77


10.1 Installing and Configuring the Archiving Service and the
Synchronization Service ........................................................................ 77
10.2 Installing the Database Templates on Lotus Domino ............................ 84
10.3 Preparing the Archive Configuration and Management Facility
(ACMF)................................................................................................... 85
10.4 Configuring Domino Web Access/Lotus iNotes ..................................... 85

11 Additional Settings and Functions .........................................95


11.1 Service.ini Parameters........................................................................... 95

iv Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Table of Contents

11.2 Changing the Password of the Archiving Service or Synchronization


Service User......................................................................................... 102
11.3 Changing the Interval for the Automatic Restart of the Archiving
Service ................................................................................................. 102
11.4 The “recreate stub” Feature in Livelink Explorer.................................. 103

12 Configuring the Archiving Bridge as a Windows Cluster


Application............................................................................. 105
13 Upgrading to Open Text Email Archiving/Management for
Lotus Notes 9.7.5................................................................... 113
13.1 Upgrading a Standard Environment..................................................... 113
13.2 Upgrading an Environment with Multiple Lotus Domino Servers and
Archiving Bridges ................................................................................. 116

14 Removing Open Text Email Archiving/Management for


Lotus Notes ........................................................................... 121
GLS Glossary................................................................................. 123
IDX Index....................................................................................... 125

NA090705-IGD-EN-2 Installation Guide v


Preface
Introduction
Note: Due to an ongoing rebranding process, the product name prefixes are
gradually changed from Livelink ECM to Open Text.
This document provides an overview of the features of Open Text Email Archiving
for Lotus Notes and Open Text Email Management for Lotus Notes. It describes the
installation and customizing of this software.
Note: Although this guide includes some instruction regarding setting up
other products to work with Open Text Email Archiving for Lotus Notes, you
should refer to the documentation for those products for more complete setup
and configuration information.
Product CD- Open Text Email Management for Lotus Notes software is available in the Open
ROM Text Knowledge Center as product ISO image, see
https://knowledge.opentext.com/knowledge/llisapi.dll/open/13001295. This
guide assumes that you burn the ISO image on a CD-ROM or DVD. Accordingly,
this documentation refers to the product CD-ROM. Alternatively, you can also
mount the ISO image, however, this is not covered by this documentation.
Product You can find the complete product documentation for Open Text Email Archiving
Documentation for Lotus Notes in the Open Text Knowledge Center
(https://knowledge.opentext.com/knowledge/). Additional information on the
installation and the most recent information on requirements can be found in the
Release Notes.

i Structure of the Documentation


Structure Target Group
• Installation guide The Installation guide and the Administration guide are written for
• Administration Open Text Email Archiving/Management for Lotus Notes adminis-
guide trators, archive administrators and Lotus Notes project managers.

• User guide The User guide target group is the Lotus Notes and Open Text Email
Archiving/Management for Lotus Notes user community, sup-
ported by an administrator.

Familiarity of working with IBM Lotus Domino, Lotus Notes, Domino Web
Access/Lotus iNotes, Microsoft Windows, and Unix-like operating systems is
necessary to take full advantage of these documents.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes vii


Introduction

Livelink® ECM - Email Archiving/Management for Lotus Notes® - Installation


Guide
This guide consists of the following chapters:
Chapter 1: “About Open Text Email Archiving/Management for Lotus Notes”.......13
Chapter 2: “Installing Open Text Email Managed Folders for Lotus Notes on
Livelink”................................................................................................................................19
Chapter 3: “Installing and Administering Email Management Services on
Livelink”................................................................................................................................21
Chapter 4: “Installing and Administering Livelink ECM – Explorer Professional
and Livelink ECM – Explorer E-mail on Livelink” .........................................................29
Chapter 5: “Installing and Administering Livelink ECM – Billing and Quota
Management on Livelink” ..................................................................................................37
Chapter 6: “Installing or Upgrading the Livelink ECM – Records Management
Module” ................................................................................................................................43
Chapter 7: “Creating and Testing an RSI, a Retention Schedule, and a
Classification”.......................................................................................................................45
Chapter 8: “Installing Open Text Email Composer for Lotus Notes on Archive
Server”...................................................................................................................................59
Chapter 9: “Prerequisites for Installing the Email Archiving Bridge for Lotus
Notes”....................................................................................................................................71
Chapter 10: “Installing the Email Archiving Bridge for Lotus Notes” .........................77
Chapter 11: “Additional Settings and Functions” ...........................................................95
Chapter 12: “Configuring the Archiving Bridge as a Windows Cluster
Application” .......................................................................................................................105
Chapter 13: “Upgrading to Open Text Email Archiving/Management for Lotus
Notes 9.7.5”.........................................................................................................................113
Chapter 14: “Removing Open Text Email Archiving/Management for Lotus
Notes”..................................................................................................................................121

ii Conventions
Read the following conventions before you use this documentation.
Typography In general, this documentation uses the following typographical conventions:
New terms
This format is used to introduce new terms, emphasize particular terms,
concepts, long product names, and to refer to other documentation.
User interface
This format is used for elements of the graphical user interface (GUI), such as
buttons, names of icons, menu items, names of dialog boxes, and fields.
Filename
command
sample data
This format is used for file names, paths, URLs, and commands at the command
prompt. It is also used for example data, text to be entered in text boxes, and
other literals.

viii Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Introduction

Note: If a guide provides command prompt examples, these examples may


contain special or hidden characters in the PDF version of the guide (for
technical reasons). To copy commands to your application or command
prompt, use the HTML version of the guide.
Key names
Key names appear in ALL CAPS, for example:
Press CTRL+V.
<Variable name>
The brackets < > are used to denote a variable or placeholder. Enter the correct
value for your situation, for example: Replace <server_name> with the name of
the relevant server, for example serv01.
Hyperlink
Weblink (e.g. http://www.opentext.com)
These formats are used for hyperlinks. In all document formats, these are active
references to other locations in the documentation (hyperlink) and on the Inter-
net (Weblink), providing further information on the same subject or a related
subject. Click the link to move to the respective target page. (Note: The hyperlink
above points to itself and will therefore produce no result).
Cross- The documentation uses different types of cross-references:
references

Internal cross-references
Clicking on the colored part of a cross-reference takes you directly to the target
of the reference. This applies to cross-references in the index and in the table of
contents.
External cross-references
External cross-references are references to other manuals. For technical reasons,
these external cross-references often do not refer to specific chapters but to an
entire manual. If a document is available in HTML format, external references
can be active links though, that directly lead you to the corresponding section in
the other manual.1
Tip: Tips offer information that make your work more efficient or show
alternative ways of performing a task.
Note: Notes provide information that help you avoid problems.

Important
If this important information is ignored, major problems may be
encountered.

1 This applies, if target and source document are shipped together, e.g. on a product or documentation CD-ROM.

NA090705-IGD-EN-2 Installation Guide ix


Introduction

Caution
Cautions contain very important information that, if ignored, may cause
irreversible problems. Read this information carefully and follow all
instructions!

iii Abbreviations, Acronyms and Terms


A list of abbreviations used in this documentation is given in the table below.

ACL Access Control List


ACMF Archive Configuration and Management Facility
AID Archive Identifier
CGI Common Gateway Interface
DAP Database Archiving Profile
DAPT Database Archiving Profile Template
DAT Data (file extension)
DWA Domino Web Access
DXL Domino Extended Markup Language
GUI Graphical User Interface
LAPI Livelink Application Programming Interface
NSF Notes Storage Facility (file extension)
NTF Notes Template File (file extension)
RMI Remote Method Invocation (Java)
RTF Rich Text Format
SIA Single Instance Archiving
SSL Secure Sockets Layer
TCP Transmission Control Protocol
UNID Unique Identifier
SCM Windows Service Control Manager

iv Contact Information
Open Text Online is a single point of access for the product information provided by
Open Text. Depending on your role, you have access to different scopes of
information (see below for details).

x Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Introduction

You can access Open Text Online via the Internet at http://online.opentext.com/ or
the support sites at http://support.opentext.com/.
The following information and support sources can be accessed through Open Text
Online:
Knowledge Center
Open Text's corporate extranet and primary site for technical support. It is the
official source for:
• Open Text products and modules.
• Documentation for all Open Text products.
• Open Text Developer Network (OTDN): developer documentation and
programming samples for Open Text products.
• Patches for Open Text products.
The following role-specific information is available:
Partners
• Information on the Open Text Partner Program.
• Programs and support for registered partners.
Business Users
• Tips, help files, and further information from Open Text staff and other users
in one of the Open Text online communities
Administrators/developers
• Downloads and patches
• Documentation
• Product information
• Discussions
• Product previews
Feedback on If you have any comments, questions, or suggestions to improve our
documentation documentation, contact us by e-mail at documentation@opentext.com.

NA090705-IGD-EN-2 Installation Guide xi


Chapter 1
About Open Text Email Archiving/Management for
Lotus Notes
Importance of In recent years, email traffic has come to play a more complex role in daily business
Emails for activities. As a result, the volume of documents that need to be stored and managed,
Business
some for several years, has increased. Legal aspects play an important role here, too.
Advantages of Open Text Email Archiving/Management for Lotus Notes provides an archiving
Archiving solution that helps you save disk space on your email systems, helps you comply
with regulations, and makes your business more efficient. Open Text Email
Archiving/Management for Lotus Notes considerably reduces the amount of data
stored on Lotus Domino servers, enabling them to perform better. Additionally, it
requires significantly less hard disk space for backup and data storage while
optimizing the administration time. You can achieve this by archiving emails,
attachments, and entire databases.
Two Solutions – Two Open Text solutions are available for archiving Lotus Notes
emails: Email Archiving for Lotus Notes and Email Management for Lotus Notes.
Both solutions have the same core components: Archive Server, Enterprise Server
(including email specific modules), Archiving Bridge, and client components.
Archiving Email Archiving for Lotus Notes, which is the standard solution, focuses on
archiving and managing personal emails by users. This solution features the
Livelink ECM – Explorer E-mail client for accessing and full-text searching archived
emails in the Livelink personal email volume.
Management Email Management for Lotus Notes includes all Email Archiving for Lotus Notes
features. Email Management for Lotus Notes also focuses on managing business-
relevant emails. The manage layer extends the storage layer to support legal
discovery processes and structured retention management of all emails within an
email system. This solution features the Livelink ECM – Explorer Professional client
for managing and full-text searching of archived emails in Livelink, especially
intended for Livelink ECM – Records Management.
Component This documentation describes the components of both solutions. All features of
Documentation Email Archiving for Lotus Notes are included in Email Management for Lotus
Notes. The exclusive features of Email Management for Lotus Notes are marked in
the text. The term Email Archiving for Lotus Notes is used to describe the product.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 13


Chapter 1 About Open Text Email Archiving/Management for Lotus Notes

Livelink With Email Management for Lotus Notes, exporting emails from Lotus Notes to
Integration Livelink ECM – Enterprise Server is done by dragging and dropping in the Lotus
Notes mail database. Additionally, an Livelink window can be opened directly in
the Lotus Notes mail database. Administrators can define certain settings for the
integration of the Livelink into the Lotus Notes mail database.
Customizable Email Archiving for Lotus Notes provides a variety of possibilities for customizing
Archiving your archiving environment. For example, you can archive your emails
automatically (scheduled archiving) or interactively. Interactive archiving and the
display of archived objects are based on Lotus Notes custom forms. To save disk
space, Email Archiving for Lotus Notes provides Single Instance Archiving. With
this functionality, an attachment that several users want to archive is archived only
once and is referenced with the individual emails.
Offline Access Automatic and interactive synchronization of archived emails lets you access
archived emails offline. Automatic synchronization is very convenient if you do not
want to sort your emails manually for synchronization. Interactive synchronization
is a fast method to synchronize only those archived messages that you really need
for offline access.
Web Access If no Lotus Notes client is available, you can access your archived emails with
Domino Web Access/Lotus iNotes (DWA). The functionality of Email Management for
Lotus Notes is not available via DWA or Lotus iNotes, respectively.
Windows Cluster Microsoft Windows cluster support guarantees high availability of the Archiving
Application Service, which is the central component of Email Archiving for Lotus Notes.

14 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


1.1 Architectural Overview

1.1 Architectural Overview

Figure 1-1: A Possible Email Archiving for Lotus Notes Environment

1.2 Components
Server Components of Open Text Email Archiving for Lotus Notes
Open Text Email Archiving Bridge for Lotus Notes
The Email Archiving Bridge for Lotus Notes is the main component of the Email
Archiving for Lotus Notes solution. It consists of two parts: the Archiving
Service and the Database templates.
• Archiving Service
The Archiving Service is a Windows service that handles all archive, restore,
retrieve and copy back requests on the Archive Server. All requests are
queued in an Order Database.

NA090705-IGD-EN-2 Installation Guide 15


Chapter 1 About Open Text Email Archiving/Management for Lotus Notes

• Database Templates
The Archiving Bridge provides a number of Lotus Notes database templates
with which you set up the Archiving Bridge on your Lotus Domino server.
Synchronization Service
A Windows service that handles archived Notes documents whose referencing
documents do no longer exist in the Notes database. It removes “orphaned”
objects from the Livelink ECM – Enterprise Server and the Archive Server.
Installation of the Synchronization Service is optional.
Order Database
For standard archiving scenarios, the communication between the Email
Archiving Service for Lotus Notes and the client components is realized via a
special Order Database where all archive requests are queued for asynchronous
processing.
Archive Configuration and Management Facility (ACMF)
Is used to administer the Email Archiving Bridge for Lotus Notes, to create and
assign archiving profiles. You can assign an archiving profile to all databases at
the same time, or you can select individual databases. You can also use different
categories of assignment.
Log database
Records archiving tasks and displays errors.
Database Archiving Profile Template (DAPT)
An archiving profile that you can easily assign to one or more databases. A
DAPT is a Lotus Notes document that contains all relevant archiving
information for one or more databases. When a database is enabled for
archiving, a Database Archiving Profile (DAP) is created which will be copied to
the target database. This DAP is based on the settings of the Database Archiving
Profile Template. The DAP controls the archiving functionalities of a database
that is enabled for archiving.
Domino Web Access/Lotus iNotes (DWA) or Lotus iNotes
Enables access to archived documents via the Internet using Domino Web
Access/Lotus iNotes.

Livelink Modules

Caution
Uninstalling Livelink modules with associated database tables will not only
remove the module files, but also the associated database tables, i.e. it will
remove the module's metadata from your system. This applies to Livelink
ECM – Email Management Services, Livelink ECM – Billing and Quota
Management, and Livelink ECM – Records Management.

16 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


1.2 Components

Email Composer
The Single Instance Archiving feature allows administrators to reduce the
storage space significantly on the Archive Server. With this functionality, an
identical attachment that several users want to archive is extracted from the e-
mails and is archived only once. The Email Composer recomposes the
corresponding e-mails for archiving when they are displayed.
Livelink ECM – Explorer E-mail
Lets users browse their personal e-mail volume on Livelink ECM – Enterprise
Server and gives them access to the Livelink full-text search. Livelink Explorer E-
mail is included in Open Text Email Archiving for Lotus Notes.
Livelink ECM – Explorer Professional
Enables managing and full-text searching of archived e-mails in Livelink ECM –
Enterprise Server, especially intended for Livelink ECM – Records Management.
Livelink ECM – Explorer Professional is included in Open Text Email
Management for Lotus Notes.
Livelink ECM – Billing and Quota Management
Optional Livelink module that provides the ability to track Livelink users'
storage usage and facilitate billing to users or groups, based on the total usage.
Livelink ECM – Records Management
Optional Livelink module that lets users apply Classifications to their emails.
Livelink ECM – Email Management Services
Extend the functionality of the Livelink to allow storage of e-mails coming in
from the Archiving Bridge.
Open Text Email Managed Folders for Lotus Notes Administration Module
Enables administrators to define Managed Folders, assign them to groups and
thereby restrict the number of folders used for Open Text Email Management for
Lotus Notes. Located on Livelink Administration page.

Client Components
The client components reside in the supplied Lotus Notes database templates. They
consist of several agents dispatching archive requests, special forms to display
archived documents for offline support, log documents and a view to display the
documents that are concerned with the archiving operations, for example with
retrieving and copying back documents. All client components need to be integrated
into the Lotus Notes database, which should offer the archiving features.
The installation of client components is part of the Administration and described in
section 4.7 "Distributing the Offline Extension and the Archiving Toolbar" in Open
Text Email Archiving/Management for Lotus Notes - Administration Guide (NA-AGD)
Offline Extension
Enables you to manage your archived documents when your Lotus Notes client
is in local mode.

NA090705-IGD-EN-2 Installation Guide 17


Chapter 1 About Open Text Email Archiving/Management for Lotus Notes

Archiving Toolbar
Offers the main functions of the archiving menu within icons that appear in
Lotus Notes. The client design elements of the Archiving Toolbar are added to
the local database bookmark.nsf, and are so made available to the user's
database.

1.3 Order of installation


The following figure illustrates the preferred sequence of installation. It also shows
where each element has to be installed.

Note: From version 9.7.1, the product Livelink ECM – Archive Server is called
Open Text Archive and Storage Services; for simplification reasons, this docu-
ment uses the term “Archive Server” for all versions.

18 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Chapter 2
Installing Open Text Email Managed Folders for
Lotus Notes on Livelink
Note: This section is only relevant if you use Open Text Email Management for
Lotus Notes, not for Open Text Email Archiving for Lotus Notes.
In Open Text Email Management for Lotus Notes, Open Text Email Managed Folders
for Lotus Notes allows exporting e-mails by drag and drop directly to the Livelink
ECM – Enterprise Server. Managed Folders for Lotus Notes are displayed in the
folder structure of the Lotus Notes mail database. Furthermore, users have direct
access to the Livelink inside Lotus Notes. A single click on a Managed Folder
displayed in the Lotus Notes mail database displays the Livelink inside the Lotus
Notes client.
For further information about Managed Folders for Lotus Notes, see section 10.1
"Introducing Open Text Email Managed Folders for Lotus Notes" in Open Text Email
Archiving/Management for Lotus Notes - Administration Guide (NA-AGD)
Open Text Email Managed Folders for Lotus Notes are installed using the standard
Livelink installation procedure for optional modules.
Where? Install on Livelink ECM – Enterprise Server
You install any optional Livelink module in two stages. First, run an .exe file or
extract a .tar file (depending on your operating system) to unpack the installation
files into Livelink’s staging directory. Next, go to the Livelink Administration page
and click the Install Modules link in the Module Administration section to
complete the installation.
Note: For specific information about the installation process in Windows or
UNIX environments, see “Administering Livelink Modules: Installing and
Uninstalling a Module” in the Livelink Admin online help or see “Installing
and Uninstalling Modules” in the Livelink First-Time Installation Guide.
For specific information about the upgrade process in Windows or UNIX
environments, see “Administering Livelink Modules: Upgrading a Module” in
the Livelink Admin online help or see “Upgrading Modules” in the Livelink
Upgrade Installation Guide.
These guides are available in the Open Text Knowledge Center
(https://knowledge.opentext.com/knowledge/llisapi.dll/open/2120118).

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 19


Chapter 3
Installing and Administering Email Management
Services on Livelink
The Livelink ECM – Email Management Services modules extend the functionality of
the Livelink to allow storage of e-mails coming in from the Archiving Bridge. They
consist of Livelink E-mail Services and Livelink E-Mail Management.

Caution
Once installed, you must not uninstall Email Management Services. This
results in data loss.

3.1 Installing Email Management Services


Where? Install on Livelink ECM – Enterprise Server. Email Management Services is installed
using the standard Livelink installation procedure for optional modules.
You install any optional Livelink module in two stages. First, run an .exe file or
extract a .tar file (depending on your operating system) to unpack the installation
files into Livelink’s staging directory. Next, go to the Livelink Administration page
and click the Install Modules link in the Module Administration section to
complete the installation.
Note: For specific information about the installation process in Windows or
UNIX environments, see “Administering Livelink Modules: Installing and
Uninstalling a Module” in the Livelink Admin online help or see “Installing
and Uninstalling Modules” in the Livelink First-Time Installation Guide.
For specific information about the upgrade process in Windows or UNIX
environments, see “Administering Livelink Modules: Upgrading a Module” in
the Livelink Admin online help or see “Upgrading Modules” in the Livelink
Upgrade Installation Guide.
These guides are available in the Open Text Knowledge Center
(https://knowledge.opentext.com/knowledge/llisapi.dll/open/2120118).

3.2 Configuring Livelink ECM – Email Services


Livelink ECM – Email Services supports several configuration settings. You can
choose which email fields to extract for indexing and whether to index standard

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 21


Chapter 3 Installing and Administering Email Management Services on Livelink

Livelink attributes. You can choose whether the email message body should be
stored for viewing. You can also select the number of items per page to display in
the paged email folders.
Note: The Livelink full text search can be used to search the full content of
emails. To allow for searching on individual email properties from the Livelink
Advanced Search, it is necessary to perform these steps:
• The email fields are configured for indexing in the Livelink ECM – Email
Services configuration.
• The email fields are configured to be “Queryable” in the Enterprise Search
Manager. For detailed information, refer to the Livelink Admin help (Livelink
Index and Search Administration – Administering Searching – Configuring
Index Regions).
On the Configure E-mail Services page, you can configure the following settings for
Livelink ECM – Email Services:
• Extractable E-mail Fields
You can choose which email fields you want to extract for indexing. A field must
be extracted to allow searching on that field. However, you may choose to not
extract certain email fields to reduce the size of the search index and rely on full
text searching of the messages.
Note: If you choose not to extract certain email fields for indexing can affect
the functionality of other Livelink products, for example, Open Text
Livelink ECM – Explorer.
• Extractable Livelink Attributes
You can choose whether to index standard Livelink attributes for emails or not.
Limiting what can be extracted for indexing can help to reduce the memory
required for the search index, particularly in organizations that handle large
volumes of emails.
Notes:
• If you choose not to extract standard Livelink attributes, the
functionality of all Livelink products that store and search for emails
may be affected.
• If you choose not to extract the standard Livelink attributes, the
attributes listed below will not be indexed for emails and will not be
searchable for any emails in the system.
The following attributes will not be indexed if you choose not to index standard
Livelink attributes:

OTSubType OTCreateDate OTTimeCompleted

OTSubTypeName OTCreateTime OTDateStarted

OTOwnerID OTModifyDate OTTimeStarted

22 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


3.2 Configuring Livelink ECM – Email Services

OTDataID OTModifyTime OTStatus

OTRootSubType OTAssignedTo OTPriority

OTRightIDs OTAssignedToName OTReserved

OTName OTAssignedToFullName OTReservedDate

OTLocation OTDateAssigned OTReservedTime

OTCDMajor OTTimeAssigned OTReservedBy

OTCDMinor OTDateEffective OTReservedByName

OTDComment OTTimeEffective OTReservedByFullName

OTCatalog OTDateDue OTCreatedBy

OTDCategory OTTimeDue OTCreatedByName

OTUserID OTDateExpiration OTCreatedByFullName

OTUserName OTTimeExpiration

OTUserFullName OTDateCompleted

• Store Message Body


You can choose whether the email message body should be stored as metadata
in the database for viewing when email nodes are rendered in HTML.
Notes:
• Storing the email message body requires additional space in the Livelink
database.
If you choose not to store the email message body content for viewing,
the body of an email will not display in the HTML view. However, you
can still view the body of messages if they are rendered instead in the
view produced by the Livelink Filter Pack (a separate, optional module).
• For Email Archiving for Lotus Notes: This setting does not affect the
display of the body in the Lotus Notes clients. For interactive archiving,
you can select which parts of the document you want to remove after
successful archiving:
• only the attachments
or
• the attachments and the RTF fields which contain the email body.
• E-mail Folder Paging
You can select the number of items to display on each page within the paged
email folders of the Livelink E-mail Volumes. Showing more items on each web
page allows more data to be viewed at a time and there will be fewer total pages
to view. However, increasing the number of items per page will result in each

NA090705-IGD-EN-2 Installation Guide 23


Chapter 3 Installing and Administering Email Management Services on Livelink

page taking longer to load in your Web browser. The options are 25, 50, 100, or
200. The default is 50.
Note: The E-mail Folder Paging setting only applies for Livelink 9.7.0 or
earlier.
• Extracting Additional E-mail Properties
In addition to the standard email properties, you can specify custom email
properties to extract and store. To configure Outlook or Lotus to extract and
store additional email properties on the server, you need to add the list of
properties to the Extracting Additional E-mail Properties field. Entries should
be entered on one row per line, in the following format:
<MailSystem>|<PropertyName>|<Display Name>|<Region Name>

where
<MailSystem> identifies the mail environment to try extracting the properties
from. The values are either OUTLOOK or LOTUS
<PropertyName> identifies the name of the property to extract in the mail system.
For Outlook, enter the <Identifier Number> of the MAPI property. For a named
property, you must enter both the GUID of the property, plus the name of the
property as either a string or number, separated by a comma.
For Lotus Notes, enter the <Field Name> of the Document Property.
Note: If a property cannot be found, it will not be stored in the database.
Also, standard properties (Subject, From, To, CC, SentDate, ReceivedDate)
are always extracted and stored separately from custom properties.
<Display Name> is the display name that you want to use for the property on the
Properties – E-mail tab in Livelink.
<Region Name> (optional) is the region name to be used by the search engine for
indexing. If you want the additional email property to be searchable, you must
specify a region name. This can be omitted if you do not require the email
property to be searchable.
For example:
OUTLOOK|0x0017|Importance Flag|EmailImportance

LOTUS|($Classification)|Lotus Classification

OUTLOOK|{00020329-0000-0000-C000-
000000000046},Keywords|Classification|EmailClassification

• Signed/Encrypted Message Classes


You can define the special Outlook message classes for signed and/or encrypted
email messages. By default, Open Text Livelink ECM – Explorer recognizes
certain Message Classes in Livelink as signed or encrypted. Open Text Livelink
ECM – Explorer cannot properly process these types and uses the properties

24 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


3.3 Configuring Livelink ECM – Email Management Settings

entered in this section to provide an appropriate message to users who add these
types of emails to Livelink. If the list of messages included in this section is
incomplete, the list can be modified to include additional messages. Each
message class should be entered on a separate line.
• E-mail Viewable MIME Types
You can specify the MIME types for emails that should be viewed using the
stored body and email properties. By default, email nodes that users attempt to
view in the Livelink browser render in the Open Text Livelink ECM – Explorer
E-mail Integration module's HTML view. You can remove this configuration so
that Outlook messages render instead in the core view. Each MIME Type should
be entered on a separate line.
Note: Although it is possible to remove the default rendering configuration
for Lotus Notes email messages, Open Text discourages doing so, because a
core view does not exist to alternately render these messages.
Select the options that you want to configure and then click the Submit button.

To Configure Settings for Email Services:


1. On the Livelink Administration page, click the Configure E-mail Services link
in the E-mail Services Administration section.
2. On the Configure E-mail Services page, select the options for Email Services.
3. Click the Submit button.

3.3 Configuring Livelink ECM – Email Management


Settings
Livelink ECM – Email Management supports several configuration settings. For
example, you can configure the log level and the number of nodes in each folder.
The following settings are available on the Configure E-Mail Management page:
Log Settings
• Log level
You can control how much logging information is recorded when email
messages are archived. Changing the log level may be required for
troubleshooting problems.
The options are:
0
logs failures only (default setting)
1
logs tracing and debugging information

NA090705-IGD-EN-2 Installation Guide 25


Chapter 3 Installing and Administering Email Management Services on Livelink

2
logs timing and more tracing information
• Log identifiable metadata
If you select this setting, you can include email metadata in the log files.
Open Text recommends logging metadata for troubleshooting only.
Web Browser Settings
Show 'E-mail' menu under Personal
If selected, Livelink's Personal menu shows the E-mail item (default).
If cleared, the menu item is hidden for all users.
You have to restart the Livelink service for the changes to take place.
Show 'Public E-mail Volume' menu under Enterprise
If selected, Livelink's Enterprise menu shows the Public E-mail Volume item
(default).
If cleared, the menu item is hidden for all users.
You have to restart the Livelink service for the changes to take place.
Common Settings
• Bridge Service Livelink username
Click the icon to browse for the Archiving Bridge Service User.
This setting coincides with the user account that is configured in the
Archiving Service settings to allow access to Enterprise Server. If the user
account is reconfigured in Archiving Bridge, this setting must also be
updated with the same user name. This user requires system administration
rights for Enterprise Server. For further information, see the corresponding
documentation.
• Append date to node name
This setting can be configured to add a specified date to the node name of
archived emails. Each email archived to the same folder in a Personal E-mail
Volume must have a unique name. Emails with identical subjects in the same
folder are automatically renamed with a sequentially numbered suffix to
ensure uniqueness. If individuals receive large numbers of emails with
identical subjects, it can become costly to generate unique names and the
performance of the Archiving Service could decline. Configuring the Append
date to node name setting can minimize the number of emails that contain
identical subjects. There are three possible values for this setting:
• None, which disables this feature (default setting)
• SentDate, which applies the sent date of the email to the node name
• ReceivedDate, which applies the received date of the email to the node
name

26 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


3.3 Configuring Livelink ECM – Email Management Settings

E-Mail Monitoring Settings


These parameters are only valid for Email Monitoring, not for Email Archiving.
E-Mail Archiving Settings
• Folder structure
You can set the default Email Archiving folder structure for the Personal E-
mail Volume of users, which can help to prevent these E-mail Volumes from
becoming too large. If you specify a Year or Year-Month folder structure,
emails are added to a Personal E-mail Volume by the year or the year and
month that they were sent before replicating the same structure of users'
mailboxes.
Notes:
• The recommended default for Lotus Notes is Year-Month.
• Users can change this default setting in the Email Archiving settings
for the Personal E-mail Volume (E-mail Archiving tab on the My
General Settings page).
• Use Livelink domains
This setting controls the user mapping-feature between the email identity of
users and their Livelink user identity. It is applicable depending on how
Directory Services/Livelink Domains has been configured.
Selecting the check box enables an attempt to map the email domain identity
of a user to a Livelink domain.
• Username format
This setting controls the expected format of the Livelink user name identity.
For Email Archiving solutions, the user associated with the mailbox must be
mapped to a Livelink user so the emails can be added to the Personal E-mail
Volume of the correct Livelink user.
The Livelink ECM – Directory Services module can synchronize and import
users using one of two different formats for the Livelink username: Username
only or NT-style username (that is DOMAIN\username.)
The following values are possible:
• Automatic, which is the default. Note that this setting relies on a correct
Directory Services configuration for User Synchronization to determine
which format to use.
• UserNameOnly, which will attempt to map the username value to the
Livelink username only.
• NTDomainAndUserName, which will combine the domain name and
username values to look up the Livelink username.

NA090705-IGD-EN-2 Installation Guide 27


Chapter 3 Installing and Administering Email Management Services on Livelink

E-mail Management Custom Data


If an Email solution provides custom data, you can store it in Livelink. You can
specify the display name of this custom data, whether to index the data for
searching, and the search region name. The actual data is defined by the
solution.
For each entry, add a line in the text field. The format is
<CustomDataName>|<Display Name>|<Region Name>
where <CustomDataName> identifies the name of the custom data as defined by
the originating source. <Display Name> is the display name that you want to use
for the data on the Properties – E-mail tab in Livelink. <Region Name> (optional)
is the region name to be used by the search engine for indexing. If you want the
custom data to be searchable, you must specify a region name.
Livelink shows the custom data in the Properties – E-mail tab in a table with the
columns E-mail Management Custom Data and E-mail Management Custom
Data Value.
Specify the options that you want to configure and then click the Submit button.

3.3.1 Configuring Livelink ECM – Email Management


To Configure Livelink ECM – Email Management:
1. On the Livelink Administration page, click the Configure E-mail Management
link in the E-mail Management Administration section.
2. On the Configure E-mail Management page, select the options for Livelink
ECM – Email Management as described in “Configuring Livelink ECM – Email
Management Settings” on page 25.
3. Click the Submit button.

28 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Chapter 4
Installing and Administering Livelink ECM –
Explorer Professional and Livelink ECM – Explorer
E-mail on Livelink
Important
This section describes in short how to install Livelink ECM – Explorer E-
mail. It is an extract from the more detailed Livelink Explorer Installation and
Administration Guide, which you find in the Knowledge Center at the
following URL:
https://knowledge.opentext.com/knowledge/llisapi.dll?func=ll&objId=297
3127&objAction=browse&sort=name

The Livelink ECM – Explorer Professional component which is part of Open Text Email
Management for Lotus Notes allows Livelink users to manage and search archived
e-mails in Livelink Enterprise Server.
The Livelink ECM – Explorer E-mail component which is part of Open Text Email
Archiving for Lotus Notes enables Livelink users to browse and search a personal
and public e-mail volume in Livelink Enterprise Server.
Where? Install on Livelink ECM – Enterprise Server
In this chapter, you find the following information:
Section 4.1: “Installing the Modules on Windows” ........................................................ 29
Section 4.2: “Installing the Modules on UNIX” ............................................................... 30
Section 4.3: “Adding the Modules to Livelink”............................................................... 30
Section 4.4: “Uninstalling Livelink Explorer”.................................................................. 31
Section 4.5: “Distributing the Clients Using the MSI Package”..................................... 32
Section 4.6: “Completing the Client Installation”............................................................ 34
Section 4.7: “Uninstalling the Client Using the MSI Package” ...................................... 36

4.1 Installing the Modules on Windows


For the Windows version of Livelink Explorer, perform the first part of the
installation using the InstallShield installation program. The InstallShield program
allows you to select the Livelink server on which you want to install the modules
and places the module installation files in the Livelink staging directory.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 29


Chapter 4 Installing and Administering Livelink ECM – Explorer Professional and Livelink ECM – Explorer E-
mail on Livelink

To install the modules on Windows:


1. Download and run the Livelink Explorer executable file for the module version
that you want to install (Livelink Explorer Professional or Livelink Explorer
Standard). You can obtain the executable file from the Open Text Knowledge
Center or from your Open Text sales representative.
2. In the InstallShield dialog, click Yes.
3. In the Welcome dialog, click Next.
4. In the Livelink Service dialog, click the primary Livelink server on which you
want to install the module.
Note: You can install the module on only one server at a time.
5. Click Next. The installation program copies the module files to the Livelink
staging directory.
6. In the Confirmation dialog, click OK.

Note: To complete the installation, you must add the modules to Livelink. For
more information, see “Adding the Modules to Livelink” on page 30.

4.2 Installing the Modules on UNIX


For the UNIX version of Livelink Explorer, perform the first part of installation
using a .tar compressed archive file. The extraction of this .tar file places the
module installation files in the Livelink staging directory.

To install the modules on UNIX:


1. Copy the Livelink Explorer module .tar file (Livelink Explorer Professional or
Livelink Explorer Standard) to the Livelink_home directory of the primary
Livelink server on which you want to install the module.
2. At the operating system prompt, type the following command using the
Livelink Explorer .tar file name: tar -xvf filename.tar
The installation files are extracted and copied to the Livelink_home/staging
directory.

Note: To complete the installation, you must add the modules to Livelink. For
more information, see “Adding the Modules to Livelink” on page 30.

4.3 Adding the Modules to Livelink


After you install the Livelink Explorer module files to the Livelink staging directory
for Windows or UNIX, add the modules to Livelink to complete the installation and
ensure full product functionality.

30 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


4.4 Uninstalling Livelink Explorer

Note: Open Text recommends installing the Livelink Explorer Standard,


Livelink Explorer Professional, E-mail Integration, and E-mail Services at the
same time. However, due to program conflicts, do not attempt to install any
non-Livelink Explorer modules during the Livelink Explorer installation.
If you have installed Livelink Explorer Professional and the Add Modules page does
not show a check box or list a dependency for the module, it is likely that you have
an earlier version of Livelink Explorer installed. You must upgrade to the latest
version of Livelink Explorer Standard to complete the Livelink Explorer
Professional installation.

To add the modules to Livelink:


1. In the Module Administration section of the Livelink Administration page,
click the Install Modules link.
2. In the Installable Modules section of the Install Modules page, select the check
box for each module that you want to add, and then click the Install button.
3. Restart the Livelink and Web Application servers.
4. On the Restart Livelink Server page, click the Continue link.

4.3.1 Restarting the Livelink and Web Application Servers


To restart the Livelink Servers on Windows:
1. Click the Start button, click Settings, and then click Control Panel.
2. In the Control Panel, double-click the Administrative Tools icon.
3. In the Administrative Tools dialog box, double-click the Services icon.
4. In the Services dialog box, right-click Livelink:<service_name>, and then
click Restart.

To restart the Livelink Servers on UNIX:


1. Log on to the Livelink host as a UNIX user who has administration rights to the
Livelink host server.
2. In the Livelink_home directory, type stop_llserver.
3. Press ENTER.
4. In the Livelink_home directory, type start_llserver.
5. Press ENTER.

4.4 Uninstalling Livelink Explorer


You can uninstall any of the Livelink Explorer Standard, Livelink Explorer
Professional, E-mail Integration, and E-mail Services, modules.

NA090705-IGD-EN-2 Installation Guide 31


Chapter 4 Installing and Administering Livelink ECM – Explorer Professional and Livelink ECM – Explorer E-
mail on Livelink

If you have the Livelink Explorer Professional module installed and want to
uninstall Livelink Explorer Standard, you must first uninstall Livelink Explorer
Professional and then uninstall Livelink Explorer Standard.

Warning
Do not uninstall the E-mail Services module if you have any emails in your
system. Doing so removes all email tables from your database, and your
data will be lost and is not recoverable. For further assistance, contact Open
Text Support.

To uninstall Livelink Explorer:


1. In the Module Administration section of the Livelink Administration page,
click the Uninstall Modules link.
2. On the Uninstall Modules page, click the Uninstall button for the module that
you want to remove.
3. Restart the Livelink and Web Application servers and then click the Continue
link.

Note: When you uninstall a module, Livelink moves the module files to the
Livelink staging directory so that the module is available for re-installation
from the Install Modules page.

4.5 Distributing the Clients Using the MSI Package


The Livelink Explorer Standard, Livelink ECM – Explorer Professional and Explorer
E-mail clients can be distributed and updated using Microsoft Windows Installer.
For more information about Windows Installer, go to www.microsoft.com
(http://www.microsoft.com).
Information about using Windows Installer to distribute the Livelink Explorer
clients is intended for use by administrators who are knowledgeable about
Windows Installer distribution methodologies.

4.5.1 Requirements
• Open Text strongly recommends allowing client machine reboots when
upgrading or uninstalling Livelink Explorer using the MSI package if prompted.
Suppressing reboots may result in problems with Livelink Explorer.
• Windows Installer, version 3.0 or later, must be installed on the desktop
machines on which you intend to distribute the client. To download the latest
version of Windows Installer, go to www.microsoft.com
(http://www.microsoft.com).

32 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


4.5 Distributing the Clients Using the MSI Package

• The Machine Assigned distribution method must be used to distribute Livelink


Explorer Professional in an Active Directory Group Policy environment.

4.5.2 Configuration
When you distribute the Livelink Explorer clients using Windows installer, you can
customize the installation using Windows Installer features.
To configure the feature installation options for Livelink Explorer Professional, use
the feature names provided in Table 4-1 with the MSIEXEC.exe ADDLOCAL property.

Table 4-1: List of Feature Names for Livelink Explorer Professional

Feature Description
Common Mandatory common component. When customizing installation
components, this feature must be included.
Explorer_Pr Integration with Windows Explorer and the Desktop
o

Outlook Integration with Microsoft Outlook


Notes Integration with Lotus Notes
Word Integration with Microsoft Word
Excel Integration with Microsoft Excel
PowerPoint Integration with Microsoft PowerPoint
Project Integration with Microsoft Project
Visio Integration with Microsoft Visio
Acrobat Integration with Adobe Acrobat

Feature For Explorer E-mail, you must configure the following feature installation option:
installation for Common,Outlook_Email
Explorer E-mail

When you distribute the Livelink Explorer clients using the MSI package, you can
specify command-line or MSI file properties to support the installation. When you
specify MSI command-line parameters, you enter the parameters when executing
MSIEXEC.exe. When you specify MSI file properties, you use a MSI editor to specify
values in the Properties table of the MSI file, prior to installing the client.

NA090705-IGD-EN-2 Installation Guide 33


Chapter 4 Installing and Administering Livelink ECM – Explorer Professional and Livelink ECM – Explorer E-
mail on Livelink

Table 4-2: Command Line Parameters

Parameter Description
APPCHECK=<value> Where <value> is either Yes or No. Specifies
whether or not to perform the launch
condition check that all integrated
applications such as Microsoft Word or
Outlook must be exited on the computer
prior to running the installation. The
default value is Yes.

Note: If you specify No then the instal-


lation may be performed even when
integrated applications are running
and the required files and registry keys
are locked. The computer may there-
fore have to be restarted to fully com-
plete the Livelink Explorer installation.

SYNCHRONIZERDEFAULT=<value> Where <value> is either On or Off. Specifies


whether the Synchronizer process being
installed will perform automatic synchroni-
zation attempts on behalf of the user for a
new install. The default is On.

4.6 Completing the Client Installation


After installing the Livelink ECM – Explorer Professional client or the Explorer E-
mail client, you must complete additional tasks for the Livelink Explorer Integration
in the email client software that you use.

4.6.1 Livelink Explorer Lotus Integration


After you have installed the Lotus Integration, you must run Livelink E-mail
Integration User Activator if Lotus Notes is a multiuser installation and complete
the installation by importing the Livelink toolbar.

To add server information:


1. Click the Start button, point to Programs, point to Livelink Explorer, and then
click Options.
2. In the Options dialog box, click the Server Settings tab.
3. Click the Add button.
4. Enter a unique name for the server in the Server Display Name field and then
click the Next button.
5. Enter the URL for the server to which you want to connect in the URL field and
then click the Next button.

34 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


4.6 Completing the Client Installation

6. Enter the user name used to log in to the Livelink Server in the Livelink User
Name field.
7. Enter the password used to log in to the Livelink Server in the Password field
and then reenter the password in the Confirm Password field.
8. Click the Next button through the installation, until it completes.
9. Click the Finish button.
10. In the Options dialog box, click the OK button.

To run Livelink E-mail Integration User Activator for a Lotus Notes multiuser
installation:
1. Run the Livelink E-mail Integration User Activator executable file.
2. In the Livelink Explorer E-mail Integration Activator window, select the check
box for the application you want to activate.
3. Click the OK button.

Notes:
• Each user of the machine that has a Lotus Notes multiuser installation must
run the Livelink E-mail Integration User Activator.
• If Lotus Notes is a multiuser installation, a message displays during the
activation process, indicating the directory path required to import the
OTEMail toolbar. Record this path.

To import the Livelink toolbar for Lotus Integration:


1. Log in as a user that will be using the email profile.
2. Choose Preferences and then choose Toolbar Preferences on the File menu.
3. In the Toolbar Preferences window, click the Toolbars tab.
4. Click the Import button.
5. Browse to the NOTES/OTEMail directory, where NOTES is the directory where
the Notes client is installed and then select the otemail.smi file.
Note: If Lotus Notes is a multiuser installation, browse instead to the
personal/OTEMail directory, where personal is the personal Notes data
directory. The path to this directory displayed when the Livelink E-mail
Integration User Activator was run.
6. Select the Visible check box for the newly created OTEMail toolbar.
7. Click the OK button.

Note: If Lotus Notes is a multiuser installation, each user of the machine must
import the toolbar.

NA090705-IGD-EN-2 Installation Guide 35


Chapter 4 Installing and Administering Livelink ECM – Explorer Professional and Livelink ECM – Explorer E-
mail on Livelink

4.7 Uninstalling the Client Using the MSI Package


The Livelink Explorer Standard, Livelink Explorer Professional, and Livelink
Explorer E-mail clients can be uninstalled using Microsoft Windows Installer. For
more information about Windows Installer, go to www.microsoft.com
(http://www.microsoft.com).
Information about using Windows Installer to uninstall the client is intended for use
by administrators who are knowledgeable about Windows Installer distribution
methodologies.

4.7.1 Requirements
Open Text recommends instructing users to close all running applications before
attempting to uninstall to ensure all operations complete as expected.

4.7.2 Configuration
When you distribute the Livelink Explorer clients using the MSI package, you can
specify command-line or MSI file properties to support the uninstallation. When
you specify MSI command-line parameters, you enter the parameters when
executing MSIEXEC.exe. When you specify MSI file properties, you use a MSI editor
to specify values in the Properties table of the MSI file, prior to installing the client.
Livelink Explorer supports specifying the parameters listed in Table 4-3 when
uninstalling the Livelink Explorer clients. For information about supported
installation parameters, see “Distributing the Clients Using the MSI Package” on
page 32.

Table 4-3: MSIEXEC.exe Command Line Parameters for Livelink Explorer


Standard or Professional

Parameter Description
REMOVEPDS=<value> Where <value> is either Yes or No.

Specifies whether or not to remove the Livelink Explorer


Personal Data Store from the client machine on uninstallation.
The default value is No.

Note: REMOVEPDS is supported only when the end-user


uninstalls Livelink Explorer Professional.

REMOVESCI=<value> Where <value> is either Yes or No.

Specifies whether or not to remove the Livelink Explorer server


connection information from the Windows Registry on
uninstallation. The default value is No.

Note: REMOVESCI is supported only when the end-user


uninstalls Livelink Explorer Professional.

36 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Chapter 5
Installing and Administering Livelink ECM – Billing
and Quota Management on Livelink
Function of the Livelink ECM – Billing and Quota Management is an optional Livelink module that
module provides the ability to track Livelink users' storage usage and facilitate billing to
users or groups, based on the total usage.
This chapter covers the following topics:
Section 5.1: “Verifying Installation Requirements” ........................................................ 37
Section 5.2: “Installing the Email Billing & Quota Management Module”.................. 37
Section 5.3: “Uninstalling Email Billing & Quota Management”.................................. 38
Section 5.4: “Enabling the Quota Management Agent” ................................................. 38
Section 5.5: “Configuring Settings”................................................................................... 39

5.1 Verifying Installation Requirements


Livelink 9.6 or later must be installed. Before you install Email Billing & Quota
Management, ensure that you have administrative access to Livelink; that is, you are
a Livelink Administrator.

5.2 Installing the Email Billing & Quota Management


Module
You can download the Email Billing & Quota Management module from the Open
Text Knowledge Center.
Email Billing & Quota Management is installed using the standard Livelink
installation procedure for optional modules.
You install any optional Livelink module in two stages. First, run an .exe file or
extract a .tar file (depending on your operating system) to unpack the installation
files into Livelink’s staging directory. Next, go to the Livelink Administration page
and click the Install Modules link in the Module Administration section to
complete the installation.
Note: For specific information about the installation process in Windows or
UNIX environments, see “Administering Livelink Modules: Installing and
Uninstalling a Module” in the Livelink Admin online help or see “Installing
and Uninstalling Modules” in the Livelink First-Time Installation Guide.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 37


Chapter 5 Installing and Administering Livelink ECM – Billing and Quota Management on Livelink

For specific information about the upgrade process in Windows or UNIX


environments, see “Administering Livelink Modules: Upgrading a Module” in
the Livelink Admin online help or see “Upgrading Modules” in the Livelink
Upgrade Installation Guide.
These guides are available in the Open Text Knowledge Center
(https://knowledge.opentext.com/knowledge/llisapi.dll/open/2120118).
During the installation, the following LiveReports are added to Livelink:
• Billing Usage For [User] (only available to Livelink administrators)

• Current Quota Usage [For Group Name] (only available to Livelink


administrators)
• Current Quota Usage For [User] (only available to Livelink administrators)

• My Billing Usage

• My Current Quota Usage

5.3 Uninstalling Email Billing & Quota Management


Uninstall Email Billing & Quota Management the same way that you uninstall most
other optional Livelink modules. For specific information about uninstalling in
Windows or UNIX environments, see “Livelink Modules: Uninstalling” in the
Livelink Admin online help, or see “Uninstalling Modules” in the Livelink First-Time
Installation Guide.

Caution
Uninstalling the Email Billing & Quota Management module will remove all
Email Billing & Quota Management metadata from your system.

5.4 Enabling the Quota Management Agent


When a Livelink user exceeds their assigned quota threshold for storage usage, an e-
mail notification will be sent to the user (if the feature is enabled). Once they exceed
their quota, an additional e-mail notification is sent to both the user and the Livelink
administrator (or any other designated recipient).
Enabling the Quota Management Agent will allow you to send quota and threshold
e-mail notifications. You can also specify the days and times the system will check
for thresholds and quotas that have been exceeded.

5.4.1 To Enable the Quota Management Agent


1. On the Livelink Administration page, in the Notification Administration
section, click the Configure Scheduled Activities link.

38 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


5.5 Configuring Settings

2. On the Configure Scheduled Activities page, in the Quota Management Agent


section, click the Enable radio button.
3. In the Activity Schedule section, specify the days and times the system checks
for exceeded thresholds and quotas.
4. Click the Submit button.

5.5 Configuring Settings


You can enable or disable billing management and quota management for all
Livelink users.
Note: If information about the data volume for e-mails is all that is required,
Open Text does not recommend enabling billing management, because the
billing tables contain extensive information on user actions that can cause them
to become very large. The quota management tables contain sufficient data.
If quota management is enabled, you must set the default quota, in megabytes, and
the default threshold, which is a portion of the user quota defined as a percentage.
When the threshold and the quota are reached, you can choose to have an automatic
e-mail notification sent to the Livelink user. You can then modify the default format
for these e-mail notifications. The following table displays replacement strings that
you can use to dynamically insert content into the e-mail.

Table 5-1: E-mail format replacement strings

String Description
$CURRENT$ This value will be the current usage of a user from the
QuoteUsage.CurrentUsage field.

$LIMIT$ This value will be the default quota limit specified in


either Livelink Admin or the user profile (if defined).
$THRESHOLD$ This value will be the default threshold limit specified
in either Livelink Admin or the user profile (if defined).
$USERLOGIN$ This value will be the user name for the user.
$USERID$ This value will be the user ID for the user.

Quota e-mail notifications are also sent to the Livelink Administrator by default.
You can specify another user as the recipient of these e-mail notifications.
You can specify which object types – Documents (144) or E-mails (749) – will be
managed by Billing and Quota Management.
Note: If quota management or billing management is enabled, the content of at
least one object type must be managed.
You can limit billing and quota management of e-mails to the Personal E-mail
Volumes of users. In doing so, other areas of Livelink will be ignored.

NA090705-IGD-EN-2 Installation Guide 39


Chapter 5 Installing and Administering Livelink ECM – Billing and Quota Management on Livelink

As the Livelink Administrator, you can modify the quota settings for an individual
Livelink user via their user profile.
The QuotaBilling table stores data on the storage usage of a user each time they add
or delete supported managed objects in Livelink. If necessary, you can purge the
events from the QuotaBilling table that are older than a specified date.
You can also perform a one-time update of the quota statistics for users by bulk
populating the QuotaUsage table. This feature determines the byte count for all
users and then, based on the settings configured in Livelink Administration,
populates the table with this data. This bulk population will not affect Billing
Management.

5.5.1 To Enable or Disable Email Billing & Quota Management


for All Livelink Users
1. On the Livelink Administration page, in the Billing and Quota Management
Administration section, click the Configure Billing and Quota Management
link.
2. On the Billing and Quota Management Administration page, select or clear any
of the following check boxes:
• Enable Quota Management
• Enable Billing Management
3. If you selected the Enable Quota Management check box, do one of the
following:
• To set a default quota, type the per-user quota in the Default User Quota
field and then type the percentage of the user quota at which to send a
notification that the threshold has been exceeded in the Default User
Threshold field.
• To have an unlimited quota, ensure that the Default User Quota and
Default User Threshold fields are blank.
4. Click the Save Changes button.
5. Restart Livelink ECM – Enterprise Server.

To... do the following...


enable or disable quota email notification, Select or clear the Enable Quota Emails
check box.

40 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


5.5 Configuring Settings

To... do the following...


modify the default email format for quota Do any of the following:
and threshold notifications, • Modify the content in the Over Quota
Email Format field.
• Modify the content in the Over
Threshold Email Format field.

Optionally, you can click the View Sample


button next to the Over Quota Email For-
mat field or the Over Threshold Email
Format field to view a sample of the e-mail
format.
specify a different recipient for quota email Type the recipient's name in the Display
notifications, Name field and then type the recipient's e-
mail address in the Email Address field.
enable or disable content to be managed, Select or clear any of the following check
boxes:
• Manage Documents
• Manage Emails

limit management of emails to Personal E- Select the Limit to PEV check box.
mail Volumes for users,

5.5.2 To Modify the Quota Settings for a Livelink User


1. Find the user for whom you want to modify quota settings.
2. In the Actions column, click the Edit link for the user.
3. On the General Info page, select the Exclude from Quota Management check
box to exclude the user in quota management.
4. If you did not select the Exclude from Quota Management check box, do any of
the following:
• Type the quota for the user, in megabytes, in the Quota field.
• Type the quota threshold for the user, as a percentage, in the Quota warning
at field.
5. Click the Update button.
Note: If you do not specify a quota and a threshold for the user, the
defaults specified on the Billing and Quota Management Administration
page will be used.

NA090705-IGD-EN-2 Installation Guide 41


Chapter 5 Installing and Administering Livelink ECM – Billing and Quota Management on Livelink

5.5.3 To Purge the QuotaBilling Table


1. On the Livelink Administration page, in the Billing and Quota Management
Administration section, click the Purge Billing Table link.
2. On the Purge Billing Table page, click a month, date, and year in the
corresponding drop-down lists.
3. Click the Purge button.
4. Click the OK button.

5.5.4 To Bulk Populate the QuotaUsage Table


1. On the Livelink Administration page, in the Billing and Quota Management
Administration section, click the Bulk Population of Quota Tables link.
2. On the Bulk Population of Quota tables page, click the Bulk Populate button.

42 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Chapter 6
Installing or Upgrading the Livelink ECM – Records
Management Module
Important
This chapter describes in short how to install the latest version of Livelink
ECM – Records Management. It is an extract from the more detailed Open
Text Records Management - Installation and Administration Guide (LLESRCM-
IGD), which you find in the Knowledge Center at the following URL:
https://knowledge.opentext.com/knowledge/llisapi.dll/Open/2831704.
Here, you also find documentation for other versions of Livelink ECM –
Records Management.

Records Management is an optional Livelink module that enables use of Records


Management functionality within Livelink.
The Records Management module provides the ability to create RM Classifications,
Disposition searches, Holds, Reports, and Record Series Identifiers (RSIs) with
Disposition schedules, and to perform administrative tasks, such as maintaining
database tables.
This chapter covers the following topics:
• “Verifying Installation Requirements” on page 43
• “Installing the Records Management Module” on page 44
• “Upgrading the Records Management Module” on page 44
• “Uninstalling Records Management” on page 44

6.1 Verifying Installation Requirements


The following software must be available on the computer on which you want to
install the Records Management 4.2.1 module:
• Livelink 9.7.1
• Livelink Classifications 4.2.0
Before you install the Records Management module, you must also ensure that you
have administrative access to Livelink.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 43


Chapter 6 Installing or Upgrading the Livelink ECM – Records Management Module

6.2 Installing the Records Management Module


You install the Records Management module the same way that you install most
other optional Livelink modules. To install the module, you run a .exe file or
extract a .tar file (depending on the operating system you are running) to unpack
the installation files in Livelink's staging directory, and then add the module to
Livelink using Livelink's Install Modules page. The Records Management module
.exe and .tar files accompany this installation and administration guide on the
Open Text Knowledge Center. For specific information about the installation
process in Windows or UNIX environments, see section 21.1 "Installing and
Uninstalling a Module" in Livelink Administration - Admin Online Help (LLESWBA-H-
AGD), or see section 6.3 "Installing Optional Livelink Modules: Stage 1" in Livelink
ECM™ - Enterprise Server - Installation Guide (LLESCOR-IGD).
After you install the Records Management module, you must configure it. For more
information, see Open Text Records Management - Installation and Administration Guide
(LLESRCM-IGD).

6.3 Upgrading the Records Management Module


You upgrade the Records Management module the same way that you upgrade
most other optional Livelink modules. The process is similar to the installation
process, except that you use the Upgrade Modules page to add the module. For
specific information about the upgrade process in Windows or UNIX environments,
see section 21.2 "Upgrading a Module" in Livelink Administration - Admin Online
Help (LLESWBA-H-AGD), or section 11.3.5 "Upgrading Modules" in Livelink ECM™
- Enterprise Server - Installation Guide (LLESCOR-IGD).
Note: Before upgrading the Records Management module, you must ensure
that all Records Management patch files have been removed from the patch
directory. Please contact Open Text Customer Support if you have any
questions or concerns.

6.4 Uninstalling Records Management


You uninstall the Records Management module the same way that you uninstall
most other optional Livelink modules. For specific information about uninstalling in
Windows or UNIX environments, see section 21.1.3 "To Uninstall a Module" in
Livelink Administration - Admin Online Help (LLESWBA-H-AGD), or see section 9.3
"Uninstalling Modules" in Livelink ECM™ - Enterprise Server - Installation Guide
(LLESCOR-IGD).
Uninstalling the Records Management module will remove all Records
Management metadata from your system.

44 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Chapter 7
Creating and Testing an RSI, a Retention Schedule,
and a Classification
Purpose of this The purpose of this section is to provide steps to set up a system with a sample
section Records Management file plan and retention schedule that can be used to
demonstrate the Records Management capabilities that can be used with Open
Text's E-mail solutions.
The codes and schedules in this document are only samples and are not intended to
imply any legal relevance or to substitute for the process of determining proper
classification and designation of records and schedules. To learn about all of the
capabilities of Livelink ECM – Records Management, Open Text recommends taking
courses offered by Learning Services.
Sample scenario In the following sections, you will create a sample Record Series Identifier (RSI) and
a simple schedule that utilizes a calculated date based on the creation date of an
item in Livelink. The schedule will specify that the object be destroyed when the
retention period is met. The sample file plan described in this section is basic and
consists of a one-level RM classification.

7.1 Configuring Managed Objects


To apply classification to an object, the object type must be managed. To apply
classifications within a Personal E-mail Volume, the following subtypes must be
managed:
• Personal E-Mail Volume, which is the root volume object (subtype=750)
• E-Mail Folder, which consists of all the folders within a Personal E-mail Volume
(subtype=751)
• E-Mails, which consists of all the e-mails within a Personal E-mail Volume
(subtype=749)

To manage object subtypes:


1. Stop the Livelink Server.
2. Open the opentext.ini file in a text editor.
3. In the [Classifications] section, add the subtypes to the following command
line:
SubTypes={0,136,144,749,750,751}

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 45


Chapter 7 Creating and Testing an RSI, a Retention Schedule, and a Classification

4. In the [Recman] section, add the following command line:


InheritFromAdditions={750,751}

5. Save the opentext.ini file.


6. Restart the Livelink Server.
7. Go to the Livelink Administration page and then click the Managed Objects
link in the Classifications Administration section.
8. Ensure that the Managed check box is selected for the 749, 750, and 751
subtypes.

9. Click the Update button.


10. Go to the Livelink Administration page and then click the Managed Objects
link in the Records Management Administration section.
11. Ensure that the Inherit from check box is selected for the 750 and 751 subtypes.

46 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


7.2 Populating Code Tables

12. Click the Update button.

7.2 Populating Code Tables


The tables maintenance codes are used to build RSIs and RM classifications, create
disposition holds and disposition searches, and effect dispositions on your records.
Due to the diverse and contrasting requirements of organizations, the code tables
are empty when Records Management is installed; there are no predefined codes in
your Livelink system. You cannot apply classifications and their related retention
schedules to objects until you have defined the codes and rules you want to use.
For this configuration, you must add the following codes:
• Essential Record, which are used to identify vital records. Records deemed
essential (vital) are fundamental to the continued functioning or reconstitution of
an organization during and after an emergency. Essential records protect the
legal and financial rights of that organization and of the individuals directly
affected by its activities. (Examples: V – VITAL, NV – NON VITAL)
• Final Disposition, which are used to create an RSI schedule. They describe the
action to be performed on an object at the end of its lifecycle. Many organizations
also use them to track the disposition of a record at the end of each lifecycle
stage. (Example: DES – DESTROY)
• Hold Type, which are used to describe the hold being placed on items in
Livelink. (Example: LEG – LEGAL, AUD – AUDIT)
• RSI Retention Stage, which define the retention schedule stages used for records
lifecycle management. (Example: DES – DESTROY)
• RSI Status, which identify the status of the RSI. (Example: ACT – ACTIVE)

NA090705-IGD-EN-2 Installation Guide 47


Chapter 7 Creating and Testing an RSI, a Retention Schedule, and a Classification

• Status, which are used to define the status of records at various points of their
lifecycles. They appear on the record and the RM classification. (Example: ACT –
ACTIVE)

• Storage Medium, which are used during the classification of objects to describe
the format of records. (Example: MIX – MIXED)

To add codes:
1. From the Enterprise menu, choose Records Management.
2. On the Records Management page, click the Records Management
Administration link.
3. On the Records Management Administration page, click the Table Maintenance
link.
4. On the Records Management Table Maintenance page, click the link for the
table to which you want to add a code.
5. From the Add Item menu, click a code type.
6. In the Code field, type a code.
7. Specify any of the remaining settings.
8. Click the Submit button.

7.3 Creating Record Series Identifiers


A Record Series Identifier (RSI) is a method for applying retention and disposal
information to electronic records. Once you have added the necessary codes, you
can create an RSI.

To create an RSI:
1. From the Enterprise menu, choose Records Management.
2. On the Records Management page, click the RSI link.
3. On the RSI page, from the Add Item menu, click RSI.
4. On the Add RSI page, in the RSI field, type Legal-100.
5. In the Title field, type Legal-100.
Optionally, in the Description field, type a description for the RSI. For example,
type additional metadata or the reason why the RSI is being created (litigation,
compliance, etc.).
Optionally, in the Subject field, type a description for the group of records to
which the RSI will be applied. For example, type scope notes describing specific
subject matter of the RSI.
6. In the Status drop-down list, click Act...Active.

48 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


7.4 Creating Retention Schedules

7. In the Status Date section, click a month, date, and year in the corresponding
drop-down lists to specify the date the status of an RSI becomes effective or was
modified.

8. Click the Add Item button.

7.4 Creating Retention Schedules


After you have created an RSI, you can create an associated schedule. To do so, you
have to understand the criteria and timing associated with the stages of records in
your organization. A schedule comprises a series of rules; each rule defines what
happens to a record at each stage of its lifecycle. Based on the rules for each stage of
the lifecycle, you must choose the appropriate rule type to calculate when a record is
ready to be disposed to the next stage.
The following five rule types exist in Livelink:
• Calculated Date, which is used when a rule states that an action must be taken
on a record after a specified period of time has elapsed.
• Calendar Calculation, which is used when a rule states that an action must be
taken on a record after a period of time following a specified year-end has
elapsed.
• Event Based, which is used when a rule states that an action must be taken on
record following a specified event.
• Fixed Date, which is used when a rule states that an action must be taken on a
specified date.

NA090705-IGD-EN-2 Installation Guide 49


Chapter 7 Creating and Testing an RSI, a Retention Schedule, and a Classification

• Permanent, which is used when a rule states that a record must be kept
indefinitely.
In the example provided in this document, you will create an RSI schedule based on
the Calculated Date rule type.

To create an RSI schedule based on the Calculated Date rule type:


1. From the Enterprise menu, choose Records Management.
2. On the Records Management page, click the RSI link.
3. On the RSI page, click the Functions icon for the Legal-100 RSI and then choose
Create Schedule.

4. On the Add RSI Schedule page, click the Classified Objects radio button, which
lets you apply the RSI schedule to RM classified objects.
5. From the Stage drop-down list, click Des...Destroy.
6. In the Rule Type section, click the Calculated Date radio button.
7. In the Rule Comment field, type All legal content is to be retained for 5
years from the point of creation..

8. Click the Continue button.


9. On the RSI Schedule – Date to Use page, from the Date to Use drop-down list,
click Create Date.
In the Period section, in the Years field, type 5 to set the retention period.

50 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


7.4 Creating Retention Schedules

10. Click the Continue button.


11. On the RSI Schedule – Event Conditions page, click the Continue button.
12. On the RSI Schedule – Action to Perform page, from the Disposition drop-
down list, click Des...Destroy.
13. Click the Destroy radio button to destroy an object when it reaches this stage.

NA090705-IGD-EN-2 Installation Guide 51


Chapter 7 Creating and Testing an RSI, a Retention Schedule, and a Classification

14. Click the Add button.

7.5 Creating RM Classifications


The RM classification structure is normally based on the file plan of an organization.
Organizations that do not have a file plan may choose to create a one-to-one
relationship between RSIs and the RM classification structure. As a result, the RM
classification structure is flat.

To create an RM classification:
1. From the Enterprise menu, choose Classifications.
2. On the Classifications page, on the Add Item menu, click RM Classification.
3. On the Add RM Classification page, in the Name field, type Legal.
Optionally, type additional information about the RM classification in the
Description field.
4. Type Legal-100 in the File Number field.
5. In the Creation Date section, click a month, date, and year in the corresponding
drop-down lists.
6. Click a code in the following drop-down lists:
• Status

52 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


7.5 Creating RM Classifications

• Essential
Note: Choose a non-vital code.
• Storage Medium
7. In the Status Date section, click a month, date, and year in the corresponding
drop-down lists.
8. Type a disposition authority in the Disposition Authority field. For example,
type a code reference to a manual, a department name, or an the name of an
individual.
9. From the Select RSI drop-down list, click Search RSI's.
10. In the Select RSI dialog box, click the Select link for the Legal-100 RSI.
11. On the Add RM Classification page, in the Subject field, type a subject for the
RM classification. For example, type additional metadata or scope notes.
12. Type keywords for the RM classification in the Keywords field.
Optionally, click the Edit button next to the Categories field, select a category
and then click the Done button to apply a category to the RM classification.

NA090705-IGD-EN-2 Installation Guide 53


Chapter 7 Creating and Testing an RSI, a Retention Schedule, and a Classification

13. Click the Add button.

7.6 Testing the System


Now that you have created a sample RSI, retention schedule, and RM classification,
test them by applying the items to a user's Personal E-mail Volume for inheritance,
set up an intelligent classification rule to apply to all e-mails or apply it manually to
items, or set the default RM classification for e-mails (subtype 749). For this test, you
will set the default RM classification.
You must then create and run a test disposition search that allows Records
Managers to find and process records that are ready for transition from one stage in
their lifecycle to the next.

54 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


7.6 Testing the System

To set the default RM classification for e-mails:


1. On the Livelink Administration page, in the Records Management
Administration section, click the Managed Objects link.
2. On the Managed Objects page, click the Select button for the E-mail type.
3. In the Browse Classifications dialog box, click the Select link for the Legal
classification.

4. Click the Update button.

Note: You must restart your Livelink service in order for these new settings to
take effect.
The following procedure assumes that the system has e-mails with the Legal-
100 RSI applied to them.

To create a disposition search:


1. From the Enterprise menu, choose Records Management.
2. On the Records Management page, click the Dispositions link.
3. On the Dispositions page, from the Add Item menu, click Disposition Search.
4. On the Disposition Search page, in the Name field, type Sample E-mail
Disposition Search.

5. In the Description field, type Search for everything that is to be


destroyed on or after March 31, 2012.

NA090705-IGD-EN-2 Installation Guide 55


Chapter 7 Creating and Testing an RSI, a Retention Schedule, and a Classification

6. Click the Add button.


7. On the Dispositions page, click the Functions icon for the Sample E-mail
Disposition Search disposition search, choose Properties and then choose
Specific.
8. On the Properties page for the disposition search, from the Stage drop-down
list, click Des...Destroy.
9. In the Date Specifications – Choose either Manual or Scheduled section, click
the Manual (Select Date Range) radio button.
10. In the From field, click a month (March), date (31), and year (2012) in the
corresponding drop-down lists.
11. From the Select RSI drop-down list, click Search RSI's.
12. In the Select RSI dialog box, click the Select link for the Legal-100 RSI.
13. In the Object Type list, click E-mail.
14. Specify any of the remaining settings.
Note: If you select the Auto Process Search Results check box, e-mails will
be deleted when the search is executed.
15. Click the Update button.

To start the disposition search:


• On the Dispositions page, click the Functions icon for the Sample E-mail
Disposition Search disposition search and then choose Start Search.

56 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


7.6 Testing the System

To view the disposition search results:


1. On the Dispositions page, click the Functions icon for the Sample E-mail
Disposition Search and then choose View Snapshots.
2. On the Snapshot view, click the date/time of the E-mail Disposition Search
Functions icon and then choose View All Results.

NA090705-IGD-EN-2 Installation Guide 57


Chapter 8
Installing Open Text Email Composer for Lotus
Notes on Archive Server
This chapter covers the following topics:
Section 8.1: “First-Time Installation of Email Composer on Archive Server”............. 61
Section 8.2: “Upgrading Email Composer on Archive Server 9.6.1” ............................ 65
Section 8.3: “Checking the Installation” ........................................................................... 66
Section 8.4: “Configuration Parameters”.......................................................................... 66

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 59


Chapter 8 Installing Open Text Email Composer for Lotus Notes on Archive Server

Where? Archive Server

Figure 8-1: Open Text Email Composer for Lotus Notes

Tasks of Email Archive Server provides Single Instance Archiving. This feature guarantees that
Composer identical attachments will be stored only once. Archiving in single instance mode
decomposes emails, which means that attachments are removed from the original
email and are stored as separate components on Archive Server. As soon as an email
is retrieved from Livelink, Archive Storage Provider checks whether the email needs
to be recomposed. If so, it forwards the request to Email Composer, which reinserts
the appropriate attachments into the email and passes the complete email to
Livelink.

Important
Before installing Email Composer, make sure that the Administration Client
of Archive Server is installed on Archive Server.

60 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


8.1 First-Time Installation of Email Composer on Archive Server

Note: If Archive Cache Server is used by all Archiving Bridges and Enterprise
Servers, you must install Email Composer on Archive Cache Server. Email
Composer supports Archive Cache Server 9.7.1. For installation on Archive
Cache Server, note the following information:
• You must use a different installation command on Archive Cache Server,
see step 2 in the following installation description.
• You must add the parameter USE_BASE_URL_FROM_CONFIG to the Email
Composer configuration, see “Configuration Parameters” on page 66.
• For the parameter DS_CONNECTION_HOST, you must specify the real
hostname of the Archive Server and not only “localhost”, see “Installing
Email Composer on Archive Server 9.7.1” on page 62.

8.1 First-Time Installation of Email Composer on


Archive Server
Notes:
• For information regarding the upgrade of Email Composer, refer to
“Upgrading Email Composer on Archive Server 9.6.1” on page 65.
• Upgrading to Archive Server 9.7.1 is only possible from Archive Server
9.6.1. For details, see either of the following guides:
• Open Text Archive and Storage Services on UNIX (with Oracle) - Upgrading
version 9.6.1 to 9.7.1 (AR-DUO)
• Open Text Archive and Storage Services on Windows (with MS SQL or
Oracle) - Upgrading version 9.6.1 to 9.7.1 (AR-DWO)

8.1.1 Installing Email Composer on Archive Server 9.6.x


To Install Email Composer on Archive Server 9.6.x:
1. Copy the distribution file LN_COMPOSER.zip to a temporary directory on
Archive Server, for example C:\Temp. The distribution file is located on the
product CD in one of the following directories:
For Microsoft Windows platforms
NotesComposer\LEA<version no.>\Windows
where <version no.> stands for the Archive Server version.
For UNIX platforms
NotesComposer\LEA<version no.>\Unix
where <version no.> stands for the Archive Server version.
2. On Archive Server, open the command line processor and call ixinst, as
described below, from the %IXOS_SRV_ROOT%/bin directory.

NA090705-IGD-EN-2 Installation Guide 61


Chapter 8 Installing Open Text Email Composer for Lotus Notes on Archive Server

Note: If you install Email Composer on Archive Cache Server, replace the
specifier INST_AS with
• INST_CS (for Archive Cache Server version 9.6.0) or

• INST_ACS (for Archive Cache Server version 9.6.1)

On Windows platforms
>> cd %IXOS_ARCHIVE_ROOT%/bin
>> ixinst -package -prodpkg INST_AS

On UNIX platforms
Log in as root.
root>> cd $IXOS_ARCHIVE_ROOT/bin
root>> ksh ixinst.ksh -package -prodpkg INST_AS

Follow the instructions in the command line.


When you install Email Composer on Archive Server 9.6.x, the following two
warnings might appear. You can ignore them.
Name "IXOS::Installation::PkgConf::OLDOUT" used only once: possible typo at $PF line
437.
Name "IXOS::Installation::PkgConf::OLDERR" used only once: possible typo at $PF line
438.

3. Enter the directory of arbitrary packages.


Specify the temporary directory to which you have copied the
LN_COMPOSER.zip file:

[C:\WINDOWS\Temp\IXOS\as]---> C:\TEMP

4. Specify that LN_COMPOSER is the arbitrary package to be copied or configured.


5. Confirm that you want to continue with the installation.
The program will start to configure the package you installed.

8.1.2 Installing Email Composer on Archive Server 9.7.1


To Install Email Composer on Archive Server 9.7.1:
The installation consists of adding ports to Tomcat, modifying the WAR file content
and deploying the WAR file.
1. Copy the distribution file notes.war to a temporary directory on Archive
Server, for example C:\Temp. The distribution file is located on the product CD
in one of the following directories:
For Microsoft Windows platforms
NotesComposer\LEA<version no.>\Windows, where <version no.> stands
for 97, depending on the Archive Server version.
For Unix platforms
NotesComposer/LEA<version no.>/Unix, where <version no.> stands for 97,
depending on the Archive Server version.

62 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


8.1 First-Time Installation of Email Composer on Archive Server

2. On Archive Server host, open the command line processor and unzip the
notes.war file to an empty temporary folder. Adapt the LN_COMPOSER.Setup to
your environment and zip the content again to notes.war.

Important
If you install Email Composer on Archive Cache Server 9.7.1, ensure that
the value for DS_CONNECTION_HOST is the hostname of the Archive
Server. It must not be “localhost”!

On Microsoft Windows platforms


Create an empty directory and unzip the content to it. Open the WEB-
INF\LN_COMPOSER.Setup file and specify for every placeholder the
corresponding value. Save the file. Zip both directories, WEB-INF and META-
INF, again in a new file also called notes.war.

On Unix platforms
Log in as root
Create an empty directory and unzip the notes.war file to it. Open the WEB-
INF/LN_COMPOSER.Setup file and specify for every placeholder the
corresponding value. Also change backslashes in example paths to slashes
on Unix.
Save the file. Zip both directories, WEB-INF and META-INF, again in a new file
also called notes.war.
3. On the computer hosting Archive and Storage Services, stop Archive Spawner.
To do so, open a command window and enter the following:
net stop spawner

4. Stop Apache Tomcat. To do so, open a command window and enter the
following:
net stop tomcat5

Note: This assumes that you did not change the Tomcat service name.
Otherwise, change tomcat5 accordingly.
5. Email Composer requires connectors to the ports 4060 and 4061. To add them to
the Tomcat configuration, do the following:
a. In the <Tomcat installation folder>/conf, open the server.xml file with an
editor.
b. If not present already, add connectors to the ports 4060 and 4061 as shown
below:
<!-- Define a non-SSL HTTP/1.1 Connector on port 4060 -->
<Connector port="4060" connectionTimeout="20000"
acceptCount="100" disableUploadTimeout="true"
enableLookups="false" maxHttpHeaderSize="8192"

NA090705-IGD-EN-2 Installation Guide 63


Chapter 8 Installing Open Text Email Composer for Lotus Notes on Archive Server

maxSpareThreads="75" maxThreads="150"
minSpareThreads="25" redirectPort="4061" />
<!-- Define a SSL HTTP/1.1 Connector on port 4061 (if needed)
-->
<Connector port="4061"
acceptCount="100" algorithm="SunX509"
clientAuth="false" disableUploadTimeout="true"
enableLookups="false" maxHttpHeaderSize="8192"
maxSpareThreads="75" maxThreads="150"
minSpareThreads="25" scheme="https"
secure="true" sslProtocol="SSL"
keystoreFile="<path to keystore file>"
keystorePass="<keypass>" />

Here, <path to keystore> file is the location of the file generated with the
keytool command; <keypass> is the password entered when requested by
keytool. The same password must be entered in the last step, so that the
password for the certificate named tomcat equals the password of the
keystore.
c. Save the file.
6. To deploy the Email Composer WAR file in Tomcat, do the following:
a. Copy the modified and zipped notes.war file to the <Tomcat
installation>/webapps directory on Archive Server.

On Unix Platforms – Ensure the correct owner and mode:


root # chmod a+r notes.war
root # chown ixosadm:ixossys notes.war

b. Start Apache Tomcat. To do so, enter the following:


net start tomcat5

c. Start Archive Spawner. To do so, enter the following:


net start spawner

Example 8-1: LN_COMPOSER.Setup for Archive Server 9.7.1:


The following is a listing of LN_COMPOSER.Setup file with placeholders from
notes.war.

# Configure connection settings for Archive server


# Please adapt the placeholders for e.g. file paths to your
environment according to the installation guide.
CERT_FILE=<PLACEHOLDER_PATH_TO_ixoscert.pem>
# If PEM is password protected, enter
# CERT_PWD=<password encrypted using dsClient enc>
CERT_PWD=
# If HTTP is used, use port 9080
DS_CONNECTION_PORT=9080

64 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


8.2 Upgrading Email Composer on Archive Server 9.6.1

# Else if HTTPS is used, use port 9090


#DS_CONNECTION_PORT=9090
# Add the hostname of Archive Server, e.g. localhost, for Archive
Cache Server
# the real hostname of Archive Server (not localhost) must be given
DS_CONNECTION_HOST=localhost
# Do not alter this value
MEMORY_LIMIT=1025
# Set this variable to false. Note: Needed for support of Archive
Server 5.5.
USE_IAIK_SSL=false

CONTENT_DISPOSITION=attachment; filename=DATA.XML
SKIP_CLEAN_UP=false

# Leave the following setting as it is.


LOG_CONFIG_TYPE=PACKAGE_BASED
ROOTPKG=LN_COMPOSER

# configure temp directory and log settings


TEMP_DIR=<PLACEHOLDER_TEMP_DIRECTORY>
IXOS_SRV_LOG=<PLACEHOLDER_VAR_DIR>
LOG_FILE=<PLACEHOLDER_LOGFILE_PATH>\\NotesComposer.log
LOG_LEVEL=INFO
MAXLOGSIZE=1000000

# Number of threads used to compose emails


HTTP_MAX_CONNECTIONS_PER_HOST=20
#USE_BASE_URL_FROM_CONFIG=off

#enable to specify class specific logging


#LOG_CLASS_0=ixos.dms=ERROR
#LOG_CLASS_1=ixos.al=WARN
#LOG_CLASS_2=ixos.base=WARN
#LOG_CLASS_3=ixos.sec=ERROR
#LOG_CLASS_4=org.apache=WARN
#LOG_CLASS_5=httpclient=WARN

8.2 Upgrading Email Composer on Archive Server


9.6.1
Prerequisites Upgrade Archive Server from 9.6.1 to 9.7.1 according the instruction in Open Text
Knowledge Center:
https://knowledge.opentext.com/knowledge/llisapi.dll/Open/14697323

NA090705-IGD-EN-2 Installation Guide 65


Chapter 8 Installing Open Text Email Composer for Lotus Notes on Archive Server

Important
Archive and Storage Services (Archive Server) 9.7.1 completely differs from
Archive Server 9.6.1 in the installation locations and in the runtime
environment.

To Upgrade Email Composer:


1. Perform the steps described in “Installing Email Composer on Archive Server
9.7.1” on page 62 .
2. The installation steps placed a notes.war file in the <tomcat installation
directory>/webapps directory, which got deployed by the tomcat restart.

3. Restart the Spawner Service.

8.3 Checking the Installation


To make sure that you installed or upgraded Email Composer correctly, perform the
following test:

1. Open a browser window on any client computer that has access to Archive
Server.
2. Enter the following URL:
Archive Server 9.6
http://<Archive Server name>:4060/notes?info

Archive Server 9.7.1


http://<Archive Server name>:8080/notes?info

Replace <Archive Server name> with the correct host name of Archive Server.
3. Check whether the general information page of Email Composer displays. This
information page contains the product name and version number of Email
Composer.

8.4 Configuration Parameters


You can adjust the behavior of Email Composer by setting configuration
parameters. In most cases, however, you will not need to change the configuration
after installation.
Note: For the description for Archive Server 9.7.1, see “Installing Email Com-
poser on Archive Server 9.7.1” on page 62.
Windows For Archive Server 9.6.x in a Windows environment, you can change the
configuration by editing the registry keys under:
• HKEY_LOCAL_MACHINE\SOFTWARE\IXOS\IXOS_ARCHIVE\LN_COMPOSER

66 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


8.4 Configuration Parameters

• HKEY_LOCAL_MACHINE\SOFTWARE\IXOS\IXOS_ARCHIVE\COMMON

For Archive Server 9.7.1 in a Windows environment, you have to edit the
parameters in the following configuration file:
<Tomcat installation>\webapps\notes\WEB-INF\LN_COMPOSER.Setup

Unix For Archive Server 9.6.x in a Unix environment, you have to edit the parameters in
the configuration files:
• %IXOS_ARCHIVE_ROOT%/config/setup/LN_COMPOSER.Setup

• $IXOS_ARCHIVE_ROOT/config/setup/COMMON.Setup

For Archive Server 9.7.1 in a Unix environment, you have to edit the parameters in
the following configuration file: <Tomcat installation>/webapps/notes/WEB-
INF/LN_COMPOSER.Setup.

Parameters The following configuration parameters are available:

Parameters in the Registry Branch LN_COMPOSER, and in the Configuration


File LN_COMPOSER.Setup for UNIX and Windows
DS_CONNECTION_HOST
The name of the Archive Server to which you want to connect. Since in a
productive environment you always have to install Email Composer on Archive
Server, you should set this value to localhost. In case you installed on Archive
Cache Server then you must set this to the hostname of Archive Server.
The default value is localhost.
DS_CONNECTION_PORT
The HTTP port on which the document service runs.
The default value is for 9.6 8080 and for 9.7.1 9080.
DETAIL_INFO
Set this parameter to true to display the complete configuration when using
http://<Archive Server name>:8080/notes?info.

LOG_LEVEL
Sets the overall log level for Email Composer.
The default value is WARN; possible values are ALL, DEBUG, INFO, WARN, ERROR,
FATAL.

LOG_CLASS_<n>
The logging mechanism supports setting individual log levels for different
classes or groups of classes. For this purpose, configuration parameters of the
following form can be added:
LOG_CLASS_<n> = "<class or namespace>=<log level>" where <n> is a
consecutive number starting from 0.
Example: The entry LOG_CLASS_0 = "ixos.dms=INFO" sets the log level for all
classes of the namespace ixos.dms to INFO.

NA090705-IGD-EN-2 Installation Guide 67


Chapter 8 Installing Open Text Email Composer for Lotus Notes on Archive Server

MAXLOGSIZE
Sets the maximum size of the log (in bytes). If the log file reaches this size, the
system automatically creates a new log file.
The default value is 1000000.
USE_IAIK_SSL
Forces the use of the IAIK package for SSL.
Note: Must be set to false.
The default value is false.
TEMP_DIR
Specifies the directory that Email Composer uses to store temporary files.
The default value is %IXOS_ARCHIVE_ROOT%\var\notes\temp.
CONTENT_DISPOSITION
This value specifies whether the browser will show a File Save dialog box that
displays the file name for download. If you leave this field empty, the system
will not display a File Save dialog box and the archived email is shown directly
in the browser window.
This value is important only if Email Composer is called directly from a browser.
In standard scenarios, this has no effect. Therefore, change this value only for
testing reasons.
The default value is attachment;filename=DATA.XML.
SKIP_CLEAN_UP
This value specifies whether the system should skip the clean-up process (for
example deletion of temporary files). Set this value to true only for testing
purposes.
The default value is false; possible values are true, false
CERT_FILE
File path of the certificate file used for SSL communication with Archive Server.
The default value is $IXOS_SRV_CONFIG\setup\ixoscert.pem.
CERT_PWD
If the certificate is password-protected, specify the password here. Use the
dsClient enc command to encrypt the password.

Parameters in the Registry Branch


HKEY_LOCAL_MACHINE\SOFTWARE\IXOS\IXOS_ARCHIVE\COMMON , Unix
Configuration File COMMON.Setup, and Windows and Unix Configuration File
LN_COMPOSER.Setup

HTTP_MAX_CONNECTIONS_PER_HOST
The number of concurrent HTTP connections to the Document Service. If more
clients access Email Composer than HTTP connections are specified, Email
Composer might block.

68 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


8.4 Configuration Parameters

The default value for 9.6 is 32 and for 9.7.1 20.


USE_BASE_URL_FROM_CONFIG
If you installed Email Composer on Archive Cache Server, add this parameter to
the configuration and set the value to on.

NA090705-IGD-EN-2 Installation Guide 69


Chapter 9
Prerequisites for Installing the Email Archiving
Bridge for Lotus Notes
Before you start the installation, read the requirements carefully. Some action items
have to be done first and would interrupt your installation if you skipped them.

Important
See the Release Notes for Open Text Email Archiving for Lotus Notes in the
Open Text Knowledge Center for the most recent information.

Note: Additional requirements are defined for the individual components of


the Email Archiving Bridge for Lotus Notes. Those are listed within the
installation parts of the specific component.
This chapter covers the following topics:
Section 9.1: “Platform Requirements”............................................................................... 71
Section 9.2: “Archive Server Prerequisites” ..................................................................... 73
Section 9.3: “Email Archiving Bridge for Lotus Notes Prerequisites”.......................... 73
Section 9.4: “Synchronization Service” ............................................................................. 74
Section 9.5: “Users and Permissions”................................................................................ 74

9.1 Platform Requirements

Important
Depending on the component that you want to install, different platforms
are necessary. For detailed information, refer to the following table.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 71


Chapter 9 Prerequisites for Installing the Email Archiving Bridge for Lotus Notes

Table 9-1: Platform requirements

Feature Platform Description


Email Archiving Lotus Notes Client Install the Archiving Service on a com-
Service for Lotus Notes 8.5.1 FP1 puter using Microsoft Windows as the
operating system. A Lotus Notes client
8.5.1 with FP1 must be installed and
configured properly with the correct
location.
Email Synchronization Lotus Notes Client Install the Synchronization Service on a
Service 8.5.1 FP1 computer using Microsoft Windows as
the operating system where Lotus
Notes client 8.5.1 with FP1 is installed.
ACMF Lotus Domino 7.0.2 Install the ACMF template, which is
needed to create the administration
or higher tool.
Database templates Lotus Domino 7.0.2 Install the database templates with the
ACMF.
or higher
Domino Web Lotus Domino 7.0.2 Install the archiving functionality for
Access/Lotus iNotes with Domino Web Domino Web Access/Lotus iNotes.
Access/Lotus iNotes

or higher

Note: To ensure proper functioning for the integration of Livelink Explorer


into Email Archiving for Lotus Notes, you must enable the ActiveX control in
Microsoft Internet Explorer.

To enable the ActiveX control:


1. In Microsoft Internet Explorer, select Tools > Internet Options.
2. Open the Security tab, select Livelink’s zone and click Custom.
3. In the ActiveX controls and plug-ins section, enable the option Allow
previous unused ActiveX controls to run without prompting.
If the ActiveX control is installed through the Web Automatic Install
procedure, enable Automatic prompting for ActiveX controls.

72 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


9.2 Archive Server Prerequisites

9.2 Archive Server Prerequisites


The Archive Server must be installed, configured and ready for use. The
Administration Client must be installed on the Archive Server. The logical archive
that is used by the Email Archiving Bridge for Lotus Notes must already exist on the
Archive Server.

Important
The DATA.XML component must be excluded from Single Instance
Archiving on Livelink ECM – Archive Server. The Archive Server might run
into severe performance and stability problems or might even crash if huge
amounts of DATA.XML documents are archived. These documents are
different for each archived e-mail. For performing the exclusion of
DATA.XML, refer to the description of the SiaName.Setup configuration file
on the Archive Server section 14.2.2.5.5.2
"AS.SiaName.COMPONENT.SIA.SIANAME_SETUP - Component names
that prohibit(!) single instance archiving" in Open Text Administration Help -
Runtime and Core Services (ELCS-H-AGM).

Compress data To compress data on the Archive Server, specify the formats to be compressed in the
Server Configuration under Document Service (DS) / Component settings /
Compression / Component types to be compressed. The archived Lotus Notes
documents are stored with the mime types “application/vnd.lotus-notes” and
“text/xml”. If necessary, add formats, e.g. of mail attachments. For further
information, see section 5.1.1 "Data compression" in Open Text Open Text Archive
Server - Administration Guide (AR-ACN).
Email Composer Open Text Email Composer for Lotus Notes must be installed on the Archive Server.
Refer to “Installing Open Text Email Composer for Lotus Notes on Archive Server”
on page 59.
Tip: To save disk space, Open Text recommends that you enable Single
Instance Archiving on the logical archive of the Archive Server.

9.3 Email Archiving Bridge for Lotus Notes Prereq-


uisites
Archiving The running Archiving Service needs at least 2 GB of free physical memory. The
Service: Physical memory is used by Java and the underlying C layers.
memory

Synchronization The running Synchronization Service needs at least 250 MB of free physical memory.
Service: Physical
memory

Administration The administration templates on the Lotus Domino server must be installed.

NA090705-IGD-EN-2 Installation Guide 73


Chapter 9 Prerequisites for Installing the Email Archiving Bridge for Lotus Notes

Service User Archiving Service and Synchronization Service require a Lotus Notes user ID to
connect to the Lotus Notes Domino servers. This ID is referred to as the Service User.
For detailed information, see “Service User” on page 74.

Important
The last user who accessed the Lotus Notes client on the Archiving Service
host must be the Service User. Otherwise, archiving and retrieving
documents will not work correctly.
The Lotus Notes Client which is installed on the Archiving Service computer
must not be running when the Email Archiving Service for Lotus Notes is
running.
The Offline Extension DLL must not be installed and activated on the
Archiving Service computer. Otherwise archiving and retrieving will not
work correctly.

Lotus Notes The Lotus Notes Diagnostics service must be disabled.


Diagnostics

Two or more You must not install and run Archiving Service, Synchronization Service or
services Journaling Service for Lotus Notes on the same computer. Every service needs its
own computer because the Lotus Notes libraries must only be used by one
implementation at a time.
Web browser For using Email Management for Lotus Notes, only Microsoft Internet Explorer 6.0
or higher is supported, no other web browsers.

9.4 Synchronization Service


The Synchronization Service uses a simple relational database to store deletion
requests. Currently, Microsoft SQLServer and Oracle databases are supported. A
dedicated database instance must be created, following the general settings of
Livelink ECM – Archive Server. Open Text recommends that the database uses
unicode and is case-insensitive.
The Synchronization Service requires one table in that database which you create
with a script that you find in the installation directory after the installation.

9.5 Users and Permissions


Service User First, you must create the Service User that the Email Archiving Service for Lotus
Notes requires to connect to Lotus Domino.
• The Service User must be registered in the Lotus Domino directory prior to the
installation.
• The ID file must be accessible.

74 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


9.5 Users and Permissions

• The Lotus Notes client must be configured for the connection to the Lotus
Domino server with the Service User.
• The Service User must be added to the ACL of all databases to have archiving
capabilities, or to a group (for example an administrative group) that has already
been added to the ACL.
Permissions The following tables provide an overview of the permissions that users must have in
order to install and run the Archiving Bridge.

Table 9-2: Necessary Permissions for the Lotus Notes User Who Works with
the ACMF

Where? Permissions
In the Lotus Domino server document, Se- Create databases & templates privilege
curity tab (because the Activate server action creates a
new order database)
Create master templates privilege (be-
cause the Activate server action copies the
order, logging and design database tem-
plates which are marked as master tem-
plates)

Note: These permissions are necessary to perform a Notes copy. See “Installing the
Database Templates on Lotus Domino” on page 84

In all databases to archive from Designer access level with the additional
Delete documents privilege (at least) to be
able to update design elements and profile
documents
In the database Forms*.nsf (see Designer access level (at least)
“Configuring Domino Web Access/Lotus
iNotes” on page 85)

Note: ACMF, log and order databases are created by this user.

Table 9-3: Necessary Permissions for the Service User

Where? Permissions
In ACMF and log databases Editor access level with the additional
Delete documents privilege (at least)

In order databases and all databases to ar- Editor access level with the additional
chive from Delete documents and Replicate or copy
documents privileges (at least)

NA090705-IGD-EN-2 Installation Guide 75


Chapter 9 Prerequisites for Installing the Email Archiving Bridge for Lotus Notes

Where? Permissions
In the user's mail database Editor access level with the additional
Delete documents and Replicate or copy
documents privileges (at least)

Note: The permissions for the Service User (table 9-3) are included in the permissions
for the user who works with the ACMF (table 9-2). Scheduled tasks run under the
Service User. The database templates must be signed with the Service User.

With Manager access level including delete rights, all features are available for the
Service User.

Table 9-4: Necessary Permissions for Livelink

Where? Permissions
Livelink ECM – Enterprise Server Any user who is enabled for archiving must
have an account on the Livelink to be able
to search archived items on the Enterprise
Server. The permissions of the Livelink
nodes will not be kept in sync with any
permission changes made to the original
source folders.
Livelink ECM – Enterprise Server Livelink Administrator for installing and
administering the Email Management and
Email Services modules and for installing
the Livelink Billing and Quota Management
module.

Table 9-5: Necessary Permissions for Lotus Notes

Where? Permissions
Lotus Notes Mail Database Users who use the Archive now function in
the Livelink Archiving view must at least
have Editor access with the right Create
shared folders/views in the ACL of their
mail database.

76 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Chapter 10
Installing the Email Archiving Bridge for Lotus
Notes
This chapter covers the following topics:
Section 10.1: “Installing and Configuring the Archiving Service and the
Synchronization Service”.................................................................................................... 77
Section 10.2: “Installing the Database Templates on Lotus Domino” .......................... 84
Section 10.3: “Preparing the Archive Configuration and Management Facility
(ACMF)” ............................................................................................................................... 85
Section 10.4: “Configuring Domino Web Access/Lotus iNotes”.................................. 85

10.1 Installing and Configuring the Archiving Service


and the Synchronization Service
Prerequisites Check the installation prerequisites in section “Email Archiving Bridge for Lotus
Notes Prerequisites” on page 73. Additionally, all modules must be installed and
configured.
Where? Install the Email Archiving Service for Lotus Notes on a computer with a Microsoft
Windows operating system and with Lotus Notes installed.
Product CD The product ISO image comprises the complete product CD-ROM in one *.iso file.
The product ISO image is available in the Open Text Knowledge Center: Select the
product family page and then click the Downloads link. This guide assumes that
you burn a CD-ROM with the ISO image.
Note: The installation of the Synchronization Service is optional. Install the
Synchronization Service only if you want to find and delete orphaned objects
in the archive. For further information, see section 6 "Synchronizing Archive
and Email Database" in Open Text Email Archiving/Management for Lotus Notes -
Administration Guide (NA-AGD).

Important
Archiving Service and Synchronization Service must not be installed on the
same machine.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 77


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

To Install Archiving Service or Synchronization Service:


1. Log in to the computer as an administrator.
2. Insert the Open Text Email Archiving for Lotus Notes CD-ROM into the CD-
ROM drive, and double-click Mastersetup.exe in case the Master Setup does not
start automatically. The Open Text Master Setup opens. It prepares the
installation.
3. Master Setup

Follow the instructions of the Master Setup:


a. Selection
Select the product. The status tells you if and how the product is installed:
• installable
First-time installation, no upgrade
• upgrade
Upgrade installation. Previous settings will be used.
• installed
Same version is already installed. You cannot proceed.
Click Next

78 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.1 Installing and Configuring the Archiving Service and the Synchronization Service

b. Prerequisites
Read the license agreement and click Agree.
If you do not accept the terms of the license agreement, the installation will
stop.
The following screen lists the technical requirements for the installation.
Ensure that you meet the requirements and click Next.
The installation step Parameters is skipped for this installation.
c. Summary
Check the summary and click Install.
The Master Setup opens the Windows Installer which guides you through
the actual installation of Email Archiving Bridge for Lotus Notes.
4. Welcome
Enjoy the welcome greetings and click Next.
5. Custom Setup
Select one of the following scenarios:
• Archiving Service and Templates
• Synchronization Service
Note: You must not install both Archiving Service and Synchronization
Service simultaneously on one machine.

NA090705-IGD-EN-2 Installation Guide 79


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

6. Custom Setup

Select the components you want to install. The Synchronization Service is


disabled by default.
Note: To install the Synchronization Service, disable Archiving Service
and enable Synchronization Service.
Tip: You can change the installation directory. Select the component for
which you want to change the installation directory, and click Browse.
Templates are installed in a different subdirectory. The templates are
copied to the computer, locally. Later, you will copy them to the Domino
Server using Notes Copy.
Click Next and then click Install.
The selected components are installed.
7. After installation, select Launch configuration tool when setup exits. Then click
Finish.
Tip: You must configure the Archiving Service and the Synchronization
Service before you can use them. However, you can call the configuration
tool anytime later, see “Setting Up the Services” on page 81.
8. Close the Master Setup window after installation.

80 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.1 Installing and Configuring the Archiving Service and the Synchronization Service

10.1.1 Setting Up the Services


After installation, you can select to open the Email Archiving Configuration
immediately. You can also choose to set up the services later. However, you must
set up the services before you can use them.

To Open the Configuration Tool:


• From the Start menu, select All Programs – Open Text – Email Archiving for
Lotus Notes – Email Archiving Configuration.

To Set Up the Archiving Service:


1. Fill in the required fields of the Email Archiving Configuration.

Environment tab
Lotus Notes installation directory
Directory where Lotus Notes is installed. The default is C:\Lotus\Notes.
Java directory
Directory where the Lotus Notes Java Virtual Machine is installed. Typically,
this is a subdirectory jvm/ to the Lotus Notes installation directory.
Note: Email Archiving/Management supports Lotus Notes Java Vir-
tual Machine only.

Important
When changing the paths, a new service.bat file is created. If you
use custom settings in your service.bat, create a backup of the old
file and copy the settings to the new service.bat.

Lotus Notes password and Confirm password


Enter the Lotus Notes password of the Service User and confirm it
Tip: The Service User should have been the last user to log on to the
Lotus Notes system before the installation, see “Service User” on
page 74
Hierarchical name of the Domino server
Specify the name of the Domino Server, for example
MyDominoServer/MyDomain.

Archive Configuration and Management Facility


Enter the path to the ACMF database on the Domino Server, for example
acmf/acmf.nsf, see “Installing the Database Templates on Lotus Domino”
on page 84.

NA090705-IGD-EN-2 Installation Guide 81


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

Archiving Service tab


Archiving Service name
Enter a name for the Archiving Service. This must match the Archiving
Service name in the ACMF.
Product component name
Name of the service. This is the internal service name in the Windows
Service Control Manager. It cannot be changed.
Service startup mode
Windows service startup mode. This value is taken from the Windows
Service Control Manager. It cannot be changed.
2. Click Finish.
The Email Archiving Configuration writes the parameters to the Service.ini
file and creates *.bat files. You are informed, when the creation successfully
finished.

To Set Up the Synchronization Service:


1. Fill in the required fields of the Email Archiving Configuration.
2. Enter the parameters of the Environment tab as described in “Environment tab”
on page 81.
3. Enter the parameters of the Synchronization Service tab.
Synchronization Service name
Enter a name for the Synchronization Service. This must match the
Synchronization Service name in the ACMF.
Product component name
Name of the service. This is the internal service name in the Windows
Service Control Manager. It cannot be changed.
Service startup mode
Windows service startup mode. This value is taken from the Windows
Service Control Manager. It cannot be changed.
Database vendor
Select a database type, either sqlserver for “Microsoft SQL Server” or
oracle for “Oracle Database”.

Server
Enter the name of the database server.
Port
Enter the port of the database server. The default is 1521 for Oracle
Databases and 1433 for MS SQL Server.
Database name
Enter the name of the database.

82 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.1 Installing and Configuring the Archiving Service and the Synchronization Service

Database user
Enter the name of the database user
Database password
Enter and confirm the password of the database user.
4. Click Finish.
The Email Archiving Configuration writes the parameters to the Service.ini
file and creates *.bat files. You are informed, when the creation successfully
finished.
5. Create a database table for the Synchronization Service.
a. Open the <installation directory>/scripts folder.
b. Run the script for your database type against the database.

Tip: Information provided during this setup configuration is stored in the


Service.ini file, located in the installation folder, e.g. C:\Program Files\-
Open Text\Email Archiving for Lotus Notes\Archiving Service\ for the
Archiving Service and C:\Program Files\Open Text\Email Archiving for
Lotus Notes\Synchronization Service\ for the Synchronization Service. If
necessary, you can edit this file to change the information after the installation.
See also a description of the parameters for the Service.ini file in “Service.ini
Parameters” on page 95.

10.1.2 Changing the Startup Type of the Service


After the installation, a new Windows service Email Archiving Service for Lotus
Notes or a new Windows service Email Synchronization Service for Lotus
Notes is created on your system with startup type Disabled. You must change the
startup type of the service.
1. From the Control Panel, select Administrative Tools – Services:
2. Find the Email Archiving Service for Lotus Notes or Email
Synchonization Service for Lotus Notes, respectively.

3. Change the Startup Type.


• Archiving Service – Startup type must be Automatic.
• Synchronization Service – Startup type must be Manual. The
Synchronization Service is designed to run as a scheduled task or to be
started manually, not automatically.

Important
Do not start the service at this point.

NA090705-IGD-EN-2 Installation Guide 83


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

10.2 Installing the Database Templates on Lotus


Domino
To install the database templates on the Lotus Domino server, perform a Notes
copy.
Note: You need Create database and Create master template privileges on the
Lotus Domino server for the Notes copy of the templates.
Tip: In Lotus Notes 8.5, the Notes Copy option is not visible by default. To use
the Notes copy option, select View – Advanced menus.
During the installation of the Archiving Service, you copied the database templates
for the administration of the Archiving Bridge to a specified directory on the
Archiving Service host. By default, it is the following directory: C:\Program
Files\Open Text\Email Management for Lotus Notes\Templates.

To Copy the Templates to the Domino Server:


1. Open the templates on the Archiving Service computer.
This concerns the following templates:
• arcacmf.ntf: template for the Archive Configuration and Management
Facility (ACMF)
• arcdesign.ntf: template with all design elements for the Email Archiving
Bridge for Lotus Notes
• arcdocpipe.ntf: template for the Open Text Document Pipeline plug-in

• arclog.ntf: Logging database template

• arcorder.ntf: Order Database template

• arcdwa702.ntf: archiving extension for Domino Web Access 7.0.2

• arcdwa801.ntf: archiving extension for Domino Web Access 8.0.1

• arcdwa802.ntf: archiving extension for Domino Web Access 8.0.2

• arcdwa850.ntf: archiving extension for Lotus iNotes 8.5.

2. For each template, perform a Notes copy to the Lotus Domino server.
a. Select File – Application – New Copy.
b. Enter the name of the Domino Server.
c. Select the option Application design and documents.
d. Click OK.
The templates can be copied directly into the Data Directory of the Lotus
Domino server or into a sub-directory.

84 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.3 Preparing the Archive Configuration and Management Facility (ACMF)

3. Sign all database templates directly after the installation with the Service User.

10.3 Preparing the Archive Configuration and


Management Facility (ACMF)
You use the ACMF to configure the Email Archiving Bridge for Lotus Notes and to
manage the archive enabled databases. Create it directly after the installation.

Important
You can only have one ACMF for each separate server landscape. You might
replicate the ACMF for system stability.

ACL Access to the ACMF is controlled by the ACL of the database. To gain access to the
individual databases, it is necessary to start Lotus Notes under the Service User of
the Archiving Bridge or under another user who has the corresponding privileges to
all databases, for example the administrator.

To create the ACMF:


1. Make sure that you have signed the arcacmf.ntf template in the data directory
of the Lotus Domino server with the Service User.
2. Using the database template arcacmf.ntf, create a new database using folder
and name you specified during the installation, for example, acmf.nsf. See also
Section 10.1.1: “Setting Up the Services” on page 81.
3. Configure the ACL of the database. For possible access levels, refer to “Users
and Permissions” on page 74.
4. Check whether the Service User has at least read access to the Lotus Domino
directory.
5. The ACMF database is now created. For the configuration of the ACMF, refer to
section 1 "Getting Started: Open Text Email Archiving/Management for Lotus
Notes" in Open Text Email Archiving/Management for Lotus Notes - Administration
Guide (NA-AGD).

10.4 Configuring Domino Web Access/Lotus iNotes


Note: The archiving functionality within Domino Web Access/Lotus iNotes
(DWA) respectively, is available in English only.

10.4.1 Introduction
For the necessary permissions, see Table 9-2: “Necessary Permissions for the Lotus
Notes User Who Works with the ACMF” on page 75

NA090705-IGD-EN-2 Installation Guide 85


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

Versions For the supported versions of the Domino server on which you want to use the
archiving functionality for Domino Web Access/Lotus iNotes with the Forms*.nsf,
see the Release Notes. If the server version does not match, upgrade your system or
contact Open Text Global Services.

Table 10-1: Databases and Templates

Domino 7.0.2 or 8.0.1 8.0.2 8.5.0 8.5.1


version higher 7.0.x
Default Forms7.nsf Forms8.nsf Forms8.nsf Forms85.ns Forms85.ns
Domino f f (additional
forms data- Forms85_x.
base for nsf needed)
Domino
Web Ac-
cess/Lotus
iNotes (in
..\Domino\
Data\iNote
s)

Standard dwa7.ntf mail8.ntf mail8.ntf mail85.ntf mail85.ntf


Lotus Notes with version with version
template to 8.0.1 8.0.2
be used for
databases
which are to
be extended
with the ar-
chiving
functionality
for Domino
Web Access
Templates arcdwa702. arcdwa801. arcdwa802. arcdwa850. arcdwa851.
with Archiv- ntf ntf ntf ntf ntf
ing integra-
tion. In-
stalled with
Archiving
Service
Installation 10.4.2 10.4.3 10.4.3 10.4.4 10.4.5
procedure in
section

Tip: The Database - Open dialog of Lotus Notes does not display the
Forms*.nsf database. Navigate to the ..\Domino\Data\iNotes directory and
type the name of the Forms*.nsf database, manually. Then click Open.

86 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.4 Configuring Domino Web Access/Lotus iNotes

Important
If you use a different template available on the Domino server, e.g.
iNotes5.ntf, switch to the template supported by Email Archiving for
Lotus Notes.

Templates During installation of the Archiving Service, templates have been installed in the
Templates\ subdirectory of the installation directory. The templates contain the
complete Email Archiving for Lotus Notes integration with Domino Web
Access/Lotus iNotes.

10.4.2 Version 7.0.2: Installing the archiving extension for


DWA
To Install the Archiving Extension for DWA:
1. Log in as the Service User.
2. Open the arcdwa702.ntf template.
3. Click the Copy Design Elements action button.
4. From the Choose Database dialog, select the iNotes/Forms7.nsf database on
the Domino server you want to use the archiving extension for DWA on.
Confirm the appearing dialogs. The design elements are copied to the specified
Forms7.nsf database.

5. Repeat the steps 2 to 4 for other Domino servers you want to use the archiving
extension for DWA on.
6. In Domino Designer, open the Forms7.nsf file.
7. Create a backup of your Custom_JS form before you modify it. This enables you
to revert the template to the original condition if needed.
8. Modify the Custom_JS form in every Forms7.nsf database on all Domino
servers you want to use the archiving extension for DWA on. Changes are
described in the Custom_JS_* set of forms in the arcdwa702.ntf template.
Custom_JS_modified_original
already changed content of the Custom_JS design element. You can use it
directly if you did not change the original content from IBM.
Custom_JS_commented_changes
changes to be done in the original content from IBM. The form describes
how to do the changes manually.
Tip: If there were no changes done in the target Custom_JS form it is
fastest to replace its content by the content of the
Custom_JS_modified_original source form. If there were any custom
modifications done there since the original release of the relevant Domino

NA090705-IGD-EN-2 Installation Guide 87


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

server the changes must be done by editing the form manually according
to the description of changes in the Custom_JS_commented_changes
source form.
9. In Lotus Domino Designer, open the Forms7.nsf, and open the properties of
the LLCreateOrder agent.

Enter the name of the Service User into the Run on behalf of field. Make sure
this user has the required permissions to run server agents.

Important
Do not select Run as web user, because this function results in the
effective user ID Anonymous, which does not work.

10. Start or restart your Domino HTTP server task.

To Uninstall the Archiving Extension for DWA:


1. Log in as the Service User.
2. Open the arcdwa702.ntf template.
3. Click the action button Remove Design Elements.
4. From the Choose Database dialog, select the iNotes/Forms7.nsf database on
the Domino server you want to remove the archiving extension for DWA from.

88 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.4 Configuring Domino Web Access/Lotus iNotes

5. Confirm the appearing dialogs. The design elements are removed from the
specified forms7.nsf database.
6. Repeat the steps 3 to 5 for other Domino servers you want to remove the
archiving extension for DWA from.
7. Undo changes in the Custom_JS in the Forms7.nsf on each server on which
they were done during the installation. You can use the backup of the
Custom_JS.

10.4.3 Versions 8.0.1 or 8.0.2: Installing and Uninstalling the


Archiving Extension for DWA
Naming The following procedures refer to the arcdwa80?.ntf file when either the
convention arcdwa801.ntf or the ardwa802.ntf is meant.

Requirements Domino Server 8.0.1 with version 8.0.1 of Forms8.nsf


OR
Domino Server 8.0.2 with version 8.0.2 of Forms8.nsf
Mail files using the mail8.ntf template. The template name is StdR8Mail.
Note: Only Full mode is supported, since there is no customization form for Lite
mode in Domino 8.0.x.

To Install the Archiving Extension for DWA:


1. Log in as the Service User.
2. Open the arcdwa80?.ntf template.
3. Click the Copy Design Elements action button.
4. From the Choose Database dialog, select the Domino Server\iNotes\Forms8.-
nsf database on the Domino server you want to use the archiving extension for
DWA on.
Confirm the appearing dialogs. The design elements are copied to the specified
Forms8.nsf database.

5. Repeat the steps 2 to 4 for other Domino servers you want to use the archiving
extension for DWA on.
6. In Domino Designer, open Forms8.nsf.
7. Create a backup of your Custom_JS form before you modify it. This enables you
to revert the template to the original condition if needed.
8. Modify the Custom_JS form in every Forms8.nsf database on all Domino
servers you want to use the archiving extension for DWA on. Changes are
described in the Custom_JS_* set of forms in the arcdwa80?.ntf template.

NA090705-IGD-EN-2 Installation Guide 89


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

9. Add the following lines from the s_SessionInfo_commented_changes form


that is included in the arcdwa80?.ntf template to the original s_SessionInfo
form:
var gLLArchivEnabled = ('@{@GetProfileField("ixosprofile";
"txtServer")}'!='');
var gLLArchiveFeatureEnabled =
('@{@GetProfileField("ixosprofile";
"kwdFeature_Archive")}'=='1');
var gLLCopyBackFeatureEnabled =
('@{@GetProfileField("ixosprofile";
"kwdFeature_CopyBack")}'=='1');
var gLLRestoreFeatureEnabled =
('@{@GetProfileField("ixosprofile";
"kwdFeature_Restore")}'=='1');
var gLLDeleteFeatureEnabled = ('@{@GetProfileField("ixosprofile";
"kwdFeature_Delete")}'=='1');

10. Open the properties of the LLCreateOrder agent.


In field Run on behalf of, set the agent user to the Service User.

Important
Do not select Run as web user, because this function results in the
effective user ID Anonymous, which does not work.

90 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.4 Configuring Domino Web Access/Lotus iNotes

11. Start or restart your Domino HTTP server task.

To Uninstall the Archiving Extension for DWA:


1. Log in as the Service User.
2. Open the arcdwa80?.ntf template.
3. Click the action button Remove Design Elements.
4. From the Choose Database dialog, select the iNotes/Forms8.nsf database on
the Domino server you want to remove the archiving extension for DWA from.
5. Repeat steps 2 to 4 for other Domino servers you want to remove the archiving
extensions for DWA from
6. Undo changes in Custom_JS in Forms8.nsf on each server on which they were
done during the installation.
For Custom_JS, you can use the backup.
7. Undo changes in s_SessionInfo as described in arcdwa802.ntf.

10.4.4 Version 8.5: Installing and Uninstalling the Archiving


Extension for Lotus iNotes
Requirements Domino Server 8.5 with version 8.5 of Forms85.nsf. Refer to the Release Notes for
the exact Domino version 8.5 to be used.
Mail files using the mail85.ntf template. The template name is StdR85Mail.

To Install the Archiving Extension for Lotus iNotes:


1. Log in as the Service User.
2. Open the arcdwa850.ntf template.
3. Click the Copy Design Elements action button.
4. From the Choose Database dialog, select the Domino Server\iNotes\-
Forms85.nsf database on the Domino server you want to use the archiving
extension for DWA on.
Confirm the appearing dialogs. The design elements are copied to the specified
Forms85.nsf database.

5. Repeat the steps 2 to 4 for other Domino servers you want to use the archiving
extension for DWA on.
6. In Domino Designer, open Forms85.nsf.
7. Modify the following forms as described in arcdwa850.ntf > forms/subforms
> xxx_commented_changes.

NA090705-IGD-EN-2 Installation Guide 91


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

Tip: Create a backup of the forms or subforms before you modify them.
This enables you to revert the template to the original condition if needed.
• Form l_StdPageOperations
• Form l_StdPageOperations_Gecko
• Form l_StdPageOperations_Safari
• Shared Elements\Subform Custom_JS
• Shared Elements\Subform Custom_JS_Lite
Tip: Alternatively, you can replace the forms with the forms from
arcdwa850.ntf named *_modified_original if you have not done any
other modifications to these forms. In Forms85.nsf, rename the forms by
removing the _modified_original suffix.
8. Open the properties of the LLCreateOrder and of the LLCreateOrder_Lite
agent.
In field Run on behalf of, set the agent user to the Service User.

9. Start or restart your Domino HTTP server task.

To Uninstall the Archiving Extension for Lotus iNotes:


1. Log in as the Service User.
2. Open the arcdwa850.ntf template.

92 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


10.4 Configuring Domino Web Access/Lotus iNotes

3. Click the action button Remove Design Elements.


4. From the Choose Database dialog, select the iNotes/Forms85.nsf database on
the Domino server you want to remove the archiving extension for Lotus iNotes
from.
5. Repeat steps 2 to 4 for other Domino servers you want to remove the archiving
extensions for Lotus iNotes from
6. Undo changes you made during the installation in the following forms and
subforms:
• Form l_StdPageOperations
• Form l_StdPageOperations_Gecko
• Form l_StdPageOperations_Safari
• Shared Elements\Subforms Custom_JS
• Shared Elements\Subforms Custom_JS_Lite
Tip: You can use the backups of these forms or subforms.

10.4.5 Version 8.5.1: Installing and Uninstalling the Archiving


Extension for Lotus iNotes
Requirements
• Lotus Domino server 8.5.1 with version 8.5.1 of Forms85.nsf. Refer to the
Release Notes for the exact Lotus Domino and iNotes version 8.5.1 to be used.
• Existing Lotus iNotes Extension Forms 8.5 database Forms85_x.nsf. See the IBM
Lotus Domino 8.5.1 Administrator Help how to create this database.
• Supported iNotes version. Contact IBM support to receive one of the following
iNotes versions:
• Domino 8.5.1 – DWAHF_v8.51_304CHF3 or higher CHF number
• Domino 8.5.1FP1 – DWAHF_v8.51FP1_304.2CHF1 or higher CHF number
• Domino 8.5.1FP2 – DWAHF_v8.51FP2_304.5CHF1 or higher CHF number
• Mail files using the mail85.ntf template. The template name is StdR85Mail.

To Install the Archiving Extension for Lotus iNotes:


1. Log in as the Service User.
2. Open the arcdwa851.ntf template.
3. Click the Copy Design Elements action button.
4. From the Copy Design Elements dialog, select the target Lotus Domino server
and enter the location of your Lotus iNotes Common Forms (8.5) database, for

NA090705-IGD-EN-2 Installation Guide 93


Chapter 10 Installing the Email Archiving Bridge for Lotus Notes

example iNotes\Forms85.nsf, and your Lotus iNotes Extension Forms (8.5)


database, for example iNotes\Forms85_x.nsf.
Confirm the appearing dialogs. The design elements are copied to the specified
databases.
5. Repeat the steps 2 to 4 for other Lotus Domino servers you want to use the
archiving extension for Lotus iNotes on.
6. In Domino Designer, open Forms85_x.nsf.
7. Modify the following subforms as described in Forms85_x.nsf > Shared
Elements\Subforms> *_commented_changes.

Tip: Create a backup of the subforms before you modify them. This
enables you to revert the database to the original condition if needed.
• Shared Elements\Subform Custom_JS

• Shared Elements\Subform Custom_JS_Lite

Tip: Alternatively, you can replace the subforms with the subforms named
*_modified_original if you have not done any other modifications to
these subforms. In Forms85_x.nsf, rename the subforms by removing the
_modified_original suffix.
8. Start or restart your Domino HTTP server task.

To Uninstall the Archiving Extension for Lotus iNotes:


1. Log in as the Service User.
2. Open the arcdwa851.ntf template.
3. Click the action button Remove Design Elements.
4. From the Remove Design Elements dialog, select the target Lotus Domino
server and enter the location of your Lotus iNotes Common Forms (8.5)
database, for example iNotes\Forms85.nsf, and your Lotus iNotes Extension
Forms (8.5) database, for example iNotes\Forms85_x.nsf.
5. Repeat steps 2 to 4 for other Lotus Domino servers you want to remove the
archiving extensions for Lotus iNotes from.
6. Undo changes you made during the installation in the following subforms:
• Shared Elements\Subform Custom_JS

• Shared Elements\Subform Custom_JS_Lite

Tip: You can use the backups of these subforms.

94 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Chapter 11
Additional Settings and Functions
This chapter contains the following information:
You can add different parameters for the Archiving Service, in the <installation
directory>\Service.ini file. Via the command processor, you can change the
password, for example.

11.1 Service.ini Parameters


The mandatory variables do not have default values and must always be specified.
To change the settings that you have set during the installation, refer to the
following list.

Mandatory Entries in the Service.ini File

DominoServer
DominoServer=MyDominoServer/MyDomain

Specify the hierarchical name of the primary Lotus Domino server hosting the
ACMF.
ConfigurationDatabase
ConfigurationDatabase=acmf.nsf

Specify a relative path to the ACMF on the Lotus Domino server. It must be a
mandatory, valid and existing path to an existing ACMF. The folder must be in
the Domino Data directory.
ServiceName
ServiceName=de03360

This entry is the name for the Archiving Service. It is used to find and read the
related configuration settings for this Archiving Service in the ACMF database.
The Archiving Service also writes update and status information into the related
monitoring documents in the ACMF. The ServiceName must be unique over all
service instances.
ServiceUserPassword
ServiceUserPassword=7SvGJdZjWPE\=

Password of the user to log in to the Lotus Domino server. The Archiving Service
generates an encrypted password when called with the following parameter:
SetServicePassword.bat <password>

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 95


Chapter 11 Additional Settings and Functions

ProductComponentName
ProductComponentName=LNArchivingService

ProductComponentName=LNSynchronizationService

The name of the service which is to be used as a part of the path to log and
temporary files. This value is written by the setup program and must not be
changed or removed.

Optional Service.ini Parameters

LogLevel
LogLevel=3

This is the initial logging level of the Archiving Service. Default value is 3.
• 0 = Fatal
• 1 = Error
• 2 = Warning
• 3 = Info
• 4 = Debug
• 5 = Entry/Exit
The default value is used until the log level has been read out from the ACMF.
Afterwards the value configured in the ACMF is used.
MaxLogMessagesPerDocument
MaxLogMessagesPerDocument=5000

Maximum number of log traces that are logged in a single document before a
new log document is created. Default value is 5000.
MaxLogMessagesPerFile
MaxLogMessagesPerFile=50000

Maximum number of log traces (log entries) in a single log file. The default value
is 50000. If the maximum number of messages is exceeded, the old log file is
renamed to <filename>.0N (where N is a counter starting from 1) and a new log
file with the original name is created. After a maximum number of backup files
is exceeded, the old backup files are overwritten again. Therefore, only a
maximum number of backup log files are kept in the log directory, e.g.
ArchivingThread1.log, ArchivingThread1.log.01, ArchivingThread1.-
log.02 ....

MaxBackupLogFiles
MaxBackupLogFiles=9

Maximum number of backup files that are created; if the maximum number is
reached, old backup files are overwritten again. The default is 9.

96 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


11.1 Service.ini Parameters

ServiceRootDirectory
ServiceRootDirectory=C:/Temp/de03360

Path to the root directory for temporary data of this service instance (log files
and temporary databases). If this value is not set or empty, the default root
directory is: %TEMP%\LNArchivingService\<servicename>. Other
subdirectories are created under this root directory, e.g. Log, Work.
CreateComponentRetryCount
CreateComponentRetryCount=2

If the connection to Archive Server fails, it can be the result of an accidental


failure on the network or a drop-out of the HTTP connection. The connection is
retried the specified number of times. The default value is 2; valid values are 0 to
<maxint>.
CreateComponentRetryWaitPeriod
CreateComponentRetryWaitPeriod=1

If the connection to Archive Server fails, it can be the result of an accidental


failure on the network or a drop-out of the HTTP connection. The connection is
retried after the specified period. The default is 1; valid values are 0 to <maxint>
in seconds.
DumpThreadInRunningStatus
DumpThreadInRunningStatus=true

If set to true the status file %TEMP%\<service name>\Log\ServiceStatus.log


receives the current stack information of all running threads. The default value is
true, valid values are true and false.

RunningStatusWatcherInterval
RunningStatusWatcherInterval=60

Time interval in seconds after which the status file %TEMP%\<service


name>\Log\ServiceStatus.log is updated. The default value is 60.

ReplaceMacintoshWithUnknown
ReplaceMacintoshWithUnknown=true

This parameter helps to prevent problems with the IBM DXL Importer by setting
the hosttype property of attachments sent from a Macintosh computer to
Unknown rather than Macintosh.

Important
When switching the workaround off, you may provoke data loss or a
Lotus Domino server freeze-up whenever a Macintosh attachment is
restored.

The default value is false, valid values are true and false.

NA090705-IGD-EN-2 Installation Guide 97


Chapter 11 Additional Settings and Functions

LeaveTemporaryFiles
LeaveTemporaryFiles=false

Controls if temporary files should be left intact or deleted after that part of a task
is finished which would normally delete temporary files. It concerns processing
of an order which stores temporarily archived documents in a working directory.
The default value is false, valid values are true and false.
LogRichtextItems
LogRichtextItems=false

Controls whether rich text items extracted from Lotus Notes documents should
be logged as a DEBUG message in the logging document or file. Currently the
only rich text item which is extracted to be stored in Livelink is the Body item of
an email. For troubleshooting reasons it may be helpful to see the complete body
text in the log file. The default value is false, valid values are true and false.
PollingThreadLongestProcessingTime
PollingThreadLongestProcessingTime=60

For polling threads this parameter specifies the longest processing time in
seconds or operations before sleeping, e.g. queue refreshes and other tasks.
Default is 60 seconds, valid values are from 1 to <maxint>.
DeleteWorkingFilesInOtherThread
DeleteWorkingFilesInOtherThread=true

Working files used during archiving or restoring documents are deleted not in
the same thread right after a document is archived. The deletion is deferred to be
performed later by a separate thread. This speeds up the document processing.
The default value is true, valid values are true and false.
DeletionQueueCapacity
DeletionQueueCapacity=100

Specifies the maximum number of deletion requests for the cleaning thread. The
cleaning thread is responsible for deleting temporary data created during
archiving or restoring of documents. The default value is 100.
WarnAboutRestoringFromNsfOnly
WarnAboutRestoringFromNsfOnly=true

The archiving service version 6.0D or older archive only a single file (DATA.NSF)
if there were no attachments in the document or if the document was archived in
the non-Single Instance Archiving mode (with attachments inside). Since the
system can not distinguish such a document from an incomplete one. Setting this
parameter to true, creates a WARNING log entry in he log database with the
reference to the archived document. If set to false an INFO level entry will be
created.
MaximumWaitingOrdersInPriorizedQueue
MaximumWaitingOrdersInPriorizedQueue=10

98 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


11.1 Service.ini Parameters

Number of orders to be processed in sequence before the queue with the order
documents is refreshed and the list of pending orders is rebuilt. Retrieve orders
have priorities and if there were many orders with the low priority in progress
newly coming orders with the high priority would have to wait. According to
the value of this variable they will wait only until this number of low-priority
orders is finished. After the list of pending orders is refreshed the high priority
orders will be at the beginning.
MaxRetryCount
MaxRetryCount=52

During startup of the services the information from the ACMF database must be
read. If the connection to this database fails, for example because the Lotus
Domino server is down, then an incremental waiting is initiated. The interval
between two connection retries in minutes, starts with the following values 3, 5,
7, 15, 30 and continues with 30 minutes up to MaxRetryCount repeats. A value of
3 means that a maximum waiting time of 3 + 5+ 7 = 15 minutes is used, before
the service restarts. The value 52 means a waiting time of 24,5 hours.
LongestProcessingTime
LongestProcessingTime=600

Specify the longest time in seconds you expect to process a single document.
Default value is 600 seconds.
HandleRepeatedErrors
HandleRepeatedErrors=true

Some errors in the underlying software stack can lead to a difficult state of the
Archiving Bridge, causing series of documents to fail during processing. To
improve stability and availability in such situations, the Archiving Bridge now
tracks errors while processing orders. When ten documents from an order cause
a sequence of processing errors, the Archiving Bridge slows down processing
that order. When 30 documents in a row failed, the Archiving Bridge aborts
processing the order.
MaxThreadFreezeDuration
MaxThreadFreezeDuration=300

The maximum processing duration of a thread before it is considered frozen is


configured through the LongestProcessingTime parameter. Threads which
remain frozen for more than MaxThreadFreezeDuration seconds will be
interrupted, destroyed and restarted.
RestartServiceOnFrozenThread
RestartServiceOnFrozenThread=false

If it is found that restarting the thread does not solve the problem, for example
the thread freezes again, then it might be necessary to restart the service. This
can be triggered by setting the configuration parameter to true.
StatisticsDirectory
StatisticsDirectory=statistics

NA090705-IGD-EN-2 Installation Guide 99


Chapter 11 Additional Settings and Functions

The Archiving Bridge writes a dedicated file with document statistics in the
configured statistics directory. This file is renewed daily with a configurable
history of files being kept. This parameter specifies the location of the file in the
file system. The directory can be specified with a relative path to the
<ArchivingService Installation directory> or as an absolute path, for example
C:/Programs/Open Text/Archiving Service/statistics.

StatisticsHistory
StatisticsHistory=10

The Archiving Bridge writes a dedicated file with document statistics in the
configured statistics directory. This file is renewed daily with a configurable
history of files being kept. This parameter specifies the number of files being
kept.
DoRetryDXLErrorDocuments
DoRetryDXLErrorDocuments=true

Archiving of documents usually fails without a shutdown of the Archiving


Bridge, e.g. when DXL operations fail on the lower layers, or when temporary
problems with the backend systems such as Livelink ECM – Enterprise Server or
Livelink ECM – Archive Server occur. A document will be marked accordingly
and not processed again, if the cause of an archiving failure lies in a DXL
operation on the document. When the ProblemDocVersion will be incremented
and all matching documents get reprocessed, this parameter specifies if the
documents with a failure in the DXL operation should be considered.
DoRetryCrashDocuments
DoRetryCrashDocuments=false

Specifies if a document which leads to a crash should be also reprocessed if the


version-number comparison based on ProblemDocVersion considers this
document. Documents which cause an unexpected shutdown are not
automatically reprocessed by default when the version-number is incremented,
to avoid the effects of such shutdowns. Reprocessing these documents must be
deliberately forced by incrementing the version number and setting the
configuration parameter DoRetryCrashDocuments to true.
ProblemDocVersion
ProblemDocVersion=1

When processing a marked document, the configured value of the version


number is compared to the value stored in the document. Only those documents
will be reprocessed where the configured value is greater than the value in the
document.
Reprocessing of all marked documents can be desirable, typically when a fix for
some DXL processing problem or other is available. Reprocessing is activated by
incrementing the version number in the Service.ini through this configuration
parameter. Since the problem doc version is also stored in the document, this
value must be higher than the highest version in any document. That means you
should always set this value to the same value on all your Archiving Bridge
hosts.

100 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


11.1 Service.ini Parameters

PipelineDisableCharactersEscaping
PipelineDisableCharactersEscaping=false

Forbids prepending of a character \ before the special characters ,, | and \


which have a special meaning in a string value. Setting this parameter to true
turns on the feature, the value false writes the strings escaped. This parameter
can be used to force compatibility with old versions. Default value is false.
PipelineJoinMultilineStrings
PipelineJoinMultilineStrings=true

Joins strings extending over more lines with the delimiter \n. It can be used to
get a string value always on a single line. The value false writes multi-line
strings on multiple lines. The default value is false.
PipelineStringEncoding
PipelineStringEncoding=UTF-8

Defines character encoding for string values written to the COMMANDS file for the
archiving pipeline. The encoding must be available on the operating system
where the archiving service runs. The parameter value Default is reserved for
the default system character encoding (code page). The default value is UTF-8.
PipelineIntegerNumbersOnly
PipelineIntegerNumbersOnly=false

Restricts numerical values written to the COMMANDS file to their integral part only
and limits their range from -2147483648 to -2147483647 (32 bits). This can be used
to force compatibility with old versions. The value false allows bigger numbers
and the decimal fraction to be written, possibly in the scientific notation. The
default value is false.
PipelineDateTimeFormat
PipelineDateTimeFormat=ISO

Chooses a format for values of the type DATETIME. Possible values are ISO and
OLD. The ISO 8601 format is YYYY-MM-DDThh:mm:ss,fffTZD and the old format
is DD.MM.YYYY. You can use the old format to force compatibility with old
versions. Fraction seconds in the ISO format are not supported.
PipelineMultipleStringsOnly
PipelineMultipleStringsOnly=false

Disallows support for multiple values for other types than the string. This can be
used to force compatibility with old versions. The default value is false.

Java System Properties

user.dir
Alternative directory to search for the configuration file Service.ini. It is the
home directory of the current user.

NA090705-IGD-EN-2 Installation Guide 101


Chapter 11 Additional Settings and Functions

java.io.tmpdir
Root directory for temporary data of the service, e.g. log files and temporary
files; sub directories are created there: %TEMP%\LNService\<ServiceName>.
Another possibility to change the root directory for the service is the
ServiceRootDirectory variable in the configuration file Service.ini. The
default values are the system temporary directory - environment variables TEMP
and TMP, valid is any existing path.
com.opentext.notes.mediator.LocalNotesMediator.nativeLibrary
Name of a shared object library with an implementation of NotesMediator. The
default value is OTNotesMediatorMT. Other libraries can be supplied here, for
example a debug or an alternative version.

11.2 Changing the Password of the Archiving Service


or Synchronization Service User
For each service, you can change the password of the Service User. This function can
be useful if you entered a wrong password during the installation or changed the
password afterwards. The password is encrypted and saved in the configuration file
(Service.ini) of each service.
Note: The Service.ini can be found in the corresponding installation
directory of the Archiving Service or Synchronization Service.
You can change the password using the Configuration Tool, see “Setting Up the
Services” on page 81.

11.3 Changing the Interval for the Automatic Restart


of the Archiving Service
The recovery of the Archiving Service is handled by the Windows Service Control
Manager (SCM). In the Recovery tab, an action for the first, second and subsequent
failure can be specified. The option Restart service after XX minutes gives the
waiting time between the next try.
The following default values are used:
• First failure: Restart the Service
• Second failure: Restart the Service
• Subsequent failures: Restart the Service
• Reset fail count after: 0 days
• Restart service after: 1 minute

102 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


11.4 The “recreate stub” Feature in Livelink Explorer

11.4 The “recreate stub” Feature in Livelink Explorer


Using the recreate stub feature, you can create stubs from archived documents in
Livelink.
To activate the recreate stub feature in Livelink ECM – Explorer Professional or
Livelink ECM – Explorer E-mail, edit the following entry in the
[OTEmailManagement] section of the opentext.ini:

ShowImportAsStubCheckbox=1

NA090705-IGD-EN-2 Installation Guide 103


Chapter 12
Configuring the Archiving Bridge as a Windows
Cluster Application
A server cluster is a group of independent servers running Windows Cluster service
and working collectively as a single system. Server clusters provide high-
availability, scalability, and manageability for resources and applications by
grouping multiple servers running Windows 2003 Advanced Server or Windows
2003 Datacenter Server.
Installation and Installing a server cluster and configuring the Archiving Service as a cluster
Configuration application is comprised of several steps:
Overview

1. Installing a Windows server cluster. For detailed information on how to install a


server cluster, as well as the requirements regarding software, hardware,
network, and shared disks, refer to the Microsoft Knowledge Base, for example
to the Step-by-Step Guide to Installing Cluster Service
(http://www.microsoft.com/technet/prodtechnol/windows2000serv/howto/c
lustep.mspx). The description in this documentation is based on the assumption
that a typical two-node cluster is installed according to the description in the
Microsoft Guide.
2. Installing the Archiving Service on each node belonging to the cluster.
For information regarding installation and configuration of the Archiving
Service, refer to “Installing the Email Archiving Bridge for Lotus Notes” on
page 77 and “Additional Settings and Functions” on page 95.

Important
• Make sure that the Archiving Bridges on the cluster nodes are
configured identically, especially that they use the same Archive
Server and Livelink and that they are using the same configuration
database (ACMF).
• The Start mode for the Windows services must be set to Manual. The
Cluster Manager automatically starts and stops the services.
• The Archiving Service name for each cluster node must be the same,
for example the name of the cluster. The Archiving Service name is
specified in the installation program of Archiving Bridges.

3. Configuring each service as a cluster application, see the following section.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 105


Chapter 12 Configuring the Archiving Bridge as a Windows Cluster Application

To Configure the Cluster Application for an Archiving Service:


Notes:
• If you use several Archiving Services, for example for email databases on
different Lotus Domino servers, you must repeat the following steps for
each service.
1. Make sure that the services on the individual cluster nodes are running.
2. On one of the nodes, select Start – Programs – Administrative Tools – Cluster
Administrator.
The Windows Cluster Administrator starts.
3. In the Cluster Administrator window, right-click the group you want to
configure the service's application for, and choose Configure Application from
the context menu.

The Cluster Application Wizard starts.


4. In the Select or Create a Virtual Server window, select a resource group that
can serve as the virtual server for the application.

106 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Click Next.
5. In the Create Application Cluster Resource window, select Yes, create a cluster
resource for my application now.

NA090705-IGD-EN-2 Installation Guide 107


Chapter 12 Configuring the Archiving Bridge as a Windows Cluster Application

Click Next.
6. In the Application Resource Type window, select Generic Service in the
Resource type drop-down list.

108 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Click Next.
7. Enter a name and a description for the application resource, and then click Next.

NA090705-IGD-EN-2 Installation Guide 109


Chapter 12 Configuring the Archiving Bridge as a Windows Cluster Application

8. Click Advanced Properties in the Application Resource Name and Description


window to define further settings for the cluster application, for example the
nodes that are capable of running the resource.
In the example, the nodes VMETORONTO5 and VMETORONTO6 are able to own the
application.

Click OK, and then click Next.

110 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


9. In the Generic Service Parameters window, enter the name of the service.
Note: Make sure to enter the name of the service, and not the display
name. If you are not sure about the service name, select Start – Programs –
Administrative Tools – Services and open the properties of the service.
The service name appears in the General tab of the Properties dialog.

Click Next.
10. In the Registry Replication window, no entry is required.
11. Complete the Cluster Application Wizard by clicking Finish.

Archiving Bridge is now configured as a Windows cluster application.

NA090705-IGD-EN-2 Installation Guide 111


Chapter 13
Upgrading to Open Text Email
Archiving/Management for Lotus Notes 9.7.5
Standard This chapter explains how to upgrade to Open Text Email Archiving/Management
Upgrade for Lotus Notes 9.7.5. It covers the standard upgrade scenario where you upgrade
your complete server environment at one go.
Multiple Servers If your landscape is very large and the upgrade process takes several weeks so that
and Archiving you have both 9.7.0 and 9.7.5 versions running, refer to “Upgrading an Environment
Bridges
with Multiple Lotus Domino Servers and Archiving Bridges” on page 116.

13.1 Upgrading a Standard Environment


Overview Upgrading to 9.7.5 involves the following steps.
• Upgrading the Archiving Bridge.
To upgrade from version 9.7.0, you can use the procedures described in this
chapter. For upgrades from earlier versions, you must uninstall the old version
and install the new version.
• Upgrading Lotus Notes database templates. The following upgrade paths are
supported.
• From version 9.6 to 9.7
• From version 9.7 to 9.7.5
For upgrades other than those mentioned here, contact Open Text Support.
• Upgrading the ACMF using agents.

13.1.1 Prerequisites
Archiving Bridge If you have customized the service.bat file on the Archiving Bridge, copy it to a
safe place. It will be overwritten during upgrade.
Note the name of the current Archiving Service. The new name must be exactly the
same. You find the name either in the ACMF or in the service.ini on the
Archiving Bridge,
On the Archiving Bridge, locate the directory where the old templates have been
installed and mark it so that you do not confuse it with the new template directory.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 113


Chapter 13 Upgrading to Open Text Email Archiving/Management for Lotus Notes 9.7.5

Templates Save each ACMF database in a safe place. It can be re-used. You will only have to
refresh the database design. Do not create a new ACMF database. Otherwise, the
upgrade design elements agents will not work.
Upgrading to Archiving Bridge 9.7.5 removes old database templates only if they
have been installed using the Install Shield wizard. Delete old templates manually if
you have moved them to a folder other than the original installation folder.

13.1.2 Upgrading Archiving Bridge, Templates and Databases


To Upgrade the Archiving Bridge:
1. Stop the Email Archiving Service for Lotus Notes.
2. Upgrade the Lotus Notes client to 8.5.1 FP1:
a. Uninstall the current Lotus Notes client.
b. Install a Lotus Notes client version 8.5.1.
c. Apply the FP1.
d. Disable the Lotus Notes Diagnostics service.
3. Install the Micrososoft .NET framework version 2.0 or higher:
a. In the Control Panel, select Add or Remove Programs.
b. Select Add/Remove Windows Components and follow the instructions.
4. Insert the Open Text Email Archiving for Lotus Notes CD-ROM into the CD-
ROM drive, and double-click Mastersetup.exe. The Open Text Master Setup
opens. The status shown in the first screen should be “upgrade”.
5. Follow the instructions of the installation wizard as described for the
installation. See “Installing and Configuring the Archiving Service and the
Synchronization Service” on page 77.
6. Configure the Archiving Bridge as described for the installation. However, most
parameters are already set as they have been in the previous installation. See
“Setting Up the Services” on page 81.

Important
The name of the Archiving Service must be exactly the same as defined
in the current ACMF.

7. Change the startup type of the Windows service. See “Changing the Startup
Type of the Service” on page 83.

114 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


13.1 Upgrading a Standard Environment

Important
Do not start the service at this point.

Tip: After the upgrade installation, you find the old versions of
service.ini and service.bat renamed to files with the extension *.upg.

To Upgrade the Templates:


1. Copy and sign templates
Remove the old templates from all your Domino servers.
Copy the new templates to the Domino servers using the Lotus Notes New
Copy function.
Sign them with the Service User.
2. Refresh design of databases
Refresh the design of your existing archiving related databases:
Log database: arclog.ntf
Order databases: arcorder.ntf
ACMF database: arcacmf.ntf template.

To Upgrade ACMF and Databases:


1. Open the ACMF and click Open Guideline.
2. Upgrade from 9.6
If you upgrade from version 9.6 you must first upgrade to version 9.7.0: Click
Update Version 9.6 –> 9.7 and follow the instructions.
3. Upgrade from 9.7
After you upgraded to version 9.7 successfully, proceed with upgrading to
version 9.7.5
a. Click Update Version 9.7 –> 9.7.5.
b. Select Yes to update the service description and order database
configuration documents.
c. Click Select to select the Lotus Domino server(s) that host the user
databases managed by the upgraded Archiving Bridge.
4. Refresh design of user databases
Ensure that the design of the existing databases which are enabled for archiving
is refreshed with the design elements from the new arcdesign.ntf template.
This can be achieved, for example, by running the Domino Designer task.

NA090705-IGD-EN-2 Installation Guide 115


Chapter 13 Upgrading to Open Text Email Archiving/Management for Lotus Notes 9.7.5

Note: When you have installed the templates patch pat09355 for previous
versions, then you must re-enable all mail databases. The patch added some
changes to the ScheduledArchive agent which were moved in Email
Archiving/Management 9.7.5 version to another location. All scheduled agents
are set to no refresh to preserve the scheduling configuration of the agent.
The Domino Designer task does not touch them.

13.2 Upgrading an Environment with Multiple Lotus


Domino Servers and Archiving Bridges
If you cannot update all Archiving Bridges at once follow these steps that allow the
coexistence of Archiving Bridges versions 9.7.0 and 9.7.5.

13.2.1 Upgrading the First Archiving Bridge


Upgrading the fist Archiving Bridge involves steps on the Archiving Bridge as well
as on the Lotus Domino Server.

To Upgrade the first Archiving Bridge:


1. Stop the Archiving Service.
2. Upgrade the Lotus Notes client to 8.5.1 FP1:
a. Uninstall the current Lotus Notes client.
b. Install a Lotus Notes client version 8.5.1.
c. Apply the FP1.
d. Disable the Lotus Notes Diagnostics service.
3. Install the Micrososoft .NET framework version 2.0 or higher:
a. In the Control Panel, select Add or Remove Programs.
b. Select Add/Remove Windows Components and follow the instructions.
4. Install or upgrade to Archiving Bridge 9.7.5 including the Lotus Notes
Templates. For details, see “Upgrading Archiving Bridge, Templates and
Databases” on page 114. Stop after the upgrade of the Archiving Bridge and
update the templates as described in the next step.
5. Copy the templates to the Lotus Domino server:
a. Open the templates in the Lotus Notes client on the Archiving Bridge.
b. Select File > Application > New Copy to copy them to the Lotus Domino
server hosting the ACMF for this Archiving Bridge.
c. Replace the existing templates.
6. Close the Lotus Notes client on the Archiving Bridge.

116 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


13.2 Upgrading an Environment with Multiple Lotus Domino Servers and Archiving Bridges

To Upgrade the ACMF and Other Templates:


1. Open a Lotus Notes client or a Lotus Domino Administrator client with which
you can access the Lotus Domino server hosting the ACMF.
2. Sign all the templates that you have copied with the ID of the Service User.
3. Refresh the ACMF with the new design.
4. Refresh the Log Database with the new design.
Note: The Order Database will be refreshed by the Design server task that
runs once a day.
5. Open the ACMF. If it was open, close and reopen it, so that the database script is
executed.
6. In the ACMF, open the Global settings tab and enter the Lotus Notes name of
the Service User.

Important
The design refresh of the ACMF disables all of the scheduled ACMF agents.
To re-enable all scheduled agents that were enabled before the refresh, you
must wait until all Archiving Bridges and all corresponding user databases
have been updated.

To Start the Archiving Service:


• On the Archiving Bridge, start the Archiving Service.

To Check the Status of Archiving Services 9.7.0:


Archiving Services 9.7.0 are running with an ACMF 9.7.5. However, they are
displayed as not running in an ACMF 9.7.5 as they do not provide the new status
data. You can check the status of an Archiving Service 9.7.0 with the following steps:
1. In the ACMF, open the All Documents view.
2. Select the desired Archiving Service document.
3. Right-click on the document and select Document Properties.
4. On the second tab, look for the fields txtRunningStatus and datLastUpdate. The
service is running when txtRunningStatus is “1” and datLastUpdate is a
current date and time.

To Upgrade Databases:
1. In the ACMF, open one of the Databases views. The Databases views are
initially empty.
2. Select Refresh > Databases on selected Server(s) and select the server(s)
managed by the upgraded Archiving Bridge.

NA090705-IGD-EN-2 Installation Guide 117


Chapter 13 Upgrading to Open Text Email Archiving/Management for Lotus Notes 9.7.5

Note: The initial addition of the database descriptions to the Databases


views are not considered an update. Therefore, if no other changes are
detected the count for Updated databases will show 0.
3. Select Tools > Design Elements > Update 9.7 -> 9.7.5.
4. Click Select to select the Lotus Domino server(s) that host the user databases
managed by the upgraded Archiving Bridge.
Tip: The servers should be the same list as selected in step 2.
Open Text recommends that you leave the default value Yes for Service
description documents as long as you have a mixed 9.7/9.7.5
environment.

13.2.2 Upgrading Subsequent Archiving Bridges


To Upgrade following Archiving Bridges:
1. Stop the Archiving Service.
2. Upgrade the Lotus Notes client to 8.5.1 FP1:
a. Uninstall the current Lotus Notes client.
b. Install a Lotus Notes client version 8.5.1.
c. Apply the FP1.
d. Disable the Lotus Notes Diagnostics service.
3. Install the Micrososoft .NET framework version 2.0 or higher:
a. In the Control Panel, select Add or Remove Programs.
b. Select Add/Remove Windows Components and follow the instructions.
4. Install or upgrade to Archiving Bridge 9.7.5. For details, see “Upgrading
Archiving Bridge, Templates and Databases” on page 114.
Tip: You need not install the Lotus Notes templates.
5. Start the Archiving Service.

To Upgrade the Databases:


1. Replicate the 9.7.5 templates arcdesign.ntf, arcorder.ntf, and arclog.ntf if
necessary from the ACMF server to the Lotus Domino server(s) serviced by the
Archiving Bridge(s) to be updated.
If there is another log database on one of these servers, refresh it with the new
design.
2. In the ACMF, open one of the Databases views.

118 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


13.2 Upgrading an Environment with Multiple Lotus Domino Servers and Archiving Bridges

3. Select Refresh > Databases on selected Server(s) and select the server(s)
managed by the upgraded Archiving Bridge
4. Select Tools > Design Elements > Update 9.7 -> 9.7.5.
5. Click Select to select the Lotus Domino server(s) that host the user databases
managed by the upgraded Archiving Bridge.
Tip: The servers should be the same list as selected in step 3.
Open Text recommends that you leave the default value Yes for Service
description documents as long as you have a mixed 9.7/9.7.5
environment.
6. Check the results in the ACMF:
• In the Databases – By Server view, all activated Lotus Domino servers with
the associated databases should be in this list.
• In the Databases – By Design Version, all updated archive enabled user
databases should have 9.7.5 Version 1 as the Design version.

To Upgrade Managed Folders:


If you are using Open Text Email Managed Folders for Lotus Notes you need to
execute the following steps after upgrading the users' mail databases:
1. In Domino Designer, open the arcdesign.ntf.
2. Open the script library ArchiveFunctionsLib and function
IxosPostDragDrop.

3. In Domino Designer, open your mail template mail*.ntf.


4. Copy the function PerformIxosDandD from ArchiveFunctionsLib to the
database script of your mail template. Insert it after End Sub of the last Sub
method.
5. Replace/copy DRAG & DROP CODE FOR THE E-MAIL MANAGEMENT to the
database script PostDragDrop event of your mail template.
6. Save the database script.

All the corresponding user mail databases will be refreshed by the design task at
night.
Environments If you are using more than one ACMF in your environment, repeat the steps starting
with more than from “Upgrading the First Archiving Bridge” on page 116 for each ACMF and all
one ACMF
Archiving Services associated with this ACMF.

NA090705-IGD-EN-2 Installation Guide 119


Chapter 14
Removing Open Text Email Archiving/Management
for Lotus Notes
In order to remove Open Text Email Archiving/Management for Lotus Notes, you
have to perform the following steps in the order described:

1. Stop all Archiving Services, and set them to status Manual.


2. Remove all administration databases on all Lotus Domino servers where you
created them. This includes ACMF, order databases and log databases.
3. Revert the Domino Web Access/Lotus iNotes integration which you made in
the Domino servers, see the uninstall procedures in “Configuring Domino Web
Access/Lotus iNotes” on page 85.
4. Remove all database templates related to the Email Archiving Bridge from all
Lotus Domino servers.
• arcacmf.ntf

• arcorder.ntf

• arcdocpipe.ntf

• arclog.ntf

• arcdesign.ntf

• arcdwa*.ntf

5. Run the removal program on any computer where you have components
installed. Use the Add/Remove Software feature in the Microsoft Windows
Control Panel.
6. If the removal program claims that it could not remove some items, delete them
manually.
7. Reboot the computer.

The removal of the Open Text Email Archiving Bridge for Lotus Notes is now
completed.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 121


Glossary
Domino Web Access/Lotus iNotes
If no Lotus Notes client is available, you can access your archived emails with
Domino Web Access/Lotus iNotes (DWA). The functionality of Email
Management for Lotus Notes is not available via DWA or Lotus iNotes,
respectively.
See also: Chapter 1: “About Open Text Email Archiving/Management for Lotus
Notes”.

Livelink ECM – Billing and Quota Management


Livelink ECM – Billing and Quota Management is an optional Livelink module
that provides the ability to track Livelink users' storage usage and facilitate
billing to users or groups, based on the total usage.
See also: Chapter 5: “Installing and Administering Livelink ECM – Billing and
Quota Management on Livelink”.

Livelink ECM – Email Management Services


The Livelink ECM – Email Management Services modules extend the
functionality of the Livelink to allow storage of e-mails coming in from the
Archiving Bridge. They consist of Livelink E-mail Services and Livelink E-Mail
Management.
See also: Chapter 3: “Installing and Administering Email Management Services
on Livelink”.

Livelink ECM – Explorer E-mail


The Livelink ECM – Explorer E-mail component which is part of Open Text
Email Archiving for Lotus Notes enables Livelink users to browse and search a
personal and public e-mail volume in Livelink Enterprise Server.
See also: Chapter 4: “Installing and Administering Livelink ECM – Explorer
Professional and Livelink ECM – Explorer E-mail on Livelink”.

Livelink ECM – Explorer Professional


The Livelink ECM – Explorer Professional component which is part of Open Text
Email Management for Lotus Notes allows Livelink users to manage and search
archived e-mails in Livelink Enterprise Server.

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 123


Glossary

See also: Chapter 4: “Installing and Administering Livelink ECM – Explorer


Professional and Livelink ECM – Explorer E-mail on Livelink”.

Open Text Email Managed Folders for Lotus Notes


In Open Text Email Management for Lotus Notes, Open Text Email Managed
Folders for Lotus Notes allows exporting e-mails by drag and drop directly to
the Livelink ECM – Enterprise Server. Managed Folders for Lotus Notes are
displayed in the folder structure of the Lotus Notes mail database. Furthermore,
users have direct access to the Livelink inside Lotus Notes. A single click on a
Managed Folder displayed in the Lotus Notes mail database displays the
Livelink inside the Lotus Notes client.
See also: Chapter 2: “Installing Open Text Email Managed Folders for Lotus
Notes on Livelink”.

Service User
The Archiving Service is connecting to all necessary Lotus Notes databases with
one special user. This user is called Service User. Therefore, this Lotus Notes user
must have the proper access permissions to the following databases: the ACMF
database, the Order Database, the logging database, the mail databases, or the
application databases.

Single Instance Archiving


The Single Instance Archiving feature of the Archive Server guarantees that
identical attachments will be stored only once. Archiving in single instance mode
decomposes e-mails, which means that the attachments are removed from the
original e-mail and are stored as separate components on the Archive Server. As
soon as an e-mail is retrieved from the Livelink ECM – Enterprise Server, the
Open Text Archive Storage Provider checks whether the e-mail needs to be
recomposed. If so, it forwards the request to the Email Composer, which
reinserts the appropriate attachments into the e-mail and passes the complete e-
mail to the Livelink ECM – Enterprise Server.

124 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Index
metadata 26
single instance archiving 66
Conventions 8
Conventions in this documentation 8
A Creating codes
Abbreviations Records Management 45
terms 10 Creating file plans
ACMF Records Management 45
permissions 75 Creating the Service User 74
Append date to node name Custom Data
configuring 26 See “E-mail Management Custom Data”
Archive Configuration and Management
Facility (ACMF) D
preparation 85 Database Templates
Archive Server installing on Domino server 84
upgrade Email Composer 65 Domino Web Access/Lotus iNotes 14, 123
Archiving Bridge configuration for archiving 85
as cluster application 105
Archiving Service
E
permissions 75
E-Mail Archiving Settings 27
E-mail Management Custom Data
B configuring 28
Billing settings E-Mail Monitoring Settings 27
configuring 39 Email Archiving folder structure
Bridge Service Livelink username configuring 27
configuring 26 Email Archiving for Lotus Notes
Bridge user 26 general information 13
removing 121
C Email Archiving Service for Lotus Notes
Changing installing 77
password 102 Email Composer
Client distribution configuration 66
using MSI 32 installation 59
Client uninstallation installation (Archive Server) 61
using MSI 36 upgrade on Archive Server 9.5 65
Cluster installation 105 Email folders
Configuring 28 setting per page item display 23
billing and quota settings 39 Email Management Services
Email Composer 66 installing 21
Livelink ECM – Email Management 25
Livelink ECM – Email Services 21

NA090705-IGD-EN-2 Open Text Email Archiving/Management for Lotus Notes 125


Index

Email message body content Livelink ECM – Email Management


storing 23 Services 21, 123
Email properties 24 Livelink ECM – Email Services
Email Synchronization Service for Lotus configuring 21
Notes Livelink ECM – Explorer E-mail 123
installing 77 Livelink ECM – Explorer Professional 123
Enabling Livelink ECM – ExplorerE-mail 29, 29
Quota Management Agent 38 Livelink ECM – ExplorerProfessional 29,
Extractable email fields 29
setting 22 Livelink Explorer
distributing client using MSI 32
F uninstalling 31
Feedback 11 uninstalling client using MSI 36
Folder structure Livelink server
See “Email Archiving folder structure” restarting 31
Livelink standard attributes
I extracting 22
Indexing Log file size
extracting Livelink standard attributes 22 for Email Composer 68
Installation 77 Log identifiable metadata
adding modules to Livelink 30 configuring 26
Email Archiving Service for Lotus Notes Log level
77 configuring 25
Email Composer 59 Email Composer 67
Email Composer (Archive Server) 61
Email Synchronization Service for Lotus M
Notes 77 Managed Foldersfor Lotus Notes
Livelink module 19, 21, 37 installation 19
UNIX 30 Max. log file size
using MSI 32 for Email Composer 68
Windows 2000/XP 29 MIME Types 25
installation requirements MSI
verifying 43 client distribution 32
Installing client uninstallation 36
Email Management Services 21 installation configuration 33
in a Windows cluster 105 uninstallation configuration 36
Managed Foldersfor Lotus Notes 19
Installing Database Templates O
on Domino server 84 Open Text Email Archiving/Management
for Lotus Notes
L general information 13
Livelink Open Text Email Composer for Lotus
permissions 76, 76 Notes
Livelink ECM – Billing and Quota installation 59
Management 37, 123 Open Text Email Managed Folders for
Livelink ECM – Email Management Lotus Notes 124
configuring 25, 28 Open Text Online 10

126 Open Text Email Archiving/Management for Lotus Notes NA090705-IGD-EN-2


Index

Open TextEmailManaged Foldersfor Lotus Setting


Notes 19 per page item display for email folders 23
installation 19 Settings 95
Overview of this guide 7 Show 'E-mail' menu under Personal
configuring 26
P Show 'Public E-mail Volume' menu under
Parameters 95 Enterprise
Password configuring 26
changing 102 Single Instance Archiving 60
Permissions Storing
for the Archiving Service 75 email message body content 23
for the Service User 75
in Livelink 76, 76 T
in the ACMF 75 Typography 8
Platform requirements 71
Preparation U
Archive Configuration and Management Uninstalling 31
Facility (ACMF) 85 UNIX
Prerequisites 71 installingEmail Management Services 21
Archive Server 73 Upgrade 113
Email Archiving Bridge for Lotus Notes Email Composer on Archive Server 9.5
73 65
Professional module Livelink module 19, 37
problems adding to Livelink 31 Use Livelink domains
PST custom data 28 configuring 27
Username format
Q configuring 27
Quota Management Agent
enabling 38 W
Quota settings Windows
configuring 39 cluster installation 105
installing Email Management Services 21
R
Records Management
creating codes and file plans 45
Records Management Module
installing 44
installing or upgrading 43
upgrading 44
Removing Email Archiving for Lotus Notes
121
Restarting the Livelink server 31

S
Service User 74, 81
creating 74
permissions 74
Service.ini 95

NA090705-IGD-EN-2 Installation Guide 127

You might also like