User Guide – SPFx

This guide is a general overview of how to use and configure the imDocShare SPFx Web Parts designed for SharePoint Online, and SharePoint on-Prem for 2016 and later. It is important to note that the SharePoint framework (SPFx) is not compatible with SharePoint environments older than SharePoint 2016. Specifically, SPFx requires the “Feature Pack 2” update which comes with SharePoint 2016.

If you would like to use imDocShare WebParts for SharePoint 2013 on-Prem environment, we provide a different Visual Webpart solution that has the correct compatibility to support older environments. This documentation also does NOT cover the installation and usage of imDocShare on Microsoft Teams, please consult our documentation for the Teams App for more info.

imDocShare WebParts can be configured and customized in several ways to show the most appropriate documents and containers for a respective user or situation. These Web Parts include*:

  1. imDocShare Document Viewer
    • Normal View
    • RecentDocs View
    • Search Folder View
    • Favorites View
  2. netDocShare Tree View

*On-Premises deployments will instead come with a universal Doc Viewer webpart which can be converted into all the above webparts by changing the webpart configuration. Integrated search is only available through extra license purchase.

Classic vs Modern pages – imDocShare WebParts can be used on both classic and modern pages. This guide mostly focuses on classic but has several sections that feature modern screenshots prominently. Please look for sections entitled “Classic vs Modern”, which should be at the end of every section of instructions.

This is not a guide for deploying the SPFx WebParts to SharePoint. This documentation assumes that an Admin user has already deployed the SPFx project into the Site Collection’s App Catalog and the webparts are ready to use. If you need help with deployment, please see our documentation entitled “imDocShare SPFx Webparts Deployment Guide”.

Note: Site Collection Libraries MUST be able to host JSON and JS files or else deployment will fail. Any security measures that block Popups or iFrames must be turned off as our authentication uses these resources. Please see the auth section for an alternative workaround which uses ‘redirect’ authentication.

Supported Browsers:

  • Microsoft Edge
  • Google Chrome (latest released version)
  • Mozilla Firefox (latest released version plus immediate previous version)
  • Apple Safari (latest released version)
  • Internet Explorer 11 (limited support only. IE11 Protected Mode is not supported)

Not Supported Browsers:

  • Internet Explorer 10
  • Internet Explorer 9
  • Internet Explorer 8
  • Internet Explorer 7
  • Internet Explorer 6

imDocShare comes with a unique license ID which will be verified on load. If you receive a message saying “Invalid License” this means that the App was able to load successfully but it was not able to retrieve your licensing info.

When receiving our imDocShare deployment materials, you should also have received a imDocShare LicenseKey.txt file. This file contains your unique key which will activate imDocShare and the specific features that you have requested. In order to activate, simply drop the key file, which we have provided, into the library where our assets were deployed. Neglecting this step will yield licensing errors and will not allow usage of the app.

For Sharepoint Online:

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

For Sharepoint On-Premises:

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

Attempting to use the app without putting in the license key will be able to yield the exact path in an error message similar to the one shown below:

All the WebParts included in this project have a few global features that are common among components regardless of which view you are using:

iManage REST API service:

The WebParts feature automatic authentication once a user has logged in once, in the same browser. This state will last for the length of your token expiration, which can be set in your application settings on iManage. Authenticated users can query any documents or source locations that they have permission to access on iManage. Users are also able to execute actions that make changes to the documents, such as add/remove favorite or Uploading a new document to a location.

Search:

All WebParts feature a search bar in the top right corner, that can be used to filter through contents or search through all containers that are set as document sources. More about this feature can be found in the section on Search.

Favorites:

Documents and containers can be set as favorite. Favorited documents and containers will be displayed in the “Favorites” view.

Configurable table view:

All components have configurable table columns which you can include in the initial AppConfig Object. Column data is based on the standard and custom fields that exist on each iManage entity. These attributes are listed further below.

If you omit the values for ``columnProperties``, our webpart will use the default properties: version, id, extension and modified date. This can be changed by editing the JSON manually or picking the values from the corresponding dropdown menus in the config Builder.

