Aiimi Insight Engine
User GuidesAiimi
  • Introducing Aiimi Insight Engine
  • Architecture
    • Overview and Key Concepts
    • Search Flows
      • Search Flow Types
      • Smart Filtering
      • Query and Prompt Classification
      • Search Algorithms
      • Extractive and Generative Models
    • Hosting Options
    • Architecture and How It Works
      • Agent Servers
        • Security Agent
        • Source Agent
        • Content Agent
        • Enrichment Agent
        • Job Agent
        • OCR Agent
        • Migration Agent
        • Tika Agent
      • Repository
        • Data Node
        • Proxy Node
        • Kibana Node
      • Gateway and User Interface
      • Document and Data Sources
    • Deployment Options
    • Security
      • User Security
      • Data and Document Security
      • Source System Security
      • Firewalling
      • Agent Servers
      • Repository
      • Gateway (Web Server)
      • Tools & Utilities
  • Installation
    • Elastic and Kibana Install (Windows)
    • Aiimi Insight Engine Installation (Windows)
      • Installation Security
      • Certificates in a Key Vault
      • SAR Configuration
      • CSOM Bridge Set Up
      • AI Studio
    • AI Services
      • Prerequisites
      • AI Enrichment Service
        • Installation and Setup
        • Enabling Enrichment Steps
        • Using AI Enrichment Steps
        • Performance and Concurrency
      • AI Model Service
        • Installation and Setup
        • Enabling Providers
        • Private Generative AI
        • Azure Open AI
        • Enabling AI History
        • HTML Cleaner Service
      • Configuration of Logging
      • Offline Set-up of Models
      • Using SSL
      • Running as a Service (Windows)
      • Using GPUs
      • AI and Semantic Search Set Up
        • Open & Closed Book AI
        • Semantic Search
          • Vectors for Semantic Search
          • Source Configuration
          • Sentence Transformer Models
          • Enrichment
          • Kibana
          • Final Search Flow
    • Email Threading Upgrade
  • Run Books
    • SharePoint Online Connector
  • Control Hub
    • Configurations
      • Config Management
      • Security Configurations
        • Security - General
        • Security - Source
          • Active Directory
          • Atlassian
          • Azure Active Directory
          • Builtin Security
          • Miro Security
          • Google Directory
          • Slack Security
        • Security - Sync
        • Security - Agents
        • Security - Scheduling
      • Source Configurations
        • Source - General
        • Source - Source
          • Alfresco Kafka
          • Azure Blob Storage
          • BBC Monitoring
          • Big Query Cataloguer
          • BIM360
          • CSV Data Loader
          • Confluence
          • Content Server
          • Data File Cataloguer
          • Document Store
          • DocuSign
          • Dropbox
          • Exchange 365
          • Filesystem
          • Google Bucket
          • Google Drive
          • Google Vault
          • Jira
          • JSON Data Loader
          • Livelink
          • MFiles
          • Microsoft Teams
          • Mimecast
          • Miro
          • ODBC Data Loader
          • PowerBi Cataloguer
          • Reuters Connect
          • ShareFile
          • SharePoint
            • Azure Portal and Azure AD Authentication
            • Sensitivity Labels
          • SharePoint Legacy
          • SQL Server Cataloguer
          • Slack
          • Versioned Document Store
          • Websites
          • XML Data Loader
        • Source - Crawl
        • Source - Agents
        • Source - Schedule
        • Source - Advanced
      • Enrichment Configurations
        • Creating a Pipeline
          • General
          • Steps
            • AccessMiner
            • AI Classification
            • Anonymiser
            • CAD Extractor
            • Checksum
            • Content Retrieval
            • Copy
            • Data Rule Processor
            • Delete
            • Email Extractor
            • Entity Rule Processor
            • External Links
            • Geotag
            • Google NLP Extractor
            • Google Vision Extractor
            • Metrics Calculation
            • Microsoft Vision Extractor
            • OcrRest
            • Office Metadata
            • PCI Extractor
            • REST
            • Set Document Risk
            • Text Cleaner
            • Tika Text Extraction
            • Trie Entity Extractor
            • Update Metadata
          • Filters
          • Agents
          • Schedule
          • Advanced
      • OCR Engine
      • Job Configurations
        • General
        • Job
          • AutomatedSearchJob
          • Command Job
          • ElasticJob
          • Extended Metrics Job
          • File Extractor
          • GoogleVaultSAR
          • Google Drive Last Access Date
          • Nightly Events Processor Job
          • Notifications Processor Job
          • Portal Sync Job
          • Purge Job
          • Text Content Merge Job
        • Output
        • Agents
        • Scheduling
      • Migration Configuration
        • General
        • Filter
        • Metadata Mappings
        • Agents
        • Scheduling
        • Advanced
    • Credentials
    • Mappings
      • Entities
        • Manage Entity Groups
        • Create an Entity
        • Manage an Entity
      • Models
        • Create a New Model
        • Find a Model
        • Enable or Disable a Model
      • Vectors
      • Rank Features
    • Featured Links
    • AI Settings
      • Classifications
      • Class
      • Class Rules
      • AI Classification
    • User Settings
    • Stats
      • Data Views
    • Global Settings
      • General
      • Authentication
      • App Settings
      • Application Access
      • Thumbnails
      • Presets
      • Code of Conduct
      • Metrics
      • Viewer
      • SAR
        • Importing Data For A SAR
        • SAR Disclosure Document Storage
        • Getting SAR data from Google Vault
        • SAR Access
        • SAR File Status
      • Disclosure Portal
        • Disclosure Portal Set Up
        • SARs From The Portal
        • Email Delivery Settings
          • Delivery Settings
          • Brand Settings
          • Customise Emails
        • SMS Delivery Settings
        • Requestor Message Limit
        • Attachment Configuration
        • Password Configuration
        • File Scanner Configurator
      • Collections
      • Visualisations
        • Related Result Connections Diagram
        • Event Timeline
        • Timeline Lens Activity Chart
        • Relationship Map
      • Notifications
      • Map Lens
      • Theming
      • User Avatar
      • OData API
      • Uploads
      • Security
    • Search Settings
      • Search Relevancy
        • Core Settings
        • Makers Algorithm
        • Filename Boost Layer
        • Minimum Matching Terms Filter
        • Field Boost
        • Modified Date Boosting
        • Hit Highlighting
        • Why My Search Matched
        • Data Search Strategy
      • Bulk Search
        • Managing a Bulk Search
      • Search Flows
        • Create a Search Flow
          • General
          • Query Classification Step
          • Search Steps
          • Model Steps
      • Filtering
      • Search Performance
      • Related Results
  • AI Studio
    • Classifications
      • Classifications
      • Classification Rules
    • Jobs
  • Labels
  • API Guides
    • Insight API Guide
      • Swagger Documentation
      • Trying Some Endpoints
      • Search Filter
      • Hits / Items
      • Inspecting REST Calls
    • Data Science API Guide
      • REST Interface
        • Login
        • Datasets
        • Fields
        • Field Statistics
        • Search
        • Scroll
        • Update
      • Python Wrapper
        • Login
        • Datasets
        • Fields
        • Field Statistics
        • Search
        • Query Builders
        • Scroll
        • Scroll Search
        • Update Single Document
        • Bulk Update
    • Creating a Native Enrichment Step
      • Creating an Enrichment Step
        • Creating the Core Classes
        • Extending our Enrichment Step
        • Adding a Configuration Template
        • Adding the Enrichment Step
        • Creating an Enrichment Pipeline
      • Other Tasks
        • Entities, Metadata and Data
        • Accessing the Repository
      • Example Code
      • Troubleshooting
    • Creating a Python Enrichment Step
      • Creating an Enrichment Step
        • Running the Example from Command Line
        • Running the Example
      • Creating Your Own Step
      • Adding or Changing Entities, Metadata
  • Whitepapers and Explainers
    • From a Billion To One – Mastering Relevancy
    • Methods for Text Summarization
      • Application
      • Technology Methods
      • Commercial Tools
      • Key Research Centres
      • Productionisation
      • Related Areas of Text Analytics
      • Conclusion
      • References
