Basic setup

MonetDB

MonetDB is bundled as part of a IBM Process Mining deployment, for the main platforms supported by Process Mining. If your deployment falls outside of this standard, you can still use Process Mining with a MonetDB deployment of your own. For more information on installation, see Installing MonetDB.

PostgreSQL

You need a working PostgreSQL instance before you proceed with the database installation. For more information about installing PostgreSQL, see Installing PostgreSQL.

To configure and initialize the PostgreSQL for the application, do the following configurations:

• Basic PostgreSQL configuration
• PostgreSQL configuration for process app

Basic PostgreSQL configuration

You must first create a user and database within PostgreSQL for IBM Process Mining use with the following script:

export POSTGRES_PROCESSMINER_PWD="XXXXXX"
export POSTGRES_PROCESSMINER_USER="processmining"
export POSTGRES_PROCESSMINER_DATABASE="processmining"

pushd /tmp
sudo -E -u postgres createuser ${POSTGRES_PROCESSMINER_USER}
sudo -E -u postgres createdb ${POSTGRES_PROCESSMINER_DATABASE}
sudo -E -u postgres psql -c "alter user ${POSTGRES_PROCESSMINER_USER} with encrypted password '${POSTGRES_PROCESSMINER_PWD}';"
sudo -E -u postgres psql -c "grant all privileges on database ${POSTGRES_PROCESSMINER_DATABASE} to ${POSTGRES_PROCESSMINER_USER};"
sudo -E -u postgres psql -c "GRANT ALL ON ALL TABLES IN SCHEMA public TO ${POSTGRES_PROCESSMINER_USER}";
sudo -E -u postgres psql -c "ALTER DATABASE ${POSTGRES_PROCESSMINER_DATABASE} OWNER TO ${POSTGRES_PROCESSMINER_USER}";
popd

To configure PostgreSQL, you need to edit jdbc settings in the persistence section in <PM_HOME>/etc/processmining.conf:

persistence: {
  jdbc: {
    database: "<database name>",
    host: "<database host>",
    port: <database port>,
    user: "<database user>",
    password: "<encrypted database password>" 
  }
...

To ensure security, you must enter the encrypted <database password> in the processmining.conf file. For more information on how to encrypt the password, see Password encryption.

PostgreSQL configuration for process app

To configure PostgreSQL for process app, edit the following attributes in the <PM_HOME>/etc/accelerator-core.properties file per your existing PostgreSQL configurations:

spring.datasource.database=<database name>
spring.datasource.port=<database port>
spring.datasource.host=<database host>
spring.datasource.username=<database user>
spring.datasource.password=<encrypted database password>

To ensure security, you must enter the encrypted <database password> in the accelerator-core.properties file. For more information on how to encrypt the password, see Password encryption.

Installing Python on other version

Versions 3.11 and non standard Python deployments are also supported with additional configuration.

To use Python 3.11 or Python 3.12 from an alternative location, use the following custom settings:

1. Ensure this settings matches Python location in the <PM_HOME>/bin/environment.conf file:

   a. Standard location:

    CMD_PYTHON=/usr/bin/python3.11

    CMD_PYTHON=/home/my-user/.local/usr/bin/python3.12

2. For Ubuntu, if you are using Python 3.11 or a non standard Python deployment, perform this check override:

    ACF_CUSTOM_UBUNTU_CHECK=1

3. Check if the original deployment matches with the details that are listed in <PM_HOME>/bin/environment.conf:

    which python3.12
    /usr/bin/python3.12

Optimizing memory for process app

To optimize the memory for process app, you can change the value of mem_limit_bytes in the custom.ini file in the following filepath:

PM_HOME/etc/accelerators/custom.ini

However, the recommended minimum value for mem_limit_bytes is 16000 * 1024 * 1024 (16 GB).

Installing NGINX

To install NGINX, use one of the following options depending on the operating system of the web server:

• If you want to install NGINX in Ubuntu operating system, use the following command:

    sudo apt-get install nginx

• If you want to install NGINX in Red Hat operating system, use the following command:

  sudo yum install nginx

Depending on your Red Hat distribution, the latest nginx version may not be available.

Run the following commands to verify and make changes:

    # check version available
    sudo yum info nginx

    # list available versions
    sudo yum module list nginx

    # reset module to allow change
    sudo yum module reset -y nginx

    # enable your latest version
    yum module enable -y nginx:<LATEST>

    # install will now install using this <LATEST> version
    sudo yum install nginx

To activate NGINX, run the following command:

  sudo systemctl enable nginx
  sudo systemctl start nginx

Configure the NGINX virtual host

To configure the NGINX virtual host, you must copy the Template Virtual Host file, which is available in the IBM Process Mining package, into the NGINX configuration. Use one of the following options to copy the Template Virtual Host file depending on the operating system of the web server:

• If you use the Ubuntu operating system, use the following command:

  cp <PM_HOME>/nginx/processmining.conf /etc/nginx/sites-available/
  

• If you use the Red Hat operating system, use the following command:

  mv /etc/nginx/conf.d/default.conf /etc/nginx/confd/default_origin.conf
  cp <PM_HOME>/nginx/processmining.conf /etc/nginx/conf.d/default.conf
  

Configure NGINX SSL

To configure NGINX SSL, do the following steps:

1. Create the ssl directory by using the following command:

     mkdir /etc/nginx/ssl
   

2. Copy the SSL certificate to the ssl directory. Use one of the following options depending on the type of certificate that you created:

   • If you created a self-signed certificate per the steps mentioned in the Self-signed certificates topic, use the following command:

     cp /home/pm/cert/server.* /etc/nginx/ssl/
   

   • If you want to create and download a certificate from a certificate authority (CA), follow the documentation of the CA that you choose. After downloading the certificate, copy the certificate in the /etc/nginx/ssl/ repository.

3. Update the Virtual Host file with the file paths of both the certificate and key that you created.

     ssl_certificate /etc/nginx/ssl/mycompany_com.pem;
     ssl_certificate_key /etc/nginx/ssl/mycompany_com.key;
   

   For example, if you created a self-signed certificate, use the following filepath:

     ssl_certificate /etc/nginx/ssl/server.pem;
     ssl_certificate_key /etc/nginx/ssl/server.key;
   

4. Depending on the operating systems, do one of the following options:

   • If the operating system of the web server is Ubuntu, use the following command to add the virtual host to the enabled sites:

       ln -s /etc/nginx/sites-available/processmining.conf /etc/nginx/sites-enabled/
     

   • If the operating system of the web server is Red Hat with the SELinux enabled, use the following command:

       chcon -t httpd_config_t /etc/nginx/ssl/*.*
       setsebool -P httpd_can_network_connect 1
     

If the SELinux security is enabled, refer to the Application service startup might fail on SELinux topic for more details.

Test and restart NGINX

To test the changes to your NGINX configuration, use the following command:

  nginx -T

If the test result is good, restart NGINX service by using the following command:

  systemctl restart nginx

Disable data-derived end-activities

In the <PM_HOME>/etc/processmining.conf file, add the following properties to the engine.defaults section to disable the data-derived end-activities:

endActivity:{
enable: false
},

Example:

engine: {

defaults: {
...
endActivity:{
enable: false
},
....
}
}