IBM FileNet SDS Tool SDST-1.0.0.3 Fix Pack Readme
© Copyright IBM Corporation 1988, 2009. All Rights Reserved.

A new command, “cleanup”, has been added. This new command will set the FNP_CLIPID index field to an 'empty string' and the FNP_ARCHIVE index field to zero after confirming that the object's SDS location has been successfully transferred to the Permanent DB/Docs Table.

This feature is only available when running Image Services 4.1.1 or later.

APAR : PJ36361

IMCS Defect # : 789289

Description : SDS_tool need an option added to perform object level verification on documents archived on Centera hardware.

This improvement incorporated the functionality of Dump_SDS into SDS_tool providing for validation checking of the content of NLS created objects for all SDS Devices.

This improvement was implemented in two ways within SDS_tool.

1. An option was added to the 'Report' command, called 'Check', that validates the contents of the object (or objects) specified by the 'Report' command selection parameters.

2. A 'Check' command was added to support the checking of a file which may be either the actual NLS object path for a file-system based object, or a file name that specified an exported object from an API based SDS device (using the SDS devices native (or 3rd party) export features.

Both command variations result in the same content checking code to be executed.

APAR : PJ36359

IMCS Defect # : 784186

Description : SDS_tool guide is misleading in its description of the 'set=hold' option.

The current SDS_tool guide 1.0.0.1 is misleading in its description of the "set=hold" option.

Problem Description:

Page 37 of the SDS_tool 1.0.0.1 Guide contains contradicting statements about the set=hold option.

The modify docid=100000 set=hold - Hold applies only to IBM TotalStorage DR550 and EMC Centera.

□ On EMC Centera and IBM TotalStorage DR550, it will hold the object indefinitely until the hold is released, regardless of any other retention settings.

□ For EMC Centera, "hold" means it is being retained indefinitely until you determine an expiration date.

The correct statement is that the "hold" is retained indefinitely until released on EMC Centera.

APAR : PJ36360

IMCS Defect # : 784195

Description : SDS_tool guide misleading - Cannot extend the EBR Expiration Date of an EBR-type document.

On Page 36 of the SDS Tool 1.0.0.0 Guide, the Modify command describes the 'set=ebr' clause. The 'set=ebr' clause is simply a triggering mechanism that changes the state of an EBR object from an indeterminate retention value to a fixed retention value. Once an object has a known retention value, the retention date can be extended. If the object's retention is indeterminate then it cannot be extended.

EBR objects are only supported on EMC Centera and the IBM DR550.

On Centera, the trigger (set=EBR) sets the retention to 1 day (default). The object is then updated with the correct retention date to match the date in the Index Database. After the object’s retention has been set, you can only hold, release, or extend the date, just like any other fixed retention object.

On DR550, since we don't trigger the object until we have reached the delete date, the 'set=ebr' call is really a no-op. Also the extend and set commands do nothing on the DR550.

IMCS Defect # : 760092

Description : ER: Need to implement Exists Option for API based Storage Devices.

This feature enhances the 'exist' capability to include API based SDS device objects.

Previous releases only support the 'exist' option on file-system based SDS devices.

The 'exist' option to 'Report' provides a fast 'existence' check of objects on the SDS device or associated file-system (working directory). It does no validation of the Document ID in any part of IDMIS or of the actual SDS object, simply the 'existence' of the object.

It also provides a 'not found' output file that listed documents that are specifically requested to be on the device and were not found.

With the additional support for API based devices, if the object is found in the working directory but not on the SDS device, it will be considered 'found' but the listing/output will indicate that it was found and display the file-system path of the object.

Incorrect Option for the Report Function:

On page 41 in the SDS 1.0.0.0 Guide, it lists an example of using the report function.

Incorrect: report <id_type>={+}<id_value> {option=FileNet|SDS|both} {file=<filename>}

This example is incorrect, option is not a keyword, the keyword should be verify.

Correct: report <id_type>={+}<id_value> { verify =FileNet|SDS|both} {file=<filename>}

EMC ARM Licensing: To take advantage of Event-Based Retention in Centera Governance and Compliance Plus editions, customers must make sure they acquire the Advanced Retention Management (ARM) license from EMC and have EMC activate event-based retention on the licensed system.

IPV6 Note: When running SDS Tool on IPv6 configured servers, the touch file /fnsw/client/config/ipv4 is required or SDS Tool will report errors. SDS Tool is not supported on IPV6 configured servers unless this touch file is in place. This applies to all IM Utilities (NLS,SDS Tool,HPII/MRII, and DART).

Tivoli Client API download and installation to use Tivoli 5.5 and above:

The SDS_tool package has been tested and is delivered with Tivoli Version 5.3 support libraries included. This is to be compatible NLS.

To use a more recently release version, such as 5.5 or 6.1, the Tivoli Client API needs to be downloaded and installed on the customers system.

To install the Tivoli client API package, the package needs to be downloaded from the IBM web site below:

ftp://ftp.software.ibm.com/storage/tivoli-storage-management/maintenance/client/v5r5

Select the appropriate platform and select the package to download. The package download has a readme file which contains the instructions to install the package. In summary, the installation process is as follows:

Step 1: Here is the link to the installation instructions:

http://publib.boulder.ibm.com/infocenter/tivihelp/v1r1/index.jsp?topic=/com.ibm.itsmc.doc/baclients.html

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: Keep an eye on the installer messages for various OS level patches needed.

Co-existing with Image Services on the HP-UX platform using different Centera shared libraries.

For SDS Tool 1.0.0 FP3 to co-exist with Image Services on the same HP-UX machine and function properly, manual steps need to be taken to prevent SDS Tool start-up errors.

1. Remove the EMC Centera libraries that were installed with SDS Tool 1.0.0 FP3 from the local directory using the following commnd:

rm libFP*.sl lib*32.sl

2. Logon as root and create a symbolic link as follows:

a. Create link : mkdir -p /opt/Centera_SDK/lib

b. chmod -R 777 /opt/Centera_SDK/lib

c. ln -s /fnsw/lib/shobj /opt/Centera_SDK/lib/32

About this fix pack

This document provides information about the SDS Tool 1.0.0.3 fix pack.

Accessing IBM FileNet documentation and fix packs

To access documentation for IBM® FileNet® SDS Tool 1.0.0.3 product:

1. Navigate to the Information Management support page (www.ibm.com/software/data/support ).

2. Select the appropriate FileNet Image Services product from the "Select a category" list.

3. From the Product Support page, click IBM FileNet Fix Packs under Download.

4. From the IBM FileNet Fix Packs page, click IBM FileNet P8 Image Services.

5. 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.

Installation, migration, upgrade, and configuration

Requirements

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.X

□ ISTK (WAL) 4.1 should utilize the PS Utility compiled for 4.1.X

Install this fix pack

See the Single Document Storage Tool Maintenance, Installation and Configuration Guide for complete installation instructions. Installation has these general steps:

Download:

1. Download the SDS Tool 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:

1. Stop any current instances of SDS_tool software running on your server. Since there are no dependencies between this version of SDS_tool and other IM Utilities, shutting down other IM Utilities or running 'wal_purge' is not required.

2. On Unix servers 'cd' to the directory containing PSL_install and the Fix-pack.

a. Execute the install script:

> ./PSL_install SDST

3. On Windows servers, execute the self-extracting package file and install the file in the folder desired.

If there are any errors, such as “text file busy”, that prevent installation, go back to step 2, and make certain all applications

PS Library Dependencies

SDS Tool does not access the PSs library so unlike other IM Utilities, this is not an issue.

Uninstall this fix pack

To remove this fix pack, you must complete a full uninstall of SDS Tool. Removal of the fix pack alone is not supported. For more information, see the IBM FileNet NLS Installation and Configuration Guide.

Product fix history

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:

□ SDST SDS Tool

□ 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

SDS Tool -1.0.0.3

APAR Name	IMCS Defect #	Type	Description
PJ36362	766381	Fix	After Integral SDS upgrade need to delete NLS objects
PJ36361	789289	Fix	SDS_tool need an option added to perform object level verification on documents archived on Centera hardare
PJ36359	784186	Fix	SDS_tool guide is misleading in its description of the 'set=hold' option.
PJ36360	784195	Fix	SDS_tool guide misleading - Cannot extend the EBR Expiration Date of an EBR-type document.
NA	760092	Enh	ER: Need to implement Exists Option For API based Storage Devices
NA	810039	Enh	ER: Currency Support for EMC 3.2 Patch 3

SDS Tool -1.0.0.2

APAR Name	IMCS Defect #	Type	Description
PJ33686	757410	Fix	SDS_tool reports the EBR retention period to exceed 136 years while the EMC CAS script reports 1 day for the same document.
PJ33687	757411	Fix	SDS_tool can't set EBR on some documents that were archived with NLS 2.0.0.
PJ33959	759930	Fix	Could not delete documents because of the reported issue of EBR period > 136 years (#757410)
PJ33960	760036	Fix	SDS_tool will start reporting errors on the 25th operation using the modify option.

SDS Tool -1.0.0.1

APAR Name	IMCS Defect #	Type	Description
35700841	744302	Fix	With EBR-enabled and f_deletedate set, NLS does not set fixed retention.
35590385	743414	Fix	NLS 2.0 with f_archivedate and f_deletedate set, archive documents use the wrong f_archivedate .
35700848	741332	Fix	SDS_tool help text incorrectly shows the “verify” option is called “option”.
35700852	741801	Fix	SDS_tool allows deletion of unexpired objects on Centera.
35700861	752570	Fix	SDS_tool cannot recover Hcap docs on Windows.
35700863	752500	Fix	SDS_tool cannot recover Snaplock docs for Windows
35700867	752482	Fix	SDS_tool cannot recover SunSAR docs for Windows
35700874	752479	Fix	SDS_tool cannot recover DR550 docs on Windows.
35700878	752251	Fix	SDS_tool cores on AIX 6.1 when running a report on a DR550 doc.
35700885	750529	Fix	SDS_tool cannot recover sunsar docs
35700887	749805	Fix	SDS_tool unable to recover centera objects
35700896	749542	Fix	SDS_tool: report of centera docs not displaying doc closure status info
35700203	749371	Fix	SDS_tool: Cannot recover documents when using a doc range.
35700909	749349	Fix	SDS_tool cores when setting docs to EBR for SunSAR
35700922	747358	Fix	SDS_tool deletes object on file system when it shouldn't
35700927	747355	Fix	Closed to 0 months from 1 month, then tried to delete, 1970 date reported back.
35700929	747354	Fix	For Centera, SDS_Tool will delete object from file
35700935	746300	Fix	SDS_tool crashes with segmentation violation - Unknown
35700938	745910	Fix	SDS Tool output file reports unsuccessful.
35700943	745909	Fix	SDS Tool output file information is incomplete
35700948	744608	Fix	Difficult to determine if SDS object has been triggered
35700955	744607	Fix	SDS_Tool segments with extend command if you provide it
35684906	743877	Fix	238,0,10 DOC ID mismatch found ssn=1642369857 found
35700960	663172	Fix	SDS_tool cores doing report on Solaris
35700966	662044	Fix	SDS_tool not listing CLIPID for docs archived with IDX, DEL but CLIPID is in outfile.

SDS Tool -1.0.0.1 (continue)

DTS #	Type	Description
213723	Fix	The Status option incorrectly reports the Centera capacity and free space.
215559	Fix	When you use the SDS_tool you get Err=255,255, 55130 (too many open clip ids).
214129	Fix	The SDS_tool core dumps on HP-UX 11.0.
213721	Fix	Centera devices set an initial retention on an archived document to 300 seconds.
213678	Fix	The SDS Tool incorrectly reports Creation and Expiration Time. What does?
210579	Fix	The SDS Tool has a segmentation violation on Solaris.
211673	Fix	EBR and Hold are not working correctly.
209703	Fix	The SDS Tool cannot recover more than one doc from sdsid file on Centera and Tivoli.
209175	Fix	The SDS Tool is not checking for a hold and EBR status on compliance edition Centera.
207171	Fix	The SDS Tool cannot recover from SnapLock.
204108	Fix	The SDS Tool cores on startup on HP-UX.
207298	Fix	The SDS Tool recover list cores on HP-UX.
207149	Fix	The SDS Tool cannot delete expired Tivoli docs.
206774	Fix	Program help needs to be updated for syntax: modify, report, and recover functions.

Contact customer support

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 8 Oct. 2007: How to get support for IBM FileNet products.

Notices

This information was developed for products and services offered in the U.S.A.

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 product, program, or service.

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:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY  10504-1785

 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation

Licensing

2-31 Roppongi 3-chome, Minato-ku

Tokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation

J46A/G4

555 Bailey Avenue

San Jose, CA  95141-1003

 U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.

Trademarks

IBM, AIX are registered trademarks of International Business Machines Corporation in the United States, other countries, or both.

FileNet is a registered trademark of FileNet Corporation, in the United States, other countries, or both.

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

UNIX is a registered trademark of The Open Group, in the United States, other countries, or both.

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

IBM FileNet SDS Tool SDST-1.0.0.3 Fix Pack Readme © Copyright IBM Corporation 1988, 2009. All Rights Reserved.

New in this fix pack

Documentation Updates