The system variables listed below are available for use. Those marked [RO] are read-only: the 'system' value can be used by referring to @varname in your infobox or on a cover sheet template. Those marked [WO] are write-only: you can assign a value to them to affect system operation, usually with $set_var; and at the same time a user variable of the same name will be created and assigned to. If you refer to the same variable later, CopiaFacts will return the value of the user variable but no 'system' action is performed. Those marked [RW] can receive an assignment for 'system' purposes and also retrieve a 'system' value when referenced. For details of how to use system variables in commands, see Expansion of Variables. Note that writeable system variables cannot be set by means of a $var_def command.
You may also create your own variables by naming them in $var_def, $set_var or $get_var commands. From CopiaFacts version 7, all new system variable names will contain an underscore character (_). Avoiding the names below and any names with an underscore will therefore help to ensure that your own variable names do not conflict with CopiaFacts system variables.
The variables coded [U] below are documented here though they are not strictly system variables. They are 'user variables' set by COPIAFACTS in various circumstances, for example in a SENT FS file or prior to processing a post-receive or post-process infobox. The description below will describe where they can be used.
ACTIVE_COUNT
[RO] At request time, contains the count of active lines.
ADAPTER_INDEX
[RW] This variable takes a numberic value, 1-based, which selects which of the comma-separated values on the $email_node_bindnames and $email_node_localnames commands. If not supplied, the first value on each command is used.
ADDOK
[RO] Provides a means of checking that an image request made using $add_image was successful. If the image was added to the request list, this variable is set to its number. If the addition failed, then this variable is set either to "INVALID" or to "LIMIT" according to the reason for failure.
AM_RESULT
[RO] Provides the result of the last Dialog Diva answering machine detection. The result has the following meanings:
0
detection has not been enabled or has been canceled.
1
human talker
2
answering machine
3
answering machine tone
4
silence
5
fax tone or modem tone (FAX_TONE will be set if fax tone)
Note that if speech continues throughout the silence-detection period, it is possible that the detector will be canceled so that AM_RESULT will be 0 rather than 3.
AMOUNT_ERROR
[RO] Provides a means of checking that a variable value spoken with the CopiaFacts Configurable Phrase-Speaking feature was processed correctly. In coding your algorithm, you can set the value in AMOUNT_ERROR using the Fn flag command if you detect an error. This flag is not set by the standard digits and amounts playback algorithms.
ANI
[RO] When caller phone number data is available from the Caller ID data supplied by the telephone company, it is placed in this variable as soon as the call has been answered. This feature requires voice hardware which supports Caller ID. The entries in this variable are either complete telephone numbers or one of the special codes 'O', 'P' or 'X'. 'O' indicates an out-of-area number for which caller information is not available. 'P' indicates a private number for which caller data has been withheld. 'X' indicates that caller data is not supported from the line.
ANSWER_TIME
[WO] Sets the timeout in seconds for unanswered outbound calls, overriding the time set by $answer_timeout.
ANSWER_XFER
[WO] Sets the timeout in seconds for unanswered transferred calls, overriding the time set by $answer_timeout.
APAGES
[RO] For a special "retry cover sheet" only, this variable indicates the number of pages in the original document which have been sent successfully in earlier attempts. See the example retry cover sheet for more information.
ASCII_FILE
[RO] For use in graphical customisation applications only, contains the name of an ASCII file being converted. The system fills this variable only if an ASCII_TEMPLATE value has been set containing the name of a GCT or GTT template to be used to format ASCII files to fax. In the ASCII template, one annotation on each page must contain just the string "@!!@ASCII_FILE".
ASCII_TEMPLATE
[WO] A value assigned to this variable (in a UJP, USR, or FS file) is used to specify a GCT or GTT file which will be used to create a fax from an ASCII original. See the section Faxing ASCII files for more information. Note that this variable affects only files named on $fax_filename commands, and has no effect on cover sheet processing.
ASCII_LANDSCAPE
[WO] A value of 90 or 270 assigned to this variable (in a UJP, USR or FS file) is used to specify that the ASCII file rendered using theASCII_TEMPLATE feature will be inserted into the field after rotation by 90 degrees. The 90 value rotates anti-clockwise, placing the left of the ASCII text at the foot of the fax, and the 270 value rotates clockwise, placing the left of the ASCII text at the top of the fax. The template field should NOT be given an 'angle' property.
ASCII_WRAP
[RW] If this variable is defined as a non-empty value, overlong lines in files converted using either normal annotations or the ASCII_TEMPLATE feature will be word-wrapped instead of being truncated. If you use this feature with ASCII_TEMPLATE, you must either ensure that the wrapped text will always fit within a page, or else insert your own formfeed (ASCII 12) characters into the text to force page breaks appropriately.
AUTOCALL
[WO] Allows setting the auto-call value, for example prior to a change of DID number. A mailbox number may also be assigned to this variable and then transferring to state 79 (DO_MAIL_BOX) will begin a normal fax-mail receive operation.
BAD_NDX_VALUE
[RO] When a $validate NDX fails to find the entered value in the index, the value is assigned to this variable so that further processing can be performed on it. The variable is cleared when a validation succeeds.
BAUD
[U] Set after a fax operation is complete, this value contains the baud codes listed in Appendix E. Actual baud rates are available as TXBAUD and RXBAUD.
BCFx
[RW] These variables contain FFBC or Job Admin broadcast-generated field data are created for all broadcasts in the FS file. The x is the column number and the value of the created variable is the value from the corresponding column for the specific job item. BCFx variables are special in that they are an exception to the rule that the longest possible variable name is always expanded. Variable expansions of the form @BCFx are processed specially, and only an exact match is expanded. Thus if you have defined BCF3 in an FS file, but have not defined BCF30, then writing @BCF30 in a cover sheet template file will not cause the value of BCF3 followed by a zero to be expanded. This feature allows you to include a large number of @BCFx expansions in a cover sheet template file, and have them correctly expand to blank if a smaller number of $var_def BCFx commands have been created in the FS file by either FFBC or another FS file generation program. In addition these variables may be written with a negative field number (for example @BCF-4) to cause the substituted field value, if not empty, to have a 'newline' appended at the end. A succession of such variables written on a text line will then be transformed into a list on expansion, with no empty lines inserted for empty fields.
The special syntax BCF%n (for example `BCF%3) will cause the value of the variable to be url-expanded, using for example %20 to represent a space character.
BCHx
[RW] These variables contain Job Admin broadcast generated field data and are created when the $job_options keyword WordMerge is used or when both CreateBCXvars and OmitListHeader are used. The x is the column number and the value is the field name from the column header of the list containing the job item. BCHx variables are used to create temporary single-data-row lists for for WordMerge operations.
BCX_fieldname
[RW] These variables contain Job Admin broadcast generated field data and are created when the $job_options keywords CreateBCXvars and either WordMerge or OmitListHeader are used. The 'fieldname' is the field name from the column header of the list containing the job item, and the value of the created variable is the value from the corresponding column for the specific job item.
BLANK_ROWS_LIMIT
[RW] This variable specifies the number of job list rows with a blank destination column (phone/address) after which writing FS files will be suppressed on launch until a non-blank column entry is encountered. It is intended to prevent carelessly-created XLS list files from generating many thousands of unusable job items. The default value if this variable is not specified is 1000. See also the $job_options keyword CheckDestination.
BPAGE
[RO] For a special "retry cover sheet", this variable indicates the page number in the original document which is the starting page for the retry operation. Otherwise the value is 1. See the example retry cover sheet for more information.
BREAK_DTMF
[RO] After an SC-Bus call transfer where $allow_interrupt has been specified, this variable will contain the DTMF code(s) that terminated the link. The value is empty if the LINK_TERM value is neither 4 nor 5.
BROADCAST_TYPE
[RW] A variable which is created in a job properties file to define the type of broadcast: FB: fax broadcast; EB: e-mail broadcast; PB: outbound poll broadcast; VB: voice broadcast; FEB1: fax numbers and e-mail addresses in a single column; FEB2: fax numbers and e-mail addresses in two separate columns. The value of this variable is normally maintained automatically by reference to the presence or absence of the corresponding FS template commands. However for a FEB1 broadcast, this variable must be specified explicitly, because in this case only a $fax_phone will be present, and the case is otherwise indistinguishable from a normal fax broadcast.
BT_FONT/BT_FP
[RO] These variables return the font filename and a 1/0 'full page' indicator respectively. They are provided for F7GCOVER to use in the pre-conversion of ASCII files to TIF.
BT_...
[WO] Values can be assigned to these variables to specify non-standard parameters for ASCII files to be pre-converted to TIF for Brooktrout transmissions. This requires the 'pre-convert ASCII to TIF' run time option for COPIAFACTS.EXE to be set. These variables can be set using $var_def in FS, USR, UJP or CFG files, or by means of $set_var in an infobox preprocess operation. The following variables are provided:
BT_TM
Top margin in tenths of an inch (default 3)
BT_BM
Bottom margin in tenths of an inch (default 3)
BT_LM
Left margin in tenths of an inch (default 5)
BT_RM
Right margin in tenths of an inch (default 0)
BT_LSPACE
Interline space in low-resolution scan lines (default 0)
BT_LENGTH
Page length in low-resolution scan lines (default 1143)
BYTE_COUNT
[RO] The approximate number of bytes transmitted in an outbound e-mail operation.
CALL_x, CONN_x
[RO] These variables are used only in the JOBDDATA, JOBXDATA, and JOBREPORT programs. When specified as a data field, they allow analysis of call time and connect time by TOSEND queue number. For example the variable CALL_123 will show for a job item the aggregate call time over attempts in queues 1, 2 and 3. CONN_9 will show connect time in queue 9. For off-peak jobs which may have to be switched to or retried in a peak-time queue, these variables allow the time at each rate to be calculated. Any of the digits 1-9 may be used to form a variable name as in the examples above.
[RW] Contains the password entered by the caller in caller response to standard voice prompt 2, as a result of using the $caller_id command. At request time, a value can be assigned to this variable to replace any entered number. This assignment is often used for data other than a password, since the CALLERID value happens to be placed in all the log records for the call and this is a useful technique to access the log record fields. See Appendix E: Transaction Log File Format.
CALLERPN
[RW] Contains the voice telephone number entered by the caller in caller response to standard voice prompt 8, as a result of using the $caller_phone command. At request time, a value can be assigned to this variable to replace any entered number. This assignment is often used for data other than a phone number, since the CALLERPN value happens to be placed in all the log records for the call and this is a useful technique to access the log record fields. See Appendix E: Transaction Log File Format.
CALLIDNAME
[RO] When caller name data is available from the Caller ID data supplied by the telephone company, it is placed in this variable as soon as the call has been answered. This feature requires voice hardware which supports Caller ID. This data can be placed in a custom variable such as DATA5 to make it available in the DBF log file.
CALLNO
[RO] Contains the current call number with leading zeros, for use in forming unique filenames at request time.
CALLNUM
[RO] Contains the current call number, of the inbound call at request time, from the $fax_callno command at transmit time.
CALLP_ACTION
[WO] Assigning a value of 1 to this variable causes call progress to be suppressed after ISDN connect. Assigning 2 treats alerting message as being a connection. Assigning 3 causes both actions. This setting affects Dialogic PRI-ISDN connections only.
CALLSECONDS
[RO] At request time only, contains the number of seconds since the start of the call. This value can be checked in premium-rate applications where the service provider requires the call time to be limited.
[RW] Contains the call type code (one-call = 1, request = 2, not set = 0). You cannot rely on this variable if the @FAXPHONELAST variable has a value of "Y" and if the system allows both types of call. Setting this variable will change the call type between onecall and callback, provided that both types of call are permitted on the line (if not, setting the variable will have no effect). You can set this variable to a value of 1 for onecall or 2 for request when $fax_phone_last is in operation and you determine the caller's delivery method using custom question-box processing. Setting this variable will then prevent CopiaFacts asking for the information at the end of the call.
CAP_V34
[RO] After a Brooktrout TR114 fax call, this variable is set in the FS file to indicate (with a non-zero value) that the remote fax had V.34 capability.
CARDNO
[RW] Contains the credit card number entered by the caller. You may set this variable (and CEXPDATE) to the credit card number (and expiration date) which you wish to use for the call. The values you assign are not checked by CopiaFacts using credit card validation. Do not attempt to set this variable using $get_var. This feature allows you to look up and use previously validated credit card information from a data file. See also VCARDNO below.
CATERM
[RO] Set by the $dial_cmd command to a value indicating the outcome of the current call. The numeric value will be one of the call placement outcomes listed for the board in FF7.SMR.
CATYPE
[RO] The connection type returned by a Dialogic board on placing an outbound call. A value of 3 indicates that the analysis has determined that a real human is likely to have answered the call, and a value of 4 indicates that an answering machine is likely to have answered.
CAUSE_VALUE
[RO] Contains the ISDN PRI cause value from the disconnect of a telephony channel attached to the line.
CB_DELAY
[RO] The system maintains information about the time delay from request to first callback attempt, for the last 20 fax call-back requests. This figure is available as an average delay in minutes in this system variable. Fractions of a minute are discarded and the calculation of the average restarts each time the main COPIAFACTS program is restarted. This feature allows you to tell a caller approximately how long it will be before the requested documents are transmitted.
CC_CSTATUS
[RO] Contains a channel state code if there is a Dialogic PRI telephony channel attached to the line. The code reflects the channel state at the time of the last event on the channel. The codes are as follows:
0
no call reference number available, channel free or not PRI
A
failed to determine call state
B
call has been released (CST_NULL)
C
inbound call offered (CCST_OFFERED)
D
call accepted (CCST_ACCEPTED)
E
call connected (CCST_CONNECTED)
F
outbound call requested (CCST_DIALING)
G
call alert sent or received (CCST_ALERTING)
H
call disconnected (CCST_DISCONNECTED)
I
call not active (CCST_IDLE)
CC_STATUS
[RO] A vector of channel state codes (see CC_CSTATUS), one for each Dialogic PRI telephony channel, showing the recorded state of the corresponding channel.
CEXPDATE
[RW] Contains the credit card expiration date entered by the caller. You may set this variable (and CARDNO) to the credit card expiration date (and card number) which you wish to use for the call. The values you assign are not checked by CopiaFacts using credit card validation. Do not attempt to set this variable using $get_var. This feature allows you to look up and use previously validated credit card information from a data file. See also VCEXPDATE below.
CHAIN_END
[RW] Used to set or retrieve the state (or infobox) to which control would be transferred by $chain either at the end of an infobox chain established with the $set_chain command or when no chain is active. When assigning to this variable, any of the formats defined for $next_box can be used. When reading this variable, a state is returned as a number preceded by 's' (e.g. s191), not as a state name, even if the assignment has been made as a state name.
CHANNEL_BUSY
[RO] Contains a value 1 or 0 to indicate whether the Dialogic or Dialogic Diva channel is currently performing an input/output operation. The value is only valid immediately after an asynchronous play operation has been started using a $type voice infobox.
CHECK_BLANK_TIF
[RW] when set to a non-empty value in a configuration, user, or FS file, this eliminates from a fax transmission any TIF document which has no non-blank pages. This is intended to allow the elimination of a blank page which may result from rendering an HTML-format e-mail message body. It is recommended that this variable should only be used when a blank document might be expected, to avoid checking every TIF file for non-white pixels.
CLASS
[RO] Contains the caller class of service from the caller-id data file.
[WO] Assigning one of the values '200x200', '204x196' or '204x98' to this variable in an FS file being processed for Document Converter will override (and change) the resolution set in the Copia Fax Converter print driver. If this variable is not defined, the default value of '200x200' will be be used, unless overridden by environment variable DEFAULT_CONVERTER_RES. Some applications maintain their own printer settings and ignore the values set by these variables.
COUNT_0
[RW] Returns the value of a general-purpose counter which is set to zero at the start of each call. You may also assign a value to set this counter.
COUNT_1
[RO] Whenever this variable is accessed, it adds 1 to the value of a general-purpose counter and then returns its value. The counter is set to zero at the start of each call.
CRDESC
[RO] This is a special variable which returns a different value each time it is referenced. At request time, it returns the image credit description (or blank if none) for the just-selected image. But to do this you must reference the variable once and only once for each image selected. At transmit time, for cover sheets, it returns the image descriptions in turn for each of the images which has a description, provided it is different from the last one returned. Images in the list which do not have descriptions are omitted and do not cause a blank description to be returned. When there are no more descriptions, the variable returns blank. See also CRNDESC below. Do not use both these variables in the same FS file.
CREATETHISFILE
[WO] Assigning a full pathname to this system variable will cause the named file to be created as an empty file, or emptied if it already exists. If the file cannot be created, no error indication is made. Use this variable with care!
CRNDESC
[RO] This is a special variable which returns a different value each time it is referenced. At transmit time, for cover sheets, it returns the image description (or image number, if there is no description) in turn for each of the images, provided it is different from the last one returned. No image number is returned for the prefax and suffax images 0 and 99999999. When there are no more descriptions, the variable returns blank. See also CRDESC above. Do not use both these variables in the same FS file.
CRSTAT
[RO] credit card approval status (text)
CRTOTAL
[RO] at request time, this variable contains the running total of credit card costs from selected items. This variable can not be used at transmit time in a cover sheet template: use @TCOST instead.
CVRT_MACHINE
[RO] This variable is set (as an FS file $var_def) to the machine name of the instance of FFEXTERN which pre-processed the file for document conversion.
CVSINGLE_SCALESTEP
[WO] When defined, in an FS file only, the numeric value specifies the percentage steps by which the FontsizeN $convert_options keyword scales the image in an HTML document conversion using the internal converter. The default value is 10.
DATAx
[RW] These variable names are special only when used on a $set_var command in a $type decision infobox. Since release 7.110 such variables have been saved in the subsequent normal log records for the transaction; however the $log_options keyword datadoc causes a special log file record to be written with the value in the in the named field. In this mode, if you assign more than one of these values in the same IIF, only one log record will be generated. If you assign values in more than one IIF, multiple log records will be generated. The log file records will have a D in the fourth flag position (see Transaction Log File Format). Values will be truncated if necessary to fit in the field. There are an additional five fields (DATA5 to DATA9) available if you use the $log_field command. Assignments to all these fields are recorded in the FS file generated for a callback as well as in the log records as already documented. Assignments at request time are not carried through to the later log records which report fax transmission data; in these records the DATA2, DATA3, and DATA4 fields may carry additional data about the transmission. The use of these fields in this way is different for different fax boards (see Transaction Log File Format). For fax broadcasts, where the $fax_origin code in the FS file is user_request, you may assign values to the DATAx fields using $var_def commands in the FS file. In this case any such assignment will override the use of the same field for fax-board-specific system data such as call seconds.
DATEL
[RO] system date for graphical cover sheets only, in Windows 'long' date format.
DATEx
[RO] from system date:
DATE0
yyyymmdd (example: 20001225)
DATE1
mm/dd/yy (example: 12/25/95)
DATE2
dd/mm/yy (example: 25/12/95)
DATE3
dd/xx/yy (example: 25/DC/95)
DATE4
mm/dd/yyyy (example: 12/25/1995)
DATE5
dd mon yyyy (example: 25 Dec 1995)
DATE6
xxxxx dd, yyyy (example: December 25, 1995)
DATE7
yy mm dd (example: 95 12 25)
DATE8
yy-mm-dd (example: 95-12-25)
DATE9
yymmdd (example: 951225)
DATE_L
The local Windows 'long date format' is used
DATE_S
The local Windows 'short date format' is used
DB_ACTION
[WO] Assign an action string to this variable to perform an action on the current database file associated with the line. See Database Interface in the Features chapter for examples of using a database.
DB_CMD_TIMEOUT
[WO] Override the timeout for database queries or stored procedures that do not return record sets.
[WO] Override the timeout for database queries or stored procedures that return record sets
DB_FILE
[WO] Assign a string of the form "prefix%=filename" to this variable to select the database to be associated with the line. See Extended Database Support in the Features chapter for examples of using a database.
DB_RESULT
[RO] Receives the value (zero = success, non-zero = error) returned from F7DATABASE after the last file specification, record selection or database action. See Extended Database Support in the Features chapter for examples of using a database.
DB_SELECT
[WO] Assign a string to this variable to select a record from the database associated with this line. See Extended Database Support in the Features chapter for examples of using a database.
DECIMALS
[WO] Assign a value to this variable to change the number of decimal places used for currency and value items spoken using $play_var from a custom algorithm file. Using the default or override amounts playback file will reset the decimal places to the default value of 2, and the default is also restored at the end of a call. Note that the supplied sample amount algorithm files assume the default value of 2 decimal places.
DEDUPE_FIELD_NUMBERS
[WO] This variable is used to specify (blank-separated) the BCF field numbers which are to be added to the target (number or address) tested in a job admin 'de-dupe' operation. A value of "none" causes no fields to be added; a value such as "3 7" causes fields BCF3 and BCF7 to be added, if there are sufficient available list columns to do so. When this variable is not set, the value specified for $fax_receiver is added. A value of "none" causes a list containing items for different named people at the same telephone number to only result in one call being made.
DELETE_OPTION
[WO] This variable can be assigned a string containing any of the keywords temp, sent, fail, tmpf, which have the same meaning as in the $delete_option command. This variable is typically used in an infobox post-process to dynamically change the settings on the command. The values given completely replace the specification on the command, and an empty string value removes all options.
DELETETHISFILE
[WO] Assigning a full pathname to this system variable will cause the named file to be deleted from the disk. If the pathname does not exist or cannot be deleted, no error indication is made. Use this variable with care!
DIAL_DIGITS
[RO] Written into an FS file after transmission, this variable shows the actual digits dialled after phone mask and phone-account processing. It is written in Job Admin FS files only, and facilitates reporting and analysis.
DIDNO
[RW] Contains the DID number used on the inbound call. If the CopiaFacts DID option has been enabled, you may also assign a new number to this variable to change user profiles during the call. This is only effective when the assignment is followed immediately by a $next_box command which transfers to state 117 (setup user).
DISPLAY_COLOR
[WO] This variable (you can also spell it DISPLAY_COLOUR) allows setting of the foreground and background colors in the line status display in COPIAFACTS.EXE. The value must consist of two color names separated by a comma, forward slash or pipe symbol, with no embedded space (e.g. White,Blue). The first is the foreground and the second the background color. The available names are: Black, Maroon, Green, Olive, Navy, Purple, Teal, Gray (or Grey), Silver, Red, Lime, Yellow, Blue, Fuchsia, Aqua, White. In addition you may specify any color by its hexadecimal R-G-B value (e.g. FFFFFF/0000FF for White,Blue). Invalid values (or identical foreground and background colors) result in the default black on white, which is also reset at the end of each call. The assignment to this variable may be made in user profiles, FS files, or infoboxes.
DISPLAYx
[RW] A value can be assigned to this variable which will be displayed on the COPIAFACTS screen if the corresponding $display_box has been enabled. The value read from this variable also represents the current contents of the display box. If the COPIAFACTS.EXE display shows active line and active max counts, the system variable shows the normal box contents, not the alternate display.
DIVA_DISABLE_ECM
[WO] The assignment of a non-empty value will disable ECM for the current Dialogic Diva fax outbound call. Note that this will also disable baud rates over 14400, which require ECM.
DIVA_DISABLE_HIGH
[WO] The assignment of a non-empty value will disable high-resolution faxing for the current Dialogic Diva fax outbound call. Faxes will be converted on the fly to low-resolution. Note that the output will normally be of lower quality than that obtained by using the $image_res keyword 'low-res', especially for text areas.
DIVA_DISABLE_MMR, DIVA_DISABLE_MR
[WO] The assignment of a non-empty value will disable the use of MMR (Modified Modified Read) or MR (Modified Read) fax compression for the current Dialogic Diva fax outbound call.
DIVA_MAXHUMAN
[RW] This value must be specified to enable answering machine detection for a Dialogic Diva voice outbound call or (when specified in an infobox in the original call) for the second call in a Dialogic Diva line-interconnect call. It specifies the maximum time in milliseconds that a human would speak when answering the phone. If the announcement from the called party is longer, the value retrieved in AM_RESULT will be set to 2.
DIVA_MAXIST
[RW] This value must be specified to enable answering machine detection for a Dialogic Diva voice outbound call or (when specified in an infobox in the original call) for the second call in a Dialogic Diva line-interconnect call. It specifies the maximum time in milliseconds that the human speech (see DIVA_MAXHUMAN) can be interrupted for it still to be interpreted as continuous speech.
DIVA_MAXSILENCE
[RW] This value must be specified to enable answering machine detection for a Dialogic Diva voice outbound call or (when specified in an infobox in the original call) for the second call in a Dialogic Diva line-interconnect call. It specifies the time in milliseconds until the remote side starts speaking. When this timeout is reached without detecting a speaker, the value retrieved in AM_RESULT will be set to 4.
DIVA_NEGOTIATE_TIMEOUT_SECONDS [WO] The assignment of a value (in seconds) to this variable will change the default limit of 45 seconds to wait for an outbound fax negotiation to complete on a Diva Server board. Assignment of values less than 30 will be silently ignored and will result in the default value being used.
DIVA_PAGE_SEND_TIMEOUT_SECONDS [WO] The assignment of a value (in seconds) to this variable will change the default limit of 300 seconds (five minutes) per transmitted page on a Diva Server board. Assignment of values less than 60 (one minute) will be silently ignored and will result in the default value being used.
DIVA_RECEIVE_TIMEOUT_MINUTES [WO] The assignment of a value (in minutes) to this variable will change the default limit of 30 minutes for the receipt of a fax on a Diva Server board. Assignment of values less than 5 minutes will be silently ignored and will result in the default value being used.
DK_CANONICALIZATION
[WO] The keyword assigned to this variable specifies whether the DKIM verifier is to verify that the signed content is exactly the same (DKSIMPLE) or to tolerate common modifications such as whitespace replacement and header field line rewrapping (DKRELAXED). The latter is the default. The canonicalization can be specified separately for the headers and the body by separating two keywords with a vertical bar, for example "DKRELAXED|DKSIMPLE" specifies relaxed checking for the headers and simple checking for the body. Note that the keyword DKNOFWS (for 'no folding white spaces') is a synonym for DKRELAXED.
DK_SELECTOR
[WO] Specifies the Selector parameter for DKIM signing. The value is placed in the "s=" parameter of the DomainKey-Signature: header. This is a required variable for DKIM signing. It specifies which public key in the sender's DNS records is to be used by the receiving MTA to verify the message key.
DLL_CALL
[WO] To call a DLL entry-point in the currently selected DLL for the line, assign the name of the entry-point to this variable. For examples of DLL calls, see the Features section.
DLL_PARM
[RW] Before calling a DLL entry-point, you should assign a value to this variable which will be passed to the DLL as a null-terminated string. After the DLL has been called, this variable can be read and will contain whatever the DLL has placed in the passed string buffer. Unpredictable results will occur if your DLL returns a string which is not null-terminated or which is longer than 8192 bytes (including the terminating null). If the DLL number is invalid the parameter will be set to "errorlib" and if the entry-point is invalid the parameter will be set to "errorentry".
DLL_RESULT
[RO] The integer (converted to a string value) value returned by the last DLL call. Before making a call, or if the call fails, the value is set to -1 and the DLL_PARM value will indicate the type of failure.
DLL_RETURN
[RO] Contains the same value as DLL_RESULT.
DLL_SELECT
[WO] A number between 1 and 8 to select the DLL loaded with that number using the configuration command $load_dll. Or a letter 'C' to select the DLL which also contains the call control DLL entry points. The selection remains in effect for the line and for the call, until overridden by a further assignment. The number is reset (no active DLL) at the end of each call.
DNIS
[RO] The full Dialed Number Identification String available from the digital network interface.
DNIS_DOC
[RO] The part of the DNIS (Dialed Number Idenfication String) used for document selection in HDID type 3.
DNS_...
[WO] These variables can be set (normally in the configuration file only) to provide a full pathname or lookup-table specification for each of the global 'do-not-send' files. If the value ends in '.NDX' it is taken to be a simple pathname; otherwise it is parsed as a database lookup specification as described in Do-Not-Send Files.
These specifications override the use of the standard NDX file names in the folder specified by $log_def. When you use these variables to specify the do-not-send lookup, the transmission will fail if the corresponding file cannot be found; without the variables the absence of the default NDX file causes the transmission to go ahead.
A special value of NONE will cause the corresponding do-not-send check to be skipped, and this is the only value that can be specified in a $var_def command in an FS file; any other override attempt will be ignored. A 'none' entry in an FS file may be useful when sending a fax or email to the target to confirm that the exclusion has been recorded.
DNS_DOMN_PATH
The specification for domain lookups (default DNS_DOMN.NDX)
DNS_MAIL_PATH
The specification for email lookups (default DNS_MAIL.NDX)
DNS_PATH
The specification for phone lookups (default DNS.NDX)
DTI_CSTATUS
[RO] Contains a 1 if there is a Dialogic telephony channel attached to the line which is not in idle state. More information about the channel state for a PRI channel can be obtained from the CC_CSTATUS variable.
DTI_STATUS
[RO] A vector of 1 and 0 digits, one for each Dialogic DTI channel, showing whether the corresponding channel is active or not. More information about the channel state for PRI channels can be obtained from the CC_STATUS variable.
DOW
[RO] Contains a day of week code calculated from the system date. Sunday = 1.
EMAIL_BINDNAME
[WO] An IP address may be assigned to this variable in a USR or FS file to select one of the available binding addresses which is to be used for specific e-mail transmissions. The use of this variable is deprecated, and $email_node_bindnames should be used in preference. However the variable overrides the settings on that command, if both are used.
EMAIL_BYTECOUNT
[RO] This variable definition is placed in an FS file after e-mail transmission and its value will contain the approximate number of bytes transmitted.
EMAIL_CONNECT_IP
[RO] This variable definition is placed in an FS file after e-mail transmission and its value will contain the IP address corresponding to the MX record used for the transmission attempt. This records the actual IP address used for an MTA which allocates addresses in round-robin fashion from a group of possible addresses.
EMAIL_ERROR
[RO] This variable definition is placed in an FS file after a failed SMTP e-mail transmission and its value will contain the error string, or extended error string, if any, returned by the remote mail server. Not all MTAs return extended error codes. RFC 2821 describes standard error codes and RFC 1893 describes extended error codes.
EMAIL_FROM
[RO] Contains the e-mail from value, or that from $email_esender if no $email_from exists. Note that variables referenced in the corresponding command parameter will not have been expanded in the value of this variable. For more information, see variable recursion.
EMAIL_PRIORITY
[WO] A TOSEND number (from 1 to 9) may be assigned to this variable in a UJP file to specify the launch priority for any e-mail items in a Job Admin broadcast of type FEB1, FEB2 or EB. This allows separate priority values to be set for e-mail and overrides the $priority setting. When setting this variable you should normally avoid using $retry_tosend in case it moves items to a different priority level.
EMAIL_LOCALNAME
[WO] A fully qualified domain name or an IP address may be assigned to this variable in a USR or FS file to override the $email_localname configuration command. It specifies the address to be used on the HELO command at the start of the SMTP or ESMTP conversation. The use of this variable is deprecated, and $email_node_localnames should be used in preference. However the variable overrides the settings on that command, if both are used.
EMAIL_SUBJECT
[RO] Contains the e-mail subject from $email_subject. Note that variables referenced in the corresponding command parameter will not have been expanded in the value of this variable. The variable-expanded subject is available in EMAIL_XSUBJECT.
EMAIL_TARGET
[RO] This variable definition is placed in an FS file during an e-mail transmission and its value will contain the effective target address (e.g. name@company.com) which has been parsed from the parameter on the $email_address command. It is available for use within the body of the e-mail. Variables used in the $email_address parameters will have already been expanded, unless the $email_options keyword 'nomacro' has been given. This string value is that which will have been looked up in the e-mail do-not-send index, if specified, and the text following the @ sign is that used for lookup in the domain do-not-send index.
EMAIL_TO
[RO] Contains the e-mail target address from $email_address. Note that variables referenced in the corresponding command parameter will not have been expanded in the value of this variable. For more information, see variable recursion.
EMAIL_URL_TARGET
[RO] Contains a copy of the EMAIL_TARGET value but with non-ASCII characters rendered using %xx syntax where xx is the hexadecimal value of the character. This format is typically needed for inclusion in a clickable URL which requires the target address as part of the URL.
EMAIL_XSUBJECT
[U] Contains the e-mail subject from $email_subject, with variables expanded.
EMBED_COUNT
[RO] Contains the number of embedded images in an MHTML e-mail transmission.
EMPTY
[RO] Special variable for use in comparisons to test for an empty value in another variable.
FAX_AVAIL
[RO] 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.
FAX_BYTECOUNT
[RO] 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.
FAX_HEADER_xx
[WO] 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 is BN for Brooktrout TR114, BM for Brooktrout TR1034 and TR1034-based Trufax, DN for Dialogic, EN for Dialogic Diva Server, GN for Gammalink, PF for Commetrex PowerFax and PV for job fax preview.
FAX_TONE
[RO] 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).
FAXBOARD
[RO] 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, GAMMAFAX, POWERFAX and EICON.
FAXCOVER
[WO] 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.
FAXIN_STRIP_HEADER
[WO] 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).
FAXPHONELAST
[RO] Y or N depending on whether fax number and routing questions have been deferred on this call by using $fax_phone_last.
FIDx
[RO] Contains the values (x = 1, 2 or 3) from the "follow-on ID" DTMF string provided by a PBX telephone switch when specified using sdid3.
FFBASE
[RO] Expands to the CopiaFacts base directory. A trailing '\' is not used.
FFBC_OPTIONS
[WO] 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.
FFCJOB
[RO] 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.
FFEXTERN_CONSECUTIVE_ERRORS [WO] You can assign a numeric value to this variable to specify the number of consecutive document conversion errors after which the program status will be set to 'not active'.
FFEXTERN_QUEUE_ERRORS
[WO] You can assign a numeric value to this variable to specify the number of consecutive preproc queue read errors after which the program status will be set to 'not active'.
FFEXTERN_TIMEOUTS
[WO] You can assign a numeric value to this variable to specify the number of document conversion timeouts after which the program status will be set to 'not active'.
FFJOBS
[RO] Expands to the name of the USERJOBS folder in the CopiaFacts base directory. A trailing '\' is not used.
FFLOG
[RO] Expands to the log files directory. A trailing '\' is not used.
FFPO
[RO] Expands to the post office (fax mail) directory. A trailing '\' is not used.
FFREQ
[RO] Expands to the request directory (containing the SENT, FAIL and TOSEND directories). A trailing '\' is not used.
FFRESULT
[U] Contains the exit code from a $run operation. This value is not available for testing in the same infobox as the $run command.
FFUSER
[RO] Expands to the user profiles directory. A trailing '\' is not used.
FFVERSION
[RO] This variable is available in version 5.360 and later, in all the places supported for testing system variables. In version 5, it is the only variable available for testing with $if in the configuration file (FAXFACTS.CFG). The format is a four-digit number, for example 7188 for version 7.188. The number represents the version of the CopiaFacts engine.
FIRST_DATE, FIRST_TIME
[RO] These variables contain the date and time of the first attempt and can be used in any subsequent attempt for the transmission.
FORCE_CSV, FORCE_TAB
[WO] This variable 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.
FORCE_FAIL
[WO] A numeric value can be assigned to this variable by means of a $var_def statement added to an FS file during preprocessing or 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.