If you omit the values for ``contextMenu``, our webpart will select all available menu options by default. This can be changed by editing the JSON manually or picking the values from the corresponding dropdown menus in the config Builder.

Sorting:

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

View Document:

All documents displayed in a WebPart, upon click, will (by default) open the document’s preview page which is powered by iManage. 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:

Open iManage preview (default):

Clicking on any document will open the document in the iManage preview window

Open in iManage (default):

Clicking on any document will open the document’s page in the iManage.com website

Download:

This option will simply download the selected document on click

Search is a global feature that exists on every WebPart. Search functionality will vary depending on the type of content that is retrieved by the WebPart. The search bar can be used as an API search that sends a query to the IManage API for matching content or metadata information.

In cases where prominent subfolders exist, such as in workspaces with subfolders or in TreeView where there are multiple sources, the user will see a search button denoted by the standard magnifying glass icon.

When the user clicks the search button or presses enter with a search term, the WebPart will execute a query to iManage that searches through all containers and sub-containers that are contained within the primary container which contains the source location used. The current contents of the display table will then be replaced by the search results. Users can revert to the previous view by pressing the “x” button inside the search box.

User can select the ‘filter icon’ to filter column data based on the current data being displayed in the table. Enter a filter query into any of the column fields and the view will update with current data that matches the query.

A user can end the filtering by either clicking the ‘x’ in the field where a filter query was entered, or by re-clicking the ‘filter icon.’

Users can upload a new document into any WebPart which has a specific source location that is a container. For example: folders and workspaces are valid containers that one can upload to. Whereas, views such as RecentDocs or Favorites or Saved Search View are not valid containers and therefore cannot be uploaded to.

Simply click the upload button and it will open an upload dialog window. In this window, users can choose a file from their local machine to upload.

In TreeView, there are usually multiple sources displayed. In this case, the upload destination will be the latest workspace/folder/sub-folder selected by the user.

The uploaded documents will immediately be sent to your iManage repository barring any error happening. Users will be notified of any errors during upload. Please note that, even after successful upload, in some limited cases, the user’s view on imDocShare may not immediately update to show the newest upload. This is due to the fact that iManage processes and indexes the files in the background and the indexing priority tends to be lower for API uploads. This can be avoided by waiting a few minutes and refreshing the WebPart.

imDocShare Config Builder is one of our essential webparts when working with imDocShare for the first time. The Config Builder can be used to help create configs for all the other webparts

Note: More information about the Config Builder can be found in “How to use Config Builder”

Creating A Config Builder webpart

Create a new page or use existing Config Builder webpart.

After choosing the IManageViewer webpart, click edit button and wait till right panel shows up. At this point, you will be able to tell whether the App has loaded successfully or not. If you see a message stating “Please input your iManage Configuration Object”, the webpart is ready to configure and use. If you see any other message, some part of the deployment has gone wrong. Please ensure that imDocShare has been deployed properly by seeing our Deployment Guide. Create the Config Builder webpart by pasting the following into the webpart configuration window on the right side:

