Overview
The FileShare integration module in CAM is used to connect to Network Shares. The module will track the shares, tag with the client and matter metadata, create templates, and apply security up to CAM.
Follow this guide to verify the requirements and install and configure the integration.
...
| Table of Contents | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
|
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.
Unsupported
Windows does not support the following special characters:
...
| Note |
|---|
Unsupported special characters will be escaped in Fileshare if included in the filename. |
Workflow Steps
Get the UNC path.
Install the Agent service for Fileshare.
Configure the FileShare application to connect to the UNC path and sync.
Open the Database Tab first.
Then the CAM Login tab.
Then the Active Directory tab.
Then the FileShare tab.
Create Folders through Folder Template Editor or
...
the FileShare.
Create Workspaces using the Workspace Wizard.
Installation
...
Navigate toAdministration.
Click on Downloads-> Fileshare
...
.
...
The Exe and MSI downloads are available. Exe should be used for first-time installations.
Run the installer on the machine with access to the
...
file share.
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.
| Info |
|---|
Note: If the configuration fails saying the ProgramData folder is inaccessible, the folder for Fileshare will have to be given shared security for those application users. |
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 the run, the user interface will show 7 tabs: FileShares, CAM Login, Database, Active Directory, Agent, Command, and Log.
Database tab
On the first run, this tab should be opened first. This tab sets the database connection string.
...
Column | Description | ||
SQL Server Name | The name of the SQL server hosting the billing database. | ||
Database | The name of the database that you created on the SQL server to be used by FileShare to upload the data from the fileshare to the staging DB to CAM.
| ||
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) |
Click Test to test the authentication to the SQL Database.
Click Save to save the database information. A message says Database Configuration Saved Successfully if all is well. An error appears if one of the items is incorrect or wrong.
Troubleshooting Common Database Errors:
...
This tab displays all the active directories connected. The following information is displayed 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 count of the fileshare. For example the number of folders and documents in the file share. |
Last Synced | Shows the date and time the file share was last synced. |
Status | Shows the status of the sync of the file share. Running: Sync is running Stopped: The Sync is stopped, or the service is stopped. StopPending: The service is trying to stop in Windows Services. Utilize Windows Services panel for any failure stacktraces. StartPending: The service is trying to start in Windows Services. Utilize the Windows Services panel for any failure stacktraces. Completed: Sync is completed successfully. |
Sync Now | Runs the sync immediately manually. It will only run if the folder(s) do not have a sync status of 10 (means already synced) |
Add | Adds a new file share configuration. |
ReScan Now | Re scans the fileshare immediately manually. |
Edit | Edits the fileshare |
Delete | Deletes the fileshare |
Create Folder | Creates a folder inside the fileshare. |
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.
Enable Metadata Filter. Select to filter the Metadata of the FileShare. Client and Matter expressions can be set. The Format would be, for example, by default:
Client Number Regular Expression: ^\s*([a-zA-Z0-9]+)[^--]+ and
Matter Number Regular Expression: (?<=-)[^-]+(\s*). These expressions will filter matter and client when the client/matter number is set up as 1000-001 for example.
When the file share sync is ready to begin, select the Automatic Sync Enabled button to Yes.
Enter the timeframe for the sync. For example, Sync every 30 minutes. The default is 10 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 because 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.
The fileshare syncs automatically will skip hidden folders and subfolders in any sync.
Actions
The following actions can be taken on file shares 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 . Download the metadata in CSV form from the fileshare. Allows an easy export of all metadata, to be used in CAM.
...
This tab displays all the jobs running on File Share syncs. The following information is displayed on the tab:
Column | Description |
Fileshare Path | The fileshare path in full. This allows you to determine which fileshare is used. |
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, Already Synced and Failed are options. If failed the exception can be opened and copied with the Copy Exception button. |
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. |
...
This tab displays all the Sync logs. The following information is displayed on the tab:
...
This tab displays all the agents set to sync fileshares. Multiple agents can be used to scale up batch processing or to divide the workloads. The following information is displayed on the tab:
...
AppSetting | Defaults 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 | How long to keep the audit logs. 30 days | ||
CsvBatchSize | Sets the number of matters that will be synced per batch in the CSV. Default=4
| ||
LogCsvFolderPath | The path for the FileShare logs that are stored locally. Default=C:\ProgramData\Prosperoware\CAM\Fileshare\Logs | ||
Stage | <add key=”Stage” value=”” />
|
...
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. | ||
SQL Server Name | The name of the SQL server hosting the billing database. | ||
Database | The name of the database that you created on the SQL server to be used by FileShare to upload the data from the fileshare to the staging DB to CAM.
| ||
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) |
Self-Healing
...
Fileshare now checks if any security changes to the share violate controls and overwrite overwrites them accordingly.
This is called self-healing in CAM.
...
FileShare now supports importing non-inherited folders and files from the FileShare. A flag is inherited and displayed when non-inherited folders are imported.
Process
...
if someone removes (excludes) or adds/edits (includes) a user/group or access in the Folder Security that violates the policy setup in the Control Center.
That is then synced using the linkfileshare job by the Fileshare app.
After the job is completed, it gets pushed to the control center to re-apply the security control.
CSVs
...
CSVs are stored in three locations:
...