[CV >J] A non-empty value in this parameter in a job instance variable causes JOBMON and other programs which scan for FS files to restrict the scan to the folders corresponding to the $priority, EMAIL_PRIORITY and $retry_tosend values (modified if appropriate by the SMALL_JOB... settings). You should not set this variable if you are in the habit of manually moving FS files from one folder to another. Its presence also suppresses the 'resubmit priority' setting on the JOBADMIN 'retry failed items' dialog.
[SRO] A smart variable which attempts (when accessed) to allocate a fax channel during the request phase of a call, then returns the name of the fax board channel type. The variable to which @fax_avail is assigned is set to blank (@empty) if no channel is available, and otherwise to the same result as for @faxboard. This variable could be used, for example, to pre-allocate a fax channel at the start of a one-call IVR session to ensure that it is available at the end of the call when the fax is ready to be sent. This variable should only be used for one-call operations and in systems which fewer SC-Bus fax channels are available for dynamic allocation than the total number of lines in the system which can use one of them.
[CV C>] This variable will be set to the aggregate size of the fax data transmitted in the last transmission attempt, for Dialogic fax boards only; or to the aggregate size of the fax files to be transmitted in the first transmission attempt, for Dialogic Diva fax boards only. In the later case, the value does not take into account any byte-count changes resulting from changes to the fax format negotiated with the remote fax machine.
[CV >C] To allow for sites who use a mix of different fax boards, variables may be set to override the $fax_header settings when the fax is transmitted on a specific board. The 'xx' in the variable name specifies the board type and other fax header settings. For details, see the topic on configuring fax header lines.
[CV C> >G] Used internally to specify the fax header for preview and archive faxes.
[CV J>] The values record the fact that a new date and time have been set when a Job Administration DLL function is called to update the job scheduled launch time. These variables can be used on a proof cover sheet to inform the user about the launch time of the job.
[SRO] Reports whether a fax tone was detected either during the initial greeting message or during a question box process whose $get_var specified the F parameter. The value is 0 for no tone detected, 1 for CNG (transmit or poll), and 2 for CED (receive).
[SRO] A variable which returns the name of the fax board. This could be used, for example, on a $if command in a cover sheet template to select different include-file syntax for a system with different fax boards in different network nodes. The current return values are: DIALOGIC, BROOKTROUT, TESYSTEMS, BLADEWARE, FAXMODEM and EICON.
[CV >C] At request time, the full pathname of a cover sheet template file can be assigned to this variable to override the value specified on the $cover_sheet command. If there was no such command in the user profile, setting FAXCOVER will enable a cover sheet for the call. If the value expands to 'NONE' then no cover sheet will be sent.
[CV J>] Set to the number of pages added to a job following a Job Administration IVR session which resulted in a broadcast master document being faxed in.
[CV >C] You can assign to this variable the number of (high-res) scanlines to be stripped from an incoming Job Admin IVR FAXIN file to remove the header line. This variable is provided to replace the Brooktrout-only 'overlay fax header' capability for other makes of board. The variable should be assigned in a user job properties file (UJP).
[SRO] Y or N depending on whether fax number and routing questions have been deferred on this call by using $fax_phone_last.
[SRO] Expands to the CopiaFacts base directory, without a trailing '\'.
[CV >B] You can assign a string value to this variable containing one or both of the keywords DEDUPE and OMITLISTHEADER. If the two keywords are separated by an embedded space the value must be enclosed in double-quotes. The use of these options is described under fax broadcasting.
[SRO] Expands to the name of the certificates directory. A trailing "\" is not used.
[SRO] Expands to the pathname, excluding the file extension, of the current job instance UJP file. A trailing '.' is not used. When written in lower case (@ffcjob) on the $end_job_tasks command, the 'short' version of the filename is used, which may simplify the syntax in a Windows command file called to perform end-job processing.
[SRO] Expands to the name of the USERJOBS folder in the CopiaFacts base directory, without a trailing '\'.
[SRO] Expands to the log files directory, without a trailing '\'.
These variables must be defined in an FFMERGE template file to control the operation of an FFMERGE task. The default template file path is C:\FFMERGE\TASKS\DEFAULT.FST. Using T=taskname on the FFMERGE action line selects an alternate template file taskname.FST.
[CV >M] A non-empty value causes FFMERGE to generate $email_attach commands with a content type of 'application/pdf' which cause the document to be converted to a US-Letter size PDF before transmission. If FFM_PDFA4 is also non empty, the PDF will be A4-size instead.
[CV >M] If a pathname of a .USR file is specified here, it will be used as $fax_user for e-mail items in the merge, but not for items which also have a fax number. When used, it will also replace the path specified by FFM_USERPATH.
[CV >M] A non-empty value causes FFMERGE to generate an $email_attach command with a content type which supplies the value as a name for the main transmitted document.
[CV M>] Set in generated FS files by FFMERGE to the Windows login name.
[CV M>] Set in generated FS files by FFMERGE to the Windows computer name.
[CV >M] A non-empty value causes FFMERGE to append any FS filename it creates to the JCF used by STATUS to monitor outgoing transmissions for the user. The JCF is found from the OwnerFolder value used by FFCLIENT in the user account from which FFMRGMV was started. In a Terminal Services environment you will usually need to override this using FFM_MONITORUSER.
[CV >M] The value of this variable is used to override the OwnerFolder for a task which is to be used by a Terminal Services user other than the one from which FFMRGMV was started. It is ignored if FFM_MONITORSTATUS is not defined.
[CV >M] In conjunction with FFM_EMAILTOPDF, a non-empty value causes FFMERGE to generate the $email_attach commands with a content type of 'application/pdf' which cause the document to be converted to an A4 PDF before transmission.
[CV >M] The characters in the value are used to filter the characters of the action line which are used to form a fax phone number. The default if not supplied is '0123456789#$'.
[CV >M] This variable specifies the pathname of the USR file whose $image_locn commands are used to locate attachments from AT= tokens on the FFMERGE action line. If not specified, the user profile from the template $fax_user command is used.
[SRO] Expands to the post office (fax mail) directory, without a trailing '\'.
[SRO] Expands to the request directory (containing the SENT, FAIL and TOSEND directories), without a trailing '\'.
[CV C>] Contains the exit code from a $run operation. This value is not available for testing in the same infobox as the $run command.
[SRO] Expands to the scripts directory, without a trailing '\'.
[SRO] Expands to the user profiles directory, without a trailing '\'.
[SRO] This variable has been available since version 5.360. The format for versions up to 8.0 (where each program and DLL might have a diff erent version number) is a four-digit number, for example 8001 for version 8.001. From CopiaFacts 8.1 onwards, the value is a six-digit number, with three single digits for the first three version elements, and three digits (with zero fill) for the build number. For example 820063 for 220.127.116.11, and 820123 for 18.104.22.168. The version number is now common to all components of a build.
[SRO] These variables contain the date and time of the first attempt and can be used in any subsequent attempt for the transmission.
[CV >E] Used to fix the encoding of Unicode characters in e-mail bodies and headers, especially for Asian languages. See $email_charset for an example.
[CV >C] when set to a non-empty value, causes Error Correction Mode to be disabled for FaxModem board-type transmissions.
[CV >C] when set to a non-empty value, causes high-resolution to be disabled for FaxModem board-type transmissions.
[CV >C] when set to a non-empty value, causes MMR or MR encoding to be disabled for FaxModem board-type transmissions.
[CV >C] when set to a non-empty value, causes Error Correction Mode to be disabled for FaxModem board-type reception.
[CV >C] when set to a non-empty value, causes high-resolution to be disabled for FaxModem board-type reception.
[CV >C] when set to a non-empty value, causes MMR or encoding to be disabled for FaxModem board-type reception.
[CV C>] Contains the contents of the caller ID "name" string, if any, forming the first part of the From: URI in the message header of an incoming BladeWare SIP invite. Double-quotes and angle-brackets, if present, are removed. See also CALLIDNAME.
[CV C>] Contains the complete From: URI in the message header of an incoming BladeWare SIP invite.
FORCE_CSV, FORCE_TAB, FORCE_KNOWN_EXT [CV >JB] The first two of these variables may be assigned a string of file extensions which are to be forced in FFBC, WBC and Job Admin broadcast lists to either CSV or TAB format respectively. The format of the value is a sequence of one or more file extensions with no embedded blanks (e.g. ".ABC.DE.FGH"). The $var_def command must be in the configuration file for FFBC and WBC, or for Job Admin may be defined in the UJP hierarchy for a job instance. An extension should not appear in both lists; case is ignored; extensions .XLS and .DBF cannot be overridden and are ignored in these lists. If you plan to make these variables job-owner or jobtype-specific, it is recommended that you do not define the variable in FAXFACTS.CFG. You should instead place any required global setting in SYSTEM.UJP and override both variables in a specific owner and/or jobtype. If FORCE_KNOWN_EXT is defined to a non-empty value, the launch operation rejects the use of lists with extensions other than DBF, XLS, XLSX, TXT, CSV, TAB, TLS or those named in FORCE_CSV or FORCE_TAB.
[SWS CV J> >CJX] A numeric value may be assigned by the launcher to this variable by means of a $var_def statement added to an FS file during job launch. If non-zero, it will force the FS file to be treated as failing with the outcome code assigned. It is possible that the value may be overridden if other errors are detected while loading an FS file which includes a $var_def statement for this variable. Setting this variable in a pre-process $set_var statement is too late to affect its operation (see FS_PREFAIL instead): however it can theoretically be set in a $type FS infobox to cause the generated FS file to fail. The special value of 42 causes the item to be treated as a success without processing it. The variable is automatically cleared if a file is resubmitted.
[SRO] Contains the actual number (filename part) of the current FS file at transmit time.
[SRO] Contains the sequential FS number. This will be different from the actual FS number if a job has been launched with reversed FS numbers to randomize pickup.
These variables contain data about the FS file at infobox pre-process time during outbound call preparation and at infobox post-process time for an outbound operation. If a pre-process changes the $fax_filename data (for example by converting a referenced file to low-resolution), the variables are not updated.
[SRO] The number of e-mail attachments in the file. Note that if an attachment is a multi-page file and the content-type specifies a single-page image time (JPG, GIF or PNG) then the attachment count for that attachment will be its page count.
[SRW] The content type field from the referenced attachment. Assigning a value of DELETE to this field will delete the corresponding attachment. For a multi-page image attachment, if you modify this field you MUST modify ALL the attachments originating from the same file with the same value.
[SRW] The index (1 to FS_ACOUNT) of the attachment item referenced with the FS_ACTYPE and FS_ANAME variables. If you assign a value above FS_ACOUNT (with no gaps) you can then assign to FS_ACTYPE and FS_ANAME to add a new attachment.
[SRW] The full pathname of the referenced attachment, expanded if it contained ` variables. For a multi-page image attachment, if you modify this field you MUST modify ALL the attachments originating from the same file with the same value.
[SRO] The filename (without path) of the referenced attachment, expanded if it contained ` variables. This variable is intended tor use in the body of an e-mail to reference attachments. Each time you de-reference it, the value of FS_AINDEX is automatically incremented. Note that the name is that of the original attachment file, not any new name which will be assigned from the attachment content-type string.
[SRO] The full pathname of the FS file at the time its contents were last read or written.
[SRW] The full pathname of the referenced file. Assigning a filename to this variable during infobox preprocessing results in a different file being transmitted. Assigning an empty variable deletes the file from the transmission list. At post-process time the filename returned may be the name of a temporary file, for example if a specific input file needed to be processed to change resolution or other image settings before transmission.
[SRO] The full pathname of the referenced file. At post-process time this will still be the original filename even if the actual file transmitted was a temporary copy on which image pre-processing had been performed.
[SRO] The fax resolution of the first page of referenced file, using the following code:
Low resolution (standard): 204 by 98 or 200 by 100
High resolution (fine): 204 by 196 or 200 by 200
Superfine: 204 by 392 or 200 by 400
300 by 300
Ultrafine: 408 by 392 or 400 by 400
The code is incremented by 128 if one or more pages in the file have a resolution different from that of the first page.
[SRO] The file type of the referenced file. For the meanings of the codes, refer to $fax_filename.
[SRW] The index (1 to FS_FCOUNT) of the $fax_filename line item referenced with the FS_IFILENAME, FS_IFILEORIG, FS_IFILETYPE, FS_INPAGES, FS_IFILERES and FS_IWMKTYPE variables. When a value of 0 (the default) is assigned to the index, these FS_I... variables refer to the cover sheet.
[SRO] The file type of the watermark file. This variable is undefined if the FS_ITYPE variable does not indicate a GCT or GTT file.
[SRO] Used to determine the 'outbound type' of the FS file: 1: Worker Box; 2: Normal Fax; 3: Fax Mail Deliver; 4: Voice; 5: Fax Poll; 6: E-Mail; 7: SMS; 8: VSP; 9: JOB Worker Box; 1000+: Error Detected; 0: Unidentified. If the FS file originated in an MSMQ, 100 is added. If there was an error during FS loading it will be recorded as the variable value less 1000 (but this may not be the final outcome code of the attempt). This variable can be checked at any time in the processing of an FS file, from pre-process to post-process.
[CV >C] Assign a numeric value to this variable to specify that an infobox pre-process operation has determined that the transmission should not go ahead. An assignment to this variable may also be used in worker-box processing and will then cause the FS file to be moved to FAIL instead of to SENT on transfer to the KILL_MAINTOP state (128). The value is used as the outcome code. The special value 42 can be used to treat the item as a success without processing it.
[SRO] The contents of $fax_receiver, without variable expansion. For FFBC-created FS files, BCF variables will already have been expanded in this field. For Job Administration FS files, BCF and BCX variables will already have been expanded.
[SRO] The TOSEND folder number from which the FS file was loaded (0=TOSEND).
[SRO] Deprecated: use FS_OBTYPE instead. Used to determine the type of FS file currently being pre-processed. The values are: 2:outbound fax, 16: faxmail delivery; 256: voice outbound; 2048: fax poll outbound; 8192: e-mail outbound.
[CV >CJ] When set to a non-empty value, causes FS number generation to wrap at 1,999,999,999 instead of 99,999,999. Please consult Copia support before using this feature, which is incompatible with JOBMON and so requires custom end-job detection.
[SRO] Returns the text value of the remaining destinations which will be selected by $chain commands, comma separated. Normally this will be a series of infobox names. Unlike NEXT_CHAIN, the end chain state or destination is not appended, and if no chain exists, or the chain is finished, an empty string is returned. When a state is returned it is as a number preceded by lower-case 's' (e.g. s191) not as a state name. Infobox names are returned as upper-case. Note that the delimiter in the returned string will always be a comma.
[SRO] This variable contains a value returned from the Application Support DLL to indicate failure of the function which has been invoked.