Basic setup

Distribution package

The installation package for IBM Task Mining is available in the file, taskminer_setup_X.Y.Z.tar.gz.

Ensure that the version of Task Mining version you install is the same as the version of IBM Process Mining you have installed on your machine.

By using the login credentials, you can download the installation package from the IBM website. You must replace the denotations, X, Y, Z with the release numbers to get the accurate URL.

Installing NGINX

NGINX is a recommended tool for production environments.

You need to install NGINX only if IBM Task Mining is installed on a different server than IBM Process Mining.

Use the following script to install NGINX:

apt-get install -y nginx

Application installation

Run the following steps to install the application:

1. Unpack the application archive to create the <TM_HOME> directory. Ensure that the <TM_HOME> directory is created in the /opt folder.

   cd /opt
   sudo tar xvf taskminer_setup_X.Y.Z.tar.gz
   

   As shown in the following figure, the created <TM_HOME> directory includes the various folders:

   

   • Bin
     Executable files for start and stop applications
   • Conf
     Configuration file
   • Data
     Folder to store and process the files that are pushed by Task Mining Agent. It is suggested to configure this folder in a separated volume.
     
   • Database
     Script for database creation
   • Logs
     Logs files that are produced by scheduled job
   • Tomcat/log
     Log produced by web application
     

2. Create the RUNAS user.

   sudo adduser taskminer
   

3. Change the owner of <TM_HOME> to the RUNAS user.

   sudo chown -R taskminer:taskminer <TM_HOME>/
   

4. Optional: Allocate the run rights to shell scripts.

   chmod +x /opt/taskminer/tomcat/bin/*.sh
   chmod +x /opt/taskminer/bin/*.sh
   

By default, <TM_HOME> refers to: /opt/taskminer. If the actual location is different, you must update the correct location in the configuration file.

Database installation

Default database is IBM Db2 database (v11.5 or later). Optionally you can select the database as PostgreSQL 15.

Database instance must be up and running before proceeding. The minimum storage requirement for IBM Db2 database is 20 GB. You use the standard setup procedure based on your operating system.

You also need to create the database that you need to use for the IBM Task Mining.

The application automatically runs the DDL statements. Hence, you need not manually run the SQL query.

Basic configuration

Use the following steps to complete the basic configuration of IBM Task Mining:

1. Edit the file <TM_HOME>/bin/environment.conf and replace the placeholders with actual values, according to your operating environment:

   Parameter	Description	Example
   <DATABASE_TYPE>	The database type, which is either db2 or pgsql	db2
   <DATABASE_HOSTNAME>	Database host	172.16.1.10
   <DATABASE_PORT>	Database port, 5432 for pgsql or 50000 for db2	50000
   <DATABASE_NAME>	Database name	pmdb
   <DATABASE_USER>	Username	taskminer
   <DATABASE_PWD>	Password	Tmppwd_1
   <DATABASE_SCHEMA>	In most cases, this value is the same as the username. - For Db2, provide the value in uppercase. For PostgreSQL, provide the value in lower case.	- For Db2: TASKMINER - For PostgreSQL: taskminer
   <PROCESSMINING_HOST>	URL of the IBM Process Mining host. Leave this value empty if IBM Process Mining and IBM Task Mining are installed on the same server.	- If IBM Process Mining and IBM Task Mining are installed on different servers: processmining_host=https://processminer.my-company.com - If IBM Process Mining and IBM Task Mining are installed on same server: processmining_host=
   <PROCESSMINING_JWT>	Secret passphrase AES 256	2A704F2073D88D9858A0007F18E73AA19E88033FB58DD61BCC99B4BA22858F8E
   <PROCESSMINING_JWE>	Secret passphrase AES 256	EFD8B222ADEF765282DDD7FB0E6B5C4648F28B549F04091577EED9B84AD5C9E0

2. Use the site, https://asecuritysite.com/encryption/keygen to generate a secret passphrase.

3. Select the encryption algorithm as illustrated in the following figure to generate and encrypt two passphrases, one for JWT and another for JWE.

   

4. Copy the JWT and JWE tokens in the IBM Process Mining configuration file to enable the communication channel with the target instance of IBM Process Mining.

   <PROCESS_MINING_HOME>/etc/processmining.conf
   

5. Update the following information (illustrated in the figure) in the authentication section.

   

By default, the files that are produced by the TM Agent are stored in the folder, /opt/taskminer/data.
You can change the property application_path to store the files into a dedicated volume.

Advanced configuration

You can locate the configuration parameters in the file, <TM_HOME>/conf/application.properties.

The following table describes the parameters in the application.properties file.

Web application startup

Start the web container with the following command:

<TM_HOME>/bin/tm-web.sh start

On running this command, the web application acts as the TM Data Collector. It is important to start this component before TM Data Processor and TM Task Miner.

Application Uninstallation

Use the following steps to uninstall the application:

1. Stop all the services.

   <TM_HOME>/bin/tm-web.sh stop
   

2. Delete or rename <TM_HOME> folder.

Trusting the server channel

Use the following steps to complete the process:

1. Import the CA certificate in the keystore as a trusted certificate to ensure a correct communication from IBM Task Mining to IBM Process Mining.

   cd <TM_HOME>/ibm-openjdk-semeru/bin
   ./keytool -import -keystore 
   ../lib/security/cacerts -trustcacerts -alias "My Custom Server CA" -file /home/pm/cert/rootCA.pem
           
   (password is: changeit)
   

The certificate (rootCA) to use for this step is the same one used for IBM Process Mining.
The rootCA certificate installation is required only if a self-signed certificate is configured.

2. Restart Tomcat.