imDocShare SharePoint User Guide

imDocShare SharePoint User Guide





A picture containing logoDescription automatically generated


imDocShare SharePoint User Guide




This document details how to setup a imDocShare webpart for SharePoint.

How to add imDocShare Viewer in SharePoint

Navigate to a SharePoint page and edit the page to begin adding the imDocShare webpart:


A screenshot of a computerDescription automatically generated

Config Builder

After you have added the imDocShare webpart please select edit webpart and open the config builder:


A computer screen shot of a computerDescription automatically generated

Once you select the “Open Config Builder” option you will see a popup detailing all of the different options for our imDocShare Webpart.


A screenshot of a chatDescription automatically generated

In the config builder you can select different view types to configure you webpart you can choose from the options below:


A screenshot of a computerDescription automatically generated

Once you have selected the view type, please configure the rest of the options to your specifications and configure the webpart.


Normal View

The Normal View in the imDocShare webpart allows users to select and configure a single iManage source location. This setup is ideal for displaying content from a specific iManage library, ensuring focused access and streamlined interaction.


Steps to Configure Normal View:


View Type -> Normal View: Displays results in a standard layout.
Source Type: 
Library: 
Library Name: Select the name of the library.
Workspace: Select the workspaces.
Folder: Select the specific folders.
Recent: View of recently accessed items.
Favorites: View items marked as favorites.
My Matters: Allows users to view the Matters for the current logged in user.
My Emails: Allows users to view the emails for the current logged in user.
My Checked-Out Documents: Provides control over documents checked out by the user for editing or review.
Documents Per Page: Configures the number of documents displayed per page for optimal navigation (Min: 1 and Max: 50).
Compact Mode: Display the most simplified version of imDocShare, which focuses solely on the file list. This mode is ideal for minimalistic layouts or constrained spaces, with the following dimensions supported:
Minimum Width: 245
Maximum Width: 800
Minimum Height: 245
Maximum Height: 800
Show/Hide Logo: Offers customization of branding visibility within the interface.
Show/Hide Logout: Show or Hide the logout section in UI.
Action Buttons: Provides quick access to essential operations such as Search, Upload, Quick Sync and Filter.
Read-Only View: If enabled, the users won’t have any edit access for the files.
Context Menu Options: Access essential file operations like Download, Delete, and Rename.
Populate Mandatory Fields: Metadata fields like Author, Operator, Type, and Class will be automatically filled in when creating a document.
Sort Order: The way search results or items are arranged, either in ascending or descending order based on specific criteria.
Default Click Behavior: Users can either view the content in iManage Web or iManage Desktop or download the document.
Override CSS: Allows the users to have custom styles for a more personalized appearance.




Save the Webpart and Publish the Page


Once all configurations are complete, click Save to confirm your changes.
Publish the webpart to make the updates live on the SharePoint page.

A screenshot of a computerDescription automatically generated



Tree View


The Tree View in the imDocShare webpart allows users to select and configure multiple iManage source locations. This setup is suitable for users requiring access to content across multiple libraries or workspaces in iManage, providing a hierarchical display of the selected sources.


Steps to Configure Tree View:


View Type -> Tree View: Users can select multiple sources, such as workspaces or folders, to view their contents.
Source Type: 
Library: 
Library Name: Select the name of the library.
Workspace: Select the workspaces.
Folder: Select the specific folders.
Documents Per Page: Defines how many documents are displayed on a single page for better usability (Min: 1 and Max: 50).
Parent Container: Provides control over showing or hiding the parent container.
Show/Hide Logo: Offers customization of branding visibility within the interface.
Show/Hide Logout: Show or Hide the logout section in UI.
Action Buttons: Provides quick access to essential operations such as Search, Upload, Quick Sync and Filter.
Read-Only View: If enabled, the users won’t have any edit access for the files.
Context Menu: Provides file-specific actions like Download, Delete, and Rename for efficient management.
Populate Mandatory Fields: Metadata fields like Author, Operator, Type, and Class will be automatically filled in when creating a document.
Sort Order: The way search results or items are arranged, either in ascending or descending order based on specific criteria.
Default Click Behavior: Users can either view the content in iManage Web or iManage Desktop or download the document.
Override CSS: Allows the users to have custom styles for a more personalized appearance.


