Source System Configuration

The Source System Integration is 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 etc.

Follow the process below for configuring a source.

Configuring A New Source System

• Open up the Source System Configuration panel.
• On the upper right options menu, click it, and select New Source System.
• The first step shows is called System Basic Configuration. Enter the following information:

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 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.
• Based on the Authentication type configuration will be displayed on the left side down corner of the page.
Authentication Configuration
Authentication type OAuth:
With Oauth, a set of tokens are obtained initially and then used with subsequent calls. These tokens are renewed periodically. No
passwords are stored. Tokens are stored as encrypted.

1. Auth Token Configuration, Enter the following information and click Next

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.

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.

   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.

3. Refresh Token Configuration and Click Save.

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.
Authentication type Fetch OAuth:
This 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
Field	Description
Auth URL	This is required field. Authorization URL of the source system.
Client ID	This is required field. Client ID of the source system.
Client Secret	This is required field. the Client secret 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.
Username	Enter Username.
Password	Enter Password.
Authentication type UserId/Password:
When 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
Field	Description
User ID Field	This is required field. User Field Name.
User ID Value	This is required field. User Field Value.
User Password Field	This is required field. Password Field name.
User Password Value	This is required field. Enter Password value.
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
• 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.
• After Authentication Configuration is completed, Object Configuration page is enabled on the right side of page.

• Enter the following information on Object Configuration page.
Object Configuration

• Select New Object Available options are:
  • Matter,
  • Metadata,
  • User,
  • Group,
  • Tab,
  • GroupMembership

• After selecting New Object, the following fields are available to fill out 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, High Q, Kira, or CAM
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
Body	The request body. The area where the user can enter custom parameter field/value pairs.

• Click Next to save Basic Object Configuration and it will also fetch the response. It contains Page Info i.e. Total Records and Total pages in the response. And records per page i.e. FirstRecord : 1 and LastRecord : 50

Response pane is displayed for user to configure



Field	Description
Pagination Field Type	Sorting Parameter to be used.
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.

Click Save Fields and On successful response configuration, map the CAM fields and Web response by clicking Add MapOr Edit existing mapped fields.



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. Option Availability Prefix Users can add custom text to the beginning of the folder name. Custom Value Users can assign a custom name to the folder. Suffix Users can add custom text to the end of the folder name.
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}

Click Confirm to complete Object configuration. Follow the same process to set rest of Objects.

• Once objects are configured schedule button will be enabled at the top of the page to schedule the data sync. Click Schedule button to configure:

  Schedule

  Select Sync Repetition and set time.

  • Hour

    • Set recurring time : Sync every {x} of Hours

  • Day

    • Choose Time : Sync at {x}

  • Year
    • Set Date and Time
  • Recurring every minute, 5 minutes or 15 minutes

  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.

Once Source System is configured it will be listed at Administration -> Source System Configuration.

Quick Actions