Professional Documents
Culture Documents
Installation Guide
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
• 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.
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.
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.
Caution
Cautions contain very important information that, if ignored, may cause
irreversible problems. Read this information carefully and follow all
instructions!
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).
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.
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.
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.
• 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.
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.
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.
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.
Caution
Once installed, you must not uninstall Email Management Services. This
results in data loss.
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:
OTUserName OTTimeExpiration
OTUserFullName OTDateCompleted
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
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.
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
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
Note: To complete the installation, you must add the modules to Livelink. For
more information, see “Adding the Modules to Livelink” on page 30.
Note: To complete the installation, you must add the modules to Livelink. For
more information, see “Adding the Modules to Livelink” on page 30.
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.
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.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).
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.
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
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.
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.
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.
Note: If Lotus Notes is a multiuser installation, each user of the machine must
import the toolbar.
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.
Parameter Description
REMOVEPDS=<value> Where <value> is either Yes or No.
• My Billing Usage
Caution
Uninstalling the Email Billing & Quota Management module will remove all
Email Billing & Quota Management metadata from your system.
String Description
$CURRENT$ This value will be the current usage of a user from the
QuoteUsage.CurrentUsage field.
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.
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.
limit management of emails to Personal E- Select the Limit to PEV check box.
mail Volumes for users,
• 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.
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.
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.
• 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.
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..
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
• 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.
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.
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.
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.
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
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
[C:\WINDOWS\Temp\IXOS\as]---> C:\TEMP
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 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"
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.
CONTENT_DISPOSITION=attachment; filename=DATA.XML
SKIP_CLEAN_UP=false
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.
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
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.
• 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.
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.
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.
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.
Important
See the Release Notes for Open Text Email Archiving for Lotus Notes in the
Open Text Knowledge Center for the most recent information.
Important
Depending on the component that you want to install, different platforms
are necessary. For detailed information, refer to the following table.
or higher
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.
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.
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.
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.
• 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.
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)
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.
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.
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.
Important
Archiving Service and Synchronization Service must not be installed on the
same machine.
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.
6. Custom Setup
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.
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.
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.
Important
Do not start the service at this point.
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.
3. Sign all database templates directly after the installation with the Service User.
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.
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
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.
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.
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.
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
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.
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.
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.
Important
Do not select Run as web user, because this function results in the
effective user ID Anonymous, which does not work.
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.
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.
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
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.
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>
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.
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.
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
RunningStatusWatcherInterval
RunningStatusWatcherInterval=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.
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
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
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
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
PipelineDisableCharactersEscaping
PipelineDisableCharactersEscaping=false
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.
user.dir
Alternative directory to search for the configuration file Service.ini. It is the
home directory of the current user.
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.
ShowImportAsStubCheckbox=1
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.
Click Next.
6. In the Application Resource Type window, select Generic Service in the
Resource type drop-down list.
Click Next.
10. In the Registry Replication window, no entry is required.
11. Complete the Cluster Application Wizard by clicking Finish.
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.
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.
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.
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.
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.
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 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.
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.
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.
• 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.
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.
S
Service User 74, 81
creating 74
permissions 74
Service.ini 95