Configure Data Uploader

Installation Requirements

Hardware Requirements

• A Windows PC or Server

  • Windows Server 2016+ is recommended for the note below.

• 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

To format the dates, go to Administration-> Settings->General tab-> Default Data Format.

Open

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.

Important Note for Windows Server 2012

• A dedicated or Shared SQL server

• 8+GB of free RAM

• 4+CPU (cores/threads)

• 10+GB free hard disk space*

• SQL Maintenance plans setup as typically configured.

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

• If the user is using the CheckOut feature, the user will need at a minimum read/write access to the check-out path. If it is a path on the local PC, then that local PC will also need to be on the network.

Installing Data Uploader

1. Ensure the requirements are met. The requirements can be found here.

2. In the Welcome to Data Uploader Setup Wizard dialog, click Next.

3. If you would like to install the Data Uploader somewhere other than the default location displayed in the installer, click Browse and navigate to your desired installation folder; otherwise, leave the path unchanged.

4. To install it for your access only, click Just me or select Everyone to allow access to anyone using your system.

5. Click Next to continue.

7. Click Close on the Installation Complete pop-up box once it notes DataUploader has been successfully installed.

8. The Cloud Data Uploader is installed as a shortcut on your desktop. Double-click it to launch the application.

Upgrade Data Uploader

Installation

1. Review the Hardware and Software Requirements for Data Uploader.

2. You must create a backup of the existing DU database before the upgrade. If you are not utilizing a dedicated SQL database for DU, then skip this step.

3. Make a backup copy of the current Data Uploader installation directory:

   • Prosperoware Data Uploader folder found at: C:\Program Files (x86)\Prosperoware\Prosperoware Data Uploader.

4. Log into your CAM website.

• If you are already logged in, sign out and sign in back in to ensure the latest update is available.

5. Navigate to Administration

6. Click on Downloads and download the latest version of Data Uploader onto the server where DU is installed.

7. Run the installation wizard.

8. Click Next. Keep the install folder path the same.

9. Click Next.

10. This version of the Data Uploader now requires that you enter a Windows Services domain, username, and password of the service account.

11. Click Install to begin the installation.

12. Once the installation is complete, click Close to close the wizard. Continue with Updating the Configurations section below.

Source Files Config

Source files set where the source files for Data Uploader and any mappings exist. The out-of-the-box configurations set uniqueids which are important unique identifiers in CAM and other systems used. This 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.

1. Update the uniqueid line to the columns and source that makes a user unique to the firm. Most commonly it is the type of user, the userid, and the database of the source.

For example, uniqueid client id, matterid is pulled from CreateorUpdateWorkspace.sql

Last Modified Date in the Config

If the last modified date is in the config, then the last modified date is used to check the data brought in. However, the Job Delta ensures the records from the sync before remain in the Staging tables. Only any new, or changed records get imported from there into CAM. Similarly, the SQL files tab will use the last modified date in those SQL files.

Modifying Application Settings

The application configuration can be further edited from the AppSettings.config file in the Data Uploader directory.

To restore a prior configuration:

1. First, backup the appsettings.config.

2. Then, upgrade Data Uploader as you normally would.

3. Finally, restore the config, or copy the configuration to another system.

CheckOutPathMap.Config

Configure this script to scan for remote check-in files from Data Uploader.

The script looks like this. Use the attributes description to understand variables.

CAM processes the checkoutPathMap.config file according to the following sequence:

1. Check for a Matching Pattern

   Starting from the top of the checkoutPathMap.config file, CAM searches for a matching pattern. Once a match is found, CAM will not continue to read the remaining entries in the configuration file. The order of pattern matching is as follows:

   • Check for pattern: username (match-user-name) + machinename (match-machine-name) + drive (match-drive-name)

   • Check for pattern: username (match-user-name) + drive (match-drive-name)

   • Check for pattern: username (match-user-name) + machinename (match-machine-name)

   • The final check is for a drive only.

