IBM FileNet Image Services Toolkit 4.1.2.10-ISTK-FP010 Fix Pack Readme
© Copyright IBM Corporation 2011. All Rights Reserved.

This document provides information about the IBM® FileNet® Image Services Toolkit (ISTK) 4.1.2.10-ISTK-FP010 fix pack. The Image Services Toolkit 4.1.2.10-ISTK-FP010 fix pack updates an existing ISTK 4.1.2 system. ISTK fix packs are cumulative and include content from all previously released fix packs since the base release. ISTK fix packs are released approximately every 10 weeks, and include the binary executable installer, the manifest file, and the readme.

• The ISTK fix pack is a separate installation from the IS fix pack. Install the ISTK fix pack after the IS fix pack has been installed.
• To determine the current ISTK fix pack version installed on your server, enter the following command: UNIX®
  /fnsw/client/bin/fn_rel Windows®
  \client\bin\fn_rel
• The ISTK 4.1.2 fix pack installation program installs files belonging to ISTK Developer's Edition even on machines with ISTK Runtime Edition installed. Refer to Tech Note # 1461071 on the IBM support site for details.

Accessing IBM FileNet documentation

1. Navigate to the Product Documentation for FileNet P8 Platform support page. http://www-1.ibm.com/support/docview.wss?rs=3247&uid=swg27010422
2. Select a PDF or a Doc Link, whichever is appropriate.

ISTK documentation is not available on the IBM Web site. ISTK documentation is distributed with the ISTK software after ISTK is purchased.

New in this fix pack

No new features are introduced in this fix pack.

For details about the resolved defects in this fix pack, see "Product fix history".

For more information about new features and known issues, see the IBM FileNet Image Services Release Notes.

Compatibility

Introduced in Image Services 4.1.2.-IS-FP009

Introduced in Image Services 4.1.2.7-IS-FP007

Software Tags are available as a common solution for identifying the product name, product version and fix pack level installed. This information is now standardized, making collecting system information more efficient for support teams, automated problem determination and compatibility advisors.

Introduced in Image Services 4.1.2.6-IS-FP006

Images Services now supports Windows 7 for it's client applications, Image Services Toolkit (ISTK) and Image Services Remote Administration Console (ISRAC). Refer to tech note 1419868 Image Services Supports Windows 7 for ISTK and ISRAC for details.

Installation, migration, upgrade, and configuration

This section contains the following topics:

Note Installation of this fix pack is not affected by any virus protection software that might be running in the background.

Support documentation

Before installing this fix pack, verify you have a copy of the latest IBM FileNet Image Services Toolkit documentation. The ISTK documentation packages contain additional information that you might need to perform the procedures mentioned in this readme, such as stopping services and applications.

Requirements

This fix pack has the following minimum requirements:

Software requirements

• ISTK 4.1.2

Disk space requirements

• Directory for ISTK software (typically, /fnsw/client), two times the size of the fix pack
• Temporary disk space (by operating system)

• The path specified by the TMP environment variable
• If TMP is not defined, the path specified by the TEMP environment variable
• If both TMP and TEMP are not defined, the Windows directory

Note The installer does not run any checks to verify that a specified directory exists.

You can override the temporary directory on both UNIX and Windows servers by adding -is:tempdir to the command line as shown below. However, must already exist, and it must be located outside of the /fnsw directory (UNIX) or the \fnsw and \fnsw_loc directories (Windows).

Installation log files

Several log files are created during the fix pack installation. You can check these log files to determine the status of a fix pack installation. If the installation failed, these log files can help you determine the cause of the problem.

UNIX

Use the more or less commands to view the log files on UNIX servers, which are stored in the following directories:

Windows

Use WordPad in landscape mode to view the log files on Windows servers, which are stored in the following directories:

Fix pack installation logs

The . / /HFP / directory contains the istk_ -HFP .log file. This log file lists all the ISTK modules that were replaced. Each time you run the installer, new information is appended to the end of the file.

