Upgrading IBM Task Mining

You must download the installation package from IBM® Passport Advantage®. To know more about downloading packages, see Downloading Packages. The IBM Task Mining installation package is taskminer_update_X.Y.Z_<build number>.tar.gz, where X.Y.Z indicates the version of IBM Task Mining, and <build number> indicates the build or part number.

For troubleshooting the IBM Task Mining upgrade process, see Troubleshooting application configuration.

To upgrade from IBM Task Mining version 2.0.1 to version 2.2.0, do the following steps:

1. Stop the Task Mining application services.

2. Copy the compressed file to the destination server and extract it to a directory. For example, /home/<mydir>/taskmining-update.

3. Go to the taskmining-update directory.

4. Set the environment variable TM_HOME according to your installation, such as export TM_HOME=/opt/taskminer

5. Run the shell script update.sh. The shell script creates a backup of your existing version in <TM_HOME>/backup_<current date> and upgrades your IBM Task Mining deployment to 2.2.0.

   Important: This step is only applicable for upgrading from IBM Task Mining 2.0.1 to version 2.2.0. For upgrading from versions 1.14.0 or earlier to the later versions, follow the documentation of the respective versions.

By default, update.sh does not overwrite the customized files. Run update.sh from a folder or parent that does not contain spaces in its name. update.sh can update a customised bin/environment.conf. In IBM Task Mining, you can use the force option for the update.sh shell script to overwrite the customized files. Use the following shell script to run the update.sh:

    ./update.sh --help
     *** USAGE:  update.sh [--help | -h] [--force]
       --help  : display this usage information
       -h      : same as --help
       --force : will overwrite any files that have changed
                   original copies will still be available in backup folder

When you run the default ./update.sh command, the changed files are labelled as follows:

: file has been modified, will not overwrite.

Such files are summarized at the end of the script run. The original files remain without any change and the new file is saved in the same folder with the .2.2.0 file extension. This information is also stored for future reference in $TM_HOME/modified.txt.

The following script is an example for the default update:

      ./update.sh 2>&1 | tee update-log.txt
      ...
      *************************************************
      *************************************************
      current files backing up to [/opt/taskminer/backup_2025-03-14_1824]
      ******
        >license
        >logs:
        >tomcat/logs:
      ...
      *************************************************
      bringing over new files/folders to [/opt/taskminer]
      ******
        >agent:
          TaskMining.Agent.Setup.Bootstrapper_2.0.1_b38dec1d.exe
        >bin:
          tm-backup.sh
      ---
      upgrade complete.
      .
      Some files have been modified and unable to automatically update.
        Check these files manually.
        Your file HAS NOT been modified, compare it with the new copy '*.2.0.1'
      --
          conf/application.properties
          conf/application.properties.2.0.1
        --

When you override the file changes using the ./update.sh --force command, the changed files are labelled as follows:

: file has been modified, forcing overwrite

Such files are also summarized at the end of the script run. The files are overwritten by the new 2.2.0 files. The original files are stored in the backup folder. This information is also stored for future reference in $TM_HOME/modified.txt. The following script provides an example for the force update:

  ./update.sh --force
  ---
  upgrade complete.
  .
  Some files have been modified and have been overwritten.
  Check these files manually.
  compare it with the backup 'backup_2025-03-14_1824'
  --
      conf/application.properties
      backup_2025-03-14_1824/conf/application.properties
  --
  -

If you do not set the environment variable when you upgrade to IBM Task Mining 2.2.0, the update.sh returns the following error message:

  ./update.sh
  Error: TM_HOME environment variable is not set. Set it to the taskmining home. 

To allocate the run rights to shell scripts, do the following steps:

1. Run the following script:

       chmod +x ${TM_HOME}/tomcat/bin/*.sh
       chmod +x ${TM_HOME}/bin/*.sh
   

2. Change the owner of <TM_HOME> to the RUNAS with the following script:

       chown -R taskminer:taskminer ${TM_HOME}/
   

3. Start the service.