2. Read and Parse the Replacement Pattern

   CAM compares the replace-start-with value and replaces it with the parsed replace-pattern. For example, if a file is checked out to C:\NrPortbl\file.doc on the machine desktop1, the following pattern designates the path as \\desktop1\c$\yyyy rportbl\file.doc:
3. <path match-drive-name="c:" replace-pattern="\\@machine@\@checkoutdrive@$\yyyy" replace-start-with="@checkoutdrive@:"/>

4. When No Pattern Match Found Occurs

   If no matching pattern is found in the checkoutPathMap.config file, CAM defaults to using the checkout path location recorded in the WorkSite database.

Implementation Notes

1. matchdrivename will be according to the checked-out path. If you have a checkout path on the c drive then pass the matchdrivename like c:\. If you are using a network path for the checked-out document then enter the path like \\machine_ip\ i.e
   94.130.20.199

2. To remotely check in a document for any checked-out document, implement this in the following way:

   1. Grant full access to the service account to the checkout dir.

   2. Add the following line to CheckoutPathMap.config on the Data Uploader server

      <path match-user-name="MyUserID" match-machine-name="MyLocalMachine" match-drive-name="c:" replace-pattern=\\@machine@\@checkoutdrive@$ replace-start-with="@checkoutdrive@"/>

Filtering Active Directory Users/Groups

ADMapping.config

Filtering on the data brought in from Active Directory can be done on the configuration file in Data Uploader. This is so specific users or groups can be included or excluded from the sync. Multiple values are supported, but users cannot add multiple in one configuration.

To set the config:

A sample configuration is below for users:

Set the following options for creating groups in Azure with the following:

1. Office365 (recommended) - Allows teams to collaborate and share a workspace for conversations, files, and calendars using group email.

2. Distribution - Allows to send emails to all group members.

3. Mail-enabled security - Uses all distribution list functionality and additionally uses it to control access to OneDrive and SharePoint.

4. Security - Allows to control access to OneDrive and SharePoint and uses for Mobile Device Management for Microsoft 365.

A list of Active Directory ad-properties and attributes can be found in the Microsoft documentation.

OU filtering

The organization units in Active Directory contain multiple groups with multiple users.
Now you can filter the user from a specific group in a single organization unit. The supported property is the "memberof." The "memberof" property takes the group name as a value and operators (%% - contains and !% - not contains) that are used to help in the filter. These parameters return the list of the users who are present or not present in the specific group.

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,

• ad-property name - represents the search value or string.

• Value – represents character(s). It must be present in the search value or string.

• Operator – represents the searchable value. It must come either at the start of the string (s%) or at the end of the string (e%)

• MultivaluedDatabasevalueMapping

  • It is a new database property value "MultivaluatedDatabase" which allows you to add multiple databases to the value field in AD-mapping that allows you to generate multi-input CSV or multi- delta CSV, respectively.

Sample Multivalueddatabase property value

• SkipUpdateIfExists

  • While importing new AD users to iManage for the first time, the property name "SkipUpdateIfExists" with a value ="True" for iscamuser and iscamgroup has been added in the AD-Mapping that allows you to skip the update programmatically if it exists already.

Sample SkipUpdateIfExists property value - iManage

Sample SkipUpdateIfExists property value - M365

• Preferred Database field

  • Add property value "PreferredDatabase", allows you to specify the user's Preferred Database on user creation

Sample PreferredDatabase value

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

Sample Password flag Mapping

AppSettings

App Settings allow for configuring the settings to the Data Uploader application as a whole. Any performance, or implementation settings reside in here.

Open up the AppSettings.config in C:\Program Files (x86)\Prosperoware\Prosperoware Data Uploader\configs file path.

Available Settings

1. Show Fileshare: If your firm uses fileshares and imports from one in Data Uploader, set this to true during the implementation. The default is false.

2. SQLFolderPath: This sets the folder where the SQL files to run that display in the SQL Files tab reside. If you’ve changed the folder location from default, change this before you implement and sync.

3. CsvFolderPath: This sets the folder where CSV’s that were generated by the data uploader reside during the sync. If you’ve changed the folder location from default, change this before implementing and syncing.

