Home
Home
German Version
Support
Imprint
25.2 Release ►

Start Chat with Collection

Main Navigation

  • Preparation
  • Datasources
  • Configuration
  • Operations
  • User Manual
  • SDK
  • Release Notes
  • Security
  • Product Information
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