User Guide – netDocShare app for Microsoft 365 SharePoint Online / SharePoint Server 2019 / SharePoint Server 2016 – Installation

Let’s add the Document Viewer, our first real WebPart after Auth. You can add the Document Viewer WebPart by picking it in the same menu where you added the Auth WebPart from. Like auth, it will require the user to insert a configuration object before it can start up. An example and explanation of the DocumentViewer JSON Config Object is shown below:

Note: The Document Viewer features several ways to select the source of your document. If you intend to use query string features such as netcode or cnum / mnum, then note that those values will override any source defined in the primarySource config.

Note: For example, If you have a primary source defined but netcode is set to true and the URL has a valid netcode in it, then primary source will be overridden by the source that the netcode is pointing to.

Viewtype: Normal View

{

“viewType”: “normalView”,

“netDocsClientId”: “AP-P0VO45CC”,

“netDocsClientSecret”: “22neL4s4DF5WU18HpBjdcMaUX2piUWkMzg460urwyr2xMCsf”,

“netDocsBaseUrl”: “https://api.vault.netvoyage.com/v2“,

“netcode”: “false”,

“metaWebPartListLocation”: “”,

“metaWebPartTitle”: “”,

“primarySource”: { “id”: “:Q8:u:n:k:v:%5EW190117113020165.nev”, “type”: “workspace” },

“columnProperties”: [“extension”, “id”, “createdBy”, “modified”],

“defaultSortProperty”: “”,

“filters”: [],

“CDNBaseUrl”: ” https://m365x634254.SharePoint.com/“,

“AuthSuffix”: “SitePages/auth.aspx”,

“removeSort”: [],

“contextMenu”: [“checkin”, “checkout”, “rename”, “view”, “viewNetDoc”, “delete”, “lockVersion”, “secureLink”, “follow”, “checkinNew”, “changeVersion”],

“showSearchBox”: true,

“showLogo”: true,

“authPage”: “redirect”,

“assetPath”: “https://m365x634254.sharepoint.com/sites/AppCatalog/ClientSideAssets/23dea53d-fbee-49c3-8b16-c6b586b0422f/

}

For explanations of each property, what they do and what values should be used to change them, please see our Config Builder Properties Appendix at the end of the document.

Note: Starting from version 2.4.2, users can also use the config builder directly on a new page instead of copying and pasting JSON values.

Viewing a workspace in Normal View

The Workspace view in our NetDocShare normal view differs slightly from the other views as workspaces tend to have specific use cases in NetDocuments. We have made sure to align to these use cases by mimicking the Overview page seen in the NetDocuments web platform. This view features:

A button to toggle between List and Summary view

  • List View: Displays all contents of the container, including sub-containers and documents
  • Summary view: Displays all containers which can be expanded or collapsed

A button to expand/collapse individual containers in the view or expand/collapse all containers

Clicking on each container will open the contents of the container

NetDocuments View:

NetDocShare View:

Highlighted in yellow you can see the options to toggle list and summary view, the ability to expand and collapse single containers and also the ability to expand and collapse all containers. Toggling to List view should show a view of all containers and documents together in the same table.

Viewtype: Recent Doc

The Recent Doc viewtype is a different configuration of the Document Viewer Webpart that shows a collection of recent documents that are derived from the account of the NetDocuments user. The only difference between a regular document viewer and RecentDocs lies in the configuration. RecentDoc has the simplest configuration as it does not require any sources or additional configuration. It simply shows the last 40 most recent documents based on the user’s account. This list will only be updated after edited documents have been checked in, or after they have been initially uploaded.

An example and explanation of theRecent Doc JSON Object is as follows:

{

“viewType”: “RecentDoc”,

“netDocsClientId”: “AP-P0V35CC”,

“netDocsClientSecret”: “22neL4s4DF5WU18HcMaUX2piUWkMzg460urwyr2xMCs”,

“netDocsBaseUrl”: “https://api.vault.netvoyage.com/v2“,

“columnProperties”: [“extension”, “id”, “createdBy”, “modified”],

“filters”: [],

“CDNBaseUrl”: “https://m365x634254.SharePoint.com/“,

“AuthSuffix”: “SitePages/auth.aspx”,

“removeSort”: [],

“contextMenu”: [“checkin”, “checkout”, “rename”, “view”, “viewNetDoc”, “delete”, “lockVersion”, “secureLink”, “follow”, “checkinNew”, “changeVersion”],

“showSearchBox”: true,

“showLogo”: true,

“authPage”: “redirect”

“assetPath”: “https://m365x634254.sharepoint.com/sites/AppCatalog/ClientSideAssets/23dea53d-fbee-49c3-8b16-c6b586b0422f/

}