4. CSVArchiveFolderPath: Archived CSVs from jobs reside in this folder path. If you’ve changed the folder location from default, change this before implementing and syncing.

5. CSVDelimiter: Tells what delimiter to use in CSV creation. \t is for tab separated and \c is for comma separated. Change this to the delimiter that your firm uses.

6. DateFormat: Sets the format of dates handled through data uploader imports. The default is: yyyy-MM-dd HH:mm:ss.

7. SyncGroups: Set as true to sync groups. This will be set to true if you select sync groups from the UI.  The default is false.

8. SuppressScriptErrors: Set as true to eliminate extra debugging errors. Set as false if you are running into errors or not getting an error to an issue/ customer care recommends. Recommended to keep true until necessary. The default is true.

9. CommandTimeout: Sets the timeout of DataUploader’s processing of syncs. The default is 600. Keep for the initial sync, unless your partner or professional services team or DevOps recommends a higher value, or if you see issues with timeouts with large batches.

10. ArchiveFilesLifeCycle: Sets the retention period in days for archived files. The default is 30 days. E.g. if 30 days is set it will keep archived files for 30 days past when it was generated. If your firm requires a longer retention, change this value in implementation.

11. RecordCountLimit: The limit of records to return per CSV when it is batching to upload to CAM. The default is 100. This setting can be changed in the Administration panel of CAM to override as well. This helps to batch the records.

12. ThreadCount: Number of processor threads to use for DataUploader on the machine running DU. Keep in mind that this depends on the machine running DataUploader, as well as the DMS you may be syncing from like iManage. Do change this during implementation.

13. ExportFolderLength: Character length max for the folder name. The default is 200 characters. If your folder name length is longer than this, you may see folder length errors, so increase this value.

14. ExportDocumentLength: Character length max for the document name. The default is 200 characters. If your document name length is longer than this, you may see document length errors, so increase this value.

15. DomainMachineName: This is the machine name or IP address of the AD server you are connecting to.

16. SkipDupeDetection: If 0, this would enable duplicate detection in the sync and flag in the validation report and job any duplicates.

17. DupeDetectionType: If 1, the log resides in the dupe folder path.

18. DupeFolderPath: Path folder for duplicates to be logged in. “Duplicate” is the default.

19. ReplicationSyncWaitTime: Time to wait between the replication of a sync to the next sync. The default is 30 seconds. If you set this too close, syncs may collide.

20. MaximumExportConcurrency: Sets the number of items to concurrently process in export. The default is 20 items. If errors exist with timeouts or Unavailable, the number could be too high for the source server.

21. EmailProfileColumns: The columns of metadata to include in the email profile. Default is: MessageId#Name,DateTimeReceived,DateTimeSent. Change this configuration during implementation if necessary to change the email profile columns.

22. UserPictureProperty: The property to bring over the user’s pictures in the sync to CAM. The default is thumbnailphoto. If you don’t want pictures, remove this property in implementation.

23. SyncNestedGroups: This parameter allows the syncing of nested groups and their children users and groups. The default is No (turned off). Turn this on if your firm in AD has one or more nested groups that you want to sync the nested groups and users.

App Settings Implementation Checklist

Must Review or Add

The following of the above settings need to be reviewed or added during implementation:

• Show Fileshare

• CSV Delimeter

• DateFormat

• SyncGroups

• CommandTimeout

• ArchiveFilesLifecycle

• ThreadCount

• ExportFolderLength

• ExportDocumentLength

• DomainMachineName

• SkipDupeDetection

• EmailProfileColumns

• SyncNestedGroups

Optional or Default System Settings

The following settings are either defaults that may not need to be changed or optional settings:

• SQLFolderPath

• CsvFolderPath

• CSVArchiveFolderpath

• SuppressScriptErrors

• RecordCountLimit

• ReplicationSyncWaitTime

• MaximumExportConcurrency

• userPictureProperty

CAM Credentials tab

