IBM Content Manager, Version 8.5.0.3

Background processing for the event monitor, BPM event handler, and case event handler

This feature supports the background processing for the event monitor, BPM event handler, and case event handler with some scenarios.

The feature supports background processing in following scenarios:

Save the authentication parameters for the background processing.
Start the event monitor in the background (event monitor continues to run in the background, even when the login user is logged off from a terminal session on a Linux, AIX®, or Solaris platform or the user exits from a command console on a Windows).
Start the BPM event handler in the background (BPM event handler continues to run in the background, even when the login user is logged off from a terminal session on a Linux, AIX, or Solaris platform or the user exits from a command console on a Windows).
Start the case event handler in the background (case event handler continues to run in the background, even when the login user is logged off from a terminal session on a Linux, AIX, or Solaris platform or the user exits from a command console on a Windows).
Terminate the event monitor that is started in background.
Terminate the BPM event handler that is started in background.
Terminate the case event handler that is started in background.
Clear the authentication parameters for the background processing.
Show the process ID (PID) of the started process.
Clear the process ID (PID) of the started process.
Disable the saving of authentication parameters.
Enable the saving of authentication parameters

Event monitor:

Save the authentication parameters of the event monitor for the background processing by calling existing scripts to save authentication parameters:

Windows - ICMEvent.bat
Linux, AIX, Solaris - ICMEvent.sh

Start the event monitor in the background by calling:

Windows - ICMEventLaunch.bat
Linux, AIX, Solaris - ICMEventLaunch.sh

Terminate the event monitor that is started in the background by calling:

Windows - ICMEventStop.bat
Linux, AIX, Solaris - ICMEventStop.sh

Clear the authentication parameters for the event monitor:

Windows - ICMLaunchUtil.bat -monitor -clearparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -monitor -clearparm

Show the process ID (PID) of the started process for the event monitor:

Windows - ICMLaunchUtil.bat -monitor -status
Linux, AIX, Solaris - ICMLaunchUtil.sh -monitor -status

Clear the process ID (PID) of the started process for the event monitor:

Windows - ICMLaunchUtil.bat -monitor -clearstatus
Linux, AIX, Solaris - ICMLaunchUtil.sh -monitor -clearstatus

Disable the saving of authentication parameters for the event monitor:

Windows - ICMLaunchUtil.bat -monitor -disableparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -monitor -disableparm

Enable the saving of authentication parameters for the event monitor:

Windows - ICMLaunchUtil.bat -monitor -enableparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -monitor -enableparm

BPM event handler

Save the authentication parameters of the BPM event handler for the background processing by calling existing scripts to save authentication parameters:

Windows - ICMHandler.bat
Linux, AIX, Solaris - ICMHandler.sh

Start the BPM event handler in the background by calling:

Windows - ICMHandlerLaunch.bat
Linux, AIX, Solaris - ICMHandlerLaunch.sh

Terminate the BPM event handler that is started in background by calling:

Windows - ICMHandlerStop.bat
Linux, AIX, Solaris - ICMHandlerStop.sh

Clear the authentication parameters for the BPM event handler:

Windows - ICMLaunchUtil.bat -bpm -clearparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -bpm -clearparm

Show the process ID (PID) of the started process for the BPM event handler:

Windows - ICMLaunchUtil.bat -bpm -status
Linux, AIX, Solaris - ICMLaunchUtil.sh -bpm -status

Clear the process ID (PID) of the started process for the BPM event handler:

Windows - ICMLaunchUtil.bat -bpm -clearstatus
Linux, AIX, Solaris - ICMLaunchUtil.sh -bpm -clearstatus

Disable the saving of authentication parameters for the BPM event handler:

Windows - ICMLaunchUtil.bat -bpm -disableparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -bpm -disableparm

Enable the saving of authentication parameters for the BPM event handler:

Windows - ICMLaunchUtil.bat -bpm -enableparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -bpm -enableparm

Case event handler:

Save the authentication parameters of the case event handler for the background processing by calling existing scripts to save authentication parameters:

Windows - CaseHandler.bat
Linux, AIX, Solaris - CaseHandler.sh

Start the case event handler in the background by calling:

Windows - CaseHandlerLaunch.bat
Linux, AIX, Solaris - CaseHandlerLaunch.sh

Terminate the case event handler that is started in background by calling:

Windows - CaseHandlerStop.bat
Linux, AIX, Solaris - CaseHandlerStop.sh

Clear the authentication parameters for the case event handler:

Windows - ICMLaunchUtil.bat -case -clearparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -case -clearparm

Show the process ID (PID) of the started process for the case event handler:

Windows - ICMLaunchUtil.bat -case -status
Linux, AIX, Solaris - ICMLaunchUtil.sh -case -status

Clear the process ID (PID) of the started process for the case event handler:

Windows - ICMLaunchUtil.bat -case -clearstatus
Linux, AIX, Solaris - ICMLaunchUtil.sh -case -clearstatus

Disable the saving of authentication parameters for the case event handler:

Windows - ICMLaunchUtil.bat -case -disableparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -case -disableparm

Enable the saving of authentication parameters for the case event handler:

Windows - ICMLaunchUtil.bat -case -enableparm
Linux, AIX, Solaris - ICMLaunchUtil.sh -case -enableparm

Usage:

You can select either the console mode (with password prompting) or the background mode (without prompting password) as needed.
Follow these steps to get started for background processing.
1. Run the program in the console mode (for example, ICMEvent) to ensure the validity of authentication data and to save authentication data into the persistent store.
2. Quit from the program in the console mode (for example, ICMEvent).
3. Start the program in the background mode (for example, ICMEventLaunch).
The background mode supports only one set of authentication data. If a different userid or password is needed, you must terminate the current program in background and run the console mode to change the authentication data. Then, quit the program from the console mode and relaunch the program in the background mode.
A user-specific Java™ Preferences setting is used as the persistent store for authentication data, which is associated with an operating system user. Only if you are the same operating system user, can you access your own persistent store.
Only one instance of event monitor is allowed, regardless of where it was started (ICMEventLaunch or ICMEvent). Internally, both ICMEventLaunch and ICMEvent start the same event monitor program. You can check the error messages in icmmonitor.log, which is the log file for event monitor regardless of where it was started (ICMEventLaunch or ICMEvent).
The -clearstatus option in ICMLaunchUtil is used to fix the inconsistency issue when the event monitor process, the BPM event handler process, or the case event handler process is manually deleted (for example, by using kill in Linux, AIX, Solaris) and the status becomes an orphan. You are advised to use this -clearstatus option with caution. Before using the option, make sure that there are no running instances of the program in the background. Also, note that the status cannot be cleared if there is a running instance of the program in the background in a Windows environment because of the platform-dependent implementation of Java Preferences. To stop a background process, use ICMEventStop for event monitor, ICMHandlerStop for BPM event handler and CaseHandlerStop for case event handler.
The -disableparm option in ICMLaunchUtil is used to disable the saving of authentication data. However, for the authentication data, which is saved, it is still effective for starting a background process. To clear the authentication data from the persistent store, use the -clearparm option in ICMLaunchUtil.