Specify Document to be sent in a Job

$job_document filename|FAXIN|WATERMARK [type|keyword [keyword [keyword]]]

This command specifies a document filename to be included in a broadcast job. In a fax broadcast, the document will be named in each FS file on a $fax_filename command.  In an e-mail broadcast, it will be named on an $email_attach command and the type will be significant.

If this command originates in the Owner Job Properties or Jobtype Job Properties file it will be copied into a Job Instance Properties file as the job instance is created.

The parameters on this command are used as follows:

filename the full pathname of the file to be used
FAXIN a keyword indicating that the master document for the broadcast is to be faxed in during Job IVR
WATERMARK a keyword indicating that the master document for the broadcast is to be faxed in during Job IVR, and will be used as the watermark for a Graphical Customization Template (GCT) file specified on the following $job_document command.
type a valid e-mail 'content type' (see $email_attach). The special values FONTn in this parameter indicate a Brooktrout ASCII font number and are not taken to be e-mail content types.
keywordA keyword may appear on this command.  Only 'nofax' should be entered manually on this command; other keywords are reserved for internal use. It is also valid to enter this keyword as part of the quoted content-type string, from which it will be stripped before the content-type is used (see the second FEB1 example below).
nofaxThis document will not be sent to fax destinations (FEB1) or in fax attempts (FEB2)

The use of the $job_document command depends on the type of broadcast, which is normally defined either by means of the BROADCAST_TYPE variable or by selecting on the Broadcast template page in JOBADMIN.

FBFor a plain fax broadcast, each job document will be used to create a $fax_filename command in the generated FS files. The filename parameter may contain the name of a document which requires conversion. A content-type parameter if given, is ignored.
EBFor a plain e-mail broadcast, each job document will be used to create an $email_attach command in the generated FS files. A content-type parameter should be supplied.  No document conversion is done on the document and no check is made that the content-type matches the document type. If no content-type is supplied a content-type of application/octet-stream will be used.
FEB1For a broadcast list where a single 'destination' list column may contain either a fax number or an e-mail address, each job document results in both a $fax_filename and an $email_attach command being generated in the same FS file. The former commands are ignored for a job item with an e-mail destination and the latter are ignored for a job item with a fax destination.  A content-type parameter should be supplied: if the content-type parameter is missing, no $email_attach command will be generated for the document; if the content-type parameter is present and followed by a 'nofax' keyword, no $fax_filename command will be generated for the document.
FEB2For a broadcast list with separate list columns for fax and e-mail destinations, list items which contain an entry in both columns will be tried first by one method and then the other. In this case each job document results in both an $fax_filename and an $email_attach command being generated in the same FS file.  The former commands are ignored during e-mail attempts and the latter is ignored during fax attempts. A content-type parameter should be supplied: if the content-type parameter is missing, no $email_attach command will be generated for the document; if the content-type parameter is present and followed by a 'nofax' keyword, no $fax_filename command will be generated for the document.

This command also affects Job IVR processing if it specifies that a broadcast master is to be faxed in. Without the special keywords of this command, the document for the broadcast must be pre-specified.

Different filenames for different recipients

Filenames containing a variable expansion may be used (for example @BCF4 to indicate that there is a filename in column 4 of the list).  The job launcher needs to know the file extension of the job document at launch time, so:

if the list entries just contain the filename part, you must include the extension in the $job_document filename, for example @BCF4.PDF. The JOBDOC_EXTENSION variable is ignored when there is an extension in the filename (and also if there is no variable element in the filename).

If the list contains both filename and extension, the same extension must be used for all items, and you must define a variable JOBDOC_EXTENSION to contain the extension that will be found in the list.  Unpredictable results will occur if the variable content does not match the extensions in the list.  If the variable is omitted, .TIF is assumed.

 

Default: No documents are included

Examples:

Simple fax broadcast:

$job_document @FFJOBS\client234\doc1762.tif

IVR-launched broadcast with faxed-in master:

$job_document FAXIN

IVR-launched broadcast with faxed-in watermark:

$job_document WATERMARK

$job_document @FFJOBS\00001234\special.GCT

FEB2: Fax + E-Mail broadcast starting with an attempt to fax a TIF and then e-mailing the same file converted to PDF if the fax fails (after the specified number of retries):

$email_options second

$job_document @FFBASE\docs\sample.tif application/pdf

FEB1: Broadcast with either a fax number or an e-mail address in the same list column, sending a PDF file rendered to TIF for fax and an attached copy of the same PDF file for e-mail:

$job_document @FFBASE\docs\sample.pdf application/pdf

$job_document @FFBASE\docs\sample.doc "application/msword;""name=docname.doc"""

FEB1: Broadcast with either a fax number or an e-mail address in the same list column, sending one PDF file rendered to TIF for fax and an attached copy of a different PDF file for e-mail:

    $job_document @FFBASE\docs\sample1.pdf

$job_document @FFBASE\docs\sample2.pdf application/pdf nofax

or:

$job_document @FFBASE\docs\sample1.pdf 

$job_document @FFBASE\docs\sample2.pdf "application/pdf nofax"