Save the Webpart and Publish the Page


Once all configurations are complete, click Save to confirm your changes.
Publish the webpart to make the updates live on the SharePoint pageA screenshot of a computerDescription automatically generated



Hybrid Search



The Hybrid Search feature enables users to search across iManage and SharePoint seamlessly, displaying results either within the imDocShare webpart or the SharePoint search extension.


Hybrid Search Webpart/Extension: hybrid search helps to search in SharePoint and iManage based on configuration.
Asset Path: Specifies the path to resources, ensuring uniform access and correct mapping of assets.
Show Filters: Allows users to refine search results by applying specific filter criteria.
Show Results: Displays the output of search queries, helping users locate relevant content quickly.
Search Result: Provides the outcome of the search, showing items that match the specified parameters.
Result View: Choose how search results are shown – Separate, Hybrid, only from SharePoint, or only from iManage.
Separate View: Results can appear in two styles – as a list you can expand (Accordion) or as tabs. 
Hybrid View: Results can be shown in three styles – a quick overview (Summary), detailed information as a list (Detailed), or SharePoint’s default style (SharePoint OOB).
SharePoint Only View: Shows only SharePoint results.
iManage Only View: Shows only iManage results.
Search in QNA: Allows searching within Microsoft questions and answers (Microsoft QNA).
SP Configs: Settings for SharePoint connections.
SharePoint Search Type: Choose how to search in SharePoint.
Subsite: Select the subsite for the search.
List Name: Enter the name of the SharePoint list to search in.
SP Column Properties: Define which columns to include in the search.
Default Click Behavior: Decide what happens when a result is clicked. (Open in iManage Web, iManage Desktop or Download the document).
iManage Result Config: Settings for showing iManage results.
Source Type: Specifies the content source (e.g., workspace, folders, subfolders).
Library: Select the library search queries.
iManage Column Properties: Choose which iManage columns to display in results.
Context Menu: Options available when right-clicking on a search result.            
Search In: Choose specific categories, sections, or folders to search.
Default Click Behavior: Defines the default interaction when clicking an item, users can either view the content in iManage Web or iManage Desktop or Download the document.
Save: Save your settings or changes.




Save the Webpart and Publish the Page


Once all configurations are complete, click Save to confirm your changes.
Publish the webpart to make the updates live on the SharePoint page.





Dynamic View


Multi Region Configuration 


Region specific onPrem iManage can be configured in the config builder. 
Before adding configuration, data there will be an option to choose the region. 
In the config builder, Region selection will be the primary selection 
Admin user can select the region and configure the webpart  
Any single region or multiple regions can be configured for a webpart  
Each region configuration can be saved separately 
Possible to remove the region configuration.  
In the View, If a region is already selected by the user, then the webpart will pick the configuration of the selected region and the table view of the region will be shown. 


 

Dynamic View – Mapping Choice 

Added support to choose mapping type for dynamic view in the config builder. 

A screenshot of a computerDescription automatically generated 


Below are the options available as Mapping Type 
Query Param Key 
      Assign value from the query parameter matching to the key provided. 
Static Value 
      Assign value as specified in the input box 
Dynamic Value 
      As selected from the drop down. 

 

Dynamic View – Mapping Choice – Query Param 

A screenshot of a computerDescription automatically generated 

This is the default mapping choice as in the previous version of imDocShare. As in the example screenshot above, this will map the field “Client” to the value assigned to the key “clientCode” in Query Pram. 

 

Dynamic View – Mapping Choice – Static Value 

A screenshot of a computerDescription automatically generated 

In this mapping, as in the example screenshot above, the field “Client” will be assigned to the value ‘1NXDL’ for filtering data. 

 

Dynamic View – Mapping Choice – Dynamic Value 


The dynamic value option is supportable for the fields, Author and Modified Date 
Users Type: (example Author) 
Current User – The search will be applied as to list the documents matching the Author as current logged in user. 