Powered by GitBook
On this page
  • Prerequisites
  • Configure Mimecast Source
  • Connection
  • Domains
  • Mailboxes
  • Messages
  • Attachments
  • Advanced
  1. Control Hub
  2. Configurations
  3. Source Configurations
  4. Source - Source

Mimecast

PreviousMicrosoft TeamsNextMiro

Last updated 1 month ago

Mimecast is an email security company that protects emails from threats like spam, malware, and phishing. Aiimi Insight Engine connects to their cloud email archive service.

Prerequisites

Mimecast Service Account

Aiimi Insight Engine requires a Mimecast Service Account. For information on creating a Service account

Service Account Roles

Your service account requires certain roles to allow Aiimi Insight Engine to crawl Mimecast. For information on service account permissions

We require the following roles to be assigned:

  • Archive Menu - Search - Read & Search Content View

  • Directories Menu > Internal > Read

2.0 API Key

Aiimi Insight Engine requires the Mimecast 2.0 API.

For information on generating an API key

The API requires the following products:

If these products are not added you may see a 403 error when using the Util tool.

  • Email Security Cloud Gateway

  • Domain Management

  • Data Retention

  • Connector

  • User and Group Management

  • Awareness Training

  • Threat Management

  • Policy Management

  • Threats

  • Security Events and Data for CG

  • Audit Events

  • Security Events

  • Account Management

