User Guide – SP2013

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

  1. Navigate to the page in which you wish to edit the imDocShare Document Viewer Web Part. In the example below, we are selecting a “Test” page.
  2. Click Edit Page in the upper right-hand corner.
  3. Click the Web Part menu (small arrow in the upper right-hand corner) and then select Edit Web Part.
  4. Select Extended Settings at the bottom, click inside the Config Settings field and paste the App-Configuration JSON Object directly. Then click apply and then Ok.

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’.
  • 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:


If you are on Share Point on Prem Your asset Path might look like the following:


Source Properties

Normal View can be configured to show a specific source container. TreeView can be configured to show several source containers. The ‘primarySource’ and ‘sources’ properties are 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”: “ 4112-9032-1392“, “type”: “workspace”}
  • sources are always required in TreeView. sources should be an array of key-value pairs, where “id” is the id of the folder, and “type” should tell whether the object is a folder or workspace:
    • “primarySource”:[{“id”:”ACTIVE!148″,”type”:”folder”},{“id”:”ACTIVE!150″,”type”:”folder”},{“id”:”Active!143″,”type”:”folder”},{“id”:”Active!187″,”type”:”folder”}],

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 control center, and make sure that the custom fields properties are enabled, then edit the Custom Field property on the desired container or file on your iManage tenant, and the property value will appear on your ImDocShare webpart.

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 “Client” 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:


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

  • 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
  • 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.