File Content Extraction 26.1
Filter SDK C++ Programming Guide

# Lotus Notes Database Files

A Lotus Notes database is a single file that contains multiple documents called notes. Notes include design notes (such as forms, views, folders, navigators, outlines, pages, framesets, agents, and resources), data document notes, profile document notes, access control list notes, and collection (index) notes. File Content Extraction can extract text items, attachments, and OLE objects from data document notes only. Data document notes include emails, journal entries, discussion threads, documents (Microsoft Office and Lotus SmartSuite), and so on.

All components of a note are prefixed by field names such as "`SendTo:`", "`Subject:`", and "`Body:`". When a note is extracted, the field names are not included in the extracted output; only the field values are extracted.

## Enable the Reader to use NSF files

To enable the reader nsfsr to process NSF files (file format number 358), you must add the entry `358=nsf` to the `formats.ini` configuration file, in the `[Formats]` section. For example:

    [Formats]
    ...
    358=nsf

NOTE: The Notes Database (NSF) reader is an advanced feature and is sold and licensed separately. To enable this reader, you must obtain the appropriate license key from OpenText. See Pass License Information to File Content Extraction for information on adding a new license key to an existing installation.

## System Requirements

The Notes Database (NSF) reader is available only on certain platforms (see nsfsr in the platform differences section).

File Content Extraction accesses NSF files indirectly by using the Notes API. Because the NSF reader relies on functionality in Notes, a Notes client or Domino server must be installed and configured on the same machine as File Content Extraction. On Linux, the Domino server is required. For information about the supported versions of Notes or Domino, see Software Dependencies.

## Installation and Configuration

Before you can filter NSF files, you must set up the Notes client or Domino server. Full configuration is not required. The following steps outline the minimal setup for NSF filtering:

### Windows

1. Install the Notes client or Domino server. You do not need to configure the client or server.

2. Make sure that the `notes.ini` file is in the proper location.

   - If Notes is installed, the file should appear in the `install\lotus\notes` directory, where `install` is the installation directory.

   - If only Domino is installed, the file should appear in the `install``\lotus\domino` directory, where `install` is the installation directory.

   If the file does not exist, create an ASCII file named `notes.ini`, and add the following text:

       [Notes]

3. Add the File Content Extraction `bin` directory and the `install``\lotus\notes` or `install``\lotus\domino` directory to the `PATH` environment variable (the `bin` directory must be first in the path). OpenText recommends that you add the `bin` directory because the Notes or Domino server installation might contain older File Content Extraction OEM libraries.

   CAUTION: Adding the Notes or Domino directory to the PATH allows Windows to find the Notes DLLs when File Content Extraction tries to load them. Windows searches the PATH only after it has searched the current working directory, so you should ensure that the current working directory has adequate controls in place to prevent modification by a malicious actor.

### Linux

1. Install Domino server. You do not need to configure the server.

2. Make sure that the `notes.ini` file is in the `install``/lotus/notes/latest/linux` directory, where `install` is the directory where Notes is installed. If the file does not exist, create an ASCII file named `notes.ini`, and add the following text:

       [Notes]

3. Add the `install``/lotus/notes/latest/linux` directory to the `PATH` environment variable:

       setenv PATH install/lotus/notes/latest/linux:$PATH

4. Add the `install``/lotus/notes/latest/linux` and the File Content Extraction `bin` directory to the `LD_LIBRARY_PATH` environment variable:

       setenv LD_LIBRARY_PATH keyview_bin:install/lotus/notes/latest/linux:$LD_LIBRARY_PATH

   where `keyview_bin` is the location of the File Content Extraction `bin` directory. OpenText recommends that you add the `bin` directory because the Lotus Notes installation might contain older File Content Extraction OEM libraries.

## Open Secured NSF Files

File Content Extraction enables you to specify a user ID file and password to use to open a secured NSF file for extraction.

## Format Note Subfiles

The NSF reader uses XML templates to format note subfiles. You can customize the templates to approximate the look and feel of the original notes as closely as possible. For more information, see Extract and Format Lotus Notes Subfiles.

Copyright 1997-2025 Open Text
Version 26.1 | Last updated January 2026

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: File Content Extraction 26.1

Topic Title: Lotus Notes Database Files