When the data uploader is accessed for the first time, the CAM Credentials tab on the Cloud Data Uploader window displays. The Cloud Data Uploader requires domain authentication to secure information from the source destination to the target destination.

Type information in the provided fields, based on the table below, then click Authenticate. This is a one-time process only and need not be done for subsequent updates. Re-authentication may be required in case you change your credentials or your access token fails.

Upon successful authentication, you will be brought into the Data Uploader page to the Run tab by default. Go to the Connection String tab to begin.

Connection String tab

Use the following instructions to add a new connection string to connect to the billing database. This will allow the Data Uploader to connect to the SQL Server and execute the queries to upload jobs to CAM. If you run Data Uploader without a connection string, it will return an error.

1. Type information in the provided fields, based on the table below.

2. Click Save.

3. Click Test Connection. If successful, a Valid Connection message is displayed.

4. Continue to the SQL Files tab to set the SQL scripts to run for the uploader process.

Creating and Connecting to the CAM Local Database

The CAM Local Database is used to store the Data Uploader database schema, which includes various tables that Data Uploader uses to store information about the jobs it submits to CAM.  One of the CAM Local Database tables, the JobDelta table, tracks changes between job runs and is important for troubleshooting.

Open

To create the Data Uploader schema as pictured above, create an empty SQL database, then establish a CAM Local database connection to it within Data Uploader.

1. In the external system SQL server, create an empty SQL database.  It is common for the database to be named “CAMLocal” but not required.

2. On the Connection Strings tab in Data Uploader, click +Add to add a new connection.

3. Enter a Name for the connection, then in the Select Connected system list, choose CAM Local Database.

Open

4. Complete the other connection details, click Connect, then Save. The empty database is populated with the Data Uploader schema.

Using Multiple Connection Strings

If there are multiple sources, you can set multiple connection strings. For this to work, .Net 4.8 or higher is required to be on the system data uploader is installed on.

The setup of the multiple connection strings, differs where the source systems reside. Use one of the following steps below:

Both sources are cloud based: Set up the source systems in the Source System panel. The source systems can be independently run.

Both sources are on-premise and on the same sql server: The connection string can be used for both systems, since the databases reside on the same server.

Both sources are on-premise, but each source is on a different sql server: Data Uploader would need to be installed on two instances, one for each source.

There is a new ConnectionString.config file, where users can add multiple connection strings, on a file by file basis. This is edited whenever a user adds a new connection string from the Connection Strings tab in the user interface.

Active Directory tab Connect to to AD

Click this tab to sync connections to an Active Directory system including AzureAD/Entra ID which CAM DU supports. Microsoft now calls Azure Active Directory-> EntraId New name for Azure Active Directory - Microsoft Entra .

Active Directory is used to bring over users and groups into CAM.

1. Click + Add and provide details in the available fields, based on the table below.

2. Go to Run Tabs and click Run Now to trigger the AD sync manually.

3. Click Save.

Additional AD Information

If necessary these are the following mappings of AD properties to a given CAM field that is imported through Data Uploader. The CSV is created in the beginning of a scheduled sync or a run now sync. The files then are uploaded into CAM.

1. The following AD properties are mapped (from the CSV file) on data sync:

Scheduling multiple OU or Container syncs

Firms can sync multiple OU’s or containers separately if necessary.

1. To do so, create another AD configuration in the Active Directory tab.

2. Set a different OU in the domain path than the first one (e.g. OU=Asia rather than US even though the domain might be the same otherwise).

3. If a user path or group path differs, change this.

4. The container path can also be inputted to the domain field if desired.

5. Set any remaining exclusions or configurations and set them active.

6. Now the user under the Run tab can schedule each AD domain job separately so that each OU Container or path is imported.

Maintaining AD Change Events in DU by Turning on AD Logging

For Active Directory to maintain change events in DU/CAM to users and groups in regards to deletions, the Active Directory logging needs to be enabled on that AD server.

You can read this information in full from Microsoft here:

AD and LDS diagnostic event logging - Windows Server

Steps:

1. Log onto the AD Server running AD to which you will be synching CAM to.

2. Select Start, and then select Run.

