Mindbreeze InSpire Insight Applications in Microsoft SharePoint Online

Introduction

This document describes the integration of Mindbreeze InSpire insight applications in Microsoft SharePoint Online.

Software Prerequisites

The descriptions and instructions contained in this document are based on Microsoft SharePoint Online.

Embedding an Insight Application

Mindbreeze InSpire insight applications are stored as text documents in Microsoft SharePoint and embedded in pages with the “Content Editor” Web Part. Thus, an insight application can be used on multiple pages and still remain easy to maintain.

Saving an Insight Application in a text document

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

Uploading the text document

Upload the document to a document library:

Important Note:

The “Application” object in (searchapp.txt) must include the query parameters “K” of Microsoft SharePoint online:

<script>

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

window.appmb = new Application({ queryURLParameter: "k" });

});

</script>

Copy the address of the document to the clipboard:

Note: The above link is the URL of the document preview page.

Change the URL to the following and copy it:

       https://<your-tenant>.sharepoint.com/sites/<your-site>/Shared%20Documents/searchapp.txt

Note: Replace the brackets with your tenant name and site name. Copy the adjusted URL in a new bowser tab and make sure that it is working.

(Classic Site) Creating a new Web Part page

Navigate to “Site Contents” > “Site Pages“:

Create a new “Web Part Page”:

Choose a name and design. Create the page:

Add a new “Content Editor” Web Part:

Note: The “Content Editor” web part is not supported for modern pages (or Sites) according to Microsoft’s official documentation.

To create a classic site, please refer to the following link:

https://docs.microsoft.com/en-us/sharepoint/create-site-collection#create-a-classic-site

Edit the Web Part settings:

Insert the address (adjusted URL) of the text document in “Content Link”, then click “Apply”:

Click “Stop Editing” to finish editing a page: Click

(Modern Site) Script Editor Web Part

To redirect the search results to a modern site, you will need to add and configure a script editor web part. Please follow these steps:

Step 1: Download and deploy the “App” to your tenant

1. First, download MicrosoftSharePointOnline-ModernScriptEditor-<xx.x.x.xxx>.sppkg from the Mindbreeze update center.
2. Then, go to your tenant's app catalog: https://<tenant>.sharepoint.com/sites/AppCatalog/AppCatalog

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

https://docs.microsoft.com/en-us/sharepoint/dev/spfx/set-up-your-developer-tenant#create-app-catalog-site

1. From the left menu click “Apps for SharePoint” library. Then, upload the sppkg or drag and drop.
2. 
   
   
3. Click “Deploy” from the popup window.
4. 
   
   
5. Make sure the package is deployed without errors.
6. 
   

Step 2: Install the “App” into your modern site

1. From the site “Home” page, Click “+New” > “App”.
2. 
   
   
3. From “Apps you can add” section, click on “Modern Script Editor web part” to install it.
4. 
   
5. Note: Please wait for a minute until the app is installed and not grayed out in the “Site Contents” list.
6. You may need to refresh the page if it is still grayed out.
7. 
   

Step 3: Create a new result landing page

1. From the site’s “Home” page, click “+New” then choose “Page”.
2. 
   1. Choose “Blank” and click “Create page”.
   2. 
      
   3. Type a name for your page and click “Publish”.

Step 4: Add and configure the “Modern Script Editor” web part

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

1. Type “script” in the search box and choose “Modern Script Editor”

1. Click on “Edit Markup”. The configuration pane is opened on the right. Click on “Edit HTML code”.

1. Copy and paste the content of your insight app (exported from the Mindbreeze InSpire Designer) into the shown code editor.

Step 5: Important changes needed inside the code snippet

Change the queryURLParameter and export to the window object

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: "k"

   });

});

</script>

Add a listener to Microsoft search box events:

Additionally, in the same <script> tag, we have to add the following listener to reuse the search box and to redirect the search queries:

Before:

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

   window.appmb = new Application({

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

      queryURLParameter: "k"

   });

  });

</script>

After:

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

   window.appmb = new Application({

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

      queryURLParameter: "k"

   });

  });

  window.O365Shell.Search.OnSubmitSearch(function(query) {

      window.appmb.setUnparsedUserQuery(query);

  });

</script>

Resolve the styling conflicts

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="" rel="stylesheet">

After:

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

1. Finally, click on “Save”.
   

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

Changing the search results page

Click on the gear icon “Site Contents”

Click on “Site Settings”

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

Then we 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 “Result 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.

Troubleshooting

4.1. Cross-origin resource sharing (CORS)

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 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 > Advanced Settings

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

Please note that changing the “Allowed Origins Pattern” option manually will overwrite the default values, see also Documentation – Mindbreeze InSpire – Default values.