Jump to main Content | Jump to main Navigation

Folders

This section of this manual describes the function and content of the various folders within the Calm system.

Calm files follow a very set file structure. They are almost always found in the \dscribe folder on a computer or server, but the actual drive they are in (e.g. C:\dscribe) will vary depending on the drive letters you use. In a client-server setup, you will see many of these folders on the client computers, but the \dscribe\Archive\db folder will only be on the server. In a hosted setup, you will see all of these folders.

It is possible to change which folders are used in the registry, but the folders listed below are the defaults.

\dscribe\Archive (Startup Folder)

This is the most important folder for your copy of Calm. If you are backing up your system, this is the folder to choose. The subfolders and files in here hold all of your data, all of the settings that you can customise and your customisations to them, as well as standard reports and your custom reports. In Calm for Records Management, this folder also holds default mail merge templates.

\dscribe\Archive\Cmd (Command File Folder)

When Calm is trying to run a script, it will look in this folder for it. These scripts are .tcl files. Therefore, if the helpdesk ever sends you a custom script, make sure to put it in here.

\dscribe\Archive\db (Database Folder)

Your collections data goes into this folder, broken down by database (e.g. every file with a name of 'Catalog' is for the Catalogue database). The .udf and .udr files used to document your changes to a database go in this folder, as well.

\dscribe\Archive\Output (Output Folder)

If you export from Calm, whether that export is to HTML or via mail merge, it will be saved in this folder by default. Also, if you permanently change the mail merge templates that come with Calm, you should save your versions of the templates to this folder: Calm looks here for templates first when exporting, and saving here means your custom templates won't be overwritten by default ones when you upgrade Calm.

\dscribe\Archive\reports

The templates of XML reports you use when importing and exporting go here. If you are adding a new report, you will need to edit the reports.xml file in this folder to point to it.

\dscribe\Archive\Templates

Default mail merge templates are held in this folder. If you want to make changes to a default template permanently, make sure to save that changed template to \dscribe\Archive\Output instead, because whenever Calm is updated this folder is overwritten with the new default templates.

\dscribe\bin (Holds the EXE Folder)

Programs, like Calm or the Admin program, as well as the files that make them work, sit in this folder. Dscribe.exe is the executable for the main Calm application, and DSAdmin.exe is the executable for the Admin program. You should not have to make any changes here, although the helpdesk may ask you to run Messages.exe to assist in debugging Calm.

\dscribe\Docs, \dscribe\Images, or \dscribe\Archive\images (Image File Folders)

Calm has many folders you can use to hold the images, videos, audio, and documents attached to records. The folder these files are copied into by default, when attached to a record, can be any of these folders or it can be a different one—just ensure that it is a folder in a location like the server that all Calm users can access. The default multimedia, image, and document folders are set in the Admin program under the Folders menu.