The entire operation of the CopiaFacts system is controlled by command files. This section describes the principal files. All these files reside in subdirectories of the main CopiaFacts Application Data Area, which is usually based in a folder named FAXFACTS, itself in the root of a network share named COPIA.
All the files described below (except FAXCOUNT.HWL) are text files which can be edited in Notepad or any text editor. However the COPIAEDIT program is provided to edit these files more conveniently, with access to on-line help and syntax highlighting.
This file is used by almost all CopiaFacts programs to determine the operations permitted by your CopiaFacts license and to find what types of hardware are installed in each machine. It also determines whether or not your CopiaFacts maintenance is currently under support and maintenance. The file is maintained by the CFHWL program (FFHWL for version 7). The original file is supplied by Copia with your CopiaFacts license, and new license keys will be issued in .copiakey files (for version 8 only) when you add license features or renew your maintenance and support arrangements.
This main configuration file contains settings common to the whole system or to all operations on a specific machine. Some of the parameters can be overridden in other files for specific operations.
A user profile (USR) is required for every CopiaFacts operation, and contains parameters which apply to all tasks of a particular type. For incoming calls, the user profile is often selected automatically so that it applies to all calls received on a particular telephone number. For outbound calls and e-mails, the user profile might be specified for all calls originated by a specific user. User profiles can override or modify some of the configuration file settings.
Within the Job Administration system, and for tasks created by the CopiaFacts Client, the user profile is replaced by a Job Properties file (UJP) which is described in the next section.
Job Properties files (UJP) replace a USR file for all Job Administration operations and for operations generated by the CopiaFacts Client subsystem. UJP files contain a superset of the commands in a USR file.
Within the Job Administration subsystem, there are four different types of UJP file:
|SYSTEM.UJP||This file contains common properties for all the of the broadcast jobs which will be run in the system.|
|OWNER.UJP||This file contains specific properties for all of the jobs to be run for a specific owner (service bureau client).|
|JOBTYPE.UJP||This optional file contains specific properties when a service bureau client needs to run different types of job. Its use is recommended when it can be used to avoid setting up different properties for every single job that is run.|
|JOBxxxxxxxx.UJP||This Job Instance Properties file is the one which actually controls the processing of a broadcast job, acting in place of the USR file. It is built up from the SYSTEM.UJP file and the applicable OWNER and JOBTYPE properties files, together with any job-instance-specific overrides, when each broadcast job is initiated. The SYSTEM, OWNER and JOBTYPE files are not then directly used in broadcasting operations.|
Task Queue Files
The files which initiate individual outbound operations are FS files. Although the name derives from 'fax-to-send' these files are used for voice, e-mail and SMS outbound operations as well as for sending faxes.
FS files are usually generated from programs within the CopiaFacts system, but they also provide a simple means for user applications to generate outbound calls. Just create an FS file with a minimum of a user profile, destination address or fax number, and items to be transmitted, drop the file into one of the TOSEND queue folders, and CopiaFacts will transmit it. This is the simplest application program interface (API) which CopiaFacts offers.
CopiaFacts is optimized for handling large numbers of FS files in TOSEND queue folders of different priorities. But for high-volume e-mail operations CopiaFacts also supports the writing of FS file images as MSMQ messages.
Mailbox files (MBX) are used to specify how incoming faxes are to be processed (e.g printed or forwarded as e-mail). The mailbox is normally selected from the user profile which controls the inbound operation. Mail Control Files (MCF) are then created automatically, one for each incoming fax file, to record and control its processing steps.
Individual processing steps within the COPIAFACTS engine can be controlled or customized using scripting, which is specified in files also referred to as infobox files (IIF). For most common operations, CopiaFacts carries out the whole specified operation automatically, without the need for any scripting, but the scripting capability also provides enormous power to customize all operations.
The script files each specify a single step of a scripting sequence, and can be chained using logical tests and both system- and user-defined variables.
Fax Cover Sheet Template Files
Cover Sheet Template Files (GCT) specify the positioning and variable content of variable data to be added to a customizable fax cover sheet. It is not normally necessary to view or edit the detailed content of these files: instead the variable data is positioned and specified graphically, in the FFVIEWER program.
An alternate form of the cover sheet template is the GTT file (Graphical Template with TIF). This file consists of a TIF image with embedded GCT file data, combining the background image and the variable specification in a single file. It is also created and maintained by FFVIEWER.
Command File Content and Syntax