Accessing IBM FileNet documentation and fix packs
Special Notes and Dependencies
Tivoli Client API download and
installation
Installation, migration, upgrade,
and configuration
Upgrading from previous versions
of NLS
This document provides information about NLS-2.0.0.4
fix pack.
This document provides information about the IBM® FileNet® NLS-2.0.0.4-IS-FP0004 fix pack. The NLS-2.0.0.4-IS-FP0004 fix pack is a full installer that updates an existing NLS installation. NLS fix packs are cumulative and include content from all previously released fix packs since the base release. NLS fix packs are released approximately twice a year, and include the binary executable installer, the manifest file, and the readme.
To determine the current NLS fix pack version installed on your server, enter the following command:
NLS_start -v
To access documentation for IBM® FileNet® NLS-2.0.0.4 product:
Navigate to the
Information Management support page (http://www-933.ibm.com/support/fixcentral/).
Select the
appropriate FileNet Image Services product from the
"Select a category" list.
From the Product
Support page, click IBM
FileNet Fix Packs under Download.
From the IBM FileNet Fix Packs page, click IBM FileNet
P8 Image Services.
From the Fix Packs
for IBM FileNet P8 Image Services page:
Click the icon in the
appropriate release column to access the document you need.
Click the release
number to access the fix pack you need.
NLS 2.0 Fix Pack 4 includes the most recent EMC SDK 3.2.4
libraries and now supports the Windows 2008 Server platform.
Note
1: NLS 2.0
FP4 can ONLY be applied to a server that has ISTK 4.1.0 or higher installed.
ISTK 4.0.x is no longer supported and should not be used.
Note 2: The minimum version of Image Services that is supported
with NLS 2.0 FP4 is Images Services 4.1.1 FP8.
Note 3: If NLS 2.0 FP4 is to be installed and collocated on a
system running Image Services, the new version of EMC SDK libraries distributed
with NLS 2.0 FP4 will conflict with the version of EMC SDK libraries that was
released and installed with the Image Services.
To resolve the conflict, you must
replace the EMC SDK libraries that were installed by Image Services with the
new EMC SDK libraries that are installed by NLS 2.0 FP4.
Steps for copying the EMC SDK
libraries:
1.
Stop Image Services and NLS.
2.
Copy the new EMC Libraries, libFP* and libPAI*, from the NLS install location to /fnsw/lib/shobj.
3.
Start Image Service and NLS.
For details about the resolved defects in this fix pack, see "Product fix history".
For
UNIX platforms, the Tivoli Client API need to be downloaded from Tivoli API client package now needs to be installed on the
customers system. This is not needed for Windows platform.
To install the
ftp://ftp.software.ibm.com/storage/tivoli-storage-management/maintenance/client/v5r5
Select the appropriate platform
and select the package to download. The package downloaded has a readme
file contains the instruction to install the package. This readme file is
very hard to find the installation instruction, so I will try to make it easier
by explaining the steps below:
Step 1: Here is the link to the
installation instructions:
Step 2: Expand Backup-Archive
Clients
Step 3: Expand UNIX and Linux:
Backup-Archive Clients Installation and User’s Guide
Step 4: Expand Chapter 1. Installing Tivoli Storage Manager
Step 5: Expand Installing the backup-archive
client
Step 6: Select the appropriate platform and follow the instructions.
Note: please keep an eye on the installer messages for various OS
level patches needed.
After install NLS 2.0.0.4 on
HP-UX 9000 that has IS 4.0 SP4 through IS 4.1.1 installed, users must configure
NLS 2.0.0.4 to co-exist with Image Services.
On HP-UX servers (HP 9000 only), users must link the Centera
libraries that are under /fnsw/lib/shobj to a new /fnsw/lib/shobj/3rdparty/centera directory
and then add that path to the environment variable SHLIB_PATH to support EMC
Centera SDK 3.1.
To create new links for the Centera shared libraries,
1. Stop the IBM FileNet software and kill all remaining processes
by entering:
initfnsw -y stop
killfnsw -ADy
2. As the IBM FileNet software user, such as fnsw, create a new directory for the Centera shared library
links:
mkdir /fnsw/lib/shobj/3rdparty
chown fnsw:fnusr
/fnsw/lib/shobj/3rdparty
mkdir /fnsw/lib/shobj/3rdparty/centera
chown fnsw:fnusr
/fnsw/lib/shobj/3rdparty/centera
3. Change to the newly created directory:
cd /fnsw/lib/shobj/3rdparty/centera
4. Create new links for Centera by entering:
ln -s /fnsw/lib/shobj/libFPLibrary.sl libFPLibrary.sl
ln -s /fnsw/lib/shobj/libFPLibrary.sl libFPLibrary32.sl
ln -s /fnsw/lib/shobj/libFPParser32.sl libFPParser32.sl
ln -s /fnsw/lib/shobj/libPAI_module32.sl libPAI_module32.sl
5. Set the ownership for the new links by entering:
chown -h fnsw:fnusr
*
Modify the .profile and .cshrc files
Modify the .profile and .cshrc files for
the IBM FileNet software user, such as fnsw, and any
other users in the fnadmin and fnop
groups who are responsible for starting and stopping the Image Services
software.
1. Log in and use your preferred text editor to edit the .profile
and .cshrc files.
In the Bourne or Korn
shell, add the following line to the .profile file:
export
SHLIB_PATH=$SHLIB_PATH:/fnsw/lib/shobj/3rdparty/centera
In the C shell, add the following line to
the .cshrc file:
setenv SHLIB_PATH
$SHLIB_PATH:/fnsw/lib/shobj/3rdparty/centera
2. Repeat the previous step for each user.
3. Then start the Image Services software.
NOTE: Before restarting the Image Services software the user needs
to logon again as the fnsw user so the new environmental variable setting is
used.
The
IM utilities compile version must coincide with the ISTK (WAL) version
Please
see specific utility documentation on how to detect version numbers
Example:
ISTK (WAL) 4.0 should utilize the PS Utility compiled for 4.0
ISTK (WAL) 4.1 should utilize the PS Utility compiled for 4.1
See
the Single Document Storage and Retrieval Procedures and Guidelines (9844130-004)
for complete installation instructions. Basically, the installation
has these general steps:
Download the NLS fix pack from the IBM FileNet Fix
Central for your platform and save it in the
temporary directory on your server. Here is the link to IBM FileNet Fix
Central
http://www-933.ibm.com/support/fixcentral/
For UNIX installations also download the latest version of PSL_install
shell script in the same directory.
Install:
Stop any current instances of NLS software
running on your server. Since there are no dependencies between this version of
NLS and other IM Utilities, shutting down other IM Utilities or running 'wal_purge' is not required.
On Unix servers 'cd' to the directory containing PSL_install
and the Fix-pack.
Execute the install script:
> ./PSL_install NLS
On Windows servers, execute the
self-extracting package file and install the file in the folder desired.
For upgrades
from earlier versions of NLS, the NLS configuration file, NLS.cfg, may require
significant changes. See the newly installed NLS_cfg.sample
file and the Single Document Storage
and Retrieval Procedures and Guidelines (9844130-004) for details.
If upgrading
from a release earlier than NLS 1.8.0, the EMC keywords in the NLS.cfg changed
SdsSleep replaced EmcSleep
SdsRetention replaced EmcRetention
SdsDisposition replaced EmcDisposition
SdsDomain replaced EmcDomain
In short, all
keywords with “Emc” changed to the more generic “Sds”. Also new to 1.8.0 is the SdsDevice
keyword which has the four possible values: Centera,
Tivoli, Snaplock, or Filesystem.
Then, SdsDisposition keyword was added to control
whether NLS leaves a copy of the object on the filesystem (FS) or deletes it
(DEL). Finally, the Primary keyword was added to determine which surface
ID will be used in the object’s path.
NLS 1.8.2 added
the SdsChkDB performance keyword which determines
whether the DR550 returns object IDs and the SunSar SdsDevice type for Sun’s StorageTek
SDS system.
NLS 1.8.4
changed the defaults to FetchSleep and ArchSleep.
NLS 2.0.0.0
added the IgnoreChkSum keyword for performance.
The PS library,
called PSs, libPSs.sl, libPSs.so or PSs.dll depending
on your platform, is backwards compatible to the second digit of the release
number. In other words, if the PS library is version 2.5.5,
utilities compiled with the PS library 2.5.0 through 2.5.5 will run
successfully. To see which PS library your utility was compiled with, run
it with the “-v” option, e.g.:
NLS_Archive –v
In the middle
of the output will be the PS library version line:
PS Lib Vers
Lib=2.5.5
which means this version of NLS_Archive
will work with any PS library 2.5.5 or greater but less than 2.6.0.
If installing
more than one IM utility on the same directory, install the newest one last so
that the latest PS library will be installed. Make sure that all the
installed utilities have the same “PS Lib Vers”
numbers for the first and second digits, e.g. 2.5.x. You cannot mix
versions with a different first or second digit.
NOTES
The utilities are released on
a CD type that is created for all supported operating systems.
HP operating systems require a special mount
command to read an ISO9660 CD type.
mount -o cdcase /dev/cd0 /cdrom
To remove this fix pack, you must complete a full uninstall of NLS. Removal
of the fix pack alone is not supported. For more information, see the
This fix pack includes support for the AIX 6.1 platform.
The following tables list the product fixes in this fix pack. The following abbreviations are used:
NLS Near
Line Storage
IMCS Information Management Common Schema (New Defect Tracking System)
APAR Authorized Program Analysis Report
DTS # Defect Tracking System
Number (Legacy Defect Tracking System)
Bug # Bug
Track Number (Legacy
Defect Tracking Database)
IS Image Services
Enh Enhancement
|
APAR
Name |
IMCS
Defect # |
Type |
Description |
|
PJ37483 |
866448 |
Fix |
Documents archived to SnapLock
on Windows receive a message - WARNING-LastErr=0
Can't SetFileAttr - uuid
file not protected. |
|
APAR
Name |
IMCS
Defect # |
Type |
Description |
|
PJ36761 |
842289 |
Fix |
NLS_stop kills the IS TM_daemon |
|
N/A |
848579 |
Fix |
Running NLS_Archive
with debug -S -D -M causes exception error on Windows & segmentation
violation on UNIX |
|
N/A |
842697 |
Fix |
NLS_stop does not stop NLS_Archive if NLS_stop is ran before any of
the SDS_writer processes are started. |
|
N/A |
846270 |
Enh |
ER: Currency Support for EMC 3.2 Patch 4 |
|
APAR
Name |
IMCS
Defect # |
Type |
Description |
|
35818727 |
758660 |
Enh |
ER: Currency Support for EMC 3.2.1 Centera SDK |
|
35818722 |
759426 |
Fix |
NLS_Archive does not kill off SDS_writers after archiving docs on NT or UNIX |
|
35818710 |
761140 |
Fix |
NLS does not appear to archive infinite centera docs as infinite, SDS_tool
can delete and does not report infinite |
|
PJ33961 |
756880 |
Fix |
Documents archived by NLS contain FNP_ARCHIVE date
but no FNP_CLIPID |
|
APAR
Name |
IMCS
Defect # |
Type |
Description |
|
35504150 |
661523 |
Fix |
NLS 2.0 fails to archive |
|
35577397 |
741727 |
Fix |
NLS archiver failing
when archiving file larger than 200mb. |
|
35564984 |
741911 |
Fix |
NLS
doesn't appear to be retrying after a socket error (using Centera SDK). |
|
35575067 |
741912 |
Fix |
In
EBR mode, NLS sets HOLDs to |
|
35564255 |
742012 |
Fix |
NLS
is unable to archive docs to Centera if the DOC_ID is over 3,000,000,000. |
|
35564861 |
742571 |
Fix |
NLS
2.0 fails to archive ALF files over 200MB into Centera with Err <0,22,1032> and no fn_clipid is
Index DB. |
|
35566384 |
743496 |
Fix |
Can't
set document to EBR mode because of invalid EBR period. |
|
35578472 |
744302 |
Fix |
With
EBR-enabled and f_deletedate set, NLS does not set
fixed retention. |
|
35656639 |
748048 |
Fix |
NLS
logs info msg when starting - Increase OS File Size
Limit to Increase SHM Limit. |
|
35701002 |
749818 |
Fix |
NLS_Archive
appears to have archived centera docs as infinite
where NLS.cfg retention is in hours. |
|
DTS # |
Type |
Description |
|
205105 |
Fix |
<47,0,14> Docs table inconsistent with page cache - CleanCache causes NLS to delete objects out of cache before they are written. |
|
205171 |
Fix |
NLS
Support for Centera Event Based Retention (EBR) ( |
|
208325 |
Fix |
Special Sunsar/StorageTek configuration
required on volume for Windows platform. See DTS for more information. |
|
205167 |
Fix |
NLS
Support for Sun StorageTek 520 (SunSAR). |
|
200136 |
Fix |
NLS to
support processing of archival items by Doc I.D. range. |
|
195421 |
Fix |
NLS_Archive populates FNP_Archive
field without copying document to Snaplock while
changing password. |
|
196114 |
Fix |
ISAR
performance issues with |
|
203912 |
Fix |
Dump_ |
|
DTS # |
Type |
Description |
|
196297 |
Fix |
Implement
multiple management classes for DR550. |
|
196114 |
Fix |
Corrected
performance issue with child writers: Removal of a 1 sec per document
sleep Eliminate the need to temporary copy
blobs for SDK style devices (Centera/DR550) |
|
196138 |
Fix |
Object
Verify fails when documents archived contains exactly 8 pages. |
|
195744 |
Fix |
Clarify Install_Config guide for 512MB size limit. |
|
196182 |
Fix |
Configuring
too many child writers hangs processing (MaxArchChildren).
Use ShowSM to help configure the optimal
value. |
|
196451 |
Fix |
ShowSM is now documented in Install Config guide. |
|
197692 |
Fix |
Implement
page level checksumming. |
|
197693 |
Fix |
NLS_start –v switch will display the largest amount
of shared memory that is available to the application. |
|
197706 |
Fix |
Delete
after archive functionality has been corrected. Set CleanCache
to True in NLS.cfg. |
|
DTS # |
Type |
Description |
|
185056 |
Fix |
Sleep doubler needs to be described in the documentation. |
|
184956 |
Fix |
NLS_Archive
cores if flag file is present. |
|
176276 |
Fix |
NLS
enters a endless loop when trying to re-archive documents on SnapLock where the
existing object is already locked down and can’t be updated. |
|
177601 |
Fix |
Unlocking
documents not completely committed. Fixed with the new logic of only
unlocking non-surfaced objects. |
|
Bug # |
Type |
Description |
|
10442 |
Fix |
Change NLS
default values for ArchSleep and FetchSleep. |
|
10434 |
Fix |
Document
Re-Archiving Archived Objects. |
|
10433 |
Fix |
There
has been a number of changes to the reader. Please upgrade your IS
release to 4.0 SP4 + HFP 4 + |
|
10408 |
Fix |
Document
new configuration attribute, TmpDirectory={Default=”.”},
the directory used to build the FileNet object in before migrating to the
Working Directory. Default is 'current working directory' on Unix, |
|
10404 |
Fix |
Table
added to Install_Config to illustrate and simplify
the understanding of how NLS works with its parameters in NLS.cfg. |
|
10361 |
Fix |
To
improve performance, copy routine is moved from NLS_Archive to the children
to copy objects from temporary path to the working directory. |
|
10345 |
Fix |
On
shutdown request, NLS in database mode get's very verbose in arc log. |
|
10300 |
Fix |
Corrected
many documentation discrepancies in Install_Config
guide. |
|
DTS # |
Type |
Description |
|
166743 |
Fix |
Using
Window’s services, issuing “Net stop” command might stop another
utility. |
|
168230 |
Fix |
Functionality
to verify object prior to archival to Note: Objects
will be initially created in the current directory in Unix and the temporary
directory (%TEMP%) on Windows. The object will be verified (if
enabled), then moved to the |
|
Bug # |
Type |
Description |
|
10358 |
Fix |
Correct
memory leak in NLS_Archive when archiving to NetApp device. |
|
10339 |
Fix |
Corrected
problem with AppMaxDocID on Windows 2003.
This fix requires an interface change to the PS shared library. The new
library version is 2.5.0. Visit the support Matrix for utility
compatibility (http://ps-web/pages/SupportMatrix.asp). |
|
10251 |
Fix |
MaxArchChildren limit has been increased to a
maximum of 48 children. |
|
10274 |
Fix |
Document
all possible configurations for SdsDisposition in
sample configuration file. |
|
10275 |
Fix |
Reorganize
key words in sample configuration file for clarity. |
|
10298 |
Fix |
(Case #
20004086) Unlocking documents not completely migrated. |
|
DTS # |
Type |
Description |
|
168040 |
Fix |
Change handling
of Report Manager docs including warning in place of error messages. |
|
Bug # |
Type |
Description |
|
10272 |
Fix |
Corrected
migrate routine from calling ‘migrate_cancel’
excessively. |
|
10248 |
Fix |
Support
for |
|
10247 |
Fix |
Implementation
of |
|
10237 |
Fix |
|
|
10238 |
Fix |
|
|
DTS # |
Type |
Description |
|
162537 |
Fix |
Using
file list mode, the ‘-‘ switch would not skip previously archived documents. |
|
158538 |
Fix |
|
|
Bug # |
Type |
Description |
|
10164 |
Fix |
Change
working directory file permissions to 770 (rwxrwx---)
for security reasons. |
|
10206 |
Fix |
NLS
internally forces an EmcDisposition of |
|
10176 |
Fix |
Increased
the FileNet object version number from 2 to 3. |
|
10173 |
Fix |
Added
the new |
|
10164 |
Fix |
Working
Directory (Unix) security set to 770 at directory level. |
|
10161 |
Fix |
Log the |
|
Bug # |
Type |
Description |
|
10160 |
Fix |
NLS_Archive
doesn't limit last doc on query when AppMaxId is
used. |
|
10158 |
Fix |
|
|
Bug # |
Type |
Description |
|
10149 |
Fix |
Encrypted
passwords does not allow NLS to start when configured with Centera. |
|
10138 |
Fix |
|
|
DTS # |
Type |
Description |
|
147141 |
Fix |
Memory
problem when trying to archive large files greater than 250 MB. |
|
Bug # |
Type |
Description |
|
10135 |
Fix |
Expired
retention files in Snaplock are not deletable. |
|
10134 |
Fix |
NLS_Archive 4.0 Windows -- |
|
10133 |
Fix |
"NLS_start -p -f <flist>
-S -D" & "NLS_start -p -S
-D" Arch/Clips 1 doc & cores. |
|
10130 |
Fix |
On
Windows, the last doc_id in a file list isn't
processed |
|
Bug # |
Type |
Description |
|
10124 |
Fix |
(Lib
2.4.3) NLS is trying to archive docs from a doc classes w/o FNP_Archive/Clipid. |
|
10115 |
Fix |
|
|
10117 |
Fix |
Modified
|
|
10121 |
Fix |
Made
clipid file read only when in File System mode. |
|
10067 |
Fix |
Implemented
the use of date for retention value. |
|
Bug # |
Type |
Description |
|
10081 |
Fix |
NLS's
not enforcing the FileNet default 5 min retention when writing to SnapLock. |
|
10080 |
Fix |
NLS_start does not start the
usual processes. |
|
10061 |
Fix |
Added
a routine to check for archived documents with no clip IDs at startup time. |
|
10060 |
Fix |
Added
functionality for a graceful shutdown in force mode. Restart
functionality added. |
|
10066 |
Fix |
Change
SnapLock volume UUID to become optional. |
|
Bug # |
Type |
Description |
|
10006 |
Fix |
Fixed
minor problems with negative numbers and retention. |
|
10075 |
Fix |
Modified
the Index handling to always consider a zero value the same as a NULL. |
|
10007 |
Fix |
Prefetching documents when using
import mode (+filelist). |
|
10070 |
Fix |
Incorrect
default values for EmcBufSize in documentation. |
|
Bug # |
Type |
Description |
|
10118 |
Fix |
DocReportFrequency was being
overwritten by MaxFetchDocs and MaxQueryDocs.
Change the code to test and pick the minimum between
them. |
|
Bug # |
Type |
Description |
|
10122 |
Fix |
On
Windows only, retention dates resulting in a very large future date resulted
in the 'No Retention' being set. Change variables from 'unsigned long'
to 'unsigned long
long.'
|
|
10123 |
Fix |
Damaged
Index record information in an archived object was causing invalid pointers
to be created and therefore cause segmentation violations. A check was
added to prevent this Should this problem be discovered, a Warning message
will be logged and informed to re-archive the document. This does not
hinder the recovery of the document into cache since we are only reading the
pages. |
|
10019 |
Fix |
No
retention being set. |
|
Bug # |
Type |
Description |
|
|
Fix |
Changed
the retention generation routine to use the system features to allow
retention dates to extend beyond the year 2038. |
|
Bug # |
Type |
Description |
|
|
Fix |
Repositioned
the timing report line in NLS_Add2Q. |
|
|
Fix |
The
original purpose was to time tape reads when NLS was used with ASM/StorageTek Tape Silo H/W. |
|
|
Fix |
With
Centera, a second open/read/close is not needed. Moved all code to the outer
section so that it will now |
|
|
Fix |
Modified
NLS_Fetch to not retrieve into cache an object if
the object is already in cache |
|
Bug # |
Type |
Description |
|
|
Fix |
Corrected
a problem of stopping NLS under large set size conditions. |
|
Bug # |
Type |
Description |
|
|
Fix |
The
recreate path still had a small bug in that if the surface recorded in the
Clip was different
than that in the database, the file was recovered in one place but verified
in another. This causes Add2Q to fail. Updated the filename with the new path
as found in the clip Validation
of the FNP_CLIPID is now done to make sure that is defined to be at least 65
bytes. Also the FNP_ARCHIVE is checked to make sure that it is a date
type.
Completed
code to re-archive from existing files. This facilitates the use of DART as a
conversion tool. NLS will not recreate FileNet object or read from
cache but update the HSM directly from the existing file, if the file is
found. Changed
the |
|
Bug # |
Type |
Description |
|
|
Fix |
Fixed
the Volume UUID routine for Unix volume name vs. path mismatch. Added
code to 'recreate' the path of a missing document for retrieval. |
|
Bug # |
Type |
Description |
|
|
Fix |
Shared
Library interface change. |
|
Bug # |
Type |
Description |
|
|
Fix |
Fixed
AIX®
problem with mounted file systems. |
|
Bug # |
Type |
Description |
|
|
Fix |
Shared
Library interface change. |
|
Bug # |
Type |
Description |
|
|
Fix |
Full
NetApps/SnapLock support. AIX bug exists, still only supports UNC path. |
|
Bug # |
Type |
Description |
|
|
Fix |
Corrected
the use of MaxDocId and AppMaxDocId. Corrected
the MinDate conversion (get_date)
so that 2000 years were correct. |
|
Bug # |
Type |
Description |
|
|
Fix |
Corrected
the retention setting for positive, non-zero numbers. Simplified the
routine to now determine the time left based on F_DELETEDATE or
F_ARCHIVEDATE. |
|
Bug # |
Type |
Description |
|
|
Fix |
Added
shutdown knowledge when file systems gets full. This will cause the
NLS_FLAGS file to be written, if possible. A 'really' full condition on
that file system would prevent that. |
|
Bug # |
Type |
Description |
|
|
Fix |
For
Solaris needed to write our own scandir routine
because of the non-standard BSD scandir didn't work
when searching for FileNet Object files to retrieve from. |
|
Bug # |
Type |
Description |
|
|
Fix |
Major
FileNet Release. |
For information about contacting customer support:
Navigate to the
Information Management support page ( www.ibm.com/software/data/support
).
Select the
appropriate IBM FileNet product from the "Select a category" list.
From the Product
Support page, click Flash
This information was developed for products and services offered in the
IBM may not offer the products, services, or features discussed in this
document in other countries. Consult your local IBM representative for
information on the products and services currently available in your area. Any
reference to an IBM product, program, or service is not intended to state or
imply that only that IBM product, program, or service may be used. Any
functionally equivalent product, program, or service that does not infringe any
IBM intellectual property right may be used instead. However, it is the user's
responsibility to evaluate and verify the operation of any non-
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: