Task Mining Agent plugins

This section is intended for developers working on the user-end. This feature is currently offered as a Technology Preview and may be subjected to changes.

Plugins in Task Mining Agent are custom codes that enables you to customize the recording process by intercepting and modifying TM Agent events or creating new events. You can create custom plugins, attach them to processes, and run during project recordings.

Creating and deploying plugins for TM Agent involves the following steps:

  1. Meeting the prerequisite
  2. Enabling plugins in Task Mining
  3. Creating plugins
  4. Testing and deploying plugins

Meeting the prerequisites

To create and deploy TM Agent plugins, you must meet the following conditions:

  • C# (C-Sharp) environment installed on your machine.
    This is mandatory because TM Agent Plugins are made in C#, using .NET 7. If you do not have the environment set up, download and install the following packages:
  • Task Mining Agent installed on your machine. For more information, see Installing TM Agent.

Enabling plugins in Task Mining

Plugins are an optional feature in IBM Task Mining. You can enable or disable plugins by modifying the configuration parameters file.

Enabling plugins on Linux

To enable the IBM Task Mining plugins on Linux, do the following steps:

  1. Open the configuration parameters file (<TM_HOME>/conf/application.properties).

  2. Enter the following command:

    agent.plugins.enabled=true

    To disable plugins, set the value of agent.plugins.enabled attribute to false.

  3. Save and close the file.

  4. Restart the web container using the following command:

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

Enabling plugins on Red Hat® OpenShift® Container Platform (OCP)

A Fyre OCP cluster with IBM Process Mining installed is required to enable plugins on Red Hat® OpenShift® Container Platform (OCP).

To enable the IBM Task Mining plugins on RedHat Openshift, do the following steps:

  1. Log in to the regression test machine. Use the credentials available on the following website Fyre OCP Regression Test Environment.

  2. Open the CRD yaml file:

    1. Go to Administrator View > Administration > CustomResourceDefinitions.
    2. Find ProcessMining and click it.
    3. Open the Instances tab and click processmining-instance.
    4. Open the YAML tab.

  3. Optional: Make a copy of the original CRD file in case you need to restore it.

  4. Add the following code to the spec section of the CRD:

    taskmining:
    agent_plugin: true
    install: true

  5. Restart the Task Miner.

  6. Go to Administrator > Workloads > Pods.

  7. Find processmining-instance-taskminer-nginx.

  8. Click the menu button corresponding to the row with processmining-instance-taskminer-nginx-XXXXX and click Delete Pod.

XXXXX is a string of random letters and numbers that are assigned by the Red Hat® OpenShift® Container Platform (OCP) when the pod is installed.

Enabling plugins in individual projects

After you enable plugins in IBM Task Mining, you must also enable plugins for individual projects. Plugins are applied only to the projects that have the plugins feature enabled.

To enable plugins for individual projects during project creation, set Agent plugins enabled to Yes in the Create task mining project window.

Enable Projects

To enable plugins for existing projects, complete the following steps:

  1. Open the task mining project and then click the Project configuration tab.

  2. Click Edit Edit button.

  3. Set Agent plugins enabled to On.

    Edit Projects

After enabling the plugins in IBM Task Mining, you can start to create and configure the plugins.