Task Mining Agent plug-ins

Note: This feature is available as a technology preview.

This section is intended for developers working on the user-end.

Plug-ins 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 plug-ins, attach them to processes, and run during project recordings.

Before you begin

To create and deploy TM Agent plug-ins, you must meet the following prerequisites:

  • C# (C-Sharp) environment installed on your machine. This is mandatory because TM Agent Plug-ins are made in C#, using .NET 8. 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 plug-ins in Task Mining

Plug-ins are an optional feature in IBM Task Mining. You can enable or disable plug-ins by modifying the configuration parameters file.

Enabling plug-ins on Linux

To enable the IBM Task Mining plug-ins 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 plug-ins, set the value of agent.plug-ins.enabled attribute to false.

  3. Save and close the file.

  4. Restart the web container by using the following command:

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

Enabling plug-ins on Red Hat® OpenShift® Container Platform (OCP)

Note: A Fyre OCP cluster with IBM Process Mining installed is required to enable plug-ins on Red Hat® OpenShift® Container Platform (OCP).

To enable the IBM Task Mining plug-ins on RedHat Openshift, do the following steps:

  1. 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.

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

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

    taskmining:
    agent_plugin: true
    install: true

  4. Restart the Task Miner.

  5. Go to Administrator > Workloads > Pods.

  6. Find processmining-instance-taskminer-nginx.

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

Note: 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 plug-ins in individual projects

After you enable plug-ins in IBM Task Mining, you must also enable plug-ins for individual projects. Plug-ins are applied only to the projects that have the plug-ins feature enabled.

To enable plug-ins for individual projects during project creation, turn on Agent plug-ins enabled in the Create task mining project window.

To enable plug-ins for existing projects, do the following steps:

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

  2. Click Edit and turn on Agent plug-ins enabled.

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