netDocShare Favorites View Config Settings User Guide

Add a Webpart
Open a SharePoint page:
Edit the SharePoint Webpart
Click on Add a new Webpart in column one
Now add a netDocShare Viewer Webpart
Once the netDocShare Viewer Webpart is added
Click on Edit Icon to input your netDocShare Configuration:
Click on Open config builder
Config Object Explanation
View Type has Nine different types of views:
  • Normal View
  • Tree View
  • Recent Documents
  • Favorites
  • My Checked-Out Documents
  • My Email Files
  • Authentication
  • Go to Client/Matter
  • Hybrid Search
Favorites View Config Settings Explanation
Show Logo

toggle option for it to appear in the webpart

Show Log out

toggle option for it to appear on the webpart

Action Button

Field options will be visible based on the Source type selection, it has eight types

If user selects Search button, based on ‘search behavior’ and ‘search in fields’ search bar will enable a user to search for a keyword in the webpart.

Filter Process

By Clicking on the Filter Icon user will enable column-based filter options. Based on the filters selected the user can search for an absolute search term and select a file.

Refresh

If user clicks on the Refresh button in Config, the entire webpart data is refreshed.

Export

If user selects the Export button in Config, the overall data will be exported in an excel file.

Upload

Upload button helps in three ways:

  1. Create new Folder
  2. Create a new Document ( format :Excel, PPT, Word)
  3. Upload a single/multiple File/s and Folder/s

If user selects the upload button in Config, user can upload a File or Folder inside the Folder section but this does not work in Workspace or Tab.

Download

If User selects the download button in Config, user will be able to download a selected document or file.

Search Behavior

It has two types.

  • Search Current View – Searches only the current view being displayed in a webpart.
  • Search All – Searches all the webpart content based on the user configurations and also searches child-level and parent-level documents.

It has two types.

  • Title – Search based on the title.
  • Everything –Search based on all document specifications.
Column Properties

By default, our webpart will include the field “name”, “version” as default columns to include in a newly created view. However, users can customize this in various ways. Using the Config Builder, users can dynamically retrieve columns that exist in their NetDocuments account and then add or remove any columns desired (Note: This excludes the Name and version fields which are mandatory). Users can also re-arrange columns as they wish.

Default Sort Property

User will be able to select this config setting for a webpart header Name, Document Id, Extension, Filter, Created By, Client, Matter, Modified, Sync Client, Sync Matter for sorting process.

Context Menu Option

Context Menu determines what options will appear in the dropdown context menu that is opened from clicking the “…” button beside each document. The ‘contextMenu’ can be disabled by completely removing the key and value from the config object. Users can add other options indicated in the list below:

“checkin”,”checkout”,”rename”,”view”,”viewNetDoc”,”delete”,”lockVersion”,”secureLink”,”follow”, “checkinNew”,”changeVersion”

If you omit the values for ``contextMenu``, the webpart will select the default options of “open” and “preview”. This can be changed by editing the JSON manually or picking the values from the corresponding dropdown menus in the config Builder. Please see an example of the context menu with all options turned on below:

  • Download – User can download a particular file
  • Delete - User can delete a particular file
  • Rename File – User can change their file name
  • Favorites – User can add their files in favorite list items
  • Check In/Check out - User can Check in and Check out a file. Once Checked out, file will be locked and other users will not be able to Download, Preview document, View in Browser, Add to My Favorites or Check In
  • Preview Document - User can preview a document
  • View In Browser - User can view the document in a separate tab in a browser
  • Edit Profile - User can edit profile details in a popup custom attribute
  • Co-Authoring – User can share documents with external and internal users. When co- authoring starts shared members can access file and edit, view and update. Once co-authoring is stopped shared users will not have access to shared documents.
  • Lock Version – If user locks a currently edited/worked document it will be permanent for that version and cannot be edited or unlocked again.
  • Get Secure Link – This requires that the “Get Secure Link” option is turned on in the user’s NetDocuments cabinet administration options. It should be on by default. This will open a full-screen browser preview without navigating to NetDocuments.
  • Email Link - If user needs a file’s particular destination in NetDocuments user can select email link to share the file link with others.
  • Follow – If user needs to share a document with another user, user can use this follow option.
  • Create New Version – User can update the document version
  • Margin Notes – Preview the document in new dialog with same browser tab.
  • Open in Microsoft Office – Based on the file extension (example Word or PPT or Excel) it will open in a new tab.
Context Menu Size

Based on selection the size of the context menu will be displayed.

CDN Base URL

Current SharePoint root url will be fetched, and if its Teams we will provide a service url.

Use Service Based Authentication

It will be enabled by default, when enabled it will authenticate login user based service authentication process.

Asset Path

The asset Path determines where the webpart will load its code and assets from. Typically, this can be found during the deployment process. Here is an example of a typical path we usually see in SharePoint Online:

https://{your-tenant}.sharepoint.com/sites/AppCatalog/ClientSideAssets/{webpartGUID}/

For SharePoint On-Premises, your asset Path might look like:

https://{yourSharepointTenant}/SiteAssets/netDocShare/CDN/assets/images/folderIcons/

Authentication Page Behavior

Authentication works in iFrame and selecting it will open a dialog window. Selecting Redirect will open in another tab in the browser.

Use Service Based Authentication

It will be enabled by default, when enabled it will authenticate login user based service authentication process

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 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):this will open the document in the NetDocuments work web.
  • Preview with Secure link Enabled:this option will preview the document in the new tab with security enabled for NetDocuments access.
  • Profile with Secure link Disabled:this option will preview the document in the new tab with security disabled for NetDocuments access.
  • Preview with Smart Previewer system: This option will open a document with new dialog in a same browser tab.
  • Download Document This option will simply download the selected document on click.
Use Auto Refresh

once toggled based on timing the webpart will aut refresh.

Favorites view config setting view process
  • View Type – Favorites 
  • Show Logo – Enable
  • Show Logout - Enable
  • Action Buttons – Search, Filter, Refresh, Export, Download and Upload are enabled for Favorites view
  • Search Behavior – Search All
  • Search In – Everything
  • Column Properties – Here user has selected all the column properties values
  • Default Sort Property – Extension
  • Sort Order - Ascending
  • Context Menu Options – Here user has selected all the Context Menu keys
  • Context Menu Size – Medium
  • CDN Base URL – Check above cdn base url config object explanation to be added here
  • Asset Path – Check above config setting explanation to add an asset path here
  • Authentication Page Behavior – Redirect
  • Default Click Behavior – Profile on NetDocuments
  • Use Auto Refresh – Disable
  • Enhance multiple webpart – Disable

Click the Save Changes on Config Builder if the user wants to configure a Favorites View Webpart.

The page will navigate to the SharePoint page and the Favorites View netDocShare Webpart will be displayed.

Results for the Favorites View Config Values
Click the Republish button on SharePoint page.
The Favorites View Webpart is created, and all the end users can access and use the netDocShare Favorite view.
Once published user can edit a page again to change Config Settings.