Knowledge: Configuring iManage Work Browser Extensions
Back
Knowledge
Title*Configuring iManage Work Browser Extensions
ManualAdministration
Manual Level TwoIntegrations
Manual Level ThreeiManage
Created10/09/2024
DetailSometimes presented as right click context menu options, other times as icon on toolbar. The can be configured to pass profile data e.g. client no, folder information or documentID's for upload to Sysero etc.
Below is just an example further details are available in iManage Developer Documentation.
First we need to create a zip file that will be uploaded to iManage via IMCC or sent to iManage if Cloud instance. A zip file is attached to this KB article to assist in understanding the below steps:
- In the below when I use word Example obviously you can replace with client name. Also note this zip is case sensitive in text and file names etc.
- Create a folder called SyseroExampleExtension.
- In that folder create sub folders web_extensions and resources.
- In the SyseroExampleExtension root folder create a file called mainfest.yaml, in that file add the following lines:
- api_key: copy your own GUID here (note down)
- api_secret: copy your own GUID here (note down)
- # Details
- id: SyseroExampleExtension
- name: Sysero Example Extension
- publisher: Sysero
- version: 1
- # Authentication
- redirect_url: http://www.example.com/login2.aspx
- # Web actions
- web_extensions:
- - SyseroExample (Note there can be multiple lines of web_extensions in same zip, just use unique name and new line with - in front and persist same spacing).
- In the sub folder web_extensions create a text file matching the web_extensions you set in the manifest e.g. SyseroExample.yaml.
- File needs to contain the following:
- id: SyseroExample (match file name without extension)
- title: Sysero Example (what will appear in iManage)
- type: window
- url: http://www.example.com/worksite/url.aspx?id=syseroexample
- menu: [folder, workspace]
- In the resources sub folder you can add images named e.g. SyseroExample_disabled.svg and SyseroExample_enabled.svg to show icon in iManage. This must be an SVG and must match the web_extension name. Note disabled and enabled text is case sensitive.
- Lastly in attached SyseroExample.zip it has an example of using the SyseroExample.js to hide or show the extension based on iManage context.
- Zip file up from within SyseroExampleExtension directory. Name the .zip something like SyseroExampleExtension.zip.
- If on prem install follow the instructions below:
- Go to iManage Work home /imcc.
- Go to Configure > System Setup > Applications.
- Click Add Application.
- Upload zip file.
- If cloud install please see article iManage Cloud Requesting new App Registration for Client
How the extension works:
- You configure the iManage extension to point to a URL on the Sysero server e.g. http://www.example.com/worksite/url.aspx?id=demo
- The ID will match a setting in Sysero > Admin > System > iManage Work Settings.
- App setting may look something like one of these:
- The process the above and replace the Psuedo values between [] with the correct values from Worksite.
- You can always use the External field name if set as an alternative to the static database field name.
- Note : When using the worksiteupload.aspx you can map fields to form data using Admin > Data Room > Advanced Settings > Worksite Integration > Inbound Field Mappings.
Additional Manual Locations