Overview
The following process describes configuring a source systemConfiguring A New Source System
Open upClick on the Administration tab.
Click on the Source
Systems Configuration panel.
Click on the actions menu on the upper
-right corner and select New Source System.
Input the basic details in the System Basic Configuration
screen that will show (see screenshot below).
Field | Description | |
---|---|---|
System Method | The type of methods use to connect the source. SOAP+XML and REST+JSON are available. | |
System Name | The source | system system’s name. |
Description | A description of the source system. | |
Base URL | The base url of this source system to access it. | |
Authentication type | The options of authentication to the source. OAuth, Username/Password, Fetch OAuth and using Oauth through Username authentication are supported. |
Click Save System.
Note: Depending on the Authentication type (Fetch OAuth, OAuth), different configuration options will be displayed on |
bottom-left of the page. |
Click on Save System.
Authentication Configuration
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
Authentication type OAuthWith Oauth, a set of tokens is obtained initially and then used with subsequent calls. These tokens are renewed periodically. No passwords are stored. Tokens are stored as encrypted.
2. App Authorization, Enter the following information and click Validate, this allows the information to be validated before saving. If there are problems with the information, the errors will display.
|
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Authentication type Fetch OAuthThis is a combination of application + OAuth or UserId/Password. Applications such as Office-365 support this type of authentication. In Application based authentication, the application is registered in the underlying system and pre-assigned certain permissions. Fetch OAuth Configuration, Enter the following information, and click Complete Displays the following screen:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Authentication type UserId/PasswordWhen OAuth is not supported, User Id and Password are used to obtain the authentication session(token) and then session Id is passed in all subsequent calls. User and Password Configuration, Enter the following information and click Confirm
|
Info |
---|
A warning will appear once an incorrect configuration is entered. It will not allow saving until the error is corrected. |
Authentication Details of External Systems
iManage
iManage supports OAuth and User Id & Password-based authentication. OAuth is supported in cloudimanage.com and 10.3 versions of the private cloud (starting Q3 2020). Currently, CAM is using User & Password-based authentication. A complete OAuth based authentication will be supported by Dec 2020.
Permissions and Roles
You need to specify the NRTADMIN account. This is required for CAM to be able to create users, groups, metadata. Please note the “View Documents” permission is not required unless CAM is used for documents sync or Business Continuity.
Also, In future versions, CAM will support two different authentications 1. CAM authentication without download and delete document permission. Client NRTADMIn with download and delete document permission. This account will be stored in the Client’s AWS or Azure. Therefore CAM will never have direct permission to view or delete a document.
NetDocuments
NetDocuments supports OAuth. CAM obtain the OAuth token from the NetDocuments Authentication dialog.
Permissions and Roles
You need to specify an Admin account with all permissions to create metadata, users & groups, workspaces, and folders.
Office 365/Azure AD
Office 365 supports OAuth + Application authentication. CAM App is registered within the Azure Portal and assigned needed permissions. Then this App Id is used to obtain the OAuth token from the Office 365 Authentication dialog.
Permissions and Roles
You need to specify an Admin equivalent account all permissions to create team, SharePoint site, OneDrive, channel, groups, users, etc.
Minimum permissions for Azure AD are:
Permission | Description |
---|---|
User.ReadWrite.All | To add internal users via Azure AD |
User.Invite.All | To add external users via Azure AD |
After Authentication Configuration is completed, Object Configuration page is enabled on the right side of page.
Enter the following information on Object Configuration page
System Limitations
Aderant Expert Sierra
Since Expert Sierra is on AWS and Aderant exposes the Database, the recommended way to connect is to leverage Aderant Cloud’s sync to an on-premises SQL database, and then use that as a source to CAM.
Object Configuration
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select New Object Available options are:
Additional Basic Object Configuration
Response pane is displayed for user to configure:
Eval ExpressionsFor the Eval expressions within the Field Mapping, enter the javascript code for the expression. For example, the firm wants to create a workspace in iManage for the Create iManage Workspace attribute with the following criteria: If createiniManage parameter =true and the status of the workspace is not draft, then create the workspace. This will work in this script if the parameter createinimanage exists in the mapping.
|
Expand | ||
---|---|---|
| ||
ScheduleSelect Sync Repetition and set the time. CAM supports scheduling jobs on a minute-by-minute basis allowing job synchronization to occur more frequently when using source system configuration.
Click Confirm Schedule and you can view the Occurrence, Cron-Expression, Previous schedule, and Next Schedule. Click Sync Now to immediate data sync, which allows you to sync a specific object like User, Group, etc. or select All. Note: When CAM maintenance is going on, it stops scheduled job 30 mins before maintenance, and on initiating Sync Now will show warning message. Single/Multiple objects (Users & Groups, Metadata, etc.) can be independently scheduled for sync at a specific time interval.
|
Once Source System is configured it will be listed at Administration -> Source System Configuration.
Quick Actions
Action | Description | ||
---|---|---|---|
View | Shows the configuration details. | ||
View Jobs | Status of scheduled Jobs.
| ||
Upload Logo | Logo to display for source system. | ||
Export | System Configuration is exported at JSON file. Note: To Import the configuration file click on hamburger sign at top of the page and select Import Source System. | ||
Delete | Delete the source system. |
Pagination
For pagination, use the CSV Parameters for Source Systems here to set pagination. The parameters are supported for GET and POST commands.
For example, here’s how to setup pagination for Simple Legal:
Info |
---|
It is possible to add the following dynamic values for custom parameters for source system objects:
These values will be resolved at runtime and replaced with the proper value. |
Role Permission Mapping
CAM roles can be mapped to the external system role.
Permission Mapping | Set permission based on CAM Roles. Common CAM roles are following:
Examples are as follows: Users: Adding an Admin ( iManage Full Access) bob.bradely@demofirm.com|true#23/12/2019*Admin$true Adding an Editor (iManage Read/Write access) firstnamelastname2@firmname.com|true#null*Editor$true Adding a Watcher (iManage Read only) firstnamelastname3@firmname.com|true#null*Watcher$true Denying Access (iManage No Access) firstnamelastname4@firmname.com|false#null*Deny$true Groups: For example, adding an editor group PartnersGroup|true#11/3/2021*Editor$true
Click on the hyperlink of the CAM Role to show the CAM permissions available for the role.
| ||||
Click on each type of Security Role to update their respective permissions. | |||||
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) |
Managing Files of Source System Integration
In V2 of the Source System Integration, the Jobs submit JSON files instead of CSV files in the backend to avoid overloading the queue processor.
Old Version Compatibility
If a firm requires the older version of Source System Integration, V1, make the following changes to the appsettings.config file:
Code Block |
---|
\<setting name="v2Enabled" serializeAs="String"\> \<value\>False\</value\> \</setting\> |
Tip |
---|
We recommend using the V2 version of Source System Integration for more efficient processing! |
New Version Features
In addition to the new submission in JSON, there is a new folder where those CSVs are stored when the JSONs are uploaded. This folder is called newCSV. The CSVs are created and then converted from these files in this folder to JSON. If a job fails, this would be the folder that contains the JSON files to troubleshoot.
Generated CSVs still reside in the generatecsv folder for all jobs.
Archived CSVs still reside in the archivecsv folder for any successfully completed jobs over time.
Related Topics
iMange | NetDocuments | M365 |