{ “viewType”: “createConfig”,

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

The assetPath determines where the webpart will load its code and assets from. Typically, this can be found during the deploy 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 assetPath might look like:

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

Again, more information about the Config Builder can be found in “How to use SP Config Builder.”

The process of authenticating with iManage requires some steps in your iManage administration account. This can be reached through https://cloudimanage.com/work/.

In order to obtain the ClientID and ClientSecret (required for each webpart), you must create an “app” on https://cloudimanage.com/work/cc/applications/list. If this step has not been completed, please see our imDocShare pre-requisites guide before proceeding with anything else in this guide.

Access tokens have a limited lifespan. Users can customize the expiry for these tokens in the application screen on iManage:

If an API is made with an expired token, a 401 Unauthorized status is returned. imDocShare automatically processes expired tokens and attempts to retrieve a new token when required. For this, we use refresh tokens which last much longer.

This is different from a login lifetime when using iManage itself. iManage for security reasons will log out users automatically after 90 minutes of inactivity. As a iManage user, you can enable an automated login option if your organization has Microsoft Active Directory Services.

If an API is made with an expired token, a 401 Unauthorized status is returned. imDocShare automatically processes expired tokens and attempts to retrieve a new token when required. For this, we use refresh tokens which last much longer.

This is different from a login lifetime when using iManage itself. iManage for security reasons will log out users automatically after 90 minutes of inactivity. As a iManage user, you can enable an automated login option if your organization has Microsoft Active Directory Services.

Clicking on this will reveal a logout option which will remove the iManage session from the browser. Note: This will log you out of iManage in every tab of the current browser. The page will refresh automatically, and users must login to iManage before resuming usage.

Invalid URL error

Users must make sure that the URL they submit to https://iManage.force.com is EXACTLY the same as their auth page URL. This must match case and spelling exactly or else it will throw invalid URL error. This includes http and https.

Duplicate Webparts

In some older SharePoint versions, webparts linger on the page even after they have been deleted. The number of webparts can be seen here:

If there is more than one webpart on a page, it will impact how our software will function, e.g. the page might have multiple auth popups among other things, as the hidden webparts will still be loading code. To remove the unnecessary webparts officially, open the page in Web Part Page Maintenance and remove hidden webparts.

Auth failing to refresh or redirect

If Authentication is failing to redirect or failing to reload the page after logging in or clicking the “Allow / Deny” prompt, this may be due to existing errors on the page which may block attempts to navigate to another page. In order to avoid this, or to test whether this is the issue, please insert our webpart on a blank Sharepoint page that loads no other content such as ScriptEditor webparts or scripts embedded into the Master Page. If the webpart can work on the blank page but not on the original page, there is some content that is blocking the functionality of our app. In this case, we recommend fixing the existing errors on the page or using a page which does not load the problematic content.

The document viewer WebPart is the core of our application. It comes out of the box with 5 varied and configurable viewtypes.

In normal view, it can show a single source: a workspace, folder or special folders such as category folders, or search folders.

In RecentDoc view, it can show the user’s most recent document or workspaces

In Favorites view, it can show user-specified favorite documents or folders

Normal View also makes use of a breadcrumb Trail which is a visual indicator which shows the received primary source as the “root” and when navigating through subfolders, creates a sequential list of containers that can be navigated back to at any point. In the above example, “Bill – Info” is the root source that is defined in the configs. The user in the example has navigated 5 levels deeper to find the document named “Contract 19342342” and they can click on any sub-container name to travel directly back to that container. Uploading a document while inside a sub-container will upload to the sub-container instead of the primary source.

You can add the Document Viewer WebPart by picking it in the same menu where you added the Like all our webparts, 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:

Viewtype: Normal View

{

viewType“: “normalView”,

assetPath“: “https://{your-tenant}.sharepoint.com/sites/AppCatalog/SiteAssets/80f7bcb7-98fe-43d7-8c8d-cbafb53acd81/”,

primarySource“: {

“id”: “Active!88”,

“type”: “folder”

},

columns“: [“name”, “version”, “id”, “edit_date”, “type”],

libraryId“: “Active”,

clientID“: “ff6c96e7-c007-4421-ab54-e8e3fa28f241”,

baseURL“: “https://cloudimanage.com”,

contextMenu“: [“download”, “delete”, “rename”, “favorites”, “checkOutIn”, “prevTab”, “prevBrowser”],

searchBehavior“: “searchContainer”

}

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: Recent Doc

The Recent Doc viewtype is a different configuration of the Document Viewer Webpart that shows a collection of recent documents or workspaces that are derived from the individual user account of the iManage 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“: “normalView”,

assetPath“: “https://{your-tenant}.sharepoint.com/sites/AppCatalog/SiteAssets/80f7bcb7-98fe-43d7-8c8d-cbafb53acd81/”,

primarySource“: “recent”,

columns“: [“name”, “version”, “id”, “edit_date”, “type”],

libraryId“: “Active”,

clientID“: “ff6c96e7-c007-4421-ab54-e8e3fa28f241”,

baseURL“: “https://cloudimanage.com”,

contextMenu“: [“download”, “delete”, “rename”, “favorites”, “checkOutIn”, “prevTab”, “prevBrowser”],

searchBehavior“: “searchContainer”

}

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 iManage 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 primary Source.

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