For explanations of each property, what they do and what values should be used to change them, please see our Config Builder Properties Appendix at the end of the document.

Viewtype: Favorites

The Favorites viewtype is a different configuration of the Document Viewer Webpart that shows a collection of user-defined favorites that are derived from the account of the NetDocuments user. The only difference between a regular document viewer and the Favorites view lies in the configuration and the configs for favorites is identical to Recent Docs except for the viewtype.

An example and explanation of the Favorites JSON Object is as follows:

{

“viewType”: “Favorite”,

“netDocsClientId”: “AP-P0432CC”,

“netDocsClientSecret”: “22neL4s4DF5WU18HpBjdcMaUX2piUWkMzg460urwyr2xMCs”,

“netDocsBaseUrl”: “https://api.vault.netvoyage.com/v2“,

“columnProperties”: [“extension”, “id”, “createdBy”, “modified”],

“filters”: [],

“CDNBaseUrl”: “https://m365x634254.SharePoint.com/“,

“AuthSuffix”: “SitePages/auth.aspx”,

“removeSort”: [],

“contextMenu”: [“checkin”, “checkout”, “rename”, “view”, “viewNetDoc”, “delete”, “lockVersion”, “secureLink”, “follow”, “checkinNew”, “changeVersion”],

“showSearchBox”: true,

“showLogo”: true,

“assetPath”: “https://m365x634254.sharepoint.com/sites/AppCatalog/ClientSideAssets/23dea53d-fbee-49c3-8b16-c6b586b0422f/

}

For explanations of each property, what they do and what values should be used to change them, please see our Config Builder Properties Appendix at the end of the document.

Viewtype: Saved Search

The Saved Search viewtype is a different configuration of the Document Viewer Webpart that shows a collection of recent documents that are derived from the results of a saved search, created on the NetDocuments online platform. The only difference between a regular document viewer and Saved Search lies in the configuration:

An example and explanation of the Saved Search JSON Object is as follows:

{

“viewType” : “normalView”,

“netDocsClientId” : “AP-P0VO45CC”,

“netDocsClientSecret” : “22neL4s4DF5WU18HpBjdcMaUX2piUWkMzg460urwyr2xMCsf”,

“netDocsBaseUrl” : “https://api.vault.netvoyage.com/v2“,

“primarySource” : {“id”: “4825-8486-5929”, “type”: “savedsearch”},

“columnProperties” : [“extension”, “id”, “createdBy”, “modified”],

“defaultSortProperty” : “”,

“filters”: [],

“CDNBaseUrl” : “https://m365x634254.SharePoint.com/“,

“AuthSuffix” : “SitePages/auth.aspx”,

“removeSort” : [],

“contextMenu” : [“checkin”,”checkout”,”rename”,”view”,”viewNetDoc”,”delete”,”lockVersion”,”secureLink”,”follow”, “checkinNew”,”changeVersion”],

“showSearchBox” : true,

“showLogo” : true,

“assetPath”: “https://m365x634254.sharepoint.com/sites/AppCatalog/ClientSideAssets/23dea53d-fbee-49c3-8b16-c6b586b0422f/

}

For explanations of each property, what they do and what values should be used to change them, please see our Config Builder Properties Appendix at the end of the document.

Using Saved Search as a Flat View

Sometimes users want to see all documents within a certain container without having to navigate through sub-containers. This can be achieved by using Saved Search.

The savedSearch ID is needed to start. To acquire the savedSearchID, go to NetDocuments.com, choose a container (cab, workspace, folder, etc..), and search for all documents in that container. Once that is done, the search should be saved, and the ID can be acquired. In the example below, although the 3 documents may be contained within different subfolders, the saved search will let them all show up in the same view:

Your Primary Source should look like this:

“primarySource”: {

“id”: “4826-2537-5922”,

“type”: “savedsearch”

},

Viewtype: TreeView

The Tree View WebPart shows a collection of container objects (folders and workspaces) on the left pane, with a corresponding document-viewer pane on the right. Subcontainer objects such as filters, saved searches, CollabSpaces etc. will unravel and be reveal in a tree-like structure on the left pane as the user clicks deeper into the directory. In this view, all containers will appear on the left side pane and only documents will appear on the right-side pane.

Installation instructions:

Much like the set-up process for Document Viewer and Recent Doc WebParts, you will add the netDocShare TreeView WebPart from the netDocShare WebParts group under the Categories gallery and configure its settings by entering an App Configuration JSON Object inside the Config Settings field, and then clicking Apply. An example and explanation of this TreeView JSON Object is as follows:

