Communications Mining user guide

Introduction​

Why a successful integration is important​

The step-by-step integration process​

1. Sign in with Azure.

   Sign into your Azure Cloud Portal.

2. Register a new application for Communications Mining.

   Access the App Registrations menu and select the New Registration option.

   

   Register a new application:

   1. Enter an application name—for example reinfer-exchange-integration.
   2. Under Supported account types, select the single tenant option.
   3. Hit Register to complete the registration.

   

   Azure will give you an Application (client) ID and a Directory (tenant)ID.

   

3. Create a Client Secret for your Communications Mining application.

   To keep your application secure, you must create a Client Secret to log into your application. First, select Certificates & Secrets under the Manage sidebar, then continue with the following steps:

   1. Select the Client secrets option if it's not already selected.
   2. Select New client secret.

   

   3. In the sidebar, add an easily recognizable description and select an expiry date—we recommend 12 months.
   4. Hit Add.

   

   You've now created a Secret Value for your Communications Mining™ application.

   

   Note:

   Azure will only display this Secret Value to you once, so make sure to copy it. If you ever lose your secret value, simply complete Step 3 again to create a new one.

4. Set API permissions

   1. Navigate to API permissions under the Manage sidebar.
   2. Select Add a permission

   

   3. Select APIs my organization uses.

   

   4. Search for and select "Office 365 Exchange Online".
   5. Select "Application Permissions".

   

   6. Select the option "full_access_as_app".
   7. Hit Add permissions.

   

   8. Back in the API permissions menu, hit Grant admin consent for Communications Mining.
   9. In the Grant admin consent confirmation pop-up, select Yes.

   

5. Restrict access to the mailbox with a conditional access policy.

   At this point, you will likely want to limit the applications permissions so that it can only access certain mailboxes within your organisation. To learn how to do this, read Microsoft's article Limiting application permissions to specific Exchange Online mailboxes.

6. Sign into Communications Mining.

   Sign into Communications Mining through UiPath® Automation Cloud as usual.

7. Create a new integration in Communications Mining.

   1. Navigate to the Administration page from Communications Mining.
   2. Select New Integration.

   

   3. In the Create new integration page, under Add basic info, configure the following fields:
      • Project - Select an existing project.
      • Title - Optionally, enter a title.
      • API Name - Enter a name for your integration.
   Note:

   Once you set the API name, you cannot change it.

   4. Select Continue.

   

   5. Under Connect with your application configure the following:

      • Select the API type: Graph API or EWS API.

      • Select the authentication method: With client secret, With private key & thumbprint, or With NTLM.

        Note:

        NTLM only supports delegate access. For more information, check the Microsoft documentation on delegate access and EWS in Exchange.

      • OAuth Authority URL - Enter the OAuth authority URL using the tenant ID from step 2, when you registered a new application for Communications Mining, in the following format: https://login.microsoftonline.com/{tenant_id}.

      • OAuth Client ID - Enter the OAuth client ID from step 2.

      • Client Secret - Enter the client secret from Step 3.

      • Select one of the following options:

        • With service user access - Enter the username and password of your service account.
        Note:

        Graph API does not support service user access.

        • With application access

      • Select Validate & save credentials.

   6. Select Continue.

   

   7. Under Select your input data, select Add Mailbox and configure the following fields:

      Mailbox name

      • Email - Enter the email address.

      Bucket

      • New bucket - Select one of the following:
        • Create new bucket - Automatically create a bucket for the mailbox.
        • User define new bucket - Define a custom bucket by specifying a Project, Name, and Title.
      • Existing bucket - Select an existing Orchestrator bucket.

      Time filters

      Note:

      Choose a date to sync from. You can update this to sync further back as required. Already synced data will not be impacted. If total volumes are unknown, it is recommended to gauge volumes by syncing a shorter period first. AI units are charged on upload.

      • From timestamp - Configure the following field:
        • Sync from timestamp - Enter a date to sync from. It is typically recommended to sync at least 6 to 12 months of data.
      • All time - Syncs all available data.
      Important:

      This option may consume more AI units than expected.

      Folder filters

      Note:

      When applying folder filters:

      • Nested folders are separated with a forward slash /.
      • Folders visible in Outlook are normally prefixed with Root/Top of Information Store/.
      • Allowing folders means that folders not explicitly allowed are denied.
      • You can deny a folder within an allowed folder.
      • You cannot allow a folder within a denied folder.
      • Allowed folders - Enter the allowed folders.
      • Denied folders - Enter the denied folders.
      Note:

      Make sure you enter the folder location in this format: root/Top of Information Store/.

      Participant filters

      Note:

      When applying participant filters:

      • Allowing participants means that participants not explicitly allowed are denied.
      • Any denied participant is denied even if it also appears in the allowed list.
      • Participant filters are case insensitive.
      • Allowed participants - Enter the email addresses of the allowed participants.
      • Denied participants - Enter the email addresses of the denied participants.

      Participant domain filters

      Note:

      When applying participant domain filters:

      • Allowing domains means that participants not explicitly allowed are denied.
      • Any denied participant domain is denied even if it also appears in the allowed list.
      • You can wildcard the top-level domain. For example, reinfer.* matches reinfer.dev and reinfer.com.
      • Participant domain filters are case insensitive.
      • Allowed participant domains - Enter the domains of the allowed participants, for example, gmail.com.
      • Denied participant domains - Enter the domains of the denied participants, for example, gmail.com.

      Attachments

      • Sync attachment contents - Enable this option to also sync email attachments.

   8. Select one of the following options:

      • Add Mailbox
      • Discard new mailbox.

   9. Select Create Integration.

   

Final steps​