{

viewType“: “normalView”,

assetPath“: “https://{your-tenant}.sharepoint.com/sites/AppCatalog/SiteAssets/80f7bcb7-98fe-43d7-8c8d-cbafb53acd81/”,

primarySource“: “favorites”,

columns“: [“name”, “version”, “id”, “edit_date”, “type”],

libraryId“: “Active”,

clientID“: “ff6c96e7-c007-4421-ab54-e8e3fa28f241”,

baseURL“: “https://cloudimanage.com”,

contextMenu“: [“download”, “delete”, “rename”, “favorites”, “checkOutIn”, “prevTab”, “prevBrowser”],

searchBehavior“: “searchContainer”

}

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.

Other Views: Category folder, Search Folder

Other view types such as category folders and search folders are accessed in the same way that regular folders are. Simply use the ID of the specialized folder the same way you would with a regular folder.

Viewtype: TreeView

The Tree View WebPart shows a collection of container objects (folders, workspaces, specialized folders) 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.

Installation instructions:

The Tree View WebPart shows a collection of container objects (folders, workspaces, specialized folders) 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.

{

viewType“: “treeView”,

assetPath“: “https://{your-tenant}.sharepoint.com/sites/AppCatalog/SiteAssets/80f7bcb7-98fe-43d7-8c8d-cbafb53acd81/”,

columns“: [“name”, “version”, “id”, “edit_date”, “type”],

testValue“: “false”,

libraryId“: “Active”,

clientID“: “ff6c96e7-c007-4421-ab54-e8e3fa28f241”,

baseURL“: “https://cloudimanage.com”,

primarySource“: [{

“id”: “ACTIVE!148”,

“type”: “folder”

}, {

“id”: “ACTIVE!150”,

“type”: “folder”

}],

contextMenu“: [“download”, “delete”, “rename”, “favorites”, “checkOutIn”, “prevTab”, “prevBrowser”],

searchBehavior“: “searchContainer”

}

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.

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

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

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

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.

After generating the IManageViewer webpart, click edit button and wait till right panel shows up. All webparts require configs, even the config builder itself. Thankfully, unlike the other webparts, Config Builder only requires 2 configs.

Create the Config Builder webpart by pasting

{ “viewType”: “createConfig”, “assetPath”: “your-asset-path-here” }

to IManageViewer webpart.

For more information on how to obtain your asset Path please see the Config Builder Properties Appendix.

