Auxiliary Files

Applies to: Version 4

---

Version 4 introduces the concept of auxiliary files. Each Version 4 job requires an auxiliary file that is saved in a location specified by the user.

What are auxiliary files?
Auxiliary files are used to store information externally from the main MySQL database. Their main use is to store image subsamples which if stored in the MYSQL database would make the database unreasonably large. (see "Image subsamples and previews")

Auxiliary file paths
Auxiliary files need to be stored in a shared folder on a network drive and be accessible to all users
One or more paths can be defined in the Timestone Administrator with the Paths object>Auxiliary Files tab. If more than one path is defined the user can select the desired location when a new job is created.

Creating auxiliary files
Auxiliary files are created automatically when a new job is created. By default the auxiliary file is given the same name as the job and with with an extension of .auxiliary. For example a job called GreenvilleSP09 will be given an auxiliary file of GreenvilleSP09.auxiliary. Note however this automatic naming is for convenience only and the user is permitted to name the auxiliary files as he or she pleases.

Fig 1: Starting a new job. Note the auxiliary file name and location at the bottom of the window

Jobs with the same name
Version 4 allows jobs to be created with the same name however each job must have a unique auxiliary file. In these situations the user will receive a warning if atempting to use an auxiliary file name that already exists. The new job can then be created with a different auxiliary file name. An alternative approach would be to save the auxiliary file with the job name but to a different location.

Backing up auxiliary files
If the auxiliary file for a job is deleted or corrupted the job will not be able to be opened. For this reason it is recommended the auxiliary files folder(s) be backed up as part of a regular backup routine. Future versions of the software will include a mechanism for regenerating auxiliary files making their backup redundant.