netDocShare Hybrid Search Config Settings – User Guide

Open the SharePoint Page

Edit the SharePoint web part and Add the netDocShare viewer web part

Click the Edit icon on the netDocShare web part and Add the netDocShare view Config

Click Open Config Builder

Select View Type as Hybrid Search and select Hybrid Search Type Value as Hybrid Search Web part

Asset path Field value is auto-populated if the user selects the View Type

Note:  Action Buttons field disappears if the View Type is Hybrid Search

If you are in SharePoint online (currently included in the config above) your asset path may look like the following:
https://{yourSharepointTenant}/sites/AppCatalog/ClientSideAssets/23dea53d-fbee-49c3-8b16-c6b586b0422f/

If you are on SharePoint on-Prem your asset path might look like the following:
https://{yourSharepointTenant}/SiteAssets/netDocShare/assets/images/folderIcons/

User can also provide an additional asset path same as the asset path selected if required Select the Enable Option on Show Filter, Show Results, and Show Search Input

Show Filters, Show Results, and Show Search Text Input are three values that control which components appear on the page

If in all 3 field users select Disable the User will see an error suggesting that at least one of these values should be on.

The CDN Base URL should be the root URL of your SharePoint Site Collection and the URL must end with a forward slash: ‘/’

The user needs to enter the URL below if the User disabled the Use Service-Based Authentication.

Universal authentication URL: https://services.klobot.ai/apps/live/netdocshare/srvc/auth

The results view will give the ability to open the results in different ways. The two available views are the Separate view and the Hybrid view.

The User should select the Result view and Mode on Config settings

If the User selects the Separate view: In the separate view, a User can see the SharePoint and NetDocuments results individually.

Result display mode will give the ability to open the results in different ways. The two available views are Accordion and Tabs

If the User Selects Mode as Accordion Mode on  Config builder: In the Accordion mode, a User will see the results in a vertically stacked list. See below an image of the Search result’s accordion view with filters for more clarity.

Config settings:

Note: The accordions’ names are configurable in the config settings. If the User left them blank, then they will show as SharePoint Results and NetDocuments Results

Search result’s accordion view with filters:

If the User selects the Tab Mode on config settings: In the Tab mode user will see the results in Tabs as shown in the image below of the Search results Tab view with filters.

Note: The Tab names are configurable in the config settings. If the user left them blank, then they will show as SharePoint Results and NetDocuments Results.

Search results tab view with filters:

If the User selects Hybrid View on Result View field on Config: In Hybrid mode, a user will get combined results as per the config settings. Also, in Hybrid mode, a user can choose two options: Summary view and Detailed view.

If the User Selects the Summary view on config builder: In the Summary view, a user can see the results in small blocks for each document.

If the User selects the Detailed View on config builder: In the Detailed view, a user can see the detailed results in a table.

Users can select the SharePoint Search type under the SP result config

There are 2 main search options when it comes to searching in SharePoint:

  • Search in specific list(s) or library(s)
  • Search across all content in SharePoint

This essential option can be controlled by a property called “SharePoint Search Type” which can be configured in the config builder

Search in a specific list

If the user selects the Search in SharePoint List on Config builder- Searching in a list is for use cases in which you have important metadata columns that need to be searched in SharePoint along with document results from NetDocuments. This search option requires a few inputs:

  • Sub Site: The subsite where the list is located. We will present you with a list of options retrieved automatically
  • List Name: The name of the list that you want to reference
  • SP Column Properties: Select the columns you would like to display when the search results are returned
  • Alternate Search Columns (optional): Specify, if necessary, alternate names for columns if there are issues with using the original

Search across a tenant

If User selects the Search in SharePoint Tenant on config builder- This search type uses the site collection managed properties to search across the entire tenant. Managed properties are properties that are tied to ‘crawled properties’ which are linked to created columns in existing lists or libraries. They can be configured in the Site settings. Here are the inputs required by the Tenant search option:

  • A managed property and a logical relationship that describes what to search for
    • Example: “Author={searchQuery}” or “AuthorContains{searchQuery}”
    • This will generate a KQL SharePoint query in the background to execute
    • If users are well-versed in constructing SharePoint queries using KQL, users may opt to use the advanced option to use a literal KQL query

Users can directly configure the URL by clicking on the show advanced option.

Filters

Users can configure the filters that are available from the SharePoint site.

Users can select the Source Type Cabinet or Workspace

Select the ND Column Properties

Please select the Context Menu options

Select the Sort By option

Sort By: Sorting Documents can be sorted and reverse-sorted by clicking or double-clicking on the column property-title by which you want to sort.

Select the Search In option on Config builder

Search In: Search In is a property that determines in what column the value will be searched. We currently offer 2 options: “Title” will only look for your search term in the document or container title, whereas “Everything” will look for the search term across all metadata columns and also search inside the document’s content

Select the Default Search option if needed

Default Filter: The default Filter is a hidden filter that will be applied to all NetDocuments searches in the background. Example:

{“ParentClient”:”91597″}}

Adding this to your config should add the additional filter of “ParentClient” with the value “91597” to every NetDocuments search.

Select the Default Click Behavior Options

 

Default Click Behavior: All documents displayed in a WebPart, upon click, will (by default) open the document’s profile page on the NetDocuments site. This default click behavior is customizable using your config options. Please see our section on config options to customize this behavior. There are a few different behaviors that users can select:

Profile on NetDocuments (default): “Profile on NetDocuments” is the default. It will navigate to the document profile page on NetDocuments.com.

Preview with Secure Link Enabled: This will use the NetDocuments “Secure Link” feature to construct a secure URL.

Preview with Secure Link Disabled: This will use the NetDocuments to open the document profile page on NetDocuments.com and open a full-screen browser preview

Preview with Smart Previewer System: This uses a preview functionality to open the document within the document grid

Download: This option will simply download the selected document on click

Please enter the CSS path URL if needed

Override CSS: The Override CSS is used to override our netDocShare default style. Users can override the CSS just by giving the URL of the CSS file. Once the user provides a new override CSS URL it will start loading the CSS file instead of a default CSS file.

Click Configure My Filters

Configure Hybrid Columns Mapping: Configure Hybrid Columns Mapping will open a popup window that will let Users set relationships between SharePoint and NetDocuments columns for the Hybrid results view. Since each platform may not have matching column names, this is the opportunity for the user to associate columns with different names so that the search results can have a combined column that shows results from each. For example, if you have a column in SharePoint named ClientNumber and a cabinet profile attribute in NetDocuments named ClientNum, you can use this feature to display the metadata for both under a shared tag of “Client” or whatever you choose

Select the Column on SharePoint and NetDocuments

User can edit the Created Filters column, then click the Edit icon, click the Save icon and Close

Click the Save Changes on Config Builder if the user wants to config the Hybrid search views

The page will navigate to the SharePoint page and the Hybrid Search netDocShare web part has been created

Click the Republish button on SharePoint page

The Hybrid Search web part is created and all the end users can access and use the netDocShare Hybrid Search view