3. In the Open box, type regedit, and then select OK.

4. Locate and select the following registry keys.

   Domain controller: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\NTDS\Diagnostics
   LDS: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\<LDS instance name>\Diagnostics

   Each entry that is displayed in the right pane of the Registry Editor window represents a type of event that Active Directory can log. All entries are set to the default value of 0 (None).

5. Configure event logging for the appropriate component:

   1. In the right pane of Registry Editor, double-click the entry that represents the type of event for which you want to log. For example, Security Events.

   2. Type the logging level that you want (for example, 2) in the Value data box, and then select OK.

6. Repeat step 4 for each component that you want to log.

7. On the Registry menu, select Exit to quit Registry Editor.

    

Local Sync tab

This tab helps to schedule and sync CAM data to the local database.

1. Type the information in the provided fields, based on the table below.

2. Click Save.

Data Flow from AWS tenant to local database

1. It enables you to save the data from a CAM tenant into a local database through a connection string. This uses the CAM API over calls through an HTTPS connection authorized by an “OAuth token”. For details on OAuth see the subsection below.

2. Then the data is saved to the local Database into CAMSync.job. CAM will log the data being synched, the audit information, and details about the job being processed such as scheduling and recurrences.

3. CAMSync.Matter, CAMSync.Metadata, CAMSync.Users, CAMSync.Groups and other tables will be where the data resides when it is synched to CAM. Use these for your queries to see what data flows to CAM.

Open

OAuth Information

Data Uploader(DU) connects to CAM via OAuth. Initial tokens are obtained during the initial setup and then renewed on a regular interval. Token can not be used to directly log into UI. Tokens are stored encrypted locally.

Version Data Uploader Uses: 2.0

OAuth 2.0 has a client, an authorization server, a resource server, and a resource owner. As per the flow chart below, Data Uploader uses OAuth 2.0 to connect to CAM.

Open

SQL Files tab

In Data Uploader, all sample SQL files are stored in the Sample folder (C:\Program Files(x86)\Prosperoware\CAM\DataUploader\CAM\sample - this will point to the location where the uploader is installed). To execute SQL queries, move the SQL files to the on-premises database defined in the connection string (C:\ProgramFiles(x86)\Prosperoware\CAM\DataUploader\sql). This sql folder will contain all your SQL queries to be executed by the Data Uploader.

After upgrading Data Uploader:

1. Edit the Path for the SQL files to point to a folder inline in the AppSettings.config file if a custom SQL files path is used. Otherwise, skip this.

   1. Open the Data Uploader folder in the filesystem. Go to C:\Program Files(x86)\Prosperoware\CAM\DataUploader\CAM\service

   2. Open file AppSettings.config

   3. Confirm or edit the line item <add key="SqlFolderPath" value="" /> is set to the folder of the SQL files if a custom folder is set. If out of the box, skip.

2. Edit the individual SQL file configurations in the SourceFiles.config.

   1. E.g. if you added a script for Folders, a line item would be added inside SourceFiles.config like:

   2. <uniqueId columns="clientId,matterid" source="Folders.sql"/>

   3. Ensure you have a Folders.sql in the SQL folder.

   4. Repeat for all SQL files you have. If you don’t add these to the config they will not be used in the import.

Viewing SQL Files:

1. In the Cloud Data Uploader, click the Refresh button to view the updated list of files placed in the Sample folder.

2. To view or edit the script, click Edit File.

• Options to Edit are:

  • FileName cannot be edited.

  • Type of the SQL file.

3. Select if Enabled or not Enabled. If no, the remaining fields do not display. If yes, these fields display:

• Run Every: The time period to run the SQL script.

• From: The initial date of the full or delta sync.

• Start: The start date of the full or delta sync

4. Click Run Now to execute the query.

Actively used SQL files will be checked in the Active box. Inactive files are not checked and used.

