Deployment Guide – netDocShare Content Browser

Introduction

netDocShare content browser is an add-on that can be used to view and interact with NetDocuments content inside your custom project. This document outlines how users can set up and configure the netDocShare content browser component.

netDocShare content browser component can be added to the following

.NET Core / MVC
PHP
Java
React/Angular Application
Angular JS

Learn how to map the netDocShare content browse component to the button.

Setup the configuration for workspace and folder sources.

Adding the netDocShare content browser component

Add the netDocShare content browse component to a particular path in your .NET or react or Angular project.

Example

Adding netDocShare license

Add the netDocShareLicenseKey.txt in this location “/netDocShare/assets/images/foldericons/”.

netDocShare automatically runs license checks every time our webparts are loaded. License checking requires an internet connection to verify with our servers.

If you see an error message which reads “Unable to locate license key” this means that netDocShare was unable to find your license key, contained in netDocShareLicenseKey.txt. Please ensure that this file is in the correct directory path.

If you see an error message which reads “Invalid License”, this means that netDocShare was able to find the key in your system, however, validating the key with our server has failed. This could be caused by anything from server outage to local internet issues to the expiry of the license.

Please contact netDocShare support if either of these messages are encountered and you are unable to resolve the issue.

Mapping the netDocShare content browser component to a button

You can program netDocShare to activate via a button by adding a button with a specific ID to your Html content. Add the button with the id entitled “netDocShareContentBrowse_In_iframe” Or “netDocShareContentBrowse_In_window”.

Using ” netDocShareContentBrowse_In_iframe” will open the content browser component in an iframe popup and using “netDocShareContentBrowse_In_window” will open the content browser component in window.

Example buttons:

<button id=”netDocShareContentBrowse_In_iframe” type=”button”> Browse by iframe </button>
<button id=”netDocShareContentBrowse_In_window” type=”button”> Browse by window</button>

Add the script to load the netDocShare content browse component JS file.
Example script:

netDocShare content browser component path

Add the path of netDocShare content browse component in the variable “NETDOCSHARE_PATH”. Which is used to get the path of the browse component inside the project.
Example: NETDOCSHARE_PATH = “/js/netDocShare/”;

Configuration

The config is used to set up sources, base URL, asset path, show and hide the buttons in the content browser component. Users can update the config on any page using the variable NETDOCSHARE_CONFIG. This variable must have the below JSON format which is used to load the browser component.

Config Example:
NETDOCSHARE_CONFIG = {
viewType: ‘browse’,
netDocsClientId: ‘AP-v0VO4sCA’,
netDocsClientSecret: ‘122neL4s4DfcMaUX2piUWkMzg4ggurwyr2xMCsf’,
netDocsBaseUrl: ‘https://api.vault.netvoyage.com/v2’,
CDNBaseUrl: ‘https://services.klobot.ai/playground/netdocsharecontentbrowse/’,
AuthSuffix: ‘https://services.klobot.ai/apps/live/netdocshare/srvc/auth’,
assetPath: ‘https://services.klobot.ai/playground/netdocsharecontentbrowse/js/netDocShare/assets/images/foldericons’,
sources: [
{ id: ‘4840-8329-8181’, type: ‘workspace’ },
{ id: ‘4821-7117-1787’, type: ‘filtersearch’ },
{ id: ‘4824-8325-7608’, type: ‘savedsearch’ },
{ id: ‘4846-3725-4171’, type: ‘folder’ },
{ id: ‘4820-3844-3397’, type: ‘folder’ },
{ id: ‘4837-1722-6497’, type: ‘savedsearch’ },
{ id: ‘4830-4108-5418’, type: ‘sharedspace’ }
{ id: ‘ myNDHomePage ‘, type: ‘ myNDHomePage ‘}
],
TableDisplayDocsOnly: false,
clickBehavior: ‘openND’,
showLogo: false,
showLogout: false,
searchBehavior: ‘searchAll’,
showSearchBox: true,
ndThread: false,
ndTasks: false,
showUpload: false,
showDownload: false,
showRefresh: false,
showFilter: false,
showExport: false,
allowMultiSelection: true,
showContent: ‘all’,
showFavoriteWorkspaces: true,
showRecentWorkspaces: true
showGotoWorkspace: false,
workSpaceContentDisplay: ‘ShowSummaryOrListView’
}

