CAM integrates with the iManage Work Cloud and an on-premises iManage environment.
You can add and manage multiple iManage servers, define the workspaces naming convention, the templates rules to be applied, and the default folder metadata.
Warning: The Client ID & the Client Secret ID must be updated in the IManage Control Center (IMCC) to support API Authentication and enable CAM to integrate with the iManage Server. Read here for detailed instructions to update the Client ID & Secret ID.
Map iManage Server to CAM
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Is Azure Proxy Used? | Select Yes to set this server to access using Azure Proxy server | ||||||||
Server Name | Enter a name for the server. This is a required field. (e.g. iManage Server) | ||||||||
URL |
The address of the server. This is a required field. |
||||||||
Is Azure Proxy Used? Set Yes, then below 4 fields are displayed. Read here for detailed instructions to retrieve these fields. | |||||||||
Application Id | Enter the Application (client) ID from the Azure Active DirectoryPortal. | ||||||||
Application Password | Enter the application password. | ||||||||
Directory (Tenant) Id |
Enter the Directory Id from the Azure Active Directory. |
||||||||
Get Token button |
It will be enabled once URL, Application Id, Application Password and Directory (Tenant) Id is entered. Click the Get Token button, enter log in details. On successful login, the token is generated. |
||||||||
User Id |
Enter the user name to access the server. This is a required field. |
||||||||
Password | Enter the password to access the server. This is a required field. | ||||||||
Validation | Click the Validate button to verify the login credentials for the server. | ||||||||
Token | On successful validation a token is auto-generated and displayed here. If the validation is unsuccessful, Validation Failed message is displayed. | ||||||||
Is Default | Select Yes to set this server as the default repository. If the repository name is not specified in the uploaded CSV file, the data will be updated to the default repository. | ||||||||
Dynamic Group |
Select Yes to create a dynamic group in the iManage workspace. Selecting this option will allow you to add multiple users to dynamic group. Read dynamic groups for more details to create and add users to the group. Note: The dynamic group creation option specified in the CSV file will override the option set here. |
||||||||
Default Database | Select the default database for iManage. The options available for selection here are the database pre-configured in the iManage. | ||||||||
Default Security |
Set the default security for the workspace. Options available are Public, View, and Private. Public: Set Read/Write access to the workspace View: Set Read only access to the workspace Private: Restricts the access rights to the owner only. The owner can update the ACL to the workspaces. Note: The default security specified in the CSV file will override the security set here. |
||||||||
Server Alias | Use for Desksite commands. Now you can provide server alias so it can be searched in the external system from Desksite. | ||||||||
Permission Mapping |
Set permission based on CAM Roles. Common CAM roles are:
Check/ Uncheck the box to update permissions for roles. |
||||||||
Read | This allows access to only view documents, properties /metadata etc | ||||||||
Read Write | This allows full access to the document (view and edit), but limited control on properties /meta-data and no ability to change security (including for the folder, workspace etc) | ||||||||
Full Access | This allows full access to the document (view/edit/share) and full control over properties /meta-data and also the security (including for the folder, workspace etc) | ||||||||
Note: A permission similar to No Access can also be applied when adding users/groups to a workspace/folder with permission as Deny. The workspace/folder will not be visible to the users/groups. For e.g. Permission updated as: alexey.marcus@prosperoware.com|false#23/12/2019*Admin$false |
The list of information displays in the following columns:
Column Name | Description |
---|---|
Repository | The server name entered above. Click on the link to open the iManage login page. Hover your cursor over the name to view the server URL. |
Credentials |
Will display Configured, if the user name and password are successfully validated during configuration. |
Last Modified |
The last updated date and time |
Last Modified By | Name of the user who was logged in when the change was made |
Status | The health status of configured system |
Is Default | Is updated based on selection made during configuration. |
Dynamic Group | Is updated based on selection made during configuration. |
Server | Click Edit to edit the configuration set up. The iManage Server Setup- Edit window is displayed. Make the necessary changes and click Update. Click Delete to remove the server setup. |
Metadata | Click Manage to map the Metadata to the repository. The Metadata Mapping window is displayed. |
In the Metadata Mapping window, the columns are updated with the metadata auto mapped from CAM to iManage. If the columns are not populated, click the Auto Discover button to automatically find and map the metadata from CAM to iManage. The default database displayed in the Select Database drop-down is based on the database selected in the iManage server configuration. To manually add and map additional metadata, click the Add Metadata button. In the Add Metadata Mapping window type information in the provided fields, based on the table below, then click Save.
Column Name | Description |
---|---|
CAM | Select the metadata from CAM to be mapped to iManage. To assign a metadata, either click the drop-down menu and select from the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata. |
iManage | Select the metadata from iManage to map to CAM. The drop-down will include all the metadata defined in the iManage database. |
Is Unique Identifier | Select Yes to set the metadata value as a unique identifier. When a job is uploaded with a unique metadata, CAM will only modify the iManage workspace(s) that have the unique metadata assigned. If the unique metadata does exist in any of the existing workspace(s), CAM will create a new workspace for the uploaded job. |
You can also copy metadata mapping from one database to another. In the Metadata Mapping window, from the Select Database drop-down, select the target database to copy the metadata mapping. Click the Copy From button. In the Copy From window, select the source database from where you want to copy the metadata mapping. Click Save. All the metadata mapping will be copied from the source database to the target database.
The list of information displays in the following columns:
Column Name | Description |
---|---|
CAM | List of the metadata from CAM mapped to iManage. |
iManage | List of the metadata from iManage mapped to CAM |
Unique Identifier | Is updated based on selection made when adding metadata |
Action | Click to edit the mapped metadata. The Edit Metadata Mapping window is displayed. Make the necessary changes and click Update. Click Delete to delete the metadata mapping. |
Note: • CAM supports all special characters that iManage supports for metadata values !@#$%^&*()+[]{};"|:<>/<>/.
Define the iManage workspace names rules and format to be applied
Field | Description |
---|---|
Is Default |
Select Yes to set the workspace name as the default format. Note: If the workspace name is not specified in the CSV file uploaded via the Jobs tab or in the SQL file uploaded via the Data Uploader, the workspace name set as default here, will determine the workspace name format. |
Rule | Enter a name for the rule |
Format |
Enter a format for the workspace name to displayed. A sample rule is displayed as the placeholder in the format field. Tip: The naming format is suggested as "Client ID- Matter ID- Matter Name" {@ClientId@ - @MatterId@ - @MatterName@} |
Metadata |
Displayed if No set as default option. Select the metadata from the drop-down. The metadata drop down will display both the metadata name and the display name added. To assign a metadata, either click the drop-down menu and select from the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata. In the corresponding text box, type the metadata value to be matched for the rule to be applied. To add more than one metadata to the rule click the '+' sign at the end of the text box. Select the search operator from the drop-down. You can also combine the two search operators.
The Workspace rule will only be applied if the search criteria matches with the metadata defined here. |
The list of information displays in the following columns:
Column Name | Description |
---|---|
Rule | The rule name entered above. |
Format | Workspace name format specified above |
Is Default | Is updated based on selection made when adding workspace name |
Action | Click to edit the workspace name and rules. The Edit Rule Creator window is displayed. Make the necessary changes and click Update. Click Delete to delete the rule setup. |
Define the iManage template names rules and format to be applied
Field | Description |
---|---|
Is Default |
Select Yes to set the workspace name as the default format. Note: If the template format is not specified in the CSV file uploaded via the Jobs tab or in the SQL file uploaded via the Data Uploader, the template set as default here will be applied to the workspace created. |
Template | Select a template from the drop-down. The drop-down will include all the templates created in Administration> Template Editor. To remove a template click the x. |
Rule | Enter a rule name |
Metadata |
Displayed if No set as default option. Select the metadata from the drop-down. To assign a metadata, either click the drop-down menu and select from the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata. In the corresponding text box, type the metadata value to be matched for the rule to be applied. To add more than one metadata to the rule click the '+' sign at the end of the text box. Select the search operator from the drop-down. You can also combine the two search operators.
The following operators are available:
The Template rule will only be applied if the search criteria matches with the metadata defined here. |
The list of information displays in the following columns:
Column Name | Description |
---|---|
Rule | The rule name entered above. |
Template | The template selected for the rule. |
Action | Click to edit the template rules. The Edit Rule Creator window is displayed. Make the necessary changes and click Update. Click Delete to delete the template rule. |
Define the default metadata to be applied to the folders within the workspaces created in iManage.
Field | Description |
---|---|
Metadata |
Select the metadata from the drop-down. To assign a metadata, either click the drop-down menu and selectfrom the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata. The metadata selected here will be applied to all the default folders in iManage. |
Note: The default folder metadata set here only applies to folders and does not copy down to the search folders. Client and matter metadata must be specified on the search folders specifically. Read here for instructions to add search folders.
The list of information displays in the following columns:
Column Name | Description |
---|---|
Metadata | Folder Metadata selected above. |
Action | Click to edit default metadata. The Edit Default Metadata window is displayed. Make the necessary changes and click Update. Click Delete to delete the default metadata. |
Define the default group security to be applied to the workspaces created in iManage. If more than one rule matches the criteria then matched groups will be added on the workspace ACL.
Field | Description |
---|---|
Is Default |
Select Yes to set the workspace name as the default format. Note: If the Group rule name is not specified in the CSV file uploaded via the Jobs tab or in the SQL file uploaded via the Data Uploader, the group rule set as default here will be applied to the workspace created. |
Metadata |
Displayed if No set as default option. Select the metadata from the drop-down. To assign a metadata, either click the drop-down menu and select from the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata. In the corresponding text box, type the metadata value to be matched for the rule to be applied. To add more than one metadata to the rule click the '+' sign at the end of the text box. Select the search operator from the drop-down. You can also combine the two search operators.
The following operators are available:
The Template rule will only be applied if the search criteria matches with the metadata defined here. |
Select Group | Select a group from the drop-down. The drop-down will include all the groups created in CAM. To remove a group click the x. |
Select Permission | Select permission based on CAM Roles from the drop-down. Admin Or Editor Or Watcher. Click here for permission details. |
Rule | Enter a rule name |
The list of information displays in the following columns:
Column Name | Description |
---|---|
Rule | Rule name. |
Permission | Permission selected above. |
Is Default | Is updated based on selection made when creating workspace. |
Groups | List Group names selected above. |
Action | Click to edit default metadata. The Edit Rule Creator window is displayed. Make the necessary changes and click Update. Click Delete to delete the group rule. |
Define the default metadata to be applied to the documents within the folders within the workspaces created in iManage.
Field | Description |
---|---|
Metadata |
Select the metadata from the drop-down. To assign a metadata, either click the drop-down menu and select from the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata. The metadata selected here will be applied to all the documents in iManage. |
The list of information displays in the following columns:
Column Name | Description |
---|---|
Metadata | Folder Metadata selected above. |
Action | Click to edit default metadata. The Edit Default Metadata window is displayed. Make the necessary changes and click Update. Click Delete to delete the default metadata. |
This allows end user in the iManage system to edit Workspace name based on the metadata and the criteria set here. Otherwise edit option will be disabled.
Field | Description |
---|---|
Metadata |
Select the metadata from the drop-down. The metadata drop down will display both the metadata name and the display name added. To assign a metadata, either click the drop-down menu and select from the list or manually enter the value, which will auto-complete if it is assigned in Administration>Metadata. In the corresponding text box, type the metadata value to be matched for the rule to be applied. To add more than one metadata to the rule click the '+' sign at the end of the text box. Select the search operator from the drop-down. You can also combine the two search operators.
The Workspace Edit Name rule will only be applied if the search criteria matches with the metadata defined here. |
Rule | Enter a name for the rule |
The list of information displays in the following columns:
Column Name | Description |
---|---|
Rule | The rule name entered above. |
Action | Click to edit the metadata name and rules. The Edit window is displayed. Make the necessary changes and click Update. Click Delete to delete the rule setup. |
Warning: First whitelist the IP's below on the iManage side before uploading the zip into IMCC.
Note: The packages for IMCC are in the section below. Follow the section for editing the web extensions if you use the full package.
Do not modify any of the information in IMCC during the process.
The following are links to the IMCC packages for upload. Select which one suits best:
• Basic CAM IMCC package without the web extensions
• Full CAM IMCC package with web extensions
If the web extensions package is to be used, the extension files should be updated to your system.
1. Extract and open up the CAM_IMCC_web_extensions.zip file.
2. Go into the web_extensions folder.
3. There should be six files:
AspNetShareFolderMenuItem.yaml --- This allows end users to share a folder if a user has access to the workspace (read/write or above) and also has CAM permission to share.
4. Each file needs to be edited for each CAM Tenant.
For AspNetManageFolderMenuItem.yaml:
• Open the file with an editor like Notepad, Notepad++ or Visual Studio Code.
Edit the URL for the CAM tenant for the firm. For example the url is: https://[subdomain].prosperoware.io
If desired, change the type from [window] to [iframe] if you want the window to change into an iframe.
Save the file.
For AspNetDeleteFolderMenuItem.yaml:
• Open the file with an editor like Notepad, Notepad++ or Visual Studio Code.
Edit the URL for the CAM tenant for the firm. For example the url is: https://[subdomain].prosperoware.io
If desired, change the type from [window] to [iframe] if you want the window to change into an iframe.
Save the file
For AspNetCreateWorkspaceMenuItem.yaml:
• Open the file with an editor like Notepad, Notepad++ or Visual Studio Code.
Edit the URL for the CAM tenant for the firm. For example the url is: https://[subdomain].prosperoware.io
Edit the Wizard ID for the CAM tenant and add it to the URL:
Add the wizardid into the URL like such: https://tenantname.prosperoware.io/workspacewizard?wizardId=2b04aeff4cb52638a3c46420668faa0d.
For AspNetEditNameAndProfileMenuItem.yaml:
• Open the file with an editor like Notepad, Notepad++ or Visual Studio Code.
Edit the URL for the CAM tenant for the firm. For example the url is: https://[subdomain].prosperoware.io
If desired, change the type from [window] to [iframe] if you want the window to change into an iframe.
Save the file.
For AspNetShareFolderMenuItem.yaml:
• Open the file with an editor like Notepad, Notepad++ or Visual Studio Code.
Edit the URL for the CAM tenant for the firm. For example the url is: https://[subdomain].prosperoware.io
If desired, change the type from [window] to [iframe] if you want the window to change into an iframe.
Save the file.
For AspNetShareDocumentMenuItem.yaml:
• Open the file with an editor like Notepad, Notepad++ or Visual Studio Code.
Edit the URL for the CAM tenant for the firm. For example the url is: https://[subdomain].prosperoware.io
If desired, change the type from [window] to [iframe] if you want the window to change into an iframe.
Save the file.
• Login to the CAM tenant
• In your browser (preferably Chrome or Firefox), Inspect the page (CTRL+SHIFT+I)
• In the Chrome/Firefox inspection panel, click on the Network tab if not selected. Note in Firefox CNTRL+SHIFT+I does open the network tab, and responses will be organized more intuitively.
• Click on the Plus icon in CAM to get to a workspace wizard.
• In the inspection panel, in the 'Name' Column, an entry called 'workspacewizard' appears toward the bottom of the list.
• Click on the first 'workspacewizard' entry.
• Inside the Network Tab, click on the Response Tab.
• In Chrome scroll right until you see "wizardId". In Firefox, wizardId will display right on the screen.
• The number following, such as " 2b04aeff4cb52638a3c46420668faa0d " is the Wizard ID.
• Add the wizardid into the URL like such: https://tenantname.prosperoware.io/workspacewizard?wizardId=2b04aeff4cb52638a3c46420668faa0d.
5. Finally, zip the files back up after making the changes.
Register App on your Azure Portal to be accessed for provisioning from CAM. Following details are required during External System Configuration: the Directory(Tenant) Id, Application Id and password, follow these steps:
Click on “New Registration” tab.
Advanced Settings - Select Live SDK support to Yes and Default client type to No.
Enter Admin consent display name : User.Read.
Delegated Permission | Description |
user_impersonation | Allow application to Access Client's proxy on behalf of the signed-in user. |
Delegated Permission | Description |
User.Read | Allows users to sign-in to the app, and allows the app to read the profile of signed-in users. It also allows the app to read basic company information of signed-in users. |
Redirect Endpoint URI's are as follows:
Domain | Region | URI |
Staging | EU (eu-west-1) | https://indfh04pbk.execute-api.eu-west-1.amazonaws.com/v1/cam/auth/redirect |
Staging | US East | https://4cpwp6xw51.execute-api.us-east-1.amazonaws.com/v1/cam/auth/redirect |
Production | UK (eu-west-2) | https://5cerfmm2b5.execute-api.eu-west-2.amazonaws.com/v1/cam/auth/redirect |
Production | EU (eu-west-1) | https://y20ve77is6.execute-api.eu-west-1.amazonaws.com/v1/cam/auth/redirect |
Production | US East | https://90uqmfzsbl.execute-api.us-east-1.amazonaws.com/v1/cam/auth/redirect |
Production | APAC (ap-southeast-1) | https://c9efufodx8.execute-api.ap-southeast-1.amazonaws.com/v1/cam/auth/redirect |
For iManage, create an NRTAdmin account in iManage that does not have the View Document permission granted to the role. That allows CAM to read all metadata but cannot download or view the document or its content.
Note: If this is setup, the CAM export feature or Data Sync export job cannot be used for this account. You can use Desktop Export, or setup Data Sync with another account with rights.