User Guide – netDocShare Admin app

Introduction

This user guide is a general overview of how to use and access the netDocShare Admin App designed for netDocShare Admin Users. In this Admin app, Admins can have the ability to control the Global settings that can reflect in the configs of each webpart or tab implementation of netDocShare.
In This documentation we will cover the below mentioned parts.

What is the Admin App and how to access it
Why to use the admin app and common use cases
A Walkthrough of the admin App interface
Global Defaults, overrides and how they will affect your webparts

Note: netDocShare Admin App is introduced in netDocShare version 3.2.0.2503. Using the admin app with a version of netDocShare earlier than 3.2 may cause issues as older versions of netDocShare do not support the processing of global Configs.

What is the Admin App?

The admin app is specially created for netDocShare admin users to view and manage global Configurations for netDocShare config settings. As you may know, netDocShare uses config options to control every aspect of what the users can view and interact with, as well as many default settings that are required for the netDocShare to function.

Using this app, administrators can control the config settings by restricting the override options for certain settings or by applying the pre-defined defaults which will be customized for your environment and replace the factory default settings. This system is applicable for SharePoint, Teams Custom Tabs and WebApps.

The admin app is a service hosted by KLST which can be reached with this url:

https://admin.netdocshare.com/

Who can use Admin App?

netDocShare Admins can use this Admin app. Admins are automatically set to primary contact user emails when a client creates an account with our company. Admins are also be able to manage this list to add or remove user emails. Navigate to Admin Users page and add valid users’ Email IDs or remove them and click “save” to persist.

Why use the Admin App?

By default, we allow users to edit all config settings. We also provide some factory defaults that may or may not be fitting for your specific environment. Typically, users will have to change these settings on each webpart or tab that they wish to customize.

However, using this Admin app provides a solution which allows administrators to set up trusted defaults that will be applied across ALL SharePoint webparts or ALL Teams tabs. Admins can also override specific settings only, the experience can be as general or as granular as desired. As shown in below image Admins can allow whatever the settings that user can edit override.

Overall, there are 2 main questions that an Administrator must decide when setting up configurations globally:

Does this setting need to have a default value that is different that the factory default?
- If yes, then picking an option in the admin app will globally provide your selection as default in all environments
- If no, then not picking an option will set the app to use individual user-defined values or factory defaults for that config option
Should users be able to change from the setting that is provided to them?
- If yes, then turning off “Allow override” in its respective environment will disallow users from changing this setting
- If no, then turning on “Allow override” will let users change the setting

Using the system above there can be 4 different results for each setting:

Default setting is provided via global config and user is NOT able to change it
Default setting is not provided, user is NOT able to change it (this means the setting is effectively disabled or forced to use factory default)
Default setting is provided via global config but user is able to change it
Default setting is NOT provided and user is able to change it (the setting will use factory default but user is able to change it. This is the state that existed before Admin App)

Example Use Cases

Let us get through some examples to understand the Admin app more clearly.

Case 1: Defaulting display options to “off” and hiding them

In the example below, we have disabled override options for some settings which will restrict users from overriding in SharePoint. We have disabled Show Logo, Show Logout and Show Search Box with the pre-defined settings.

Show Logo : – Disable

Show Logout :- Hide

Show Search Box :- Hide

Now if the user navigates to a Config page or attempts to edit an existing webpart using config builder, they will be unable to edit these settings. They will see prompt message in the tooltip that states “This setting cannot be overridden!”.

In this state, all users across SharePoint & Teams will no longer be able to edit these 3 properties and also they will be provided default values which will disable and hide these display options.

Case 2: Removing undesired behaviors

In this case, we would like to remove “delete” from the list of available context menu options and disallow it in Teams only. This means that SharePoint users will still be able to add the “delete” option but now, Teams users will no longer be able see or select this option. To achieve this, simply de-select the ‘delete’ item from the list of context menu items and “allow override” in SharePoint only.

Case 3: Providing global defaults