Once the query is executed, the Data Uploader will create a CSV folder in the default installation location C:\Program Files(x86)\Prosperoware\CAM\DataUploader\csv. Each query is returned in the form of a separate CSV file, which is placed by the Data Uploader in this CSV folder. The CSV file is then uploaded to the Jobs tab for further processing. The log details of this uploaded job can be viewed in the Log tab in the Data Uploader.

Validation of SQL Files:

This feature allows for the validation of the Data Uploader SQL files. It checks if the metadata is present in CAM, if the metadata mappings are present, and if the column names are defined. Additionally, if templates are set, it will check that the templates exist in CAM. Users and Groups ACL's are also confirmed to ensure the users and groups exist in CAM.

1. Click Validate SQL Files from the options menu in the SQL Files tab of Data Uploader.

User Creation and Validation

When a user is created through an SQL file, whichever metadata is present in CAM Internal Metadata will validate successfully. Missing metadata will show an error. The particular failed data entries will be in the Application Log of Data Uploader. Any portion of the Validation that fails will have a red X.

The tables checked will be the Users, UserGroups tables as these are the staging tables. Under the schema CAMSync, the users and usergroup tables there will be where the records that are new or changed need to be imported into CAM.

Open

Open

By default, all SQL files are checked. If you uncheck the all button, then you can individually select one or multiple files.

If a validation error or error shows that the group name or username is too long, please modify this. See this page for the group name character limitation: CAM Limitations | Data Uploader

Setup the Schedule button

The best strategy for scheduling both AD sync and SQL scripts is to first determine the frequency of changes applicable to each. Next, based on the determined frequency, individually schedule each SQL script from the SQL tab, and the AD sync from the Active Directory tab, and ensure that tasks do not overlap.

The global schedule for the queries to be executed can be set on the Run tab. The content from your source database will be automatically updated to CAM as per the frequency defined here. You can set the option to execute the queries Minutely, Hourly, Daily, Weekly, or Never (for a manual or one-time run).

The table below lists the set up available. The timer is available for each SQL file available.

1. Set the timer

2. Click Save. The Last Run time and the scheduled Next Run time is updated in the tab.

   1. You can also click Run Now to execute the job manually.

The Data Uploader task is also added to the Windows Task Scheduler on the machine where the Data Uploader tool resides, if scheduled for a timeframe. The schedule for the Data Uploader can also be adjusted from the Task Scheduler. The user must have an account with permissions to enable the scheduler task.

Each CSV file will be uploaded one at a time into the Jobs tab to eliminate collisions.

By default, when deleting logs, CAM will delete all filtered logs. For example, if you filter based on date, it will delete all log records from that time period.

Validate button

This button validates the data and configuration files, and provides status.

Any portion of the validation that fails will have a red X. The particular failed data entries will be in the Application Log of Data Uploader.

For example if it says Templates do not exist in CAM, the templates need to be created in CAM first before running DataUploader. See step 8 of the Provision checklist here: Provision Implementation Checklist

Open

Run Now button

This will pop up a window that provides options for the user to decide which files to run. It allows users to select individual SQL files or Active Directory Sync.

1. Click Run Now to open the following dialog:

Open

2. Select Sql Files, Active Directory, or All

   1. If Sql Files is selected, it displays a list of active SQL files with checkboxes. See below.

Open

3. Click Run so the selected files will be executed, or click Cancel to close the dialog. You can see that CAM has created a separate CSV folder under the parent CSV folder for each SQL file to help us identify the specific SQL file.

Task Scheduler Configurations

4. After successfully running the SQL files, navigate to the Task Scheduler. Notice a CAM folder is created programmatically containing SQL files, as shown below:

Open

5. Select the job and double-click to edit. The following screen opens:
   
   

   Open

   

6. Select Run whether user is logged on or not.

7. Check the box for Run with highest privileges.

8. Click OK to run the job or click Cancel to close the dialog.

Logging of the Job

1. Click the Log tab to view information on the jobs executed in the Data Uploader, including process information and the type of error. The following types of entries are displayed:

• INFO- Any information or generic notes regarding certain jobs uploaded.

• ERROR- Displays a message describing the failure. Click Details in the message to view the error details and stack trace.