(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

Column Properties:

The desired columns displayed on the web part.

Context Menu:

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

Please refer to the Config Builder Properties Appendix to see a full list of config values and what options are available to fill them out.

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

Please refer to the URL on iManage.com to find out ID codes for each document or container.

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

If deciding to modify an existing page, then click on “edit” button, and click on the IManageViewer webpart. After right panel pops up, replace the config that was generated using Config Builder into IManageViewer web part.

Click ‘Publish’ to publish the page.

Step-By-step instructions for how to update an existing Web Part:

  1. From the Home page in your SharePoint account, navigate to Site Contents on the left-hand side menu.
  2. Click Site Pages .
  3. Select the page in which you wish to edit the imDocShare Document Viewer Web Part. In the example below, we are selecting a “Test” page.
  4. Click Page in the upper left-hand corner.
  5. Click Edit Page on the far left.
  6. Click the Web Part menu (small arrow in the upper right-hand corner) and then select Edit Web Part.
  7. Select Extended Settings at the bottom, and then select the ellipsis button to the right of the Config Settings field. Note: this feature only works in Internet Explorer browser.
    If you are using a different browser, you can simply click inside the Config Settings field and paste the App-Configuration JSON Object directly.

  8. Edit the App-Configuration Document Viewer JSON Object within the Text Editor – Webpage Dialog window, then click OK.
  9. Lastly click Apply.

Additional Feature: Compact Mode

You can also enable compact mode from the Config Builder. This feature will enable the simplest form of imDocShare by only showing the list of files.

You can also modify the length and height of this table on Config Builder.

Classic vs Modern

Add a page by navigating to Pages, which should be a tab link in the homepage of the site collection.

Note: Make sure that the page created for the webpart is specifically a “webpart page” instead of “wiki page,” which is the default option. Clicking “new” to create a new page will default to wiki page. Working with webparts on a wiki page is possible, however, may cause unexpected issues.

From here you can simply create a new page and use the edit buttons that you see on the page instead of the ribbon. In edit mode, press the + button to add a new WebPart.

The WebPart should be available in this list if you have deployed correctly:

Once you have added the WebPart, click on the edit (pencil button) on the top left to bring up the properties pane and enter your configuration. The WebPart should respond and begin its document retrieval process immediately upon entering the config.

Much like the update process for Document Viewer, Recent Doc, and Saved Search Web Parts, you will edit your imDocShare TreeView Webpart by clicking on the Web Part Menu (small arrow in upper right-hand corner of Web Part), clicking Edit Web Part, click Extended Settings, and depending on whether you are using Internet Explorer browser, click the Ellipsis to the right of the Config Settings field, or if you are using any other browser, click within the Config Settings From there, you can directly edit the App-Configuration TreeView JSON Object. Don’t forget to click Apply when you’re done!

Classic vs Modern

Add a page by navigating to Pages, which should be a tab link in the homepage of the site collection.

Note: Make sure that the page created for the webpart is specifically a “webpart page” instead of “wiki page,” which is the default option. Clicking “new” to create a new page will default to wiki page.

From here you can simply create a new page and use the edit buttons that you see on the page instead of the ribbon. In edit mode, press the + button to add a new WebPart.

The WebPart should be available in this list if you have deployed correctly:

Once you have added the WebPart, click on the edit (pencil button) on the top left to bring up the properties pane and enter your configuration.

ImDocShare uses a JSON-formatted config object to customize views and webparts to suit a user’s needs. Below you will find a list of properties and their possible values. All properties should be editable in a more user-friendly fashion by using the SharePoint Config Builder webpart, however, more technical users can also edit these properties manually in the JSON.

Base Properties

Base properties are fundamental requirements of each webpart. They often set baseline properties that are required for the webpart to work in the first place.

  • viewType is the property that tells SharePoint which imDocShare WebPart to load. The available values are: ‘normalView’, ‘treeView, ‘createConfig’.
  • ClientId, and BaseUrl are needed to access the iManage Rest Api. This can only be obtained by making a new app on https://cloudimanage.com/. More info in the section entitled “Authenticating with iManage”.
  • The IManagesBaseUrl is the root URL used to retrieve API content from the API servers. This will differ only between On-Prem enviroenments. For all cloud customers the baseURL should be: https://cloudimanage.com/.
  • 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/imDocShare/CDN/assets/images/folderIcons/

Source Properties

Normal View can be configured to show a specific source container. TreeView can be configured to show several source containers. The ‘primarySource’ property is used to control this.

  • primarySource is the container object that you would like DocumentViewer to display. primarySource is always required, even if using a source that does not have an explicit source ID such as Recent Documents. primarySource can be a folder, workspace, Category, Search folder. In the case of a workspace, primarySource can look like
    • “primarySource”: {“id”: “ ACTIVE!136″, “type”: “workspace”}
    • A recent documents source will look like this “primarySource”: “recent”
    • A favorites source will look like this: “primarySource”: “favorite”
  • primarySource in Treeview will be an array of objects rather than a single object with properties. The format of the object does not change.

Optional Source Properties

Users may forgo the traditional usage of 12-digit IDs to identify source locations if they have unique identifiers already being used in SharePoint. In this case, we have set up a system in which the IDs can be stored in a separate SharePoint List which will translate the unique codes into the IDs that the webpart needs.

Display Properties

columnProperties are a collection of iManage properties by which you would like to see and sort you’re the metadata of your content. The Document Viewer WebPart displays “name” as the first default document property to display, and in this example, “Ext“, “id“, “createdBy“, “modified” are the next four customizable document properties to display. ‘Ext’ or extension translates to “Document type,” “DocId” to “Document Id,” “createdBy” to “Pillsbury author,” and “modified” to “Date modified” as seen below:

If you omit the values for ``columnProperties``, our webpart will use the default properties: id, extension, createdBy and modified. This can be changed by editing the JSON manually or picking the values from the corresponding dropdown menus in the config Builder.

ImDocShare also supports the insertion of custom column properties. In order to use custom properties, please visit your iManage cabinet admin page, and make sure that the properties are enabled in the cabinet. When inserting the property into the ImDocShare config, the spelling and capitalization must match exactly to the attribute that you have defined in the profile Attributes section of iManage 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 iManage API.

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

  • contextMenu 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:

“download”,”delete”,”rename”,”favorites”,”checkOutIn”,”prevTab”,”prevBrowser”

If you omit the values for “contextMenu”, our webpart will select the default options. 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:

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 iManage ndThread 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 letters ‘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
  • DefaultSortProperty is the default iManage property you would like to sort your documents, folders, saved searches, and filter searches by. Leaving this field empty means that the WebPart will default sort by the ‘name’ property, unless you are looking at a workspace, in which case the default sort property will be ‘Ext’ or extension.
    Note: iManage Document Properties are case-sensitive, follow the official iManage spelling and character case as shown near the top of this user-guide.
  • filters is an array of key-value pairs, denoting specific iManage 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 iManage properties noted previously, and desired values for those properties.
  • removeSort is a feature where user insert single or multiple column properties to turn off input column’s sorting and filtering capabilities by disabling and removing. The empty configs “removeSort”:[] is default.

Example: “removeSort”: [‘name’, ‘versions’] will disable both the name and versions column sorting and filtering.

User can disable sorting and filtering from the following list of column properties dependent on the property’s user had added to columnProperties:

“extension”,             // Extension

“id”,                        // Document Id

“createdBy”,            // Created by

“modified”,              // Date modified

“aclStatus”,             // Acl status

“created”,               // Date created

“createdByGuid”,     // created by GUID

“envId”,                   // Environment Id

“modifiedBy”,          // Modified by

“modifiedByGuid”,   // modifiedByGuid

“officialVer”,            // Official version

“size”,                     // Size

“syncMod”,             // syncMod

“url”,                       // URL

“versions”,               // Versions

“client”,                   // Client Id

“matter”,                 // Matter Id

“filterColumn”          // Document Type

    • If you omit the values for “columnProperties”, our webpart will use the default properties: id, extension, createdBy and modified. This can be changed by editing the JSON manually or picking the values from the corresponding dropdown menus in the config Builder.
  • 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 imDocShare 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

  • For Normalview: showBreadCrumb is a property which hides or shows the bread crumb trail. A Breadcrumb trail allows you to navigate through multiple levels of nested folders.
    • Click on any part of the breadcrumb trail to go back to that location.
    • For Treeview: TableDisplayDocsOnly is a property which determines what types of objects will appear in the right-side display table as opposed to the left-side navigation tree in Treeview. Setting this value to true will display ONLY documents in the display table. Setting this value to false will display BOTH documents AND subfolders in the display table. Regardless of this setting, subfolders will display on the left-side navigation tree.
  • searchCriteria is search file files by criteria. The search criteria can filter files using extension, version, client, matter and doc type.

Example:

“searchCriteria” : {

“docType”: [“AGREE”, “CLOSING BINDER”], //Accepts string

“version”: [1], //Accepts int

“extension”: [“pdf”, “msg”], //Accepts string

“client”:[“1004”], //Accepts string

“matter”:[] //Accepts string

}

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 iManage. 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 in order to display a customized message. For users editing using the JSON config Builder, we have provided a rich-text editor as seen below:

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