A screenshot of a computerDescription automatically generated 

Date Type: (example Modified Date) 
  1. Today 
  2. Yesterday 
  3. Last 7 days 
  4. Last 30 days 

A screenshot of a computerDescription automatically generated 


The search will be applied as to list the documents matching to the modified date by today / yesterday / last 7 days / last 30 days. 
Dynamic View – Class Mapping 

A screenshot of a computerDescription automatically generated 


Special field class is added to the filter as to filter the document based on the class value. Class field supports Query Param, Static and Dynamic mapping types. 
As example this can be used to filter documents by selected client/matter and with class as ‘closing’ to list all closing binders of the client/matter. 
Dynamic View – Compact Mode 


A screenshot of a computerDescription automatically generated 


Added option for selecting compact mode to enter width and height for the component in dynamic view in addition to that we added option to hide the total count panel from that view as it will take considerable height in the compact view. 
Multiple dynamic view webparts in dynamic pages  
This version stores the mapping data directly in the config builder Json compared to the SharePoint list of the previous version. This change is being made to give possibility to add multiple dynamic view webpart in the same page. 


Save and Deploy the Webpart
Once all configurations are finalized, click Save to confirm changes.
Publish the SharePoint page to make the updated view accessible to end users.




Displaying Region Specific Library


If a user has configured multiple libraries, each assigned to a specific region, the WebPart should display the library corresponding to the user's current region

1. Create a new page and add the imDocShare WebPart, or edit an existing page that already has the WebPart configured. Then, open the property pane for the imDocShare WebPart.
2. Click the "Open Config Builder" button to access the configuration settings.
3. Set the view type to “Dynamic View”.
4. Once configured the query params or static value to display library documents.
5. Configure “Map User’s Region” to “Asset JSON” or “Query Param”

Asset JSON
Configure the region to library mapping using a JSON file in the client-side assets. The library displayed will be based on the user's region.

Create “regionLibraryMap.json” file and create in below format

      {

               "Location_FROM_SharePoint": "Library",

                "Location_FROM_SharePoint": "Library",

                "Location_FROM_SharePoint": "Library",

      }

  1. Open SharePoint client side asset using https://{youtenant}.sharepoint.com/sites/appcatalog/ClientSideAssets
  2. Upload the “regionLibraryMap.json” file.
  3. imDocShare reads the Office Location from a SharePoint Crawled Property, typically mapped to a Managed Property like “OfficeLocation” or “OfficeNumber.”     
  4. Configure the “User location property” to "OfficeNumber." If your Office property comes from a different SharePoint Crawled Property, configure it to use that specific Crawled Property instead.




Query Param
  1. Configure the region to library mapping using query param.
  2. Enter the query param key in the “Map User's Region Query Param” field and click the add button.
  3. Select a library from the dropdown and enter the region name to display this library.
  4. Add multiple libraries and map each one to a region
6. Click 'Save Changes' to apply configuration.

Default Filter in imDocShare Webpart (NEW)