• FATAL- Displays a complete description of the error.

2. The Log has a Filter option that allows you to narrow the entries to a particular set of results.

3. You can also Export the content of any log to Excel. This can be helpful when contacting Support regarding an issue.

4. Click the Refresh button to refresh the values to show the latest log entry.

5. Click Delete to clear the log.

Re-queue a Job:

There is a new queue parameter to re-queue any old jobs. To do this:

1. add/update the CSV parameter of the job CSV to Queue=1 and upload.

Users do not need to wait for the complete job to see the log within CAM. When it appears, double-click on the Jobs tab in CAM.

Sync with an On-Premises SQL Database

Data Uploader comes with the ability to sync CAM with an on-premises local SQL database. Users may need the CAM data for third-party databases like SPM. Additionally, this locally stores the uploaded workspace jobs before uploading them to CAM. This enables an efficient Delta upload by allowing Data Uploader to compare the local data for changes and only upload those workspace jobs that need to be updated.

To setup an On Premise Sync

1. Open Data Uploader.

2. Go to the On-Premise Sync tab.

3. Enter the SQL server name. If it is on the localhost, you can put (local).

4. Enter the Database Name.

5. On the Trusted Login option, select Yes or no.

   • Yes is if the user will use Windows authentication to connect to SQL.

   • No lets the user set the UserId and Password.

6. Click Connect and Create Schema.

This creates the needed schema on the database for the CAM Data Uploader sync(s).

After the schema is created, set up the sync properties and schedule.

What do you want to sync?

• Users

• Groups and Group Membership

• Matter(Workspace)

• Metadata

How often do you want to sync?

• Minutes

• Hourly

• Daily

• Weekly

• Never- Means one time manually

Schema of the On-Premises Sync

• CAMSync.GroupMembers. Contains the members of each group.

• CAMSync.Job. Contains the jobs that run.

• CAMSync.JobDetails. Details about which sync job is running. For example, is the job running a user job, matters job, etc.

• CAMSync.Matter. The matters are synched here. Note these are just references.

• CAMSync.MatterSystem. The details of the matters reside here. All system matters live here (imanage, netdocuments, office365, external systems).

• CAMSync.Metadata. All of the metadata is synched here.

• CAMSync.UserGroups. The users and their groups are synched here.

Mapping Active Directory (AD) properties

The ad-property imported can be mapped to another property so that the data comes through as desired.

To set the property mapping

1. Change the config for the AD sync to add the csvproperty.

For example, let's change the email to be the iManage userid and not the userid from Active Directory

The config should be setup like this:

2. Within the adproperty field line, add csvProperty="Property" for it to use that csv property.

3. Save the config.

4. Run Data Uploader.

The email is set as the userid for iManage, if you Generate the CSV from Data Uploader, or run the Data Uploader Sync.

Passing Users via CSV

If the UserId passed in the CSV is incorrect compared to Active Directory, CAM will still create a user that doesn’t exist, if you pass them via CSV.

Required fields for the user to be added are:

Optional fields:

• SkipUpdateifExists: Use this parameter with an AD sync or without one based on where you want users and groups to be imported. Set this setting here in AD configurations if you want the user to come from the AD system. 0 will update the user or group in both CAM and the external system, 1 will skip the external system and update only in CAM.

OS Type Ids

Configure Metadata names to Export the Document to Network Path

While exporting the document to network path with the option include CSV file, it will export the metadata selected in the query.

The CSV values are generated according to the config file related to the external system.

Configuration path: C:\Program Files (x86)\Prosperoware\CAM\Data Uploader\service\config

Configure the fields according to the information below:

• name: The Name of NetDocuments\iManage Attribute

• description: The Name of the Column that will be shown on the CSV.

• attrId: The Attribute id in the NetDocuments\iManage.

• enabled: True or False(if true that column should be included in the csv and vice-versa.)

• prosp-parent: Specify the Parent of the metadata when having parent-child metadatas.

Sample files are attached:

iManage: IManageDocProperties.config

NetDocuments: NetDocsProperties.config