Overview
Data Uploader is a CAM Windows utility to read data from your on-premises, document management, billing, NBI, or Active Directory system and upload the information to the CAM cloud for processing. Based on the rules, metadata properties, and configurations set up, CAM will create or update workspaces, users, groups, and group membership across all specified systems.
Info |
---|
Important: All Data Uploader users are encouraged to always run the latest build available for download, as that is always the most optimized. If you get a notification in Data Uploader itself, or from the CAM Administration Download tab that Data Uploader is outdated, you can find the latest version in your CAM Admin-> Downloads. |
See the Data Uploader FAQ page for additional help.
Note: For each task added via the Data Uploader, a job is queued in the Jobs tab which will then be further processed by CAM. No changes are ever made to your on-premises database.
...
Data Uploader Process Workflow
Downloading Data Uploader from CAM
Navigate to the Administration tab.
Click on Downloads.
Click on Data Uploader and save it to your machine.
...
title | Hardware, Software, and User Account Requirements for Installation |
---|
Installation Requirements
Note |
---|
Important: Currently, CAM supports and uses TLS 1.2 by default, but allows TLS 1.0/1.1 if the Data Uploader is run on a Windows 2012 Server. On June 28, 2023, AWS is dropping all support for TLS 1.0/1.1 and this could affect users using Windows Server 2012 or older with the use of Data Uploader. Windows Server 2016 and above are the natively supported versions with 1.2. |
Hardware Requirements
A Windows PC or Server
Windows Server 2016+ is recommended for the note below.
Note |
---|
Currently, CAM supports and uses TLS 1.2 by default, but allows TLS 1.0/1.1 if the Data Uploader is run on a Windows 2012 Server. As of June 28, 2023, AWS dropped all support for TLS 1.0/1.1 and this could affect users using Windows Server 2012 or older with the use of Data Uploader. Windows Server 2016 and above are the natively supported versions with 1.2. |
At least 1GB of free space for program installation and execution
Internet access to upload the CSV to CAM; 50mbps or higher upload speed is recommended
Software Requirements
.NET Framework 4.8 or higher*
*= 4.8 is required for the new version of Data Uploader since Sprint 23.
Date Format
Format all date values as
yyyy-MM-dd HH:mm:ss
SQL Requirements
Firms are strongly recommended to use an on-premises SQL database (instead of SQLLite) when the firm is a medium to large-sized company or it has more than 5,000 active matters. This allows Delta syncs to perform more efficiently as only necessary workspaces and metadata will be updated.
If the firm is using an on-premises SQL database, these are the requirements:
SQL Server 2012 Standard Edition or above.
Windows Server 2016+ is recommended for the note below.
Info |
---|
CAM Data Uploader does support SQL 2019 and 2022. |
Important Note for Windows Server 2012
Note |
---|
Currently, CAM supports and uses TLS 1.2 by default, but allows TLS 1.0/1.1 if the Data Uploader is run on a Windows 2012 Server. As of June 28, 2023, AWS dropped all support for TLS 1.0/1.1 and this could affect users using Windows Server 2012 or older with the use of Data Uploader. Windows Server 2016 and above are the natively supported versions with 1.2. |
A dedicated or Shared SQL server
8+GB of free RAM
4+CPU (cores/threads)
10+GB free hard disk space*
Tip |
---|
|
Firewall and Port Requirements
Whitelist the following ports.
Port 443 should be open. CAM and Data Uploader utilize the HTTPS ports for requests. The API manages the requests, and no data is locally accessed or stored. If you’ve changed the default port for HTTPS, use the changed port. Check with your IT team if your firm has changed the port, and if so they need to open that default port on the corresponding HTTPS.
Port 1433 should be open for SQL communication between the on-premises SQL and the API. Check with your IT team if your firm has changed the port, and if so they need to open that default port on the corresponding SQL server.
User Account Requirements
Litera recommends a service account be used to run Data Uploader. For more details on setting up a user account, see Create CAM User Accounts
This service account should have:
Permission to download, install, and run the Data Uploader on the Desktop or server.
Read/Write access to the designated Data Uploader application directory.
Read access to the source database on the SQL server (to query the database and upload to CAM)
Permission to the local system to edit/enable the Windows Task Scheduler.
Read access to Active Directory.
Must be a system admin
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Install Data Uploader
This section describes the Connection Strings tab in Data Uploader and how Data Uploader is using, storing, and accessing data. In both the current and previous versions of Data Uploader, there exists a database called ClientApp2.sqlite. This database is used to store the scripts and results of the queries. This database is also used to run on-premises comparisons of the CSV files for matter provisioning and user and group management to improve performance and cut down on unnecessary transactions due to false positives. An example of this might be that a matter property that is unrelated to the workspace was updated in the time & billing system. Because the modification date on the matter in that system was updated, it might feed through many matters into the provisioning CSV. However, since none of those matter changes are related to the workspace as provisioned by CAM, CAM still needs to compare each matter entry to make sure no data has changed that would need to be updated in the downstream system (iManage, NetDocuments, etc.). By running a comparison of the files by Data Uploader using an on-premises database, we can only submit matter jobs with true changes, thus improving overall performance. Note: The minimum requirement for Data Uploader is a standard install of SQL.
Using SQLIf you are using an SQL Database, it is recommended you recreate the connection strings to the source database for workspace provisioning. This will be outlined in the steps below.
Running Data Uploader
Create a Connection String
Other VerificationsClick on the other tabs to verify that the data from the old configurations have been copied over correctly SQL Files
Active DirectoryClick on the Active Directory tab and check that your LDP configurations have been copied over correctly. If you do not see them, go back and verify you copied the data correctly from the old configuration file to the new one. Otherwise, you can recreate this by clicking the Add button. CAM Agent UpdateData Uploader comes with a new CAM Agent. There is nothing you need to do to upgrade this – the old one will be uninstalled and a new one will be installed running under the service account credentials you provided during the installation. If you did not enter the correct service account for the CAM Agent, then you can update this by doing the following:
Read here for complete instructions to configure and use the Cloud Data Uploader. Note – CAM Agent service is a window service. By default, it’s Enabled, for verification make sure that it's running.
|
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
Upgrade Data Uploader
Installation
Note:
Note: Browsers typically block MSI and exe installers downloaded from the internet, which may interfere with the version upgrade. Unblock the DU msi installer by Right-click on the file properties.
Note: The installation directory has changed slightly to “C:\Program Files (x86)\Prosperoware\CAM\Data Uploader\”
Updating the ConfigurationsThe new Data Uploader application has replaced many of the previous configuration files with new config files. Since the following instructions for copying old configurations to the new files reference line numbers, we recommend using a program like Notepad++ or other tools that have line numbering available. All configuration files are now in a directory under the install path called config located here: C:\Program Files (x86)\Prosperoware\CAM\Data Uploader\service\config If you have made any configuration changes to the following files, please follow the instructions below to copy your configurations to the new files. If you have not modified any of these files, you can skip this section.
ActiveDirectoryIntegration.config > ADMapping.configIf you did not make any changes to the ActiveDirectoryIntegration.config, you may skip to section 2.
Active Directory FilterThe organization units in Active Directory contain multiple groups with multiple users. The following are examples of supported operators: Contain (%%)
Not Contain (!%)
Wildcard A wildcard is a character(s) that substitutes for another character or string of characters when searching a database. Searching for values in the ad-property name property using a wildcard is now supported. The following are examples of a supported wildcard:
In the above example,
Data.config >ADMapping.configIf you did not make any changes to the Data.config, you may skip to section 3. If you applied filters for users and groups in the Data.config file, you will need to recreate these manually in the new ADMapping.config as there have been some changes. There are instructions in the ADMapping.config on how to apply the user and group filters.
User.config >ADMapping.config
Read more on ADMapping.config. SourceFilesConfigThis is a new configuration file that allows you to set a separate unique identifier for each of your provisioning scripts. Some content systems might support a matter index ID for a unique identifier, while others might only be able to support client and matter ID. This file configures the unique ID per script.
ADMapping.config
Sample Multivalueddatabase property value
Note: Multivalued database property is applicable only for the iManage system.
Sample SkipUpdateIfExists property value - iManage
Sample SkipUpdateIfExists property value - M365
Note: Specify "SkipUpdateIfExists" property value manually only for M365.
Sample PreferredDatabase value
Note: PreferredDatabase property is applicable only for the iManage external system. Password flag Mapping The property name “passwordExpired“ allows you to set the password expiration against user creation in iMange. Allows you to set password update on the first login after user creation in iManage using the property name “ForceUserToChangePassword“. Note: passwordExpired and ForceUserToChangePassword properties are applicable only for iManage. Sample Password flag Mapping
SQL Scripts
Note: Users and groups can be created using two ways, one by uploading the API or CSV file and two by using the AD. AppSetting.configIt provides a new export option to allow you to exclude duplicate documents like emails from the iManage and NetDocuments system during export. The following code snippet allows you to create a folder where all duplicate emails are present:
The following code snippet allows you to skip all duplicate emails during export:
Note: 1. 2. |
Data Uploader Limits
Info |
---|
Important: Currently, you can set the daily Throttle limit to a maximum of 50,000 jobs for optimum and error-free performance. Daily, you can upload the maximum jobs that are permitted as per the Throttle limit. After the daily limit is reached, you can find the Throttle limit warning message in the log. |
Note |
---|
Important: CAM has a limitation of 492 characters in the group name when adding to the group path. |
Required Permissions
...
Permissions
...
Allows User To
...
View Data Uploader
...
To download Data Uploader from the Administration tab->Downloads.
Tip: Read here for a complete list of available permissions and instructions to allow/deny CAM permissions to users/groups.
Related Topics
...
Child pages (Children Display) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|