This log file also records all the processing steps taken during the fix pack installation, and indicates if they were whether they were successful or unsuccessful. The last indicates the status of the installation:

SUCCESS - All files were copied successfully, and no errors were detected
WARNING - All files were copied successfully, but some errors were detected
ERROR - One or more files were not copied, and some errors were detected

You can determine the number of files that were copied by the following line located near the end of the log file. The actual number of files copied varies from one fix pack to another. However, the total number of files copied must equal the total number of files provided with this fix pack. If the number of files do not match, verify all ISTK-related applications are shut down, and run the fix pack again.

47 files of 47 have been copied to the target

Note Due to an InstallShield known issue about clearing out temporary directories, you might have to manually clear the temporary directory of extraneous files, especially after a failed installation

InstallShield Multi-Platform (ISMP) logs

The . / /HFP/ismp/ directory contains log files generated by the InstallShield Multi-Platform (ISMP) program if the fix pack installation was not successful.

These files contain error messages and warnings that can help you troubleshoot an unsuccessful installation. However, when you run the installer again, these files will be overwritten if any further messages are generated. If you want to save the current files, rename them before you rerun the installer.

Harmless messages: If the logs contain any warnings about Swing or AWT initialization, you can ignore them. You can also ignore these messages:

Unable to compare stamp versions.

Unable to read Host name: Null pointer exception

Miscellaneous logs

The . / /HFP/misc/ directory has several logs that can be used for troubleshooting and debugging:

• configFiles.log - Lists the configuration files replaced by this fix pack
• devModules.log - Lists development modules replaced by this fix pack
• newerFiles.log - Lists files that were newer than the ones provided by this fix pack.

This directory also contains a record of the file "stamp" information before and after the installation.

Graphical installation and silent installation modes

Silent installation does not display any messages to the user whereas graphical installation does. To determine if silent installation is running, refer to the primary error log found in the /fnsw/client/logs/hfp/ /HFP/ directory (the \fnsw_loc\logs\hfp\ \HFP\ directory on Windows servers). On UNIX servers, the command tail -f istk_ -HFP.log dynamically displays the installation log as it is created.

Before using silent installation mode, verify the amount of free space in the default temporary directory as described in the previous section. The amount of free disk space must be verified either manually or through an automated script. Lack of sufficient disk space will prevent the installer from launching successfully. Note that if no prior fix packs have been installed on the current ISTK release, the main fix pack log will not exist. The absence of this log file also indicates a failed installation.

DISPLAY environment variable on UNIX servers

The DISPLAY environment variable controls whether or not the "Welcome" screen displays on UNIX systems in graphical mode. If you use the su command to log on as root, the DISPLAY environment variable might not be correct. Check the DISPLAY environment variable by entering:

The environment variable should be set to 0:0 to display on a local monitor. If you are installing the fix pack remotely to another server, the variable on that server must be set to direct the display to the server you are working on.

Install this fix pack

In dual-server and multi-server configurations, install the fix pack on the root server first, and then on the other servers.

1. Download and extract the 4.1.2.10-ISTK-FP010 fix pack for your operating system.
2. Back up the entire ISTK application.
3. If ISTK is installed on the same server as IS, log in with a user account that has the appropriate permissions to start and stop IS.

1. Shut down IS: initfnsw -y stop
   killfnsw -DAy
2. Determine if any fnsw processes are running: ps -elf | grep fnsw
3. Shut down any fnsw processes that are still running: kill -9
4. Determine if any view log (vl) processes are running: ps -elf | grep vl
5. Shut down any vl processes that are still running: kill -9
6. (HP-UX and Solaris only) Determine if any MasterSnmpd process are running: ps -elf | grep MasterSnmpd
7. Shut down any MasterSnmpd processes that are still running: kill -9

Windows
On all Windows servers:

1. Shut down IS: initfnsw -y stop
   killfnsw -DAy The killfnsw command also stops the IS Control Service.
