Standard Directory Descriptions
This section lists the standard CopiaFacts directory structure which is created by the installation program. Except where the directory name is shown underlined, you may change any of the directory names. For example you may have a directory MYIMAGE instead of IMAGE. Each entry indicates what you have to do to specify a either the standard directory name or a different one, and how the directory is referenced by programs running on other machines.
You need not allocate all of the directories on the same drive, with the following exceptions:
•the subdirectories of the callback directory must be just that - you cannot have the SENT and the FAIL directories in different places.
The following is the list of standard directories:
This directory is used to store and load the CopiaFacts programs if they are not replicated on a local drive. The directory MUST be specified as the 'current directory' ('start in:') in any shortcut used to start the main COPIAFACTS program. To reference this directory, programs will refer to the common [CopiaFactsServer] section of the COPIAFACTS.INI file in their local Application Data directory.
This directory name is specified in the $log_def configuration file command. It is used to write the daily CopiaFacts log files, named yyyymmdd.DBF. If the 'operations monitor alert' option is used in the COPIAFACTS program, then .OMA (operations monitor alert) files are also written in this directory. If no $log_def command is given the directory for the log files is the LOG subdirectory in the base CopiaFacts directory.
This directory defaults to CALLBACK in the main CopiaFacts directory, or is specified on the $request_dir command in the CopiaFacts configuration file. It is not required if your CopiaFacts system is used only for one-call faxes, with no separate outbound capability and with no one-call cover sheets. The only files placed in this directory are the temporary files for cover sheets: each file is made unique by incorporating the line number in the filename. If you wish to place these temporary files elsewhere, you can specify a different directory using the COVERTMP environment variable.
This directory must contain the TOSEND, TOSENDx, SENT, FAIL, PREPROC, POSTPROC and ACTIVE subdirectories described below.
This named subdirectory is always in the directory specified on the $request_dir command in the CopiaFacts configuration file. It contains the NEXTFS file which is used to allocate FS file numbers across all CopiaFacts applications. This is the default directory for outbound fax requests to be processed by the CopiaFacts outbound fax server. It is not available for Job Admin broadcast operations, which must use a numbered TOSEND directory.
These optional subdirectories are created if the count parameter (from 1 to 9) is specified on the $request_dir command. The directories are typically used to hold FS request files for broadcasts which are to be sent with a lower priority. You may also select these directories for fax-on-demand requests by assigning a value to the TOSEND system variable.
Each TOSENDx directory can be set up with different capabilities at different times of day by using the Queue settings page in COPIAFACTS.EXE. These schedule settings are saved in the nodename.TSS files.
This named subdirectory is always in the directory specified on the $request_dir command in the CopiaFacts configuration file. It contains FS files which have been successfully processed. CopiaFacts does not automatically delete these files unless you so specify in $delete_option. If this directory does not exist then sent FS files are not retained.
This named subdirectory is always in the directory specified on the $request_dir command in the CopiaFacts configuration file. It contains FS files for which processing was unsuccessful after the specified number of attempts. If the 'fail extensions' option is set in the CopiaFacts program, the file name in this directory will have an extension which matches the last three digits of the fax error status. Otherwise, files are written to the FAIL directory with extension FS. CopiaFacts does not automatically delete these files.
This named subdirectory is always in the directory specified on the $request_dir command in the CopiaFacts configuration file. During processing of the each FS file it contains a temporary file with the same name as the FS file, which is used to avoid other copies of CopiaFacts on other network nodes attempting to process the same FS file. The temporary file contains only the nodename or application name to show who created it.
You should not write or run any program which opens a file in the ACTIVE directory while CopiaFacts is running. Doing so may result in failure of outbound faxes or may cause run-time errors to be reported. If you need to check for the existence of these files to monitor CopiaFacts operations, it should be safe to _stat() the files or to search for them using _findfirst() and _findnext() functions, provided that you do not open or lock the file, even momentarily.
Provided that the 'no busy check' option is not set in the COPIAFACTS program, this directory will also contain a temporary file with a file name formed from the telephone number being dialed. This is used to avoid other copies of COPIAFACTS on other network nodes attempting to dial the same fax number (self-generated busy).
Files in the active directory lose their capability to block other nodes if their timestamp indicates that they are no longer 'recent'. The default criterion for this is 30 minutes, but can be changed using $active_life. If you wish to place these temporary files elsewhere, you can specify a different directory using the ACTIVE environment variable. The selected directory must be visible to all nodes on which COPIAFACTS is running.
This directory is used by various CopiaFacts programs to store fax format files.
This directory contains the standard voice message files (SVPx.VOX or SVPx.WAV) provided with the CopiaFacts system, along with the standard digit playback, amount playback, studio playback, and alpha playback files (FAXFACTS.DIG, FAXFACTS.AMT, FAXFACTS.RST, FAXFACTS.ABC).
Normally you will wish to record your own versions of these files, but it is often convenient to use the provided files initially, until you have recorded all your own messages. To enable this, you should name this standard voice message directory on the SVP (or FAXMSG) environment variable. This leaves the user profile $vmsg_dir command free to name the directory containing your own custom messages.
This directory is provided for you to use for your custom voice message files (SVPx.VOX or SVPx.WAV) as well as your own recordings, if required, of digit playback, amount playback, studio playback, and alpha playback files (FAXFACTS.DIG, FAXFACTS.AMT, FAXFACTS.RST, FAXFACTS.ABC).
You should name this directory on the user profile $vmsg_dir command. Any messages for which you have not provided custom recordings will be picked up in the directory specified on the SVP (or FAXMSG) environment variable, which should normally point to the STDVOICE directory described above.
This directory contains a couple of sample document fax files and a selection of menu and other sample infobox files, to help you while setting up and testing your system. The provided default USR files name this directory on the second $script_locn command, after the IMAGE subdirectory, so if you happen to use the same infobox numbers as our samples, your own files in the IMAGE directory will be found first.
Do not use this directory for your own infobox and document files: if you install a CopiaFacts upgrade we may have added additional samples which could overwrite your own files.
This empty directory is provided for you to use for your fax-on-demand fax documents and for menu and other infobox files (.IIF). Its name is specified on the first $image_locn command in the provided default USR files.
Many fax-on-demand applications will benefit from creating additional image directories for different categories of document and infobox files. For example you may have documents in different languages which can be selected by caller interaction or by selection of different user profiles from an SDID entry. See $image_locn for details of how to specify multiple document search paths.
This directory is also by convention used for IIF files which implement pre- and post-processing tasks.
This directory defaults to MAIL in the main CopiaFacts directory, or its name is specified on the $post_office configuration file command. It contains all the MBX files which are used in a CopiaFacts fax mail application, and the 00000000.MBX file used for accept processing. A few sample mailbox files are provided in this directory.
This directory is set up with subdirectories SYSTEM, DIGITS, AMOUNTS, IMAGES, and STUDIO. These subdirectories are named as work directories on the $type studio infobox files provided in the DEMOIMG subdirectory (00006*.IIF) and contain default algorithm files and message lists.
After using the CopiaFacts Recording Studio to record custom messages, you should copy them from the work subdirectories into the appropriate 'live' directory. You may also record custom messages over 'live' messages by using different directory names in the $type studio infobox.
This directory is set up with a subdirectory for each Job Admin owner. For use with Job IVR, the owner folder names must be numeric-only, to allow selection using DTMF entry. If job types are in use, the owner folder may have a subfolder for each applicable job type; otherwise a special NO_JTYPE folder is used. Job instance files (JOBnnnnn.*) are kept in the applicable job type folder or in NO_JTYPE under each owner.