In the final example case, we are setting up global defaults for settings that should rarely be changed. For example, in this case, we are setting default click Behavior to “Preview with Smart Previewer system”. Setting override to false for all environments should disallow users from deviating from this option on all environments.

Walkthrough

Here is a detailed walkthrough that goes through every step of accessing and manipulating the configs. To enter the netDocShare Admin App panel, the client will need to providde a valid License key. This license key is typically provided by KLST when netDocShare is purchased.

After entering the License key, it will start validation. Once that is successfully completed, it will allow the user to authenticate with NetDocuments.

Now click on Login to NetDocuments button.

Enter valid netdocuments credentials to complete the auth process. After completion of the auth process it will lead to Admin app home page with success message.

Navigate to the Admin Users page to add or remove administrator emails.

Navigate to Valid domains page to add or remove domains which have permission to edit the Admin settings.

On the Policies page, admins can provide custom defaults for all the values in the form and allow or deny the option to override that setting. If the admin allows override then the user will be able to change the setting, otherwise the global setting that the admin has chosen will be applied. If no global Setting is chosen, a factory default setting will be applied.

Authentication

Admin Users can access the Admin App by entering a Valid License key.

Enter Valid License Key

After entering valid license key user need to verify captcha.

Once the captcha is successfully verified the license validation will start. If the License key is successfully verified, it will enable the Login to NetDocuments Button.

Users need to authenticate with NetDocuments login credentials.

After completion of all the authentications user will be navigated to Admin App home page.

Main Settings Screen

In the main settings screen, we will cover Company Details, Admin Users and Valid Domain details.

Company Details: Here we will get the Organization details along with Office address and Primary contact number which are derived from the license info that is stored in the KLST client database. You may change any settings here to update your firm’s information.

Also, we have additional settings of Admin Contact Name and Email ID which can be editable. These are the details end users can directly contact for any assistance.

Admin Users: As we can see below, we can add or remove admin users who can have the ability to access the admin app. These allowed users can manage all the settings in the admin app.

Valid Domains: In a single firm we may have multiple domains. By using this Valid domains we are able to control which domain user can able to access the Admin App.

Global Config

The Global config is the main part in the Admin app. Here only the Admin can restrict the settings that can be controlled by the users. As we can see in the screenshot below, Admins can Allow Override or not. Based on these settings only the config screens will be updated accordingly.

Note: Admin must select the Pre-defined setting to restrict the override option. Otherwise, users may end up with trying to select the setting.

Allowing Override

Admins will have almost all the settings to control except settings that are specific to particular web part view. For example, we are not allowing the compact mode options to be changed in admin settings because it is specific to normal view. Similarly, there is an option for treeview which determines whether the table shows only documents or documents AND containers, this option is also not available in the Admin interface.

If the Admin allows override, then users will be able to change the settings using the config builder or by manually editing the JSON. If admin does not allow the override, then users will get whatever the setting provided by Admin.

Config Appendix

NetDocShare uses a JSON-formatted config object to customize views and webparts to suit a user’s needs. In the admin app, Admins can restrict the settings that can be overridable. Below you will find a list of possible properties admin can restrict.

Base Properties

CDNBaseUrl should be the root url of your SharePoint Site Collection. This URL must end with a forward slash: ‘/’

AuthSuffix should be the relative path of the page where the netDocShare Auth WebPart exists. An example webpage URL for the Auth WebPart would be:

https://{yourSharepointTenant}/SitePages/auth.aspx

NEW: Starting from version 2.4.1, users may input a Universal Authentication URL instead of one which leads to the auth page. Please see our Service-Based Authentication section for more info.

assetPath is the full path where static assets are stored and must be obtained during deploy. This config is mandatory as it is also used to determine licensing information.

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 Share Point on Prem Your asset Path might look like the following:

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

AuthPage is an optional, but very important property which will determine what type of Authorization process is preferred. The two available types are: iFrame and single-page redirect.

iFrame uses a popup window to display the login or Allow/Deny screen presented by NetDocuments.

The redirect option will change the current page url and navigate to the Auth page.