{

“viewType”: “Tree”,

“netDocsClientId”: “AP-P0V245CC”,

“netDocsClientSecret”: “22neL4s4DF5WU18HBjdcMaUX2piUWkMzg460urwyr2xMCsf”,

“netDocsBaseUrl”: “https://api.vault.netvoyage.com/v2“,

“metaWebPartListLocation”: “Lists/MetaWebPart “,

“netcode”: “true”,

“metaWebPartTitles”: [“Know How”, “Business Plans”, “Documents”],

“sources”: [{

“id”: “4823-3491-4693”,

“type”: “folder”

},

{

“id”: “4812-5902-0677”,

“type”: “folder”

},

{

“id”: “4844-2657-1397”,

“type”: “workspace”

},

{

“id”: “4820-3844-3397”,

“type”: “folder”

},

{

“id”: “4851-5781-2357”,

“type”: “folder”

}

],

“columnProperties”: [“extension”, “id”, “createdBy”, “modified”],

“defaultSortProperty”: “”,

“filters”: [],

“CDNBaseUrl”: “https://dw1sp2013dev02.pillsburywinthrop.com:7070/“,

“AuthSuffix”: “SitePages/auth.aspx”,

“removeSort”: [],

“contextMenu”: [“checkin”, “checkout”, “rename”, “view”, “viewNetDoc”, “delete”, “lockVersion”, “secureLink”, “follow”, “checkinNew”, “changeVersion”],

“showSearchBox”: true,

“showLogo”: true,

“authPage”: “redirect”.

“assetPath”: “https://m365x634254.sharepoint.com/sites/AppCatalog/ClientSideAssets/23dea53d-fbee-49c3-8b16-c6b586b0422f/

}

For explanations of each property, what they do and what values should be used to change them, please see our Config Builder Properties Appendix at the end of the document.

Viewtype: Integrated Search

Note: This feature is only available to Enterprise level clients.

The integrated search webpart is a fully configurable view that can show consolidated search results from SharePoint search and NetDocuments search. It comes out of the box with the following features:

2 view type options: Accordian view and Tab view

A compact mode option which will only show the search box and automatically redirects to the results page (instead of executing search on the same page)

Configurable Search result tables with dynamic column retrieval or ability to manually edit JSON

Filters that can also be dynamically retrieved. Filters can be set as shared or individual in case of data mismatch or discrepancy between the two data sources

Its own configuration builder view

Please see the screenshots below displaying several different view options and configurations for this view:

Search box only: compact implementation

Accordian view with filters:

Tab view with filters:

Installation Instructions:

Integrated search requires an additional license option. This feature will only be enabled if the licensing process detects that your key has this feature enabled. If you do not, you may encounter an “invalid license” error.

Once the licensing has been established you will have access to 2 new viewtypes: intSearch and searchConfig.

Start off by creating a searchConfig webpart using the configuration below OR you may manually generate your JSON config object for intSearch if preferred:

{“viewType”:”searchConfig”,

“assetPath”: “{{ your asset path }}”

}

Your integrated search config object should look something like this:

{

“viewType”: “intSearch”,

“assetPath”: “your asset path”,

“altAssetPath”: “an alternate asset path”,

“netDocsClientId”: “AP-P0VO45CC”,

“netDocsClientSecret”: “22gU18HpBw460urwyr2xMCsf”,

“netDocsBaseUrl”: “https://api.vault.netvoyage.com/v2”,

“CDNBaseUrl”: ” https://m365x634254.sharepoint.com/“,

“AuthSuffix”: “SitePages/auth.aspx”,

“mode”: “accordian”,

“SPResultConfigs”: {

“listName”: “Matters”,

“subSite”: “sitetemplates/IPSite/”,

“columnProperties”: [“MatterNumber”, “ClientNumber”, “ApplicationNumber”, “PreviousFileRef”, “CountryName”, “MatterStatus”]

},

“NDResultConfigs”: {

“netDocsBaseUrl”: “https://api.vault.netvoyage.com/v2”,

“cabinetId”: “NG-6T8NGXSE”,

“clickBehavior”: “smartPreview”,

“columnProperties”: [“id”, “client”, “matter”, “modified”, “DocType”],

“contextMenu”: [“preview”, “checkin”, “checkout”, “download”, “view”, “viewNetDoc”]

},

“filtersOn”: true,

“resultsOn”: true,

“overrideCSS”: “your Override path”,

“filterAssociations”: [{

“Client”: [“ClientNumber”, “Client”]

}, {

“Matter”: [“MatterNumber”, “Matter”]

}, {

“Document Type”: [“”, “DocType”]

}, {

“Application Number”: [“ApplicationNumber”, “”]

}, {

“Previous File Ref”: [“PreviousFileRef”, “”]

}]

}

