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
  • General
  • ChatBot
  • External Search Links
  • Layout
  • Site Logo
  • Navigation
  • Landing Page Logo
  • Landing Page Background
  • Site Message
  • Colours
  1. Control Hub
  2. Global Settings

Theming

PreviousMap LensNextUser Avatar

Last updated 1 month ago

Customise and brand Aiimi Insight Engine with logos, background images and colour palettes within the Control Hub. Putting the control in your hands to configure and evolve Aiimi Insight Engine with your brand.

To help with accessibility we prompt where text contrasts against the colour palette would not meet WCAG 2.1 AA standards.

General

There are a number of settings to customise Aiimi Insight Engine. You can change names, contact details, and branding.

  1. Display Name - Enter the Display Name you want to use for Aiimi Insight Engine.

    • You could change the name to match any internal naming conventions.

  2. Support Email - Enter the Support Email to be used for support and queries.

    • There are a couple of ways users can contact admins, you can choose where they're sent.

  3. Show Support Email As A Modal - Check this so users can see and copy the support email.

  4. Include "Powered By Aiimi Insight Engine" - Check this to show this message within the system.

  5. Help Centre URL - Enter the URL users are navigated to when they select "Visit the Help Centre".

ChatBot

  1. ChatBot Name - Enter the name that will be used for the chatbot within your system.

  2. ChatBot Description - Enter a description for the ChatBot.

External Search Links

External search tool links can be added so users can quickly search that tool from Aiimi Insight Engine.

  1. Select Add Link to add new search tools to Aiimi Insight Engine.

  2. Link Name - Enter the External Search Link Name to add a new search tool in Link Name.

  3. URL - Enter the URL for the External Search Tool.

    • This must be a valid link with a suffix of "q=".

  4. Select Add.

You can edit or delete an existing search link from the external search link table.


Layout

We recommend testing images to ensure it contrasts well with the foreground before deploying.

Site Logo

Choose a logo to use in the navigation bar, on the login page. You can also customise where selecting the logo will take you.

  1. Select Upload a Logo.

  2. Within the modal, drag and drop the logo

Or

  1. Select Upload a Logo.

  2. Select Choose a file to open up your file explorer.

Navigation

Landing Page: Select this to take users to their landing page when they select the logo.

Custom Page: Select this to take users to a different URL when they select the logo.

  1. Specify where users will be taken by entering the URL into the Custom page URL.

Landing Page Logo

  1. Select Upload a Logo.

  2. Within the modal, drag and drop the logo

Or

  1. Select Upload a Logo.

  2. Select Choose a file to open up your file explorer.

Landing Page Background

Choose the type of background and the logo to use on the Aiimi Insight Engine landing page.

Background image - Select this to use an image for your landing page background. It will use the Additional background Image used for the login page.

Background colour - Select this to use a colour for your landing page background.

  1. Hex colour - Enter the hex code value for the colour you want to use for the background.

    • The text contrast check will check if this colour is accessible with our dark text.


Site Message

This adds a message to the top of every users Aiimi Insight Engine. You can share important information, updates or upcoming down time.

  1. Turn on a site wide messages with the Toggle at the top of the page.

  2. Site Message - Enter the text you want to be displayed across the application.

  3. Banner Colour - Select the colour of banner.

    • Each colour has certain connotations in a users mind.

      1. Blue - A routine message or sharing information.

      2. Yellow - An action is required or important information.

      3. Red - Some critical information or urgent action is required.

      4. Grey - A neutral message for information only.

Custom Banner Colour

  1. Hex Code - Enter the hex code of the colour you want to use.

    • This may be helpful if you have business standards for banners.

  2. Text Contrast Check - This ensures that the hex code you enter passes the AA accessibility standard with the standard font colour.


Colours

Customise the 3 main colours used across the system. We recommend these match your brand.

We recommend testing colour combinations for accessibility before deploying.

  1. Enter the Hex Code for each colour type.

    • Primary

    • Secondary

    • Tertiary

  2. When you enter a colour checks will be done for the colour contrast.

    • This will tell you if the colours are WCAG AA accessible against the white, grey and black backgrounds used.

We recommend a minimum accessibility level of AA. .

Visit the WCAG website for more information on accessibility