Runtime troubleshooting

After you install and activate the IBM Task Mining application, you can troubleshoot the missing data in the IBM Process Mining processes associated with the IBM Task Mining projects.

Audit page

Every IBM Task Mining process has a specific Audit page where you can verify the correctness of the elaboration of chunks that the application collects by using the Task Mining Agent (TM Agent) client.

This page is the first place to verify the correctness of the complete IBM Task Mining pipeline.

Audit page

To identify a chunk of interest in the list, use the information in the following columns:

  • Capture ID
    The registration identification number.

  • Upload time
    Time taken for the TM Agent to send chunks to the server.

  • Host ID
    Identification string of the sender.

    To retrieve the Host ID on the client side, complete the following steps:

    1. Right-click the TM Agent tray icon on the taskbar and click About.
    2. Click the Click to copy icon next to Host Id to copy the Host Id to clipboard.
      TM Agent Host Id

The processing pipeline of chunks has the following three steps:

  1. Processor
    In this step, the system applies the project configuration that is defined in the IBM Task Mining application to the recorded data by extracting the relevant data and task events (start and end).
  2. Miner
    In this step, the system correlates the data that is extracted during the Processor step to generate the event log that is sent for process mining.
  3. Process Mining Upload
    In this step, the system calls the IBM Process Mining API to upload the generated event logs.

The steps to run depend on the type of the chunk:

  • For the “partial” chunks, run the Processor step.

  • For the “end” and “full” chunks, run all three steps. For the “end” type chunks, Miner and Process Mining Upload steps involve all the chunks in the same session. In other words, the last two steps do not start until you complete the Processor step for all the chunks of the session.

Status of Task Mining steps

The upload of the Processor, Miner, and Process Mining Upload data assumes different states when you collect a chunk. The following image shows all the possible states:

![Pipelinestatus](images/pipelinestatus.png)

Elaboration correctly completed

If there is a warning status during the Miner step, expand the corresponding Capture Id to verify the error messages and other related information of a chunk.

Remember:

  • When you perform the steps, ensure that:

    • Processor is always required for every type of chunk.
    • Miner is required for the “full” and “end” types of chunk.
    • Process Mining Upload is performed only if the Miner completes the elaboration accurately or with a warning. If there was an error or nothing found message in the previous step, the system does not run the Process Mining Upload step.

  • If the Processor step for a “partial” chunk displays an error, the system runs the Miner and Process Mining Upload steps. The system ignores the chunks in error during these steps and includes only the chunks that were processed without errors.

Chunk content

If you do not find the problem after checking the pipeline information, the next step is to retrieve the chunks data and verify the output for each step of processing. The cause of the problem might be a missing match inside the pipeline steps.

Every data that is collected in a chunk can be downloaded from the Audit page through an encrypted compressed file. You can use this file to verify the output of each step of the Task Miner.

ⓘ Note: To use this troubleshooting method, you must first contact IBM Support. The downloaded file is encrypted for security. You need to use the decryption key that the IBM Support provides you to download and decrypt the file. For more information, see the Downloading a capture topic.

Download log

Package creation for external support

If you cannot find the cause of the issue and you require external support, integrate the support request with a ZIP package containing the following information:

  • Content of chunks involved in the issue.
  • Task Mining logs
    • <TM_HOME>/logs/ folder.
    • <TM_HOME>/tomcat/logs/ folder.
  • IBM Process Mining logs (different server and environment to IBM Task Mining)
    • <PM_HOME>/repository/logs folder.

Connection to Task Mining Agent failed

  • Effect

You might notice TM Agent connection failures if the endpoint URL is incorrect, the endpoint is inaccessible, or the internet is down.

Failed Connection TM

Check the latest TM Agent logs for more details, which you can find in the directory: C:\Users\<user_name>\AppData\Roaming\IBM Task Mining Agent\logs

  • Troubleshooting
1. Check if your endpoint is correct
  • When a connection fails, you might see the following information in the logs:
    2023-03-14 02:19:11,975 INFO  AppWindow - '': Initializing WebView
2023-03-14 02:19:14,530 INFO  AppWindow - '': WebView initialized successfully
2023-03-14 02:19:15,651 INFO  AppWindow - 'https://example_endpoint.com': Initializing WebView
2023-03-14 02:19:16,369 INFO  AppWindow - 'https://example_endpoint.com': WebView initialized successfully
2023-03-14 02:19:17,195 WARN  AppWindow - Error on navigating to 'https://example_endpoint.com/'. Status: 'HostNameNotResolved'
2023-03-14 02:19:17,872 WARN  AppWindow - Error on navigating to 'https://example_endpoint.com/'. Status: 'ConnectionAborted'
2023-03-14 02:19:22,927 WARN  AppWindow - Error on navigating to 'https://example_endpoint.com/'. Status: 'ConnectionAborted'
2023-03-14 02:19:53,026 WARN  AppWindow - Error on navigating to 'https://example_endpoint.com/'. Status: 'ConnectionAborted'
2023-03-14 02:20:53,076 WARN  AppWindow - Error on navigating to 'https://example_endpoint.com/'. Status: 'ConnectionAborted'
  • Check if the endpoint in the appsettings.json file is correct. You can also try connecting to it using a browser.
  • You can find the appsettings.json file in the folder in which TM Agent is installed (for example, C:\Program Files\IBM Task Mining Agent\appsettings.json).
  • You can manually correct the endpoint details and save it.
2. Check if your endpoint is reachable
  • If the endpoint access URL is unable to resolve or if you have internet issues, you can try connecting again after some time.

User not authorized to use the Task Mining Agent

  • Effect

You might notice the following error after you log in to the Task Mining Agent:

User not Authorised

  • Troubleshooting

The error indicates that you do not have the necessary authorization to access TM Agent. Contact the system administrator who can provide you the authorization to use the TM Agent from the User Management form in IBM Process Mining.