Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Navigate to the Administration tab.

  2. Click on Downloads.

  3. Click on Data Uploader and save it to your machine.

Installation Requirements

Expand
titleHardware, Software, and User Account Requirements for Installation
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
  • *Solid state drive(s) are preferred for the SQL file storage

  • Collation is recommended to be SQL_Latin1_General_CP1_CI_AS for the US. If you get a collation error when running SQL scripts. add a collation conversion in the script.

  • A full recovery database option is recommended for production level environments, for the database restoration and login aspects. A dev or test or staging environment might be able to have a simple recovery set, but it is the firm’s decision!

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
titleInstall Data Uploader

Install Data Uploader

Info

Important: All Data Uploader users are encouraged to always run the latest build available for download (#552 as of Dec 2023), as that is always the most optimized. Issues like the validation of connection strings as ODBC in build #533 are no longer present in build #552.

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.

Info

Important Information: if you are a larger organization, we might suggest you create an on-premises SQL database for this purpose. Sizing recommendations can be found at On-Premises Recommendation.

Using SQL

If 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.

  1. If you are using an on-premises SQL database, create a Database – suggested name = “CAMLocal”

  2. To create a connection string to this database, CAM will need an account that has dbo rights to this database so it can create the schema and manage the data in this database.

  3. The schema for this database will be created after you launch Data Uploader and create a connection string to this database outlined in the Create a Connection String section.

Running Data Uploader

Tip

Best Practice: When you first run the new Data Uploader, you must run it as an administrator.

  1. From the Windows Start menu, right-click on Prosperoware Data Uploader and Run as administrator.

  2. If Data Uploader prompts you to reauthenticate, put in the tenant URL then the user email and password for your CAM account.

  3. Click on the Connection Strings tab

  4. If using the SQLite database, and if you copied your connection strings configurations to the new ConnectionString.config, you should see your connection strings here.

    1. If not, then you can manually add the connection string by selecting Add, then selecting the “Select Connected System” as Source Database.

  5. If using an on-premises SQL database, you must first create the CAM Local Database connection string before creating any other connection strings.

Create a Connection String

  1. Click the Add button.

  2. Create a name for your connection string, e.g., CAM Local.

  3. From the “Select Connected system”, choose CAM Local Database.

  4. d. Select whether this is a direct SQL Connection or ODBC Connection.

    1. i. If ODBC, you will need to add a connection string.

    2. An example is: Data Source=100.10.200.220\MSSQL2017;Database=localdb;User=sa;Password=yourpassword.;Integrated Security=false

      1. Type in the name of the SQL Server or instance first. If in azure or a remote system include the ports first.

      2. Type in the name of the Database.

      3. Select login type and pass the correct credentials. Reminder: this account needs to have dbo rights to this database.

      4. Click Connect or Save

  5. You may now add all other desired connections to the data source for the workspace provisioning. Make sure to select Source Database from the “Select Connected System” drop-down.

Other Verifications

Click on the other tabs to verify that the data from the old configurations have been copied over correctly

SQL Files

  1. Click on the SQL Files tab and click the Refresh button if you do not see your SQL files. If you still do not see them, make sure they were copied to the correct directory.

  2. Next to each script, click the hamburger menu and select Edit.

    1. Select whether you want to enable this script and select the appropriate connection string against which this script will be executed. CAM supports multiple databases against which you can execute scripts.

  3. From the hamburger menu, you can also select the Validate option to test and validate your scripts before you run them in production.

Active Directory

Click 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 Update

Data 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:

  1. Go to the Windows Services

  2. Double-click on CAM Agent

  3. Click on the Log on tab. The CAM agent will be installed by the installer. The user has to select just Service Account and should have access to the CAM data uploader folder or accessible part.

Tip

Best Practice: If you are currently using the CAM Agent, just make sure it is running at some point during the upgrade.

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.

Tip

Tip: You can set multiple instances of the Data Uploader. For e.g. You can set an instance to run the SQL file to update the matter information based on a schedule and another instance to update the AD sync on a different schedule.

Info

Important: If an SQL File is disabled and the connection string is not set, the file will be skipped by default.

...