DXP
Digital Experience Platform Squiz Marketplace

Supercharge your Squiz DXP with components, templates, extensions, and more.

Multiple use cases for Funnelback & Sharepoint (Office 365)

A range of the most common Funnelback and Sharepoint use cases in a single recipe - just delete what you don’t need

Implement this recipe to enable some of the key Funnelback / Sharepoint use cases. It’s easy to delete flows for use-cases you don’t need, and you can customise flows if you have additional requirements.

  • Retrieve list of files from a Sharepoint document folder and push them to a Funnelback collection for search
  • Retrieve the file metadata with permission detail from a Sharepoint document folder and push it to a Funnelback collection for search. This flow constructs the permission detail as the document lock string and push to a Funnelback push collection.

Note: This recipe provides a starting point for Funnelback to index Sharepoint documents via Connect,  it doesn't cover the end to end solution for supporting document level security which will involve an additional search query interface and key-lock string matching functionality outside the Connect platform

Sharepoint Funnelback Use case

It’s easy to integrate using a Recipe. All you need is the right credentials to connect. We recommend you test the integration with a Sandbox account before using it in production.

  1. Click the Activate recipe button to deploy this Recipe in Squiz Connect.
  2. Sign into Squiz Connect if you’re not already signed in.
  3. Follow the on screen instructions to finish deploying the Recipe.

Setting up the integration

There are 4 key steps to setting up this integration - both of which are explained in greater detail below:

  1. Configure Microsoft Azure App registration to get the credentials for Sharepoint
  2. Activate the recipe in Connect by adding or selecting credentials for Sharepoint and Funnelback
  3. Provide configurations for the Sharepoint and Funnelback settings
  4. After the recipe is activated, point the flow to connect to you selected Sharepoint site

Getting the Sharepoint credentials and adding them to Connect

1. Go to your Microsoft Azure portal and click on App registrations to setup a Connect app

App registrations

2. Choose New registration to create a new registration for your connect recipe

app registration

3.Record the Application (Client) ID, this value is required when adding the Sharepoint credentials to Connect

app registration step 2

4. Open Certificates & secrets page using the the left hand navigation, and choose  New client secret. Record the value once the secret is created as the value only displays on the screen when the secret is created.  This value is required when adding the Sharepoint credentials to Connect.

app registration step 3

5. Now you have both Client ID and Client secret details from the Step 3 and 4, the auth URI and token URI required for the credential should follow the format below:

AUTH URI: 
https://login.microsoftonline.com/{REPLACE_THIS_VALUE_WITH_YOUR_SHAREPOINT_URL}/oauth2/v2.0/authorize
TOKEN URI:
https://login.microsoftonline.com/{REPLACE_THIS_VALUE_WITH_YOUR_SHAREPOINT_URL}/oauth2/v2.0/token

6.  Log into Connect and open the workspace where you will set up your flows. Add the Sharepoint credentials as follows.

sharepoint credential

7. Click on Authenticate button, it will validate the credentials and the button turns green once it 's validated. Then click Save button to store the credential.

Provide configurations for the Sharepoint and Funnelback settings

At the recipe activation step 4, select "No Auth" type for creating a placeholder credential for your Funnelback system.

At the recipe activation step 5, you need provide configurations for the Funnelback and Sharepoint settings. Below is a template that you can copy and paste into the configuration credential field, and just replace the minimal three value fields in bold.

{
  "sharepoint": {
    "path": "",
    "folderId": "root",
    "options": {
      "orderBy": "",
      "select": "",
      "top": "",
      "skipToken": ""
    }
  },
  "funnelback": {
    "X-security-token": "Value of a Funnelback API security token",
    "push_endpiont": "URL of the push collection PUT end point"
  }
}

Set up flows to connect to your selected Sharepoint site

Once you have activated the recipe, review the flows that have been created and delete any flows you don't need. For the flows you do need, you can now edit them to point to the correct Sharepoint site.

Go to the Sharepoint step of the flow to select the Site Identity. The dropdown list shows the sample Sharepoint sites from the recipe. Click the reload icon to refresh the list from your Sharepoint instance.

reload sharepoint site dropdown

TypeRecipe
For  Squiz Connect
Flows 2
  Documentation