Introduction

CopiaFacts includes facilities for system housekeeping but because requirements vary so much, not all of them are enabled by default.  The principal task is to remove or archive the control files that have been used for completed work, such as SENT or FAIL FS files and incoming MCF and TIF files.

Automatic Housekeeping

A number of file types are automatically 'cleaned up' by the system.  These include:

Trace Files.  The engine trace files (nodename.TRx) and FFTRACE trace files (nodename.FTx) are automatically emptied and rewritten when the system starts to use a new trace file after midnight each night.  Restarting the engine or FFTRACE at other times appends to the existing file.

COPIAFACTS Temporary Fax Files.  The COPIAFACTS engine needs to write temporary fax files for cover sheets and for fax boards which cannot send directly from a network location. These are saved in the folders specified with COVERTMP and GFAX environment variables.  Because the filenames incorporate a the 'line number' the names are re-used as needed, and the number of temporary files should remain manageable without specific action to clean them up.

FS Files with a $delete_option Command. These files are automatically removed after use. The delete options can also specify that temporary files and e-mail attachments associated with the transmission are to be removed.  We recommend that this option be used only in stable, established applications, because the removal of these files can make it hard to investigate problems which occur during transmission.  Also the option should not be used in conjunction with Job Administration, since the FS files are needed for job completion testing and for reporting.

Job Administration Files

The Job Administration system normally requires FS files to be retained at least until a whole job is completed and accounting and reporting procedures are complete.  In some cases it may also be necessary to a 'manual retry' of some items after the job has been completed for the first time.  The Job Administration system therefore includes an archiving utility JOBZIP, which is normally scheduled to be run automatically some time after the job has completed. JOBZIP can also be run from JOBCONS at predetermined intervals.  It can also deal with 'job instance' files, and files other than FS files related to the broadcast job.

CopiaFacts Client Files

The CopiaFacts Client (FFCLIENT) includes facilities for archiving and deleting files as specified for each user. For information about configuring the archiving and deletion of files, please see the Administrator Guide.  CFHK or DELETEOLDER (see below) are used to implement the processing specified by the Client Administrator.

CFHK

For other archiving tasks, we recommend the use of the CFHK utility.  This provides a convenient, interactive, method of setting up housekeeping parameters, and replaces the DELETEOLDER batch-file program.  Apart from its use as a housekeeping configurator, CFHK is also installed as a service application to perform the deletion and archiving tasks at the appointed times.

DELETEOLDER and DELWEEK

Older versions of CopiaFacts performed housekeeping tasks by having a COPIAFACTS engine run batch files at intervals. New installations should use CFHK instead.

To automate the regular (for example, daily or weekly) running of this utility, you should create a DELWEEK.CMD batch file or adapt the one provided in the Program Files\Copia Folder.  This batch file is run from the DELWEEK.FS worker-box FS file described below.  The default batch file contents are:

set debug=

rem set the -dnn to the number of days old for removal

date /T >>%faxfactsdir%\delweeklog.txt

time /T >>%faxfactsdir%\delweeklog.txt

"%programfiles%\copia\deleteolder" -d90 %faxfactsdir%callback\temp\*.*  >>%faxfactsdir%\delweeklog.txt

"%programfiles%\copia\deleteolder" -d90 %faxfactsdir%callback\fail\*.*  >>%faxfactsdir%\delweeklog.txt

"%programfiles%\copia\deleteolder" -d90 %faxfactsdir%callback\sent\*.*  >>%faxfactsdir%\delweeklog.txt

"%programfiles%\copia\deleteolder" -d10 %temp%\*.*                      >>%faxfactsdir%\delweeklog.txt

"%programfiles%\copia\deleteolder" -d1 %faxfactsdir%callback\active\*.* >>%faxfactsdir%\delweeklog.txt

"%programfiles%\copia\UJArchive"

The parameter -d90 in the above commands deletes files after 90 days.  You can of course choose another value here if you prefer.  To delete files from other folders, or files used by your own applications, you can add other DELETEOLDER commands in this batch file.

To run the DELETEOLDER batch automatically at set intervals, three other files are required:

DELWEEK.IIF is an infobox which resides in FAXFACTS\SYSTEM which actually runs the batch file.  It contains:

$type query

$run "@PFC\delweek.cmd"

$error_exit s:FINISH_MAINT_OP   ; (125)

$next_box s:FINISH_MAINT_OP     ; (125)

DELWEEK.USR normally resides in the FAXFACTS folder and directs the system to find the DELWEEK.IIF file in the SYSTEM subfolder.  It contains:

$script_locn    DELWEEK DELWEEK @FFBASE\SYSTEM

$fax_phone_last

The supplied DELWEEK.FS file (placed in the TOSEND9 folder by the server installer) actually defaults to run every day, despite its name, but you can change this to run weekly by modifying the value of the WORKER_DAY_INTERVAL variable to 7.  The default FS contents are as follows:

$worker_box delweek

$fax_origin user_request

$fax_user @FFUSER\delweek.usr

$fax_status1 2

$fax_sender "Delete Week DO NOT DELETE THIS FILE"

$fax_send_time 08:00:00

$var_def WORKER_DAY_INTERVAL 1

For examples of how to change the worker box intervals, see the $worker_box topic.  We recommend using the 'schedule by interval' mechanism for this application.