config-explanation

Config values that are not mentioned in this section can be safely removed from the config as they do not have an effect in this specific case.

viewType is mandatory and there is no need to change the value “browse”.
netDocsClientId, netDocsClientSecret, and netDocsBaseUrl are needed to access the NetDocuments Rest API. Omitting these values will cause the webpart to fail authentication.
CDNBaseUrl should be the root URL of your project. This URL must end with a forward slash: ‘/’
The NetDocsBaseUrl is the root URL used to retrieve API content from the API servers. For example. The US URL is: https://api.vault.netvoyage.com/v2 and https://api.eu.netdocuments.com/v2 for our EU/UK clients. Please follow the EU format for other regions.
AuthSuffix should be the URL https://services.klobot.ai/apps/live/netdocshare/srvc/auth. Which is used to authenticate NetDocuments.
assetPath is the full path where static assets are stored and must be obtained during deployment. This config is mandatory as it is also used to determine licensing information.
Your asset Path might look like the following:
{path of netDocShare content browse component}/assets/images/folderIcons/
sources property is used to add the multiple sources (using NetDocuments IDs) to display in the browse window
showLogo, showLogout, showSearchBox, ndThread, ndTasks, showUpload, showDownload, showRefresh, showFilter, showExport, showGotoWorkspace are optional properties that show or hide specific features from view. showLogo controls whether a netDocShare logo is displayed on the top left. showLogout, when turned on, will display a User greeting and the option to log out on the top right. showSearchBox hides or shows the search box.
allowMultipleSelection property is used to allow a user to select multiple selections or single selection if allowMultipleSelection is true it is allowed to multi selecting otherwise it is a single selection.
showContent property is used to show either documents or folders, else both. In the case of “folders”, showContent property will show only the files within a particulate folder, whereas in the case of “all” will show both files and folders.
workspaceContentDisplay property is used to show workspace content folders and documents in a separate view In configuration add the type and id as “myNDHomePage”, which is used to show the logged-in user home page content from NetDocuments.

Add NetDocuments home page as source

In configuration add the type and id as “myNDHomePage”, which is used to show the logged-in user home page content from NetDocuments.
For example, { id: ‘ myNDHomePage ‘, type: ‘ myNDHomePage ‘ }

Go to workspace

Go to workspace is used to show the specific workspace contents based on client and matter, also able to control go to workspace button based on configuration.
For example, showGotoWorkspace: false to hide the go to workspace button

When clicking the go to workspace button it will open the popup window and it shows cabinet, client, and matter fields once selected all the fields and click ok means it will open the selected workspace.

Enable summary or list view for Workspace

In workspace source, users can show the folders and documents as a separate view called summary view and list view using the property “workSpaceContentDisplay”

WorkSpaceContentDisplay property has two options called “ShowSummaryOrListView” and “ShowAll”.
“ShowSummaryOrListView” option is used to enable the summary or list view which is used to show folders and documents in a separate view.
“ShowAll” option is used to show folders and documents in the same view

Selected id collection

Users can select 1 or more items and click the save button. this will save the selected content ids as a collection in the “NETDOCSHARE_SELECTEDCONTENTS” variable.

END-USER netDocShare LICENSE AGREEMENT

This is a Legally binding agreement between you (either an individual or a single entity) and KLoBot, Inc. (“KLoBot”) for the “netDocShare” Software and associated media and printed materials, and many include online or electronic documentation for netDocShare Software Product or netDocShare Software (collectively “netDocShare”). By installing, copying or otherwise using netDocShare, you are agreeing to be bound by the terms and conditions of this agreement, including netDocShare license and disclaimer of netDocShare software warranty below. Please read this document carefully before using netDocShare. If you do not agree with the terms and conditions of this agreement you should not install or use netDocShare.

