The FileShare integration module in CAM is used to connect to Network Shares and sync their legacy contents. The module will track the shares, tag with the client and matter metadata, create templates and apply security, and PII Scanning up to CAM.
Requirements
UNC path is accessible on the machine that the FileShare application is installed on
A blank SQL database for the FileShare schema to be installed on.
An Active Directory connection
Workflow Steps
Get the UNC path.
Install the Agent service for Fileshare.
Configure the FileShare application to connect to the UNC path and sync.
Create Folders through Folder Template Editor or through the FileShare.
Create Workspaces using the Workspace Wizard.
Installation
Download the installer from Administration->Downloads-> Fileshare within CAM.
Run the installer on the machine with access to the fileshare.
The installer will install the FileShare Application and the CAM FS windows service.
The program is installed in the x86 program files folder by default.
Configuration
Start the Application CAM.FileShare.UI.exe from the Prosperoware\CAM\Fileshare\Agent\ folder. It is not necessary to run as an administrator.
On run, the user interface will show 7 tabs: FileShares, CAM Login, Database, Active Directory, Agent, Command and Log.
File Shares tab
This tab displays any file shares configured in the application. Multiple fileshares can be setup.
The following information displays on the tab:
Column | Description |
File Share | Shows the name of the file share. The hyperlink brings the user to the fileshare path. |
Stats | The stats column shows the contents of the fileshare. For example the number of folders and documents in the file share. |
Last Sync | Shows the date and time the file share was last synced. |
Status | Shows the status of the sync of the file share. |
Run Sync | Runs the sync immediately. |
Add | Adds a new file share configuration. |
CAM Login tab
This tab sets the CAM login credentials to connect to CAM.
The following information displays on the tab:
Column | Description |
Domain | Enter the domain name that contains the data to be synced to cloud. E.g. sitename.tenantname.io. Leave off the https:// and the ending / |
Enter your domain email ID. E.g. myemail@company.com | |
Password | Enter password for the email specified above that is used to log into CAM. |
Active Directory tab
This tab displays all the active directories connected. One Active Directory is required.
The following information displays on the tab:
Column | Description |
Domain | Shows the name of the file share. The hyperlink brings the user to the fileshare path. |
Username | The stats column shows the contents of the fileshare. For example the number of folders and documents in the file share. |
Users Path | Shows the date and time the file share was last synced. |
Active | Shows the status of the sync of the file share. |
Edit | Edit the active directory configuration. |
Delete | Delete the active directory configuration. |
Add | Add a new active directory configuration. |
Command tab
This tab displays all the jobs running of File Share syncs.
The following information displays on the tab:
Column | Description |
Command | Example commands are scanfolders (scanning the file share), createworkspace or createfolders. These are the jobs that are running. |
Status | The job status. Queued, In Progress, Success and Failed are options. |
Response Status | If a job is successfully created a Success response is passed. |
Remaining attempts | If the job is created with multiple attempts, the number of attempts remaining show. |
Created | Date job created |
Updated | Date job last updated (as it processes) |
Response Sent | The date of the sent response. |
Log tab
This tab displays all the Sync logs.
The following information displays on the tab:
Column | Description |
Log Level | Example levels are: Info, Debug, Error, Warning |
User | The user working with fileshare. |
Server | Server from which the log was sent. |
Created | Date created |
Message | Log message including any error stack traces. |
Database tab
This tab sets the database connection string.
The following information displays on the tab:
Column | Description |
SQL Server Name | The name of the SQL server hosting the billing database. |
Connected System | Shows the connected systems that can be set. Options are Local Sync Database, Source Database, and CAM Local Database. Local Sync is one used for DataSync. Source Database is the external system typically used. CAM local database allows connecting to a CAM local database to use. |
Database | The name of the database that you created on the SQL server to be used by Data Uploader. |
Authentication | Choose the type of authentication to be used to connect to the data source database. Options include Windows authentication using the Windows credentials and SQL authentication using specific database-only credentials. |
Username | Enter the username of the database. (SQL authentication only) |
Password | Enter the password for the username of the database. (SQL authentication only) |
To add a New File Share
Click the Add button from the File Shares tab.
Enter the UNC folder path of the File Share in Folder Path. Format: \\ComputerName\Folder. Is required.
Choose an Active Directory Domain in the Default Domain lookup. Is required.
Choose a Default OU for users and groups if necessary. Format is OU=Department
Select the organization format of the File Share.
First level folders are matters (workspaces or projects)
Second level folders are matters (workspaces or projects)
Custom: Allows a custom level of folders to determine the root matter/workspace/project. Select from the selection button.
Set metadata filters up to filter the metadata of the fileshare. Client and matter expressions can be set. Format would be for example Client: ^\s*([a-zA-Z0-9]+)[^--]+ and Matter: (?<=-)[^-]+(\s*). These expressions will filter matter and client when the client/matter number is setup as 1000-001.
When the file share sync is ready to begin, select the Sync Enabled button to Yes.
Enter the timeframe for the sync. For example, Sync every 30 minutes.
Select whether or not to sync documents.
Select whether or not to perform personal data detection. Personal data could be any sensitive information for example social security numbers, and the personal data would be scrubbed.
Select whether to sync the Audit. This is important as if the Event Log or Audit is truncated or removed prematurely, delta syncs may not capture the last sync information.
A nickname for the sync can be given.
File Share Actions
The following actions can be taken on fileshares from the File Share tab:
Edit: Edit the file share configuration.
Delete: Delete the Configuration.
Create Folder: Allows to create a folder within the fileshare from the application.
Sync Now: Runs the File Share sync immediately. Good for one time sync.
Re-Scan Now: Allows Fileshare to rescan the UNC path for folder and document count statistics.
Personal Data Detection: Allows the user to detect and manage personal sensitive data found in the file share.
Import Metadata: Allows the import of metadata to the fileshare using CSV. Read CSV parameters for all metadata
Download Metadata CSV: Downloads the metadata in CSV form from the fileshare. Allows an easy export of all metadata, to be used in CAM.
Configuration files
The Connection Strings will be saved to the Prosperoware\CAM\Fileshare\Agent\Config folder. The following connection strings are important:
AppSettings.config: Contains application global settings.
AppSetting | Default s and Descriptions |
Token Endpoint | |
ClientUI | Address and Port for the ClientUI |
AWSRegion | The AWS region if specified |
DocumentAnalysisServiceEndPoint | Service address and port for the document analysis services. http://127.0.0.1:5000 |
CoreAPIURL | URL for the Core API |
CSVFolderPath | Folder path for csvs |
CSVArchiveFolderPath | Folder path for archives |
CSVDelimiter | The type of delimiter to use in the CSV. \t= tab. \c=comma |
DateFormat | Format of system and file dates. Default= yyy-MM-dd HH:mm:ss |
SuppressScriptErrors | Default= true; for debugging, leave as false to show all errors. |
ClientSettingsProvider.ServiceURi |
|
CommandTimeOut | Time for command timeouts. 300 secs |
ArchiveFilesLifecycle | Days to keep archive CSVs in Archive folder. 30 days |
RecordCountLimit | Record Count limit per batch; Default=500 |
ThreadCount | Number of threads to use. Default=20 |
DomainMachineName | Name of the machine name on the domain |
Log4net.Internal.Debug | False: Used for log debugging |
AuditLogLifeCycle | 30 days |
ConnectionString.config: Contains the connection string that is created when the application is installed.