Credentials

The Mimecast connector requires a Client ID and Secret credential. For support setting up a credential

Configure Mimecast Source

  1. Source System: Select Mimecast from the dropdown.

Connection

  1. Mimecast API Endpoint: Enter the Mimecast endpoint to use for API requests.

  2. Authentication Endpoint: Enter the Mimecast endpoint used to authenticate requests.

  3. Select Credential: Choose the Mimecast Client ID and Secret from the dropdown.

  4. Select the Domains tab.

Domains

  1. Included Domains: Choose to crawl specific domains only. Enter the domain names you want to crawl using Regular Expression.

    • If blank, all domains will be crawled.

  2. Include local domains: If checked, local domains will also be processed.

    • This depends on the filtered domains.

Mailboxes

  1. Included Mailboxes: Choose to crawl specific mailboxes only. Enter the email addresses you want to crawl using Regular Expression.

    • If blank, all mailboxes will be crawled.

  2. Excluded Mailboxes: Choose to exclude specific mailboxes only. Enter the email addresses you don't want to crawl using Regular Expression.

    • If blank, all included mailboxes will be crawled.

Messages

  1. Start Date: Select the earliest date messages should be retrieved from when crawling a mailbox for the first time.

    • This also applies if Ignore Delta Tokens is checked.

  2. End Date: Select the date of the latest message to retrieve.

    • Leave this empty for ongoing delta crawls.

  3. Ignore delta tokens: Check this to ignore delta tokens and re-crawl all messages.

    • Use this to find missing messages, if the Start Date is changed, or to process deleted messages.

    • This is slower than a standard delta crawl.

  4. Excluded Message Subjects: Limit the emails processed depending on their subject. Enter the subjects you don't want processed using regular expressions.

    • If blank, all messages will be processed.

  5. Blank Subject Default: Enter a default subject for any messages processed without one.

Attachments

  1. Extract Attachments: Check this to extract and store attachments and email separately.

  2. Excluded Attachment Names: Limit the attachments processed. Enter the attachment names you don't want to process using regular expressions.

    • If blank, all attachments will be processed.

  3. Blank Attachment Name: Enter a default name for any attachments processed without one.

Advanced

Parallelism

  1. Parallel Mailbox Crawling: Enter the maximum number of mailboxes that should be crawled at once.

  2. Parallel Folder Query: Enter the maximum number of Elastic queries that can be processed at once.

    • This may impact Elastic performance.

  3. Parallel Mailbox Deletion: Enter the maximum number of mailboxes that can be deleted at once.

    • This may impact Elastic performance.

Logging

  1. Trace Level: Select the connection trace level from the dropdown.

    • None - Do not log graph calls

    • Calls - Log URLs and status codes

    • All - Log URLs, status codes, request forms and JSON responses

  2. Stats Logging Interval (Seconds): Choose how often the Graph API call stats are logged in seconds.

    • This includes the total number of calls, call rates, HTTP errors and 429 errors.

    • Set this to 0 to disable stats logging.

Performance

  1. Results Page Size: Enter the maximum number of results retrieved in a single request.

  2. Retry After Multiplier: Enter a multiplier to pause processing after receiving a 'retry after' message. The multiplier will be multiplied by the 'retry after' value.

    • Retry after values are typically between 1 and 3. A multiplier of 1000 will convert the value to that number of seconds.

  3. Delta Token Offset (Minutes): Enter the number of minutes to overlap that is applied to a saved delta token.

    • This allows time zones to be accounted for.

    • Negative values are subtracted.

  4. Authentication Token Offset (Seconds): Enter an offset in seconds that is applied to the authentication token expiry.

    • Negative values are subtracted.

For support setting up credentials use

see Mimecast's documentation on creating a service account user.
see Mimecast's documentation on Granting API Service Account User Permissions.
see Mimecast's video explaining how to generate an API Key.
see our guide on creating Client ID and Secret credentials.
our guide on managing credentials.