1. GRANT OF LICENSE; netDocShare USE RESTRICTIONS.
In consideration for your payment of any applicable license fee for netDocShare, KLoBot hereby grants to you a personal, non-transferable (except as expressly provided in Section 4 below) and non-exclusive right to use and execute netDocShare on a single Microsoft Office 365 SharePoint Online Tenant or Microsoft SharePoint on-premises farm (collectively “tenant”), without right to sublicense netDocShare. Under no circumstance may you store, use or allow the use of netDocShare in any manner on more than one tenant at a time. You agree that you will not reverse engineer, decompile or disassemble any portion of netDocShare. If you dispose of any media or apparatus containing netDocShare, you will ensure that you have completely erased or otherwise destroyed any netDocShare contained on such media or stored in such apparatus. Except as expressly provided in Section 4 below, you may not distribute, lease, transfer for profit, loan or otherwise convey netDocShare or any portion thereof to anyone.

2. COPYING RESTRICTIONS.
In order to effect your license rights hereunder, you may install netDocShare by copying it onto the tenant for use thereon, and you may make full or partial copies of netDocShare, but only as necessary for backup or archival purposes. You agree that

(i) your use and possession of such copies shall be solely under the terms and conditions of this Agreement, and

(ii) you shall place the same proprietary and copyright notices and legends on all such copies as included by KLoBot on the authorized copy of netDocShare that you downloaded from the netDocShare web site.

3. OWNERSHIP OF netDocShare AND MEDIA.
You agree and acknowledge that KLoBot transfers no ownership interest in netDocShare, in the intellectual property in any netDocShare or in any netDocShare copy, to you under this Agreement or otherwise, and that KLoBot and its licensors reserve all rights not expressly granted to you hereunder. After you pay any applicable license fees and/or the purchase price of the applicable KLoBot, you will own the media on which netDocShare was originally provided to you hereunder and on which you subsequently copy netDocShare, but KLoBot and its licensors shall retain ownership of all netDocShare and copies of netDocShare or portions thereof embodied in or on such media.

4. TRANSFER RESTRICTIONS.
If you transfer ownership of netDocShare you may transfer netDocShare and all licenses and rights in netDocShare granted to you under this Agreement to the transferee provided that:

(i) such transferee agrees in writing to accept the terms and conditions of this Agreement, and

(ii) you also transfer all netDocShare, including all copies thereof, to such transferee. Except as provided in this Section, you may not sublicense, transfer or assign this Agreement or any of your rights or obligations under this agreement, in whole or in part.

