Overview
The Source System Integration functionality allows CAM to integrate with any cloud-based system or system with a web service/REST API as an input to the provisioning process.
CAM supports integration with iManage, Azure AD and APIGEE-based systems.
Source System Limit
A limit on the number of jobs a tenant can submit in Source System Integration now applies. The limit is 50,000 jobs. An error will warn the user on the limit, and any new Source system jobs will not be submitted for processing until the batch completes. This eliminates newer jobs continuously filling the queue or causing timeouts on the current original job.
This limit is parameterized, and can be adjusted by Litera Devops if your firm has a case to do so. Do note potentially increasing this parameter could potentially affect costs; ask your Devops team member for more details when adjusting.
Please raise a support request for this, and will require approval before this increase is implemented and any uplift in costs.
Configuring A New Source System
Click 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’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. Note: Depending on the Authentication type (Fetch OAuth, OAuth), different configuration options will be displayed on bottom-left of the page. The following sections go over the details for each type. |
Click on Save System.
Authentication Configuration
Note: For all authentication types, a warning will appear if an incorrect configuration is entered and CAM 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.
For Permissions and Roles, you need to specify the NRTADMIN account. This is required for CAM to be able to create users, groups, and metadata. Please note the “View Documents” permission is not required unless CAM is used for document sync or Business Continuity.
In the future, CAM will support two different authentications:
CAM authentication without permission to download and delete documents.
Client NRTADMIn with permission to download and delete documents. 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 obtains the OAuth token from the NetDocuments Authentication dialog.
For 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
Office365 supports OAuth + Application authentication. The CAM App is registered within the Azure Portal and assigned the needed permissions. Then, this App Id is used to obtain the OAuth token from the Office365 Authentication dialog.
For Permissions and Roles, you need to specify an Admin-equivalent account for all permissions to create teams, SharePoint sites, OneDrives, channels, groups, users, etc.
The minimum permissions for Azure AD are:
Permission | Description |
---|---|
User.ReadWrite.All | The permission is required to add internal users via the Azure AD. |
User.Invite.All | The permission is required to add external users via the Azure AD. |
After the Basic Authentication Configuration is completed, the Object Configuration panel is enabled on the right side of the page.
Enter the information on the Object Configuration page (see next section).
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
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. A limit on the number of jobs a tenant can submit in Source System Integration now applies. The limit is 50,000 jobs. An error will warn the user on the limit, and any new Source system jobs will not be submitted for processing until the batch completes. This eliminates newer jobs continuously filling the queue or causing timeouts on the current original job. Note: In Data Uploader, or SSI or CAM in general, When a provisioning job for a team or channel or site is received, CAM creates a separate job for each tab or app in addition to the Team creation or provisioning job. For provisioning users, or groups or workspaces or folders, there is only one job when bulk updating or creating records from DU or SSI. E.g. one record will show for Data Upload. Then a record shows for the subsequent action of Create Workspace if the job was creating workspaces from DU. |
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 to set pagination. The parameters are supported for GET and POST commands.
For example, here’s how to set up pagination for Simple Legal:
It is possible to add the following dynamic values for custom parameters for source system objects:
{{today}}
{{yesterday}}
{{last_week}}
{{last_month}}
{{last_run_time}}
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
Note: Dates are based on your system setting found here: Admin->Settings.
Click on the hyperlink of the CAM Role to show the CAM permissions available for the role. The permissions for these roles can only be edited after the server information has been saved. If the server details have not been saved, the Edit button will be grayed out. If hovered over, a tooltip will warn users about this. |
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:
\<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 the new 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 |