2. Stop the SNMP process: net stop "SNMP"

• If it appears as if the installer is not running, compare the size of the downloaded fix pack to the size of the fix pack posted on the the IBM support site. If they differ in size, download and run the fix pack again. However, installation of this fix pack can take between 6 to 10 minutes, depending on the server processor speed.
• If a message indicates that IS was not shut down correctly, determine if any processes previously shut down abnormally, and then shut them down correctly. UNIX - If any files are in the /fnsw/procs directory, open them to determine the name of the process, and then run ps -ef | grep . Windows - Use the Windows Task Manager to check for and terminate any processes that were shut down abnormally.

UNIX

1. Verify the DISPLAY environment variable is set correctly. For more information, see "DISPLAY environment variable on UNIX servers" earlier in this readme.
2. Verify the file is executable. If it is not, add execute permission with the following command: chmod +x .bin
3. Change to the directory where you installed the fix pack file, and enter the file name: Graphical mode ./istk_4.1.SP2-FP10_ .bin Silent mode./istk_4.1.SP2-FP10_ .bin -silent

Windows

1. Locate and double-click the executable (.exe) file.

1. Open a command prompt and enter the name of the fix pack: :\istk_4.1.SP2-FP10_win.exe -silent

System failures associated with ISTK shared memory address space allocation

Windows only After you install or upgrade ISTK, the address space that is allocated to the SysV shared memory for ISTK processes might conflict with the existing address spaces that are allocated by other products. Conversely, after you install or upgrade another product that is installed on the same server as ISTK, the address spaces allocated by those other products might conflict with the address space that is allocated to the SysV shared memory for ISTK processes.

If this address allocation conflict occurs, SysV stops the process that encounters the conflict, locks one of the shared memory semaphores (which stops other ISTK processes), and records the following error message (or a similar one) in the ISTK ISTK ELOG and Event log:

SysV: Error 487 mapping file view. Process Aborting.

Due to the complex nature of address space allocation, all of the products and conditions that conflict with the address space allocation of the SysV shared memory are unknown. Therefore, the actual error message might be different than shown. If this is the case, contact IBM support to help you analyze the results.

The products that are known to conflict with the address space allocation of the SysV shared memory are:

• Microsoft® SQL Server 2005
• Microsoft security updates - The Microsoft security updates that might conflict with the address allocation of the SysV shared memory are: KB931768, KB933566, KB937143, KB931784, and KB937143

SysV creates a memory map, determines the largest area of free memory, and creates a registry edit file to update the starting address

This release of ISTK provides a SysV feature that troubleshoots and repairs the SysV shared memory address space allocation conflict. Specifically, SysV:

• Creates a memory map that has a detailed listing of every section of memory that is used by the conflicting ISTK process
• Determines the starting address of the largest amount of available memory from the information in the memory map
• Creates a registry edit file that you can run that changes the starting address of the SysV shared memory to the new starting address determined by SysV

Initiation of this SysV feature occurs:

• Automatically, when an address space allocation conflict occurs
• Manually, by creating a trigger file and running the process

Create a trigger file

Important This procedure must be performed by a qualified ISTK system administrator. If this procedure is not performed properly, it could have an adverse effect on system operation. Contact your ISTK technical support representative if you require assistance.

The starting address varies from system to system based on the configuration and other installed software. Therefore, the best address must be determined individually for each system.

