- Introduction
- Setting up your account
- Balance
- Clusters
- Concept drift
- Coverage
- Datasets
- General fields
- Labels (predictions, confidence levels, label hierarchy, and label sentiment)
- Models
- Streams
- Model Rating
- Projects
- Precision
- Recall
- Annotated and unannotated messages
- Extraction Fields
- Sources
- Taxonomies
- Training
- True and false positive and negative predictions
- Validation
- Messages
- Access control and administration
- Manage sources and datasets
- Understanding the data structure and permissions
- Creating or deleting a data source in the GUI
- Uploading a CSV file into a source
- Preparing data for .CSV upload
- Creating a dataset
- Multilingual sources and datasets
- Enabling sentiment on a dataset
- Amending dataset settings
- Deleting a message
- Deleting a dataset
- Exporting a dataset
- Using Exchange integrations
- Model training and maintenance
- Understanding labels, general fields, and metadata
- Label hierarchy and best practices
- Comparing analytics and automation use cases
- Turning your objectives into labels
- Overview of the model training process
- Generative Annotation
- Dastaset status
- Model training and annotating best practice
- Training with label sentiment analysis enabled
- Understanding data requirements
- Train
- Introduction to Refine
- Precision and recall explained
- Precision and Recall
- How validation works
- Understanding and improving model performance
- Reasons for label low average precision
- Training using Check label and Missed label
- Training using Teach label (Refine)
- Training using Search (Refine)
- Understanding and increasing coverage
- Improving Balance and using Rebalance
- When to stop training your model
- Using general fields
- Generative extraction
- Using analytics and monitoring
- Automations and Communications Mining™
- Developer
- Uploading data
- Downloading data
- Exchange Integration with Azure service user
- Exchange Integration with Azure Application Authentication
- Exchange Integration with Azure Application Authentication and Graph
- Fetching data for Tableau with Python
- Elasticsearch integration
- General field extraction
- Self-hosted Exchange integration
- UiPath® Automation Framework
- UiPath® official activities
- How machines learn to understand words: a guide to embeddings in NLP
- Prompt-based learning with Transformers
- Efficient Transformers II: knowledge distillation & fine-tuning
- Efficient Transformers I: attention mechanisms
- Deep hierarchical unsupervised intent modelling: getting value without training data
- Fixing annotating bias with Communications Mining™
- Active learning: better ML models in less time
- It's all in the numbers - assessing model performance with metrics
- Why model validation is important
- Comparing Communications Mining™ and Google AutoML for conversational data intelligence
- Licensing
- FAQs and more

