Specify Job Options
$job_options keywords
This command is used to specify job options. Job Options are additive: an Instance UJP acquires all the options set in the system, owner and job type job properties.
In owner and job type job options only, an option keyword can be preceded with a tilde (~) character to indicate that a higher-level option is to be deleted. This feature is not available in system job options because there is no higher level to affect, and is not available in job instance job options because these will have already been distilled from system, owner and job type job options when the job instance UJP file was created.
The parameters on this command are used as follows:
| keywords | one or more of the following keywords, separated by |(pipe), comma, or forward slash, with no blank space: |
(Job IVR keywords):
| NoList0 | when selecting job broadcast lists in Job Admin IVR, the caller may not key 0 to select all lists |
| Inst0 | when prompted for a job instance number in Job Admin IVR, the caller may enter 0 to select the most recently created job for the owner (or for the owner and jobtype). |
| MPT | incoming faxes in Job Admin IVR for will be saved as multi-page TIF even if this is not the system default. |
| AbsList | modifies Job Admin IVR list selection so that for example selecting 'list 3' picks the first or only file in the $listfile set with a file name of either LST00003.* or LIST0003.* or GROUP003.* instead of the default which is to select the list file from the third $listfile command. |
| StarKey | treats the '*' key as the same as the '#' key during Job Admin IVR list selection. If this option is selected the ability to de-select lists with the listconf option is disabled. |
(Reporting keywords):
| NoProofDoc | sends a proof cover only, as confirmation of remote job submission, but suppresses sending the actual document as a proof. |
| ExtractPending | causes unsent files and files in progress to be included in the job data extracted by JOBDDATA and JOBXDATA and in custom reports. |
| ExtractProofRep | causes the proof, standard report, and notify transmissions (if any) to be included in the job data extracted by JOBDDATA and JOBXDATA. |
| ExtractFailTimes | causes the extracted call and connect times to include times from failed transmission attempts. |
(Miscellaneous keywords):
| ReverseFS | causes the digits of the FS filename to be reversed, to randomize FS file pickup within a TOSENDx folder. |
(List-handling keywords):
| OmitListHeader | causes the first row to be discarded in each list opened for the job. This option is implied by, and therefore need not be specified with, the WordMerge job option (for which list header rows are mandatory). When enabled for a job with multiple lists, and when BCF variables are used, the presence of this option requires that all lists have matching header rows. This check can be suppressed (but not for WordMerge jobs) by using the NO_LIST_CHECK variable. See also the AUTO_LIST_HEADER variable. |
| In addition to the basic validation initiated with this option, any items which have a completely blank phone number or e-mail address will be discarded (with no FS file written) after one thousand consecutive such items have been failed with outcome code 128. This check only applies when other fields in the broadcast list contain data: list rows which consist only of white space and (if applicable) delimiters are ignored anyway, even without the CheckDestination option. The limit of 1000 consecutive blank items can be overridden by assigning a numeric value to the variable BLANK_ROWS_LIMIT. A value of 0 suppresses the blank check. This blank check guards against the use of an Excel list which accidentally has 65535 non-empty rows, perhaps as a result of a miscoded macro expression. |
| DeDupe | Causes a check to be made prior to launch, to fail any item which is a 'duplicate' of an earlier item in the list(s). By default a duplicate is tested on the destination number or e-mail address, plus the contents specified for the $fax_receiver command, if any). The text added to the destination number or email address can be overridden by assigning a DEDUPE_FIELD_NUMBERS variable in the UJP file. Duplicate items are forced to fail with outcome code 127. Non-numeric characters are removed from destination numbers and e-mail addresses are parsed so that only the effective address is compared. Text that differs only in the case of the letters is still considered a duplicate. There is no significant overhead for adding this check, even for lists of tens of thousands of items, but please contact Copia first if you intend to use this feature with lists containing more than of the order of a quarter of a million items. |
(Document-handling keywords):
| PreConvert | before launch automatically convert job documents which are not faxable TIF and for which conversion is specified in the $convert_types configuration command. Currently this conversion can only be performed if the file is a local file, not a document or web page which first has to be downloaded from an external location using HTTP or FTP. It is recommended that the $preproc_qname command is used to specify a document conversion priority queue: this will be used to prioritize pre-convert operations in the FFEXTERN instance(s) processing document conversions. |
| SingleDoc | causes all TIF files (single or multi-page) in a transmission to be concatenated into a single multi-page file before transmission. If a GCT cover sheet is also present the output file will be a .GTT file and the contents of the incorporated GCT will be applied to the resulting multi-page document. This is the principal purpose of this option. If no GCT cover is present the output will be a multi-page TIF, but there is little benefit in doing this. The filename of the output file will be the basename of the job instance UJP, with '_SD.GTT' or '_SD.TIF' appended. This option can also be used to pre-convert the TIF documents in the transmission to lower case before launch when the $image_res keyword LOW is used. |
| SingleEmailDoc | extends SingleDoc (which need not also be specified) to create an $email_attach command for the personalized GTT file. You will also need to assign a control variable SINGLE_EMAIL_CT to specify the content-type for the single file, and to specify whether it is to be sent as TIF or PDF. |
| WordMerge | See also the Word Merge topic. This keyword causes all Word documents (.DOC or .RTF) to be checked prior to launch for MERGEFIELD variables. If present, the document is not pre-converted even if the PreConvert keyword is given. Instead individual word merge operations are performed for each Word item in the job, in which the original DataSource is replaced by a two-row data source (headings and data) extracted from the supplied job list, which is expected to be the original word merge data source. All MERGEFIELD variable names must be present in the list header row, and if multiple lists are specified all header rows (which must always be present) must be identical unless the CreateBCXvars keyword is also used. If CreateBCXvars is used and no BCF or ?n variables appear in the specification of the broadcast destination or receiver, the check for identical columns is not done, although all used variables must still appear in the headers of all lists. A discrepancy in the headers will cause the launch to fail. This option can place a heavy load on FFEXTERN instances set up to perform conversions. Do not specify this keyword for jobs which will not involve a Word merge: this keyword causes the job to be processed differently, and also implies OmitListHeader. |
| HtmlExpandVars | causes all local HTML documents to be checked for the presence of variables prior to launch. If any variables of the form `BCFn or starting `BCX_ are found, then the document is not pre-converted even if the PreConvert keyword is given. Instead individual convert operations are done for each item in the job, expanding any `BCFn and `BCX_name variables from column data. If `VARNAME variables are found other than for column data, then the document is pre-converted if the PreConvert keyword is also given. For this purpose, the HtmlExpandVars keyword overrides the setting in the Options checkbox of the FFEXTERN document converter setup screen. Note that this keyword only affects $job_document entries which specify a fax destination for the HTML document. If an HTML document is only for e-mail and requires expansion of variables, it should normally be placed on an $email_body or $email_altbody command. If an HTML job document has content type text/html it will be expanded only if the $email_options keyword expandattachvars is set, not as a result of HtmlExpandVars. |
Note that the CheckDestination and DeDupe options are designed to minimize the load on the CopiaFacts engine, which uses the presence of the FORCE_FAIL variable (with value 127 or 128) to flush the FS file through to FAIL as efficiently as possible. However post-processing and writing of notification queue records, if specified, takes place as usual.
Default: no options
Example:
$job_options listconf|mpt
In addition to job options specified on this command, a number of additional options can be specified using variables. The variables listed below are specified in the normal way using $var_def; they are not job options:
