- Release notes
- Task Mining overview
- Setup and configuration
- Notifications
- Task Mining
- Additional resources
Project setup
Before starting the recording process, access the Settings module to configure the project's output, recorded apps, goals, and data collection policies. Check out the following pages for details about each option:
An Administrator or Project Administrator can Start, Stop or Pause a recording user, using the button available in the Details column. To Start recording for multiple uses, select using the checkmark the users needed to start recording and select Start near the Delete button in the upper right side of the screen.
Output configuration lets you choose if you want PII data masking to work as per details below.
PII Data Masking option
Personally identifiable information (PII) is information that, when used alone or with other relevant data, can identify an individual. This can be switched on or off based on your preference using the Edit button.
To find out more about personally identifiable information check PII data masking page.
View and manage the list of applications where tasks made by the users are captured. The Recorder Client logs only data for these applications.
The Recorded Apps feature enables you to make sure the recorder is only collecting important data from specific applications selected in the tool. By selecting only specific application the amount of nosiness in data is reduced and the recorded focuses on gathering only the data it needs.
This way you can make sure that only data permitted is captured, and information from websites, or application from the deny list is ignored.
In order to tell if the application is recording data from an application, a green light shown by the client is visible .
Under the Recorded Apps section, create the Recorded Applications list by adding applications or websites. This is a mandatory step to be able to record successfully. The recording application will only log data for these applications and websites.
Below is an overview of the available lists:
-
Globally for all users - the list of applications that are implemented and recorded for all the users. Once you set the list of the Recorded Apps, users cannot change it.
- Allow recording - the list of applications and websites that will be included in the recording.
- Deny recording - the list of applications and websites that the Recorder will ignore when recording.
Allow an application or website to be recorded
To add an application or website to the Allow recording list, use the Search option to be sure the app is not already added and follow the applicable scenario as listed below.
Perform the search as in the illustration below:
You can also select applications and/or websites from the Deny recording list and move them to the Allow recording list.
Follow these steps to add an application or website that is not available in the Allow recording list tab.
-
Select Allow.
- The Allow Application or Website pop-up is displayed.
-
Enter the name of the application or the domain of the website for which you want to allow recording and select Add. See the illustration below for an example.
.exe format. For websites, make sure that you enter the correct domain name and the extension, for example, uipath.com. To find the correct executable name of an application, see How to Find the Executable File for a Program.
If a browser was set on the allow list, all websites/url are collected. To avoid collecting data from personal websites, use the deny list to prevent specific websites from being collected.
You can also just add the websites from where you want to record data in the allow list. This ensures that you collect data only from the allowed websites.
By adding a website to the Allow recording list, you are giving permission for that specific site to be recorded regardless of what browser is used to access it. Even if the browser itself is not explicitly added in the Allow recording list, the permitted website will still be recorded.
Deny recording an application or website
To add an application or website to the Deny recording list use the Search option to be sure the app is not already added and follow the applicable scenario as listed below.
You can also select applications and/or websites from the Allow recording list and move them to the Deny recording list.
Follow these steps to add an application or website that is not available in the Deny recording list tab.
-
Select Deny.
- The Deny Application or Website pop-up is displayed.
- Enter the name of the application or the domain of the website for which you want to deny recording and select Add.
.exe format. For websites, make sure that you enter the correct domain name and the extension, for example, uipath.com.
To find the correct executable name of an application, see How to Find the Executable File for a Program.
Delete an application or website
Follow the steps below to Delete an application from the recording list.
- Locate the application or website in the list and select the option button.
- Click on Remove.
-
The application or website is removed from the list.
Important: If the recorded apps list is empty, you will be prompted with a notification dialog that allows you to add apps or skip and proceed, but by skipping, you will not record any steps.
The Data collection policies allows the Company Admin(s) to easily inform the users about the recording process and gather their consent to record the data for a Task Mining project.
Below is a description of the available options.
| Option | Description |
| Show consent dialog for users | Displays a consent dialog for a user when you start a user recording process.
Users will be presented with a dialogue to accept or decline the recording terms and conditions before the desktop application begins capturing the data. By default, the timeframe for the recurring consent collection in the Show at the Start of every <> days(s) field is set to 7 days. Users will be prompted with the consent dialogue after the specified amount of days passed since the user accepted the consent the first time. View users consent logs enables you to browse the consent collection history. Note:
The Show consent dialog for users option is enabled by default. You cannot disable it. |
|
Anonymize user names on the Results page |
Enables you to anonymize user names that are displayed on the Results page to protect the privacy of individuals represented by the data. |
Viewing the Users consent logs
You can browse the users consent collection history in the Users consent logs. Follow these steps to view the Users consent logs.
-
Open the project for which you want to view the Users consent logs.
-
Go to the Settings tab.
-
Select the Data collection policies option from the Table of contents.
-
Select View users consent logs.
The Users consent logs is displayed.
|
Element |
Description |
|
Name |
The name of the recording user. |
|
|
The email address of the user. |
|
Consent status |
The current consent status of the user. Note:
Consent status is only available if the Show consent dialog for users option on the Data collection policies page is enabled, allowing users to give consent. |
|
Terms of Use |
A hyperlink to the document that describes the terms of use that applied at the time the consent was approved. |
|
Timestamp |
The date and time the user approved the consent. |
From the Team tab, you can invite users to your project's recording initiative and manage their accounts. On the Team tab you can also configure the project's team of users and assign specific roles. See also:
To add a user to a project in Task Mining, the user needs to:
- Have an active account in Automation CloudTM. If a user's invitation is in Pending status, they can be invited to a Task Mining project, but the user cannot sign in to the recording application until they complete the Automation CloudTM registration.
- Be registered in the Task Mining tenant. If the user account is not displayed in the Task Mining User Invitation form it means that the user is not registered in the Automation CloudTM tenant.
Follow the steps below to invite a user to record data.
-
Open the project for which you want to invite a user to record data.
-
Go to the Team tab.
-
The Invite Recording users panel is displayed.
Select +Invite.
-
In the Users field, start typing the name or email address of the user you want to invite. The users that match your search entry are listed.
-
Select the user from the list.
Note:You an invite up to 10 users to a project. It is recommended to invite 2-7 users.
- Provide a context description in the Recording context field to inform the recording users about the goal of the recording. For example, you can describe the scenario you want the user to record and add notes for the user to pay attention to when recording.
- In the Recorder type field, indicate whether you want to send a link to the installer. If you select the MSI installer option, the Recorder Installer Link is included in the invitation email that is sent to the user.
-
Select Invite.
A confirmation message is displayed and an email containing the link to download the recording application is sent to the selected user.
Inviting a user who is on another project
There may be instances in your organization where a recording user you wish to add to a Task Mining project has recorded or is recording for another Task Mining project. Depending on whether the recording user is actively recording for another project, as a project administrator, you will be asked to complete a few additional steps to add them. Below is a description of the different scenarios.
The user is recording on another project
If you invite a user who has started recording, or is pending recording, in another Unassisted Task Mining project, a warning message is displayed, since users cannot be concurrently recording for multiple projects at the same time.
Select Show users' assignment to see the projects to which the user is assigned.
-
In the message box, select the user for which you want to request approval.
-
Select Request approval. A notification message is displayed.
The user is currently not recording on the other project
If you invite a user who is assigned to another Unassisted Task Mining project but is currently not recording, because the recording has stopped or paused, the user is added to your project. In this case, an email is sent to the project administrator of the project to which the user was previously assigned.
If a user is invited to the other project, but not has started recording yet, the user is also added to your project.
A user from your project is invited to join another project
There may be instances in your organization where a user has recorded or is recording for your Task Mining project is invited to join another Task Mining project. Depending on whether the recording user is actively recording for your project, as a Project Administrator, you will be notified and asked to approve the request. Below is a description of the different scenarios.
The user is recording
The status of the user will change to Pending in your project. At any time, the user can decide to come back, log in and start recording for your project.
The user is currently not recording
The status of the user will change to Pending in your project. At any time, the user can decide to come back, log in and start recording for your project.
User status, details, and activity review
The recording status and the application activity are displayed individually for each user in a tabular format. This includes the following columns:
-
Status - the recording status of the user. The following statuses are available:
- Invited – users who have been invited but did not accept the invitation yet.
- Recording – users for whom the recording application is turned on and capturing data.
-
Paused - users that have temporarily stopped the capturing process.
- Stopped – users for whom the capturing process has not been started or has been stopped.
- Error - users for whom the capturing process has registered an error and cannot continue.
- Pending - users who did not accept the recording consent.
- Stopped - No consent - users who declined the recording consent.
- Details - provide information about the current user status. It can indicate errors, alerts, pause instances, or consent status. See also Troubleshooting.
- Last Active - the last time the user's recording application was active.
- Time Captured - the total amount of time when the user's recording application was on and recording.
- Data Captured - the total amount of data captured by the user.
- Ready for Analysis - the percentage of captured data successfully archived and ready to be analyzed. Displayed as a percentage of actions processed/data captured.
-
Uploaded - the percentage of captured / uploaded data.
- The data collected from the users is uploaded to the Task Mining Cloud storage where the data is processed to become ready for analysis.
- The telemetry is calculated on the server and updated periodically via real time notifications or when you refresh the Team page.
Users recording with multiple devices
For a user who is recording the data for the project with multiple devices, the data from the different recordings is aggregated and uploaded as a single dataset. In case of any errors, the log information in the Details contains information on the device on which the error occurred that you can use for further analysis.
See also Recording with Multiple Devices.
User Details and Actions
For each user account, you have access to a set of Actions to manage their information and recording process.
Follow the steps below to delete a user.
-
Open the project for which you want to delete a user.
-
Go to the Team tab.
-
In the Recording users list, locate the user for which you want to mange the information.
-
Select the
icon to open the context menu.
Below is a description of the actions.
- Restart Desktop App remotely restarts the Desktop App to retry recording if errors occurred.
- Start Recording remotely starts selected users that are in Stopped status.
- Stop Recording remotely the recording application from the user's machine.
-
Delete the user fom the project. See also Deleting a User.
- Download logs option enables you to download the recorder logs, queue logs, and magma logs for the selected user if their status is labeled with error.
Deleting a User
Follow the steps below to delete a user.
-
Open the project for which you want to delete a user.
-
Go to the Team tab.
-
In the Recording users list, locate the user you want to delete.
-
Select the
A confirmation message is displayed.
-
Choose whether you want to Keep Data or Delete Data when deleting the user. Below is a description of the available options.
|
Option |
Description |
|
Keep Data | The user's traces and data will remain accessible in existing analysis results. |
|
Delete Data | The user's traces will remain in existing analysis results, but you may not be able to access the images of the user's actions.
Note: When you select the Delete Data option, future analysis for the project will not include the user's data either.
|
The user is removed from the list of Recording users on the Team page.
You can grant access to the current project with other users in your organization to collaborate on the project. For example, if you are a Business Analyst and you want to collaborate on the project with a colleague Business Analyst.
You can assign the Project administrator or Business analyst role to a user or group. This enables you to manage access for the current project.
You need to have the Project Admin or the Business Analyst role to assign roles to other users or groups.
-
If you have the Project Admin role, you can assign Project Admin, or Business Analyst roles.
-
If you have the Business Analyst role, you can share the project and assign the Business Analyst role.
Follow these steps to assign a project-level role to a user, several users, or a group.
-
On the Team tab, select +Assign role.
-
Select the project-level role you want to assign. The Assign role panel is displayed.
-
In the Add Users & Groups field, enter the email address of the user, or the name of the group to which you want to assign the selected role.
-
Select Assign.
The user or group is listed in the Project administrators and Business analysts list on the Team tab along with the assigned project-level role.
Removing a User of Group
When you remove a user or group, the individual user, or the users that are part of the group do no longer have the assigned permissions for the project.
Follow these steps to remove a user or group.
-
In the Project administrators and Business analysts list, select the user or group you want to remove.
-
Select Remove. A confirmation message is displayed.
-
Select Proceed anyway to remove the selected user or group.
The user, or group, is removed from the Project administrators and Business analysts list on the Team tab and no longer has permissions on the project.
