Recording user interactions with Task Mining Agent

After you create a Task Mining project, you can go on to use Task Mining Agent (TM Agent) to automatically record actions and collect user interaction data such as keystrokes, mouse clicks, and data entries on your system's selected applications. You need these recordings to perform the process analysis: TM agent sends the recorded data to Task Mining Backend (TM Backend) where a business analyst can analyze the task mining process on the Task Mining Web user interface. The recordings help you monitor the desktop activities and provide a complete analysis of each step that is captured. This helps you to understand the user experience of a workflow.

Before you begin

  • Before you use TM Agent, the Administrator must create your user profile and select the Agent enabled checkbox. For more information, see Creating users. If you already have an account, but do not have the permission to access TM Agent, the administrator can enable TM Agent for you by completing the following steps:
    1. Go to Administration menu in the IBM Process Mining application..
    2. Next to the user for whom you want to enable Task Mining Agent, click the Edit icon.
    3. In the Profile tab, select the Agent enabled checkbox.
    4. Click Save changes.
  • You must install the TM Agent as your desktop application that runs locally on your system. To do that, see Installing the Task Mining Agent for the installation steps. The installer itself includes all the prerequisites needed to install the agent.

Using the TM Agent project overview page

After you log into TM Agent, all the projects you created in IBM Task Mining are displayed in the TM Agent user interface. For more information, see Creating a task mining project. If you do not have any recordings and projects yet, see Recording user interactions with Task Mining Agent.

Do the following steps to view the project overview page:

  1. Select the project you want to open from the list of projects.
  2. Search, select, and expand the required project.
  3. Click Open project to see the project overview.

The project overview provides the following information:

Help and information
An in-app application introduction tour.
View allow list
Add or remove applications or web pages to the allow list.
Start a new recording
Record your task workflow.
Recording summary
The number of recordings captured in each project along with the status of the recording.

Recording your interactions

The TM Agent records, analyzes, and generates insights about your interactions with the applications and web pages before entering the information into IBM Process Mining.

Before you start recording the user interactions using the TM agent, ensure you have an allow list with added applications or web pages. Only applications or web pages on the allow list are included in the recording. The analyst responsible for the project must configure the allow list. The most up‑to‑date version of the process allow list will be automatically retrieved by the agents before starting the recording. See the Task mining agent compatibility matrix to get more details on the supported applications.

Do the following steps to create an allow list:

  1. From the projects list, click expand icon next to the required project.
  2. Click Create allow list to display the Settings page of the selected project.
  3. Add the list of allowed applications:
    1. Under Settings, select Allowed applications.
    2. Search the application and click Add to list +.
    3. Click Apply preferences to recorder.
  4. Add the list of allowed web pages:
    1. Under Settings, select Allowed web pages.
    2. Search the web page and click Add to list +.
    3. Click Apply preferences to recorder.
    Note: To capture any web pages, you must add a browser in the Allowed applications list. Then, you need to install the browser extension for IBM Task Mining in that browser.
  5. Add the list of blocked pages:
    1. Select Allowed applications or Allowed web pages.
    2. Expand the required application or web page.
    3. Find the page and click Block.
    4. Click Apply preferences to recorder.

In the allowed applications or web pages list, you can also block or delete specific pages that should not be captured during recording.

Note: You can only edit an allow list if the Monitoring list has the write permission in the Authorization tab. The administrator can grant the permissions from the User Management page. If you do not have the write permission for your recording, you can view the allow list in the read-only mode.

You can now start a new recording to capture actions and collect user interaction data. The recorded .JSON data and encrypted screenshots are temporarily saved on your file system while it is being sent to the back-end server.

Do the following steps to record your interactions and data entries with the allowed applications and web pages:

  1. Open the project to be recorded.
  2. Click Start a new recording.
  3. Click Stop to stop the recording.

    The user interactions on the allowed applications and webpages are automatically captured until the recording is stopped or paused.

    If the recording is stopped in between (for example: system restart), you can click Continue recording to resume.

Configuration files

The file appsettings.json under the TM Agent installed directory (for example, C:\Program Files\ Agent\appsettings.json) holds the TM Agent configuration settings.

Warning: The configuration options in the appsettings.json file are self-explanatory. Do not change the values of openrpaChromeExtensionId, myinvenioChromeExtensionId, and ibmChromeExtensionId in the appsettings.json file.

Configuring proxy authentication

You can configure an authentication method used by the proxy.

The proxy can be enforced to TM Agent by adding proxy key in appsettings.json, as in the following example:

{
  "agentOptions": {
    "endpoint": "https://brunelleschi.automationcloud.ibm.com/",
    "allowUntrustedCertificate": false,
    "openrpaChromeExtensionId": "hpnihnhlcnfejboocnckgchjdofeaphe",
    "myinvenioChromeExtensionId": "gmpnnjghibofefmnppkgkadiijlblhia",
    "ibmChromeExtensionId": "ikgbbcgkljolbooedlbifopnmecdbphk"
    "proxy": "proxy.example.com"
  }
}

If the proxy requires an authentication, you must specify the credentials for your proxy server.

Note: Starting from IBM Process Mining 1.14.0, TM Agent supports New Technology LAN Manager (NTLM) proxy by default and does not require further configuration. Also, you don't need to manually authenticate the proxy in TM Agent because NTLM proxy uses Windows authentication for access.

Next step

Configuring a task mining project in Task Mining Web