Steps to Configure Default Filter

  1. Create a new page and add the imDocShare WebPart, or edit an existing page that already has the WebPart configured. Then, open the property pane for the imDocShare WebPart.
  2. Click the "Open Config Builder" button to access the configuration settings.
  3. Set the view type to "Normal View" (currently, the default filter is supported only in Normal View).
  4. Select your iManage source (Library or Workspace or Folder).
  5. This enables the Default Filter option, allowing you to configure "Add Additional Criteria" at the bottom of the form.
  1. Click the 'Add Additional Criteria' button to configure the default filter. You can add multiple criteria.

  1. If you choose a string field like Name, the following conditions will be available for selection:
    • Contains - Documents containing the term or variations of the term are returned in the results. If the term credit in the Title and select the Contains option, the system returns all the documents that contain the term or its variations in the Title of the documents.
    • Contains Exactly - Documents containing the exact term or phrase are returned in the search results. If the term Credit Agreement in the Title and select the Contains Exactly option, the system returns all the documents that contain the term/phrase in the Title of the documents.
    • Does Not Contain - Documents that contain these terms are excluded from the results.
    • Contains
      - Documents containing the term or variations of the term are returned in the results. If the term credit in the Title and select the Contains option, the system returns all the documents that contain the term or its variations in the Title of the documents.
    • Contains Exactly
      - Documents containing the exact term or phrase are returned in the search results. If the term Credit Agreement in the Title and select the Contains Exactly option, the system returns all the documents that contain the term/phrase in the Title of the documents.
    • Does Not Contain
      - Documents that contain these terms are excluded from the results.
  1. If you choose a number field like Document ID, the following conditions will be available for selection.
    • Is - The document returned exactly matches the document number entered. If you search for the number 45678, and select the Is option, the system returns the documents whose ID is 45678. NOTE: Document numbers themselves must be entered without any commas.
    • Between - The documents with numbers falling between the specified document numbers are returned. If you search for documents within a range, then enter the document numbers within which you want to search, and select the Between option. The system returns documents falling between those numbers
    • Before - Documents with numbers less than the entered document numbers are returned. If you want to search for documents with document numbers falling before the entered number, enter the document number, and select the Less than option. The system returns the documents falling before the specified number.
    • After - Documents with numbers greater than the entered document numbers are returned. If you want to search for documents with document numbers falling after the entered number, enter the document number, and select the Greater than option. The system returns the documents falling after the specified number.
  1. If you choose a date field like Modified Date, the following conditions will be available for selection.
      • Specific Date
        - Based on the field selected, say Modified Date, all the documents that were created on a custom date are returned.
      • Between - The documents with date falling between the specified date are returned. If you search for documents within a Modified date range, then enter the Start Date and End Date, and select the Between option. The system returns documents falling between those date
      • Before - Documents with Modified Date less than the entered Date are returned. If you want to filter for documents with Modified Date falling before the entered date.
      • After -Documents with Modified Date Greater than the entered Date are returned. If you want to filter for documents with Modified Date falling after the entered date.

    1. If you choose a Lookup field like Client, the multi select dropdown will appear to choose the options.
    2. Click 'Save Changes' to apply the configuration.

Document View in imDocShare Webpart (NEW)

Steps to Configure Document View

  1. Display documents from different libraries based on document ID’s configured in the config settings.
  1. Create a new page and add the imDocShare WebPart, or edit an existing page that already has the WebPart configured. Then, open the property pane for the imDocShare WebPart.
  2. Click the "Open Config Builder" button to access the configuration settings.
  3. Set the view type to “Document View”.
  4. Choose a library and enter multiple document IDs separated by semicolons
  5. To configure another library, select a different library and enter the document IDs. The document IDs configured for each library will be preserved.
      6. Click 'Save Changes' to apply the configuration.

    • Related Articles

    • imDocShare Admin App User Guide

      imDocShare Admin App User Guide Introduction This User Guide is a general overview of how to use and access the imDocShare Admin App designed for imDocShare Admin Users. In this Admin App, Admins have the ability to control the Global settings that ...

    • Does imDocShare allow to access iManage Work Server 10.2+ / iManage Cloud content “live” content in SharePoint?

      Yes, imDocShare allows to view, add, edit, attach, search, sync, & provision iManage Work Server 10.2+ / iManage Cloud content “live” content in SharePoint Intranet Sites & Pages as well as in the SharePoint Client Extranet Sites & Pages.

    • imDocShare v3.6.0.0304

      New Features imDocShare SharePoint app & imDocShare One Hybrid Search - The SharePoint results display order can be done in the hybrid search view control in the config setting. My Co-Authoring Action Button - User can now use an action button to all ...

    • imDocShare v3.3.6.1610

      New Features imDocShare SharePoint app and imDocShare One Enhanced the co-authoring features. Add more co-authors once the co-authoring process is started. Default co-author users will be listed when the user starts the co-authoring process. Fixed ...

    • imDocShare v3.1.1.0503

      New Features imDocShare SharePoint app Enhancements in the Search Results (Separating the Folders, Email, and Documents) imDocShare Hybrid Search Ability to narrow down the list of search results to the folder level with the config builder settings. ...