Communications Mining user guide
This section contains an overview of the different roles and the permissions they grant in the Communications Mining™ platform.
Permission types
|
Permission type |
Description |
| Sources permissions | Refer to the data your company uploaded for analysis. |
| Datasets permissions | Grant access to datasets (i.e. named collections of labels), general fields and training data. |
| Streams permissions | Grant access to streams, which allow you to take actions on newly ingested data. |
| Users permissions
(deprecated) | Allow you to view and/or modify users in their projects. |
| Buckets permissions | Grant access to buckets, which are containers of raw data items that you can upload. |
| Integration permissions | Grant access to integrations, which allow you to connect other services to the platform. |
| Utility permissions | Include any permissions which do not belong to any of the other categories. |
Buckets, integration, and utility permissions are typically only granted to programmatic users such as development engineers. In addition, these permissions are not required for the daily use of the platform.
Permissions (Legacy)
| Permission type | Permission | Permission description |
| Service (only non-project) | Tenant admin |
Create, modify, and delete projects and users for a tenant. Additionally, all admins on UiPath® Cloud also receive this permission in the Communications Mining platform automatically. |
| Sources | View sources | View sources and the messages they contain. This is required to view individual messages on the platform.
Note: To view any data related to a source, dataset, or message in the platform both View Sources and View Labels, or their parent roles, are required.
|
| Sources |
View sensitive data Grants View sources | View any user properties which have been marked as sensitive, in addition to others. |
| Sources | Edit messages | Create, update and delete messages in a source via the API |
| Sources |
Sources admin Grants View sensitive data | Create, modify and delete sources. Source creation must be done via the API. |
| Sources | Create translated sources | Create sources (via the API) which are automatically translated into English. |
| Datasets |
View labels | View pinned and predicted labels on the user's datasets. This is required to view individual messages on the platform.
Note: To view any data related to a source, dataset, or message in the platform both View Sources and View Labels, or their parent roles, are required.
|
| Datasets |
Modify datasets Grants View labels | Update a dataset's properties: e.g. its description, sources and general fields. Enable Quality of Service and Tone analysis. |
| Datasets |
Review and label Grants View labels | Create, edit, and delete labels, and pin them to messages in the user's datasets. Add pre-trained labels. |
| Datasets |
Datasets admin Grants Modify datasets and Review and label | Create and delete datasets. Pin trained models for use in streams. |
| Datasets | Modify dashboards | Create, edit and delete dashboards within datasets. |
| Datasets | Export datasets | Export datasets via the UI |
| Streams | View streams | View streams and their configuration |
| Streams | Modify streams | Update a stream's properties: e.g. its description and filter. |
| Streams | Consume streams | Fetch and advance the output of a stream. |
| Streams |
Streams admin Grants View streams and Modify streams | Create, modify and delete streams. |
| Users | View users | View information on the other users in this user's projects. |
| Users |
Modify users Grants View users | Modify other users' permissions and projects |
| Buckets | View buckets | View information on raw data buckets |
| Buckets | Add/remove buckets | Add or remove raw data buckets |
| Buckets | Upload data to buckets | Upload data to buckets |
| Integrations | View integrations | View information on external integrations |
| Integrations | Modify integrations | Add or remove integrations with external services |
| Alerts | View alerts | View alerts, and issues raised by them. |
| Alerts | Alerts admin | Create, modify and delete alerts. |
| Utility | Upload files | Upload files to the Communications Mining™ server via the web UI |
| Utility | Read appliance configs | Fetch appliance configs |
| Utility | Write appliance configs | Upload new or replace existing appliance configs |
**) Triggers have been renamed to Streams in the platform, to better reflect their functionality.
Legacy roles
- Alerts - Read - View alerts and issues raised by them.
- Alerts - Manage - Create, modify, and delete alerts.
- Appliance Configs - Read - Fetch appliance configs.
- Appliance Configs - Write - Upload new or replace existing appliance configs.
- Buckets - Upload - Upload items to raw data buckets.
- Buckets - Download - Download items from raw data buckets.
- Buckets - Read - View information on raw data buckets.
- Buckets - Manage - Add or remove raw data buckets.
- Documents - Manage - Create, update, and delete messages in a source via the API or the UI, including CSV upload.
- Dashboards - Manage - Create, edit, and delete dashboards within datasets.
- Datasets - Manage - Create and delete datasets. Grants all other dataset permissions except Export Datasets.
- Datasets - Export - Export datasets via the user interface.
- Datasets - Model Admin - Pin and unpin trained models and update their tags.
- Datasets - Read - View annotated and predicted labels on the user’s datasets. Required to view individual messages on the platform.
- Datasets - Review - Create, edit, and delete labels, and pin them to messages in the user’s datasets.
- Datasets - Write - Update a properties of a dataset, including sources, general fields, and models.
- Files - Upload - Upload files to the Communications Mining™ server via the web user interface.
- Integrations - Read - View information on external integrations.
- Integrations - Manage - Add or remove integrations with external services.
- Sources - Manage - Create, modify, and delete sources.
- Sources - Read - View sources and the messages they contain. Required to view individual messages on the platform.
- Sources - Read Sensitive - View any user properties which have been marked as sensitive, in addition to others.
- Legacy Streams Manage - Create, modify, and delete streams.
- Legacy Streams Consume - Fetch and advance the output of a stream.
- Automation Cloud organization administrators are automatically granted the CM Tenant Admin role. This role cannot be removed without removing their organization admin role.
- The project administrator receives all the roles in a project, and can distribute the roles to all the users. You can only assign to a user the roles and permissions that you already have. You need the administrator of your project to first assign other permissions to you.
Updating the project roles and permissions of a user
To edit the project roles of another user and assign them permissions, proceed as follows:
- Log into Communications Mining™, and go to the Manage Access tab.
- Select a project from the All projects drop-down list.
- Select any permission in the Project Permissions column for the user you want to update the permissions.
- Select or deselect the roles you want to assign in the Project-specific permissions sidepanel.
Administrator permissions appear shaded in a darker colour, and automatically grant other permissions:
Updating the global roles and permissions of a user
To grant tenant administrator permissions to another user, proceed as follows:
- Log into Communications Mining™, and go to the Manage Access tab
- Select a project from the All projects drop-down list.
- Select CM Tenant Admin in the Global Permissions column.
- Select CM Tenant Admin to grant the tenant administrator permission.
- Log into Communications Mining, and select the gear icon to access the Administration page.
- Go to the Manage Access tab.
- Select the All Projects drop-down list, and select the project you want to add the new user to from the dropdown menu.
- Select New user to create a new user.
Note: If you are part of multiple projects with different members in them, the Add a user modal is displayed.Add user modal
- Select Create userNote: If you are part of one or more projects with the same members, the platform skips the Create user step, and displays the Create a new user modal instead.Create new user modal
- Fill in the required fields, which are describes as follows:
- Username - the username of the new user.
- Email - the company email of the new user.
- Send welcome email - the user will receive a welcome email that enables it to finish setting up its new account.
- Select Create user.
To remove, or to completely delete, a user from a project, proceed as follows:
-
Go to the Manage Access tab.
- Select the ellipsis for the user you want to remove or delete.
- Select Remove from project.
- Select Confirm to remove the user, or, for non-Automation Cloud users, to completely delete the user.
- Roles and their underlying permissions (legacy)
- Permission types
- Permissions (Legacy)
- Legacy roles
- Updating roles and permissions (legacy)
- Updating the project roles and permissions of a user
- Updating the global roles and permissions of a user
- Creating a new user (non-Automation Cloud admins)
- Deleting or removing a user (legacy)