5. U.S. GOVERNMENT USERS.
If netDocShare is acquired by or on behalf of an entity of government of the United States of America, the following provision applies: U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND. Use, duplication or disclosure of SOFTWARE by the Government is subject to restrictions as set forth in FAR 52.227.19( c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer SOFTWARE clause at DFARS 252.227.7013 and/or in similar or successor clauses in the FAR or the DOD or NASA FAR Supplement. Unpublished rights reserved under the Copyright Laws of the United States. Contractor/manufacturer is KLoBot, Inc.

6. EXPORT RESTRICTIONS.
The software is exported from the United States in accordance with the Export Administration Regulations. Diversion contrary to U.S. law is prohibited. You agree that you will not:

(i) export or re-export the software, directly or indirectly, to Iran, Syria, Sudan, Cuba or North Korea; or

(ii) release the software to a person on the denied persons list, unverified list, entity list, specially designated nationals list, debarred list or nonproliferation sanctions list (see http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm ). The foregoing obligations will apply to you unless the Office of Export Licensing of the U.S. Department of Commerce has granted authorization to you in writing for the export or re-export of the software. Your obligations under this section shall survive any termination of this Agreement.

7. ENFORCEMENT OF TERMS; TERMINATION.
If you fail to fulfill any of your material obligations under this Agreement, KLoBot and/or its licensors may pursue all available legal remedies to enforce this Agreement, and KLoBot may, at any time after your default of this Agreement, terminate this Agreement and all licenses and rights granted to you under this Agreement. You agree that KLoBot licensors referenced in netDocShare are third-party beneficiaries of this Agreement and may enforce this Agreement as it relates to their intellectual property. You further agree that, if KLoBot terminates this Agreement for your default, you will, within thirty (30) days after any such termination, deliver to KLoBot or render unusable all netDocShare originally provided to you hereunder and any copies thereof embodied in any medium.

8. DISCLAIMER OF SOFTWARE WARRANTY.
KLoBot PROVIDES netDocShare TO YOU AS IS AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. NO ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN BY ANY KLoBot EMPLOYEE, REPRESENTATIVE OR DISTRIBUTOR WILL CREATE A WARRANTY FOR THE netDocShare, AND YOU MAY NOT RELY ON ANY SUCH INFORMATION OR ADVICE.

9. INTELLECTUAL PROPERTY RIGHTS PROTECTION.
If any third party brings a suit against you that is based on a claim that netDocShare, solely as furnished to you under this Agreement, constitutes direct infringement of any patent issued by, or copyright registered in, the United states, KLoBot shall defend such suit or proceeding and shall pay any damages and costs finally awarded therein against you with respect to such matter, provided that you promptly inform KLoBot of any such claim, furnish KLoBot with a copy of each communication, notice or other action relating to the alleged infringement and give KLoBot the authority, information and assistance necessary to settle, compromise or litigate such suit or proceeding. Following notice of a claim or a threatened or actual suit, KLoBot may, without obligation to do so, at KLoBot sole option:

(a) procure for you the right to continue to use netDocShare as furnished,

(b) replace or modify netDocShare to make it non-infringing, or

(c) discontinue your license for netDocShare and refund to you any license fee that you paid for it, less a reasonable value for use, determined by prorating such license fee on the basis of a thirty-six (36) month straight line depreciation method, applied to the period of actual use.

KLoBot shall not be obligated to defend or be liable for costs and damages if the infringement or claim thereof arises out of:

(i) use or combination of netDocShare with products or data not provided by KLoBot,

(ii) use of other than the latest unmodified release of netDocShare made available to you by KLoBot if such infringement would have been avoided by the use of such release of netDocShare,

(iii) modification of netDocShare by anyone by KLoBot,

(iv) use of netDocShare after receiving notice, or having reason to believe, that netDocShare infringes a patent or copyright of a third party, or

(v) a claim based on any portion of the Windows(r) software that may be included with netDocShare.

THE FOREGOING STATES YOUR EXCLUSIVE REMEDY AND KLoBot ENTIRE LIABILITY WITH RESPECT TO INFRINGEMENT OF ANY PATENT OR COPYRIGHT BY netDocShare, AND KLoBot SHALL HAVE NO LIABILITY WITH RESPECT TO ANY OTHER INTELLECTUAL PROPERTY RIGHT.

10. GOVERNING LAW.
This Agreement shall be governed by and interpreted in accordance with New Jersey law, excluding its choice of law rules.

11. TECHNICAL SUPPORT TERMS.

Definitions.As used herein the following capitalized terms have the meanings set forth below:

“Correction” means, without limitation, a workaround, maintenance release, patch and/or documentation change, as KLoBot deems appropriate.
“Defect” means a material failure of netDocShare to operate substantially in accordance with the applicable user guides and reference manuals.
“Update” means a maintenance or minor release of netDocShare that provides corrections or performance improvements, is designated by KLoBot as an Update and is generally made available to all KLoBot technical support customers.
“Upgrade” means a major release of netDocShare that provides new features or functional enhancement, is designated by KLoBot as an Upgrade and is generally made available to KLoBot Premium technical support customers.

Technical Support.

During any 12/24/36-month support period for which you have pre-paid the required premium support payment, KLoBot will provide you:

Notification, if you have requested to be notified, when Updates are available for downloading from netDocShare website at www.netdocshare.com ;
Notification, if you have requested to be notified, when Upgrades are available for downloading from KLoBot’ website; and
Access to My netDocShare Support Portal on KLoBot’ website through which you may:

- Download Updates when commercially available;
- Download Upgrades (Premium technical support customers only) when commercially available;
- Report Defects in netDocShare and obtain Corrections as described herein and in accordance with the types of response and timing referenced on KLoBot’ website;
- Request General advice on implementation, operation, functionality and use of netDocShare as described on KLoBot’ website;
- Participate in community forums, review KLoBot’ extensive knowledge base and obtain usage tips and other useful information regarding netDocShare, including up-to-date information on current releases, product compatibility, restrictions, enhancements, workarounds and fixes; and
- Access on-line documentation regarding netDocShare, including application notes that include installation instructions, release notes and Frequently Asked Questions (FAQs).

Defect Correction.

When you report a suspected Defect in netDocShare to KLoBot using its My netDocShare Support Portal, KLoBot will attempt, based upon information provided by you, to recreate the suspected Defect. If the Defect is confirmed, KLoBot will use commercially reasonable efforts, given the nature and scope of the Defect, to make available to you through the My netDocShare Support Portal a Correction in accordance with the guidelines set forth on KLoBot’ website. KLoBot will make available to Premium technical support customers live chat, telephone call back and live meeting support as appropriate and warranted to confirm Defects and develop Corrections.
KLoBot will not be responsible for correcting Defects in any release of netDocShare other than the most recent release of netDocShare, provided that KLoBot shall continue to support the prior release superseded by recent release for a reasonable period sufficient to allow Premium technical support customers to implement the newest release or until the end of the current non-Premium technical support period.
You agree to implement within a reasonable time all Corrections provided by KLoBot hereunder.

Limitations.

KLoBot will not be obligated to provide technical support relating to problems, errors or malfunctions caused by

malfunction of the computer system and communications network on which you have installed and are using netDocShare,
other software installed in the same SharePoint environment not licensed pursuant to this Agreement,
any use of netDocShare in disregard of any known adverse consequences, including without limitation the failure of user to make appropriate backups, warning messages, and other written instructions,
any modification to netDocShare not authorized by KLoBot,
Mainstream Support of a given SharePoint Platform has been retired by Microsoft, or
any other cause not attributable to KLoBot.

Renewal of Support.

KLoBot provides the first year of basic technical support for no additional charge. Unless renewed in accordance herewith, basic technical support will cease on the last day of the 12-month support period that commenced upon the effective date of netDocShare license.
For an additional fee, you may obtain Premium technical support. Unless renewed in accordance herewith, Premium technical support will cease on the last day of the support period for which you have paid the additional Premium technical support fee.
Support fees for additional support periods must be paid in advance on or prior to last day of the support period for which you have paid the required support fee.
Approximately forty-five (45) days prior to the termination of the then current support period, KLoBot will invoice you for renewal of technical support. The support fee due for the next support period shall be KLoBot’ then current applicable list price for renewal of technical support as of the date of invoice.
KLoBot reserves the right to withdraw technical support of netDocShare, and to alter the prices, terms and conditions for technical support in advance of any renewal of support. Any such withdrawal or alterations will become effective as of such renewal date.

Reinstatement of Support.

If you allow technical support to expire, in order to reinstate support of netDocShare, you may be required to pay to KLoBot a reinstatement support fee, the then current annual support fee, and, If you are not licensing the then current release of netDocShare, an upgrade license fee for the current release of netDocShare.
Required Identifier.

In order to access My netDocShare Support Portal you must provide the identifier issued to you when you licensed netDocShare. Upon entry of such identifier access will be granted if you have paid in full the required maintenance fee.
Termination of Technical Support.

Notwithstanding Section 4 above, resale, assignment, or transfer of the technical support provided by KLoBot is strictly prohibited and will be grounds for termination of the technical support.

Connect with us