Testing and deploying plug-ins

When your plug-in is ready, you can test it against your IBM Task Mining Agent installation.

Before you begin

You must compile the plug-in first and then copy the generated DLL file into the /plugins/ folder in your IBM Task Mining Agent installation directory. For example, C:\Program Files\IBM Task Mining Agent\plug-ins.

Testing and debugging plug-ins

To test and debug your plug-ins, do the following steps:

  1. Open a project that has plug-ins enabled with the IBM Task Mining Agent.

  2. Click Plug-ins enabled for this project to see if your plug-in with a .dll extension is loaded and enabled.

    If your DLL is not loaded, check whether the following conditions are met:

    • Plug-ins are enabled both in environment and project.
    • The dll is saved in the correct directory (plugins folder in the TM Agent installation directory).
    • The log (%appdata%\IBM Task Mining Agent\logs) does not show any errors.

  3. When the dll is loaded and enabled, you can start the recording. During recording, you can attach your code to IBM Task Mining Agent process by using the Attach to process feature in Visual Studio Code. The process is named TaskMining.Agent.UI.exe.

You can also debug your plug-in during recording by placing breakpoints or changing your code live.

Deploying plug-ins

After testing and debugging, your plug-in is ready to be deployed.

To deploy plug-ins, copy the plug-in dll file into the /plugins/ folder in the IBM Task Mining Agent installation directory.

When opening projects that have plug-ins enabled and deployed, users get the Plug-ins enabled for this project message in IBM Task Mining Agent.

Note: By default, all deployed plug-ins are enabled and available for users. Only the IBM Task Mining administrators and monitoring list editors can disable plug-ins by using the toggle button in Project configuration.
Important: TM Agent has a performance warning check. If your plug-in compromises recordings by using excessive resources, the IBM Task Mining Agent issues a warning to the users.