We recommend using iFrame as it tends to have a better user experience, however, we understand that many of our clients may work in environments which block iFrames by default.

In that case, please be sure to include this “authPage” config in ALL webparts intending to use this system and set to ‘redirect’. If this config is NOT included, the webpart will default to ‘iFrame’ behavior.

Once again, if you are intending to use the ‘redirect’ option for Auth, please include “authPage”: “redirect” in ALL webparts, not just the Auth webpart. If you are intending to use iFrame, you may omit this property in all webparts.

Additionally, if you wish to auth page with redirect enabled, once the page has been created you will not be able to edit the page, due to the default behavior of the page, that redirects you to the netdocuments auth pages.

Optional Display Properties

ndThread is a property used to hide or show a second tab which will connect to the ndThread instance that is associated with the current container on the NetDocuments ndThread site. Setting it to true will show the tab, setting it to false will hide it.

ndTasks: ndTasks is a property used to hide or show a third tab which will connect to the ndTasks instance that is associated with the current container on the NetDocuments ndTasks site. Setting it to true will show the tab, setting it to false will hide it.

menuSize property controls the size of the context menu mentioned in the above section. There are 3 sizes available: Small, Medium and Large, denoted by the letter’s ‘s’, ‘m’ and ‘l’. The default is small and omitting this property will set the webpart to use the default option.

showLogout is a property which control whether or not the welcome message on the top right appears. This message can be clicked to reveal a small dropdown containing the ‘logout’ option. The default value is false, omitting this value will set the value to false.

Note: On the Microsoft Teams implementation of our app, logout is required on every page, therefore this property is set to true and will not be editable by users

filters are an array of key-value pairs, denoting specific NetDocuments property filters you wish to place on the Web Part. The example above includes two filters for the document “property”: “Ext,” and the specific extension “value(s)”: “doc” and “pdf”. The filters array can take any specific filter-key-value-pair in relation to the list of NetDocuments properties noted previously, and desired values for those properties.

showSearchBox is to show or hide the search box to execute filtering on the container contents or execute a full API search to the parent container.

Example: “showSearchBox” : true, //Accepts Boolean

showLogo is to show or hide the netDocShare logo image at the top left. Note: Image can be customized by replacing the file in the static images' library.

Example: “showLogo” : true //Accepts Boolean

autoRefreshTimer will refresh the WebPart every 15+ seconds.

Example: “autoRefreshTimer”: 15 //Accepts int that is bigger than 1

authMsg is an optional value that is used to display an optional message that will be displayed when users authenticate with NetDocuments. Administrators tend to use this feature to reassure users that the login popup is part of the document retrieval process. Please see the image below for an example:

If you are editing JSON manually, you may insert html and css elements as a string to display a customized message. For users editing using the JSON config Builder, we have provided a rich-text editor as seen below:

Note: NetDocuments Configuration Properties are case-sensitive, follow the official spelling and character case as shown above.

Search Behavior is a global feature that exists on every WebPart. The search bar can be turned on or off in the configuration. Search functionality will vary depending on the type of content that is retrieved by the WebPart and also how it is configured. There are 2 main options for search configuration: “Search Current View” or “Search All”.

Search Current View: Will execute a search on NetDocuments with the current container as the search scope (including sub-containers). It will return all results matching the metadata columns of the existing view.

Search All: Will execute a search on NetDocuments with the current container as the search scope (including sub-containers). It will search across all metadata including keyword searching the content of the document.

Note: Search All cannot expand the search scope beyond the original source container.

Context menu determines what options will appear in the dropdown context menu that is opened from clicking the “…” button beside each document.

Default click behavior: The Default click behavior will define how the click behavior acts when user click on the documents. We have multiple behaviors as given below. Profile on NetDocuments (Default): opens document on NetDocuments.com. Preview with Secure link Enabled: opens preview in full screen. Preview with Secure link Disabled: opens on NetDocuments.com and preview will open. Preview with Smart Previewer system: opens preview pop up of the document within the window.

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