Source System Integration
Overview
What Source systems does
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 Panel in CAM
Here’s what Source Systems looks like:
The table displays the following:
System
System Method
Authentication Type
Description
Base URL
Created By
Last Updated At
Actions
Filtering is possible in this panel.
The following filters can be used:
System Name (Text Search)
System Method (Dropdown)
Authentication type (Dropdown)
Description (Text Search)
Base URL (String Search)
Last Updated By (Dropdown)
Last Updated At (Sorts either ascending or descending)
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.
Please Consider: If you have a large number of jobs that you need to run, you could start all jobs at the same time and let Source System Integration work through the backlog. However, this results in poor performance and even failure if the number of jobs is too high. The first few jobs are put into the Running state and the remaining jobs are put into the Queued state. This could make a lot of jobs fail even when they aren’t running and that can negatively impact the other jobs that are running.
Please work with your partner or professional services consultant to discuss best practices of managing and queueing jobs to that limit.
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
Authentication type OAuth
With 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.
Enter the following information for the Auth Token Configuration:
Field | Description |
|---|---|
Client ID | This is required field. Client ID of the source system. |
Grant Type | This is required field. The way an application gets an access token E.g. Authorization Code, Client Credentials or Password. |
Auth URL | This is required field. Authorization URL of the source system. |
Include Client Secret in Auth Token Request? | Yes or No. If yes, will enable Client Secret field to enter the details. |
Include Scope in Auth Token Request? | Yes or No option. If yes, will enable Scope field to enter the restrictions to access source system. |
Base 64 encoding? | Yes or No. If yes, all information will be encoded. |
Click Next.
For the App Authorization, enter the following information:
Field | Description |
|---|---|
Auth URL | This is required field. Authorization URL of the source system. |
Include Client Secret in App Authorization? | Yes or No. If yes, will enable Client Secret field to enter the details. |
Include Scope in App Authorization? | Yes or No. If yes, scope will be included in the configuration. |
Base 64 encoding? | Yes or No. If yes, all information will be encoded. |
click Validate, this allows the information to be validated before saving. If there are problems with the information, the errors will display.
For the Refresh Token Configuration, enter the following details:
Field | Description |
|---|---|
Grant Type | This is required field. The way an application gets an access token E.g. Authorization Code, Client Credentials or Password. |
Token Type | This is required field. Select from the lookup values. |
Include Client Secret in Refresh Token Request? | Yes or No. If yes, will enable Client Secret field to enter the details. |
Include Scope in Refresh Token Request? | Yes or No. If yes, scope will be included in the configuration. |
Click on Save.
Authentication type Fetch OAuth
This is a combination of Application + OAuth or UserId/Password. Applications such as Office365 support this type of authentication. In an Application-based authentication, the application is registered in the underlying system and pre-assigned certain permissions.
for the Fetch OAuth Configuration, enter the following information:
Field | Description |
|---|---|
Auth URL | This is a required field. Authorization URL of the source system. |
Client ID | This is a required field. Client ID of the source system. |
Client Secret | This is a required field. the Client secret of the source system. |
Grant Type | This is a required field. The way an application gets an access token E.g. Authorization Code, Client Credentials or Password. |
Username | Enter the username. |
Password | Enter a password. |
Click on Complete.
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).
3E
Complete the Basic configuration and the Auth Configuration for Source Systems first.
If you are using the new subscription key for 3E, go to Administration > Source System > Find 3E > View > For each configured object > Edit > click on Custom Parameter.
Type in x-subscription-key for the field key. Add in your subscription key value. Click Add.
Click Next, and Save.
Then on the call in Postman, pass the required variables:
ClientId - Your unique client id.
ClientSecret - Your unique client secret.
AccesstokenURL - https://auth.thomsonreuters.com/oauth/token
Audience - the site of your cloud instance: https://3ecloud.thomsonreuters.com/api/pprd/preview/3e_api/...
Base_url - connects to the 3e URL: https://tenantname.us.preview.3e.thomsonreuters.com/web/api/v1
Application name - 3E rest API.
For more help, reach to your Litera Professional Services consultant or partner.
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
Select New Object. The available options are as follows:
Matter
Metadata
User
Group
Tab
GroupMembership
Expand the corresponding New Object section and fill out the available fields to add new objects to be imported.
Field | Description |
|---|---|
Relative URL | The url of the object in the source system |
Method | The method to use when pulling the data. Options are: Get, Post, Put, Delete, Patch. For example, a GET, is a select of the data. |
Content type | The type of the content in configuration format. E.g. Application/x-www-form-urlencoded, application/json |
Choose the system | The system to create the object in. Available: Netdocuments, Imanage, or CAM For example if you are trying to write to iManage choose iManage. An exception to this is if you are using a custom system parameter. For example, if you want to set the createiniManage parameter to true and have other mapping configurations, it is best to set the system to CAM, and ensure the mapping is done for the createiniManage parameter. |
Suggested parameters | The suggested parameters to set. Content-type, Authorization are available. |
Custom parameters | Set custom parameters for the objects, with a field and value pair. Click +Add |
</>Encode | If the record is base64 encoded, click encode. |
Header | The request header. In configuration format, Application/x-www-form-urlencoded
|
Additional Basic Object Configuration | Additionally, you can include the API Call for same system to Fetch Data and Flattening Response containing Nested Objects by toggling ON. To configure see the below. |
Response | The response pane.
|
Click Next to save Basic Object Configuration. This will also fetch the response which contains Page Info (i.e. Total Records and Total pages in the response), and records per page (i.e. FirstRecord : 1 and LastRecord : 50).
Additional Basic Object Configuration
To configure Additional Basic Object Configuration
Expand the Additional Basic Object Configuration section. The following screen is shown for you to input the details:
Fields | Description |
|---|---|
Relative URL | Specify the Endpoint URL. Based on the requirements you can replace actual Id to Uniqie_id in the Endpoint URL that helps to identify the backend process from where to replace id in the URL. |
Method | Select Method type from the drop down to perform an action.
|
Mapping | To set the mapping of fields used for creation of the object. For example, if you want to create an item in iManage, set the createiniManage parameter to true. It is best to set the system to CAM, and ensure the mapping here is done for the createiniManage parameter. |
The Response pane is displayed for the user to configure:
Field | Description |
|---|---|
Pagination By: | Sorting Parameter to be used. Select from
|
Pagination field | Field to be used for pagination, select from the list or manually enter the value by setting Custom Value On. |
Result field | Select object name. |
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.
Click Save Fields.
After a successful response configuration, map the CAM fields and Web response by clicking Add Map Or Edit existing mapped fields.
Eval Expressions
For 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.
let arr = custom_attributes || [];
let createInImanage = arr.find((value)=>{
if (value.attribute_name === "Create iManage Workspace") {
return true
}else{
return false
}
});
if ((createInImanage && createInImanage.value !== "False") && status !== "draft") {
exports.x = "1"
}else{
exports.x = "0"
}Field | Description |
|---|---|
CAM Field | Select the CAM 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. Specifies how users can customize the name of the CAM Field -
|
Web Response | Select the source system metadata from the drop-down. Or Manually enter a value for the field by setting Custom Value On. |
Field Value | Select the default value to be assigned to the CAM metadata. Manually enter a value for the field. |
Conditional Field | Dynamically setting values: e.g. ClientId = {FieldNameFromSource}&MatterId={FieldNameFromSource} |
Eval Expression (Conditional Sync) | Allows you to perform the conditional sync process using Eval expression. This process helps you to filter records coming from a source system such as the Google API.
if(typeof name !== 'undefined'
&& name
&& name.startsWith("new-folder"))
{
exports.skip = false;
}
else
{
exports.skip = true;
}
|
Once objects are configured, you can schedule the data sync between the source system and the target system. Click on the Schedule button to configure your data sync schedule.