1. If the shared memory conflict occurred during the ISTK startup process, begin at "Confirm the creation of the virtual memory map. " to view the results of the SysV analysis of the conflicting process. If the shared memory conflict has not occurred, begin by creating a trigger file in the next step.
2. Create a trigger file that contains the name of the ISTK process to examine. For example, "my_istk_app" is a sample name of an ISTK process: cd \client\tmp echo my_istk_app > dump_vmap.txt OR cd \client\tmp echo all > dump_vmap.txt Notes
   • The client\tmp directory is located in the directory where ISTK is installed. This installation directory is referred to as WAL_ROOT and is set in the Windows registry using the following path: HKEY_LOCAL_MACHINE\software\FileNet\WAL\CurrentVersion\WAL_ROOT.
   • Although you can enter any ISTK process name in the trigger file, use the name of the process that links to the conflicting product to ensure that the trigger file captures all of the relevant libraries in the memory map. If the process name is unknown use "all" in the trigger file instead of the name of an unrelated process.
3. Restart the ISTK applications to manually initiate the analysis of an ISTK process.
4. Confirm the creation of the virtual memory map by locating the following message (with a recent time-stamp) in the ISTK ELOG or the Event log. fn_NT_VMMap: saving virtual memory map in client_logs directory If this message is not in the ISTK ELOG or Event log, the virtual memory map code was not created. If this is the case, contact IBM support. Otherwise, the following message (or a similar one) is recorded in the ISTK ELOG or Event log: The Windows Registry may be updated to change the starting
   SysV shared memory address to the largest free area in memory
   (at address 0x11000000).
   A new registry edit script was created with the name:
   c:\Program Files\FileNet\FNSW\client\logs\shm_c_3172-1320.reg.txt
   To change the SysV shared memory address execute this script
   after completely shutting down all ISTK applications. SysV stores the virtual memory map file in the \client\logs\client_logs directory and names it according to the process name and ID that generated the file. For example, if the process was MyApp.exe with a process ID of 1234 and a thread ID of 5678, the file will be named sl_MyApp.exe_1234_5678.txt.

Note The "StartShmAddress" registry key does not exist in the Windows registry by default. This key is created only on systems that need to modify their start SysV shared memory address so that it is different from the default value that is embedded inside the code. This default value is 0x45000000, which is the address where SysV starts its shared memory unless directed otherwise by the "StartShmAddress" registry key.

Automatically update the Windows registry

To run the registry edit file and change the start address of SysV shared memory, complete the following procedure:

1. Remove the .txt extension from the registry edit file located in the \client\logs directory (for example: shm_c_1234-5678.reg).
2. Back up the registry edit file without the ".txt" extension.
3. Stop all ISTK applications that are running.
4. Back up the Windows registry.
5. Run the registry edit file by double-clicking its icon.
6. Restart the ISTK applications.
7. Continue with "Verify the new shared memory start address".

Manually update the Windows registry

To manually update the Windows registry and change the starting address of SysV shared memory, complete the following procedure:

1. Use a text editor to view the contents of the registry edit file in the \client\logs directory, which will be similar to: REGEDIT4
   [HKEY_LOCAL_MACHINE\SOFTWARE\FileNet\WAL\CurrentVersion]
   "StartShmAddress"=dword:13000000
2. Use the regedit command to add or update the StartShmAddress key using the path and value in the registry edit file.

Verify the new shared memory start address

1. Verify the new start address by running the following command: wal_ipc -A

Note IS and ISTK use separate shared memory. Setting the start address for one has no effect on the other. They can both use the same start address or they can use different addresses. They are totally independent.

Uninstall this fix pack

Only the most recently installed fix pack can be uninstalled. If you need to return an even earlier version, you will have to restore ISTK from your backups.

UNIX

Restriction Use only this command to uninstall the fix pack. Using the operating system tools could delete vital data that is needed for future fix pack installations.

1. Log on to the UNIX system as a user with root privileges.
2. Stop all ISTK-based applications.
3. Run the uninstall program: /fnsw/client/hfp/_uninst/uninstall_hfp.bin

Windows

1. Log on to the Windows system as a user with Administrator privileges.
2. Stop all ISTK-based applications.
3. Open the Control Panel window.
4. Select Add/Remove Programs.
5. Select the Fix Pack for Image Services Toolkit , and then click Add/Remove.

Product fix history

The following tables list the product fixes in this fix pack.