Specify Fax Filename and Parameters
$fax_filename name [group [type [exp [pages [begin_page [mbox msgno]]]]]]
This command names and describes the file to be sent in an outbound transmission. This command is omitted when only a cover sheet is being sent. The $fax_filename command can be repeated to send more than one fax document.
•For a fax-on-demand callback request the command(s) are generated automatically by CopiaFacts, from the list of requested documents, when the FS file is created for the callback.
•For a fax server request the client software (e.g. FFCLIENT or FFMERGE) will generate this command.
•For a broadcast the document to be broadcast will normally be specified by this command in the FS template file or from a $job_document command in the job instance properties (.UJP) file.
To specify faxable color files for transmission on Brooktrout TR1034 hardware [optional feature], only a single $fax_filename command can be used in an FS file. For multi-page files, a .IPK file should be specified, and for single page files either a .IPK file or a .JPG or .JPEG file. The CFCOLOR utility can be used to manipulate these Infopacket and color JPEG files. If a file exists with the same basename as the specified file, but with extension .TIF, then it will be selected for transmission if the receiving fax has no color capability.
The parameters on this command are used as follows:
|name ||the full pathname of the file to be sent. If the file extension is .1, any additional .2, .3 etc page files will be picked up automatically and must not be specified on additional $fax_filename command lines. If you are using Document Converter, the filename may take the form of a URL starting with http://, ftp://, or file:/// (as described for $image_file) and the FS file will then normally be processed via the PREPROC subdirectory. Other file extensions specified in $convert_types are also processed via the PREPROC directory. The FS file is rejected if the named file is not found, unless either the 'ignore missing' option for the COPIAFACTS program is given or the group parameter is NOTREQ. The name is enclosed in double-quotes if it contains embedded blanks. URL filenames containing blanks will be converted automatically to valid URLs in the Document Converter.|
| ||In almost all cases, no other fields on this command need be supplied.|
|group ||for a callback request, CopiaFacts will record here the actual infobox number entered by the caller to request the image. For a filename in the PREPROC directory, this field contains the filename of the fax file to be generated by FFEXTERN. For ASCII files in a Brooktrout system the special value FONTn (where n is a value from 0 to 7) overrides the font number specified in $ascii_font.|
| ||For other user-generated FS files, you may use this numeric field for other purposes. A special value of NOTREQ indicates that a missing filename should be silently ignored (provided that there are other files in the transmission). The data (other than NOTREQ) is carried through to the log file. Default value: 0.|
|type ||a numeric image type code. Originally all image types could be specified in this field. The only type codes that are now required are 35 (non-faxable TIF) and 94 (to merge multiple files onto one page). If you generate FS files, you can place 99 into this field or omit it altogether if no other fields are required on the command.|
|exp ||For a file in the PREPROC directory, this field contains the time in hours after which the file generated by FFEXTERN is deemed to require re-conversion from the Web file. Otherwise this field is ignored.|
|pages ||the number of pages that will be transmitted. This should always be 1 for ASCII files. The page count and beginning page parameters are optional in records you create, and when CopiaFacts programs generate these fields, the values will already have been checked. If you specify these fields in FS files you create yourself, the page count must correctly reflect the actual files, or else the fax may fail. Default value: the number of pages found for the specified filename.|
| ||This field should only be completed (non-zero) if you wish to suppress transmission of the last page(s) of a fax document. For example, a value of 4 would skip the .5, .6 and subsequent files of a multiple page document file set. In addition, if the fax board supports page-selection from a multiple-page TIFF/F file, then this field can specify the suppression of pages from such a file, which must then have a file extension other than .1. This field can be combined with begin_page to select pages from the middle of a document.|
| ||For a file in the PREPROC directory, this field contains a numeric value which encodes the options specified or defaulted as $web_options for this document.|
|begin_page ||the first page number that will be transmitted for this image. This value should be 1 unless page-restarts are implemented for the fax board (not yet implemented for all boards). Default value: 1.|
| ||This field should only be completed (non-zero) if you wish to commence the fax transmission with a page other than the first. For example, a value of 4 would skip the .1, .2 and .3 files of a multiple page document file set. In addition, if the fax board supports page-selection from a multiple-page TIFF/F file, then this field can specify the starting page number in such a file, which must then have a file extension other than .1. This field can be combined with pages to select pages from the middle of a document.|
| ||For a file in the PREPROC directory, this field contains an override for the retrieval timeout in seconds, if specified.|
|mbox ||the mail box number of the image to be sent. This parameter is used by the CopiaFacts fax mail system.|
|msgno ||the mail item message number used in the CopiaFacts fax mail system. |
Default: none - no file is sent (there must then be just a cover sheet)
$fax_filename @FFBASE\image\intro.TIF 25 99 0 3 1 0 0 ; intro
$fax_filename @FFBASE\fax\sales.asc ; letter