For explanations of each property, what they do and what values should be used to change them, please see our Config Builder Properties Appendix at the end of the document.

NetDocShare also supports the insertion of custom column properties. In order to use custom properties, please visit your NetDocuments cabinet admin page, and make sure that the properties are enabled in the cabinet. When inserting the property into the NetDocShare config, the spelling and capitalization must match exactly to the attribute that you have defined in the profile Attributes section of NetDocuments Admin.

Note: If you are creating a brand new column, it may take some time for the data to populate properly. Please wait a few minutes after creating the Profile Attribute for the data to be correctly associated in the NetDocuments API.

In the figure below, you can see the custom column “Testing” has been implemented.

Once custom columns are created, users can retrieve them by using the Config Builder to retrieve the columns of an existing source location such as Cabinet, Folders or Workspaces.

If the Config builder has not been created yet, the following steps will create one.

Create a new page or use existing Config Builder webpart. Adding the Config Builder is a good test to determine if the app has been deployed correctly because it is the only view which does not require authentication with NetDocuments.

After generating the NetDocViewer webpart, click edit button and wait till right panel shows up.

Create Config Builder webpart by pasting

{ “viewType”: “createConfig”,

“assetPath”: “your asset path here” }

to the NetDocViewer webpart.

(Optional) To modify an already existing config string, click the Import button on bottom left.

Copy and paste the JSON string. Then click Import. This process will populate the form with provided data.

Choose options that you would like to show on Webparts.

The possible options include:

View Type:

Normal View, Recent Documents, Favorite Documents, Saved Search, Tree View, and Authentication

Documents per page:

The number of documents loaded during the page-based scrolling. The minimum is 1, and the maximum is 50. This does NOT affect the amount of results initially loaded. This is determined by the type of container and its contents.

Net Code:

An option to leave the source blank, thus requiring the source to be derived from the net code.

Show Logo:

An option to show or hide the large logo in the upper left-hand side of the screen.

Show Search Box:

An option to be able to search through documents.

List Location:

Location of the list where you can find the Net Code.

WebPart Title:

The title of the List provided by the user.

Folder ID:

The ID of the folder, obtained in netdocuments.com *

Type:

Type of location. This can be a folder, workspace, saved search, CollabSpace, or cabinet.

Column Properties:

The desired columns displayed on the web part.

Context Menu:

What options are available in the dropdown context menu for each file.

Default Sort Property:

The category by which the documents are sorted when the page first loads.

clickBehavior:

This will toggle between different on-click behaviors for documents displayed

“openND” is the default. It will navigate to the document profile page on NetDocuments.com. As this is default, users can choose to leave out this config

“SLdisabled” will use the NetDocuments “GoID” feature to construct a URL. Navigating to the URL will open the document profile page on NetDocuments.com and also open a full-screen browser preview

“SLenabled” will use the NetDocuments “Secure Link” feature to construct a secure URL. This will directly engage the full-screen browser preview without going to NetDocuments.com

“smartPreview” will use the new smartPreviewer feature from NetDocuments to open a full screen preview of the document contents in a new tab or window

“download” will simply download the clicked document on to your local machine using the browser’s native download capabilities

Please don’t forget to press the “+” button next to fields such as CabinetID or else the form will not register the input.

The ID of workspaces and / or Cabinets can be found by inspecting the the following:

Workspace:
Cabinet:

After setting your desired configuration, click ‘JSON View’ or ‘Copy to Clipboard’ button to copy the JSON string.

Config Builder v2.4.2 Onwards: Auto-Query Features

From version 2.4.2 onwards, our config builder now has the ability to automatically query source IDs, names and custom columns directly from the NetDocuments API. This feature is available on all SharePoint environments and on Teams.

Simply choose a source Cabinet to start and then (optionally) a source workspace from our convenient dropdown menus to narrow down your choices of container to display. Users who are authenticated with NetDocuments will see their options automatically fill with content from their account. Users can still opt to manually paste a known 12-digit ID and also search for names of containers that they are familiar with.

Once a source has been chosen, users should see a button next to the Column Properties list that says “Get all Columns”. Note: Users must specify the source location in order for the button to appear since different sources can have different columns.

The retrieved names are column named retrieved directly from your NetDocuments account. From here, they can be added, removed or re-arranged to create a customized view.