Documentation

Advanced Folder Sync Settings


How to define advanced folder Sync settings
The Sync feature can be a powerful tool in a multi-user application environment, as a way to upload and share files, or as a single user environment to backup data. Please read all settings carefully.
1) The When Removed field is utilized to define the folder path (e.g. C:\Documents\Sync Location), ftp location (e.g. ftp://username:password@myftpsite.com/sync_folder_name), or http service to (e.g. http://www.mywebsite.com/syncfiles.php). When a file is removed from the active folder and its Policy Value Match is true IntelliCabinet will attemp to remove the file within the sync location by performing the neccessary actions based on the defined setting. Please see the notes at the end of this documentation for additional details.
2) The When Modified field is utilized to define the folder path (e.g. C:\Documents\Sync Location), ftp location (e.g. ftp://username:password@myftpsite.com/sync_folder_name), or http service to (e.g. http://www.mywebsite.com/syncfiles.php). When a file is added or its columns values defined by the Policy Column Name field are changed and matches the Policy Value Match setting IntelliCabinet will attemp to add or replace the file within the sync location by performing the neccessary actions based on the defined setting. Please see the notes at the end of this documentation for additional details.
3) The Policy Column Name field is where you will enter the column names to monitor for changes that will trigger the syncing of the file. If more than one column name is desired then you must define a delimiter (e.g. My Column1;My Column2)
4) The Policy Column Name delimiter is the character that divides the defined Policy Column Names when more than one Policy Column is defined. In the above example the semicolon (i.e. ;) is utilized as the delimiter.
5) The Policy Value Match field is where you would define the column value that must be true in order for syncing to be triggered. For example: If the Policy Column Name was defined as My Column1;My Column2 and My Column1 was of data type Checkbox and My Column2 was of data type Text then perhaps the Policy Column Value would be defined as True;My Text. When the file's columns defined by the Policy Column Name are edited the sync method will evaluate the values within them for a match to the Policy Column Values Match. If a match results in true then the sync operation is performed. You can also define the Policy Value Match as a Java regular expression, see the Java regular expression api for additional details on this feature.
6) The Comment Column field is where you will enter the column name that the sync operation will utilize to enter text information during the sync operation. For example, Sync was cued, Sync completed successfully, etc.
7) Toggle on the Mimic File Location setting you want the sync location to be defined as the When Removed and/or When Modified path plus the syncing filess defined folder paths. For example: If the When Modified path was defined as C:\Documents\Sync Location and a file sync was triggered that the file path was C:\My Documents\My Files\file.txt the sync path for this files sync location would resolve to C:\Documents\Sync Location\My Documents\My Files\file.txt. This feature is only usable when the When Removed and/or When Modified field is define as an operating system folder location.
8) The Alternate Location field is utilized to specify a file's alternate location parent location path, such as the sync location, http, or ftp address location. This feature is utilized when files are sync'd and shared between multiple users that do not have access to the original/residing location of the folder file.
The Derived Path Column field is utilized to specify a column name that will contain a custom file path to sync to instead of utilizing the text contained within the Path field. This is helpful when you may want the Path column to contain a different file path for opening the file over what you may want the sync path to be.
Note 1) While syncing files can be a powerful tool it is strongly recommended that you test the settings and sync triggering on test files before actually using it. You may end up performing a sync action that results in a loss of data so please make sure you have thoroughly tested this feature before utilizing it regularly.
Note 2) If an ftp location is specified, the ftp server must have passive mode enabled to utilize this feature; it will not function otherwise.
Note 3) If an http web script, such as php or asp, is specified please test what url variables are passed to the web service in order to define the intended actions to perform to the files. By specifying an http web sevice, the sync action is soley dependant on the web service performing all of the intended sync actions, we only pass the web service url variables that it needs to define what actions to perform along with a file stream to save the sync'd file data.
*** Warning! We are not responsible for the loss of data due to the usage of this feature. Do not use it if you have not thoroughly tested and confirmed the results.