Home
Home
German Version
Support
Impressum
25.2 Release ►

Start Chat with Collection

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Loop Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Connector
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SCIM Principal Resolution Service
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - Web Connector
      • Configuration - Yammer Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
      • Whitepaper - Web Connector - Setting Up Advanced Javascript Usecases
    • Configuration
      • CAS_Authentication
      • Configuration - Alerts
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - InSpire AI Chat and Insight Services for Retrieval Augmented Generation
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • JWT Authentication
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - AI Chat
      • Whitepaper - Create a Google Compute Cloud Virtual Machine InSpire Appliance
      • Whitepaper - Create a Microsoft Azure Virtual Machine InSpire Appliance
      • Whitepaper - Create AWS 10M InSpire Appliance
      • Whitepaper - Create AWS 1M InSpire Appliance
      • Whitepaper - Create AWS 2M InSpire Appliance
      • Whitepaper - Create Oracle Cloud 10M InSpire Application
      • Whitepaper - Create Oracle Cloud 1M InSpire Application
      • Whitepaper - MMC_ Services
      • Whitepaper - Natural Language Question Answering (NLQA)
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • Adjusting the InSpire Host OpenSSH Settings - Set LoginGraceTime to 0 (Mitigation for CVE-2024-6387)
      • app.telemetry Statistics Regarding Search Queries
      • CIS Level 2 Hardening - Setting SELinux to Enforcing mode
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration - Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
      • Whitepaper - Administration of Insight Services for Retrieval Augmented Generation
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.chat.v1beta.generate Interface Description
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of a Query Expression Transformer
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
      • OpenAPI Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
      • Release Notes 23.1 Release - Mindbreeze InSpire
      • Release Notes 23.2 Release - Mindbreeze InSpire
      • Release Notes 23.3 Release - Mindbreeze InSpire
      • Release Notes 23.4 Release - Mindbreeze InSpire
      • Release Notes 23.5 Release - Mindbreeze InSpire
      • Release Notes 23.6 Release - Mindbreeze InSpire
      • Release Notes 23.7 Release - Mindbreeze InSpire
      • Release Notes 24.1 Release - Mindbreeze InSpire
      • Release Notes 24.2 Release - Mindbreeze InSpire
      • Release Notes 24.3 Release - Mindbreeze InSpire
      • Release Notes 24.4 Release - Mindbreeze InSpire
      • Release Notes 24.5 Release - Mindbreeze InSpire
      • Release Notes 24.6 Release - Mindbreeze InSpire
      • Release Notes 24.7 Release - Mindbreeze InSpire
      • Release Notes 24.8 Release - Mindbreeze InSpire
      • Release Notes 25.1 Release - Mindbreeze InSpire
      • Release Notes 25.2 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    Installation and Configuration
    Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem

    IntroductionPermanent link for this heading

    This document describes the use of Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem.

    Software PrerequisitesPermanent link for this heading

    The descriptions and instructions contained in this document are based on Microsoft SharePoint On-Prem.

    Classic Sites: Embedding an Insight ApplicationPermanent link for this heading

    Insight Apps are stored as text documents in Microsoft SharePoint and embedded in pages with the Content Editor Web Part. Thus, an Insight App can be used on multiple pages and still remain easy to maintain.

    Saving an Insight App in a text documentPermanent link for this heading

    Copy the snippet from the Mindbreeze InSpire Designer into a text document. Click here for more information: Development of Insight Apps.

    Uploading the text documentPermanent link for this heading

    Upload the document to a document library:

    C:\Users\michael.biebl\Desktop\sharepoint\12_add_document.PNG

    Copy the address of the document to the clipboard:C:\Users\michael.biebl\Desktop\sharepoint\11_copy_link.png

    Creating a new Web Part pagePermanent link for this heading

    Navigate to “Site Contents“ > “Site Pages“:C:\Users\michael.biebl\Desktop\sharepoint\01_site_contents.PNG

    Create a new Web Part page:C:\Users\michael.biebl\Desktop\sharepoint\03_new_web_part_page.PNG

    Choose a name and design.  Create the page:C:\Users\michael.biebl\Desktop\sharepoint\04_new_web_part_page.PNG

    Add a new “Content Editor“ Web Part:C:\Users\michael.biebl\Desktop\sharepoint\05_empty_web_part_page.PNGC:\Users\michael.biebl\Desktop\sharepoint\10_add_content_editor.PNG Edit the Web Part settings:C:\Users\michael.biebl\Desktop\sharepoint\13_edit_web_part.PNG

    Insert the address of the text document in “Content Link“:C:\Users\michael.biebl\Desktop\sharepoint\14_set_url.PNG

    Click “Stop Editing“ to finish editing a pageC:\Users\michael.biebl\Desktop\sharepoint\16_stop_editing.PNG

    Modern Sites: Embedding an Insight AppPermanent link for this heading

    Step 1: Download and deploy the “App” to your tenantPermanent link for this heading

    First, download MicrosoftSharePointOnPrem-MindbreezeScriptEditor-<xx.x.x.xxx>.sppkg from the Mindbreeze update center.

    Then, go to your tenant's app catalog: https://<tenant>.sharepoint.com/sites/AppCatalog/AppCatalog

    Note: In case the App Catalog is not created yet, please follow this link to create a new one.

    From the left menu click “Apps for SharePoint” library. Then, upload the SPPKG or drag and drop.

    Click “Deploy” from the popup window.

    Note: Make sure SPPKG is deployed without errors.

    Step 2: Create a new result landing page Permanent link for this heading

    From the site’s “Home” page, click “+New” then choose “Page”.

    Choose “Blank” and click “Create page”.


    Type a name for your page and click “Publish”.

    Step 3: Add and configure the “Modern Script Editor” web partPermanent link for this heading

    From the top right of the page, click on “Edit”. Then click on the plus icon to add a new web part.


    Type Mindbreeze in the search box and choose “Mindbreeze Script Editor”

    Click on “Edit Snippet” to open the code editor.
    Copy and paste the content of your insight app (exported from the Mindbreeze InSpire Designer) into the shown code editor.

    Step 4: Important changes needed inside the code snippetPermanent link for this heading

    Change the queryURLParameter and export to the window objectPermanent link for this heading

    At the last <script> tag of the copy/pasted HTML code snippet, you have to change the following:

    Before:

    <script>Mindbreeze.require(["client/application"], function(Application) {  

       var application = new Application({

         rootEL: document.getElementById("mb-custom-searchapp-wrapper")

       });

      });

    </script>

    After:

    <script>Mindbreeze.require(["client/application"], function(Application) {  

       window.appmb = new Application({

         rootEL: document.getElementById("mb-custom-searchapp-wrapper"),

          queryURLParameter: "q"

       });

    });

    </script>

    Resolve the styling conflictsPermanent link for this heading

    To resolve the styling conflicts between SharePoint Online and Mindbreeze, you have to edit the <link> tag exists at the top (first line) of the insight app snippet:

    Before:

    <link href=" https://<your-inspire>/apps/designer/../css/adapted.css" rel="stylesheet">

    After:

    <link href="https://<your-inspire>/apps/designer/../css/v2/minimal-prefixed-adapted.css" rel="stylesheet">

    Click on “Save”.

    And then click on “Publish” to make the changes effective.

    Classic Sites: Change the search results pagePermanent link for this heading

    In order to use Mindbreeze InSpire search instead of the standard SharePoint Online search on a classic site, additional configuration steps are required.

    Click on the gear icon “Site contents”

    Click on “Site settings”

    Go to the search section, then click on the “Search Settings” link.

    Then you will get into the “Search Settings” configuration page.

    Under “Which search results page should queries be sent to?”:

    • Select the radio button “Send queries to a custom results page URL”
    • Enter the custom search result page in “Results page URL”.

    Click on the OK button – then wait for a minute to get the changes affected.

    Now, search for something in the top search box and hit enter – you should be redirected to the configured results page.

    Note:
    This search redirect feature doesn’t apply for modern communication sites in SP2019 (On-Prem). Please check the troubleshooting section for more details.

    TroubleshootingPermanent link for this heading

    Cross-origin resource sharing (CORS)Permanent link for this heading

    For security reasons, browsers restrict cross-origin HTTP requests initiated from scripts. In this case, when you open https://{mytenant}.sharepoint.com in a browser, a script from your appliance’s web server is loaded. This script then initiates XHR requests to your appliance (which is in another origin, e.g. https://search.myorganization.com), which is not allowed by the CORS policies by default. To allow requests from your SharePoint tenant to your appliance, you need to add your SharePoint tenant in the allowed origins of the CORS settings of your appliance.

    Configure the following in the Mindbreeze Management Center:

    Configuration > Client Services > check “Advanced Settings”

    You can find further information in Documentation – Mindbreeze InSpire – CORS Header.

    Note: Changing the “Allowed Origins Pattern” option manually will overwrite the default values, see also Documentation – Mindbreeze InSpire – Default values.

    Search redirect is not working on modern sites (SP2019)Permanent link for this heading

    In SharePoint 2019, unfortunately, modern sites cannot be customized to redirect search queries.

    Refer here.

    [Classic Sites] Search redirect is not working (_layouts/15/start.aspx)Permanent link for this heading

    If the search redirect directs to a page that is not correct, check the URL. If the URL contains _layouts/15/start.aspx, the reason is probably that the SharePoint function „Minimal Download Strategy“ is activated on your site.

    You can remove the _layouts/15/start.aspx part of your URL by deactivating the „Minimal Download Strategy“ function under Site Actions -> Manager Site Features.

    Download PDF

    • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem

    Content

    • Introduction
    • Software Prerequisites
    • Classic Sites: Embedding an Insight Application
    • Modern Sites: Embedding an Insight App
    • Classic Sites: Change the search results page
    • Troubleshooting

    Download PDF

    • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem