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. The equivalent variable for Dialogic boards (with different values) is CATYPE.
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_NO_EXPAND
[WO] A non-empty value assigned to this variable suppresses variable expansion in processing a file named as ASCII_FILE.
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.
In template files for FFBC and JOBCL, these variables have a different purpose: they act as a list filter so that lines are excluded unless they match all the values defined for such variables in the template.
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 10. 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. The equivalent variable for Dialogic Diva boards (with different values) is AM_RESULT.
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.
CFSIP_
These variables supply data for various CopiaFacts SIP implementations. The variables may be used slightly differently for different SIP port types. The variables will normally be defined on a $environment command so that different values can be used for different nodes, but can be overridden by $var_def commands.
CFSIP_PASSWORD
[RW] For Commetrex Bladeware, the contents of this variable override the value in the Bladeware configuration file for a specific call.
CFSIP_USERNAME
[RW] For Commetrex Bladeware, the contents of this variable override the value in the Bladeware configuration file for a specific call.
CFSIP_OUTBOUNDPROXY
[RW] For Commetrex Bladeware, the contents of this variable are passed to the SIP_OTF_OutboundProxy parameter for an outbound call.
CFSIP_CALLINGNUM
[RW] For Commetrex Bladeware, the contents of this variable are used as the outbound calling number (ANI).
CFSIP_SIPIP
[RW] For Commetrex Bladeware, the contents of this variable are used to form the outbound dialed number (following the '@').
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.
CUSTOM_LIST_DLL
[RW] when set to a DLL pathname in a job instance UJP, will cause the DLL to be called to load and parse the broadcast list. This allows the extraction of list data from a file format which may not contain individual rows of data. Contact Copia support if you feel you may have a use for this feature.
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.
DELAY_LAUNCH
[RW] When set to a non-empty value in a job instance, and if the job schedule date is in the future at launch time, causes a single workerbox FS file to be written instead of a full launch. When it is time to process the workerbox, it then launches the job. This can avoid large numbers of forward-scheduled files in the TOSEND folders which may delay other work. A special value of a negative integer in this variable signifies the time in minutes by which the launch will be brought forward, ahead of the scheduled launch time, to allow per-item preprocessing such as WordMerge to get started before the first transmissions. The number of minutes should be kept as small as possible to avoid defeating the purpose of this feature.
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_BAUD_MAX
[WO] An assignment to this variable in the USR file controlling the receive will limit the negotiated rate.
DIVA_RECEIVE_DISABLE_ECM [WO] Assignment of a non-empty value to this variable in the USR file controlling the receive will disable Error Correction Mode.
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_HEADERFIELDS
[WO] The value is a colon-separated list of header names which specify which headers are to be encrypted (and should match their sequence in the message). You can add unused header names to the list to prevent the message from being accepted if the header has been added en-route.
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.
DK_SHA256
[WO] A non-empty value specifies that the sha-256 algorithm is to be used for DKIM signing. The default is sha-1.
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_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_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_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. The variable will be empty if there was no e-mail transmission attempt.
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. The variable will be empty if there was no e-mail transmission attempt.
[U] Contains the e-mail subject from $email_subject, with variables expanded. The variable will be empty if there was no e-mail transmission attempt.
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.
EOJ_INFOBOX
[RW] If defined as an infobox name in job instance properties, causes a special worker FS file to be generated by JOBMON at EOJ, which will transfer control to the infobox named. This allows EOJ processing which is more conveniently performed from an infobox. The infobox processing will normally be performed before the tasks specified as $end_job_tasks, but your processing should allow for them to be performed either concurrently or afterwards. As usual, your infobox sequence must be ended by a transfer to state KILL_MAINT_OP.
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, OTF for Commetrex OTF 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.
FSNUM
[RO] Contains the number (filename part) of the current FS file at transmit time.
FS_...
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.
FS_FCOUNT
[RO] The number of $fax_filename lines in the FS file.
FS_FILENAME
[RO] The full pathname of the FS file at the time its contents were last read or written.
FS_IFILENAME
[RW] 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.
FS_IFILEORIG
[RO] 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.
FS_IFILERES
[RO] The fax resolution of the first page of referenced file, using the following code:
0
Low resolution (204 by 98 or 200 by 100)
1
High resolution (204 by 196 or 200 by 200)
2
Superfine (204 by 392 or 200 by 400)
3
Superfine (300 by 300)
4
Superfine (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.
FS_IFILETYPE
[RO] The file type of the referenced file. For the meanings of the codes, refer to $fax_filename.
FS_INDEX
[RW] 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 is assigned to the index, these FS_I... variables refer to the cover sheet.
FS_INPAGES
[RO] The number of pages in the referenced file.
FS_IWMKTYPE
[RO] The file type of the watermark file. This variable is undefined if the FS_ITYPE variable does not indicate a GCT or GTT file.
FS_PREFAIL
[WO] Used to specify that an infobox pre-process operation has determined that the transmission should not go ahead. The value is used as the error number.
FS_RECEIVER
[RO] 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.
FS_TOSEND
[RO] The TOSEND folder number from which the FS file was loaded (0=TOSEND).
FS_TYPE
[RO] Used to determine the type of FS file currently being pre-processed. The values are: 2:outbound fax, 16: faxmail delivery; 256: voice outbound; 512: fax poll outbound; 8192: e-mail outbound.
FULL_CHAIN
[RO] 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.
FUNCTION_RETURN
[RO] This variable contains a value returned from the Application Support DLL to indicate failure of the function which has been invoked.
GCT_EXPANDnn
[RO] This variable is created in the FS file when a graphical cover sheet has been processed in the presence of the Keep Graphical Cover CopiaFacts option. It records the filename which has been 'kept'. The nn is zero for the fax cover sheet and is incremented for $fax_filename lines referencing a graphical cover sheet.
GFAXRCVFILE
[RO] This variable contains the pathname of a fax file received into a temporary directory during fax polling. This variable is set for Gammalink channels only, operating behind a Dialogic E1 interface. The polled send is started when CNG is heard from the remote fax, but occasionally the CNG will be the result of a transmission made in error to a fax-polling telephone number. The variable can be tested in END_FAX state. If empty, this indicates that fax-polling proceeded normally and no fax was received.
GFX_HEADER
[WO] To retain the formatting of Gammalink fax headers which applied prior to engine release 7.162, this variable is should be set to the former contents of the header field in the Gammalink control panel applet (typically &header&user). These two fields are then set to 52 bytes of the current $fax_header value.
GSPDFx
[WO] These variables (for x=1 to x=9) are used to override the Ghostscript command parameters used for Document Conversion using Ghostscript. Variables with numbers 6 and above must be defined sequentially with no gaps in the number sequence.
GTD_CHECK
[WO] For Dialogic and Dialogic Diva boards, this variable is used to set the tone-IDs of the global tones that are to be detected on the voice channel. For example a value of "1 2 4" selects tone IDs 1, 2, and 4 defined by $global_tone for the line. Detection (or change of detected tones) is not actually enabled until the next voice play or record operation on the line. Detection terminates a play or record operation. The addition of a minus sign at the end of the string (e.g. "1 2 4 -") disables detection at the end of the play or record operation. Any assignment to this variable immediately resets the value of GTD_TONEID to zero. The value "all" or "all-" enables all defined tones.
GTD_TONEID
[RO] This variable returns the tone-ID (from 1 to 32) of the last global tone detected on the Dialogic or Dialogic Diva voice line, or 0 if no tone has been detected. If non-zero, the number will be one of those defined in the last assignment to GTD_CHECK.
HANGUP_PENDING
[RO] This variable will have a value of 1 if a disconnect has been detected but not yet processed, and 0 otherwise. It is provided principally so that a user-written DLL can detect if the caller has hung up during processing.
HARDWARE_DOWN_ACTION
[WO] A pathname assigned to this variable specifies the action to be taken when a hardware failure is detected. If the filename assigned has extension .FS, the file will be moved to the TOSEND folder. If the extension is CMD, BAT or EXE, the command will be executed, passing a single parameter of the line number on which the problem was first detected.
IBACTUAL
[RO] Contains the actual infobox number entered by the caller, before any processing specified in the $infobox command.
IIF_NAME
[RO] Contains the filename (without path or file extension) of the current infobox, if there is one.
IIF_PATH
[RO] Contains the full pathname of the current infobox, if there is one. If the infobox is in an IBC file, this variable will return the logical name of the IBC file.
IMAGECOUNT
[RW] At request time, contains the current total number of images requested. You may also assign a special value of zero to this variable to clear all images from the list of those already selected in the call.
IMAGEFILENAME
[RO] At request time, this variable returns the full pathname of the just-selected image. Alternatively, if IMAGEINDEX has been set to a value between 1 and @IMAGECOUNT inclusive then it will return pathname of the corresponding item in the list of selected images.
IMAGEINDEX
[WO] You can assign a value between 1 and IMAGECOUNT to this variable to select the corresponding value in the list of selected images for reporting using the IMAGENUMBER or IMAGEFILENAME system variables.
IMAGENUMBER
[RO] At request time, contains the infobox reference of the last image selected, whether by direct caller entry, menu selection, or by lookup. If the IMAGEINDEX variable has been set to a value between 1 and @IMAGECOUNT inclusive then this image will be selected instead of the last image.
IMAGEUPDATE
[WO] You can assign an infobox reference to this variable to specify the document to be updated in a remote image update operation. This avoids the need for the caller to respond to prompts to select the image to update and other update options. You must specify a directory by using $update_image in the user profile. After setting this variable you should use $next_box to transfer to state 148 (START_FAX_RMT) so that the caller is prompted to transmit the documents. When the fax has been received in this way, CopiaFacts will save a callback request if any image has been selected, so by preselecting the same infobox reference you can fax a copy of the received image back to the caller for verification. If you do not wish to have a generated FS file to initiate a callback verification, use the IMGUPNOFS system variable instead of this one. If you wish to specify an absolute path, use RECEIVE_FAX below.
IMGUPNOFS
[WO] See IMAGEUPDATE above.
INFOBOX_FS_FSNUM
[RO] Contains the FS file number (with leading zeros) for the FS file just created in a $type fsfile infobox.
INFOBOX_FS_FILENAME
[RO] Contains the full pathname for the FS file just created in a $type fsfile infobox.
INFOBOX_MIN
[RW] This variable can be set with the infobox number minimum length. Values from 1 to 15 (and smaller than INFOBOX_MAX) are valid.
INFOBOX_MAX
[RW] This variable can be set with the infobox number maximum length. Values from 1 to 15 (and larger than INFOBOX_MIN) are valid.
JI_DATAx
[WO] You may assign a value to this variable to specify a job data value after the job creation phase of an IVR session. The x value is normally from 1 to 4 unless you have specified extra data fields using $log_field. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_DATAx. The use of these system variables is now deprecated; it is preferable to use JI_VARDEF as described below.
JI_DELAY
[WO] You may assign a value to this variable to specify a delay for the current job, after the job creation phase of an IVR session. If the value is less than three digits, it is taken as a number of hours. Otherwise it must be a date or time in one of the formats HHMM, YYYYMMDD, or YYYYMMDDHHMM. The string length determines the format. For more complex date/time selection, use JI_TOSEND to select a TOSEND queue with an appropriate schedule. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_DELAY.
JI_PASSWORD
[WO] You may assign a value to this variable to change the password in the OWNER.UJP file that is active for the current Job IVR session. This allows an owner to change password using IVR you have provided for this purpose. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_PASSWORD.
JI_PHONE
[WO] You may assign a value to this variable to change the phone number used for both job proofs and standard job reports for the job instance. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_PHONE.
JI_TOSEND
[WO] You may assign a value to this variable to specify the job priority after the job creation phase of an IVR session. The value must be from 1 to 9. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_TOSEND.
JI_VARDEF
[WO] You may assign a value of the form "varname=value" to this variable after the job creation phase of a job IVR session, to make available the variable during the processing of the broadcast job. If updating the job properties fails, a run-time error will be recorded in the trace file and a value of 'JOBFAIL' will be assigned to a user variable JI_VARDEF.
JOB_ERROR
[RO] This variable returns an error number if processing of job owner, type or instance selection fails. It is used when the standard job selection procedure prompts have been bypassed by making assignments to the JOBINST, JOBOWNER, JOBTYPE and JOBNEWOLD system variables. When an error code has been set, control will be transferred to your $error_exit infobox.
JOB_FAIL
[RO] This variable returns the number of job items which have failed after the specified number of retries. If failed items have been 'manually' retried, they will have be counted multiple times. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_INSTANCE
[RO] This variable returns the job instance number. The variable may be used after a job instance has been created or selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_ITEM
[RO] This variable returns the sequential item number of the FS file within a job, from 1 to the total number of items in the job. A value of 0 indicates that the FS file is not part of a job. A value of -1 indicates a proof and of -2 a standard job report.
JOB_LAUNCH_LIMIT
[RW] This variable can be set in SYSTEM.UJP or in an override owner, jobtype or instance UJP file, to limit the maximum size of job to be processed. In an environment where bureau clients submit jobs themselves, this can avoid the accidental launch of a job with a very large number of recipients. Jobs with a larger number of items will fail to launch with error code -38.
JOB_LISTNAME
[RO] Contains the filename of a job list file, for use on a job report coversheet to show which list(s) have been used. If multiple lists are in use it returns them in sequence each time the variable is used.
JOB_LISTPATH
[RO] Contains the full pathname of a job list file, for use on a job report coversheet to show which list(s) have been used. If multiple lists are in use it returns them in sequence each time the variable is used.
JOB_NOTES
[RO] This variable returns the job notes field from the job instance properties, which may be required to display the client's identifying data on a proof or report cover sheet.
JOB_RETRIES
[RO] This variable returns the number retries of job items which have not been transmitted successfully on a previous attempt. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_SCHEDULED
[RO] This variable returns the scheduled processing time for a job instance, based on the fax send date and time in the $fs_template item list. If no defer time has been entered, the value returned will be empty. If the job is not yet launched, it may not be transmitted at the scheduled time if the launch is not performed before this. The format of the returned string is YYYYMMDDHHMMSS.
JOB_SECONDS
[RO] This variable returns the aggregate number of call seconds used in sending the job. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_SENT
[RO] This variable returns the number of job items which have been successfully sent. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_STATUS
[RO] This variable returns the status of a job as a two-digit numeric code, followed by space, colon, space and then the status description. To obtain just the numeric code, use $set_var to assign @JOB_STATUS to another variable with a start value of 1 and a length value of 2. For details of the codes, see Job Status/Actions. The variable may be used after a job instance has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOB_SUSPEND
[RW[ Any non-empty value can be assigned to this variable to cause the current job to be suspended. Unlike JOBACTION this variable is intended for use in a pre- or post-process infobox for a job item and can suspend the job if a specific condition is detected. The variable value will be empty if the action was successful and will contain JOBFAILn if not, where n is the (negative) error code. To allow for the action being performed simultaneously from multiple threads, no error occurs if the job is already suspended.
JOB_TIMESTAMP
[RO] This variable returns the time of the last change of status of the job instance. For example, if the job is finished, it will tell you when the job was finished. If the timestamp cannot be determined, the result will be empty. The format of the returned string is YYYYMMDDHHMMSS.
JOB_TOTAL
[RO] This variable returns the number of items in the job. For jobs which are launched over an extended period (e.g. FFMERGE jobs) the value is the job size estimate, if available. For 'open' jobs, the value returned is zero. The variable may be used after a job has been selected using IVR, or during the job processing, for example on the cover sheet for job status notification.
JOBACTION
[WO] You may assign a value to this variable to specify a job action value after the job selection phase of an IVR session. For details of job action codes, see Job Status/Actions.
JOBINST
[WO] You may assign a value to this variable to specify the job instance during the job selection phase of an IVR session. Assignment to this variable causes the system to skip the prompt for a job instance number. The value assigned must be a number of up to the number of digits allowed.
JOBLIST_FILENAME
[RO] The filename (without file extension) of the list from which the job item originated. This value is set in each FS file at job launch.
JOBLIST_PATHNAME
[RO] The full pathname of the list from which the job item originated. This value is set in each FS file at job launch.
JOBLISTS
[WO] You may assign a value to this variable to specify the job broadcast list(s) after the job creation phase of an IVR session. The value is a string of 0s and 1s representing lists to be not used and used respectively. If you use 2s instead of 1s, the caller will still be prompted for additional list numbers, and list numbers already marked with 2 will be deleted from the string (replaced by 0) if selected by the caller. Assigning an empty value (@EMPTY) will pre-select all lists. Assignment to this variable is ignored if no job instance has been created or selected at the time.
JOBNEWOLD
[WO] You may assign a value to this variable before the job selection phase of an IVR session to specify whether the session is to create a new job or work with an existing job. A value of 0 selects creation of a new job and a value of 1 selects working with an existing job. Add 2 to either of these values to skip all prompts (for autodialler entry). Assignment to this variable causes the system to skip the prompt for 'new or existing job'.
JOBOWNER
[WO] You may assign a value to this variable to specify the job owner during the job selection phase of an IVR session. Assignment to this variable causes the system to skip the prompt for a job owner. The value assigned must be a valid directory name. Leading zeros for numeric values need not be specified.
JOBOWNER_CODE
[RO] This variable returns the directory (folder) name for the Job Owner (under the USERJOBS folder). It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are removed.
JOBOWNER_FOLDER
[RO] This variable returns the directory (folder) name for the Job Owner (under the USERJOBS folder). It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are not removed.
JOBOWNER_NAME
[RO] This variable returns the full name of the Job Owner. It can be used during the job processing, for example on a cover sheet.
JOBOWNER_PASSWORD
[WO] Assignment to this variable allows the password of the current Job Owner to be changed. If the password is to be entered using IVR, it must contain only numeric digits.
JOBOWNER_PATH
[RO] This variable contains the full pathname of the current Job Owner properties file. It is only available at Job IVR time, not at the time a broadcast is being processed.
JOBOWNER_VOXFILE
[RO] This variable returns the full pathname of the voicefile describing the Job Owner. It can be used during the job IVR processing to play a confirmation message to the caller.
JOBTYPE
[WO] You may assign a value to this variable to specify the job type during the job selection phase of an IVR session. Assignment to this variable causes the system to skip the prompt for a job type. The value assigned must be a valid directory name. Leading zeros for numeric values need not be specified.
JOBTYPE_CODE
[RO] This variable returns the directory (folder) name for the Job Type, under the applicable owner folder. It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are removed.
JOBTYPE_FOLDER
[RO] This variable returns the directory (folder) name for the Job Type, under the applicable owner folder. It can be used during the job processing, for example on a cover sheet. Leading zeros in the folder name are not removed.
JOBTYPE_NAME
[RO] This variable returns the full name of the Job Type. It can be used during the job processing, for example on a cover sheet.
JOBTYPE_PATH
[RO] This variable contains the full pathname of the current Job Type properties file. It is only available at Job IVR time, not at the time a broadcast is being processed.
JOBTYPE_VOXFILE
[RO] This variable returns the full pathname of the voicefile describing the Job Type. It can be used during the job IVR processing to play a confirmation message to the caller.
KEEP_GCV
[RW] When set to a non-empty value other than NO, causes the graphical cover sheet created for an individual fax to be retained. The filename is formed from the FS file basename, with '_F00' added for a cover sheet, and '_F01' and upwards for any GCT or GTT files named on $fax_filename commands. The CALLBACK\TEMP folder is the default folder for these files, but the owner\TEMP folder is used for Job Admin items. The special value of NO assigned to this variable overrides the 'Keep Graphical Cover' global run-time option.
KEEPID
[RW] Any value which is assigned to this variable will be loaded into CALLERID after subsequent change of user profile using the DIDNO variable described above. To avoid the caller having to re-enter a password after switching user profiles, you can first assign @CALLERID to KEEPID and CopiaFacts will restore it after the profile change, thus suppressing the password request. This variable is retained for backward compatibility even though all variables are now retained through a change of DIDNO.
KILL_GROUP_ACTION
[WO] A pathname assigned to this variable specifies the action to be taken when a $kill_group is triggered. If the filename assigned has extension .FS, the file will be moved to the TOSEND folder. If the extension is CMD, BAT or EXE, the command will be executed, passing a single parameter of the nodename on which the problem was detected.
KILL_NOWAIT
[WO] Any value assigned to this variable will cause a running NOWAIT process started by a $run command to be killed. No action is taken if there is no running process of this type.
LASTERROR
[RO] Contains the last error number encountered (see COPIAFACTS Program Error Messages). If there has been no error on this call, the number will be zero. The value is not reset when a particular operation is processed without error.
LAST_RECORDFILE
[RO] Records the full pathname of the file containing the last recording made, when the file has been selected using the $record_nextmsg command.
LAST_RECORDING
[RO] Records the message number of the file containing the last recording made, when the file has been selected using the $record_nextmsg command.
LC_DETECT
[WO] On Brooktrout boards which support this capability, turns off or on, with a value of 0 or 1 respectively, the loop-current (hangup) detection on the channel.
LINE
[RO] Contains the line number, of the current request at request time or from $fax_rcv_line at transmit time.
LINK_INTRO
[WO] Can be set to the full pathname of a voice file which is to be played to the called party before an SC-Bus linked call is connected. This overrides the standard voice prompt 88 which is played at this time if present.
LINK_LNUM
[RO] Contains the line number of the line on which the outbound part of an SC-Bus linked call is placed.
LINK_DTMF_RECORD
[WO] Operates exactly as LINK_RECORD except that the recording is not started until the first or only key or key-pair specified in $allow_interrupt is detected during the link. In this case the DTMF detection does not of course break the link.
LINK_RECORD
[WO] Can be set to the full pathname of a voice file which will be used to make a recording of both sides of an SC-Bus linked call. This value must be assigned before the call is set up, but the $set_var command can be placed in the $type transfer infobox.
LINK_STATUS
[RO] Contains the status of an SC-Bus link:
0
no link
1
dial without call progress
2
dial with call progress
3
waiting for link
4
outbound call failed
5
outbound call hung up
6
timeout on link
7
DTMF detected
8
link active
LINK_TERM
[RO] A value indicating the reason for termination of an SC-Bus link:
0
no link terminated
1
link timed out
2
this line hung up
3
other line hung up
4
this line terminated the link with DTMF
5
other line terminated the link with DTMF
Although this variable is set for both halves of a linked call, it is not accessible on the outbound side because the 'line' is not it a state where infobox operations can be performed. Note that LINK_STATUS will usually be zero at the end of a call, so LINK_TERM is needed to record the cause of termination.
LINK_WRAP_D
[WO] Can be set to the full pathname of a voice file which will be played on the outbound half of the call after the link is terminated by a DTMF key on the inbound half. This overrides the standard voice prompt 91 which is played at this time if present, An empty assignment suppresses the message even if the standard prompt is present. The line is hung up after the message has been played.
LINK_WRAP_H
[WO] Can be set to the full pathname of a voice file which will be played on the outbound half of the call after the link is terminated by a hangup on the inbound half. This overrides the standard voice prompt 90 which is played at this time if present, An empty assignment suppresses the message even if the standard prompt is present. The line is hung up after the message has been played.
LINK_WRAP_T
[WO] Can be set to the full pathname of a voice file which will be played on the outbound half of the call after the link is terminated by timeout. This overrides the standard voice prompt 89 which is played at this time if present, An empty assignment suppresses the message even if the standard prompt is present. The line is hung up after the message has been played.
LNUM
[RO] Contains the number of the current line processing the call.
LOCAL_CSID
[RO] Contains the actual local CSID used for an outbound fax, after expansion of variables. The contents are only established at the start of a fax transmission, and the variable is intended for use on a $fax_header command.
LOOPEXIT
[RW] Contains the reason code for transfer to the LOOPEXIT infobox, if enabled. Can be set to the return action code required during your LOOPEXIT processing. See $loop_exit.
MAX_BAUD
[WO] A value (a valid multiple of 2400) assigned to this variable will limit the baud rate for the current fax outbound call. It overrides the $baud_max command in the CFG or USR file and has the same hardware limitations.
MAX_PROOFS
[WO] A higher value can be assigned to this variable to override the default value of 20. This limit is provided to prevent excessive proofs being attempted in automated Job Admin applications. The override allows further proofs to be attempted after the situation has been checked.
MAXSIL
[WO] Can be set to a value (seconds or milliseconds depending on the TIME_MS variable setting) of between 0 and 20 seconds inclusive to control the silence time which will terminate a voice recording. The default value is 5 seconds. This parameter can be used to reduce the wait at the end of a recording in countries where touch-tone signals cannot be used to cause a recording to stop. The value set remains in effect until the end of the call unless overridden by a further assignment.
MIN_BAUD
[WO] A value (a valid multiple of 2400) assigned to this variable will limit the baud rate for the current fax outbound call. It overrides the $baud_min command in the CFG or USR file and has the same hardware limitations.
MEMOx
[RW] These 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 @MEMOx are processed specially, and only an exact match is expanded. Thus if you have defined MEMO3 in an FS file, but have not defined MEMO30, then writing @MEMO30 in a cover sheet template file will not cause the value of MEMO3 followed by a zero to be expanded. This feature allows you to include a large number of @MEMOx expansions in a cover sheet template file, and have them correctly expand to blank if a smaller number of $var_def MEMOx commands have been created in the FS file by either FFWin or another FS file generation program.
MOVETARGET
[WO] Assigning a directory or path name to this variable will cause it to become the destination of a subsequent assignment to the MOVETHISFILE system variable. No checking takes place until the MOVETHISFILE assignment. The target persists for the current call only.
MOVETHISFILE
[WO] Assigning a full pathname to this variable will cause it to be moved (renamed) to the directory or filename currently specified as the contents of the MOVETARGET system variable. If the destination is a directory the file name will be unchanged. Any existing file with the name of the destination file will be deleted. If the move cannot be made, no error indication is made. Use this variable with care!
MPT_RECEIVE
[WO] Assigning a value of 'N' or '0' to this variable will disable multi-page TIF receive for a fax received later in the call. A value of 'Y' (or any other value) will enable multi-page TIF receive.
MSMQ_PREPROC_PRI
[WO] A string of exactly nine numeric digits in the range 0 to 6 may be assigned to this variable in a UJP $var_def statement to override the default transformation of CopiaFacts priority values (TOSEND folder numbers) to MSMQ priorities in the queues defined by $preproc_qname and $preproc_altqname. The first digit specifies the MSMQ priority to correspond to TOSEND1, and so on up to the ninth digit which specifies the MSMQ priority to correspond to TOSEND9. When this variable is not used, the standard transformation corresponds to "654321000". The MSMQ priority for items destined for the TOSEND folder is 7; this cannot be overridden, and nor can the digit 7 be used in the supplied value.
NEXT_CHAIN
[RO] Returns the text value of the next destination which will be selected by a $chain command. Normally this will be an infobox name, but if there is no chain, or when the chain is at an end, the end chain state or destination will be returned instead. 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.
NOWAIT_ACTIVE
[RO] Returns a non-empty value (the numeric exit code) if an external program which has been run asynchronously using $run has already terminated. The variable is set to empty when the external program is started.
NO_LIST_GROUP
[WO] Assigning a non-empty value to this variable suppresses the feature where a job list filename starting with the string 'GROUP' is treated as being an ASCII list of list pathnames.
NO_SPACE_DELIMITER
[WO] Assigning a non-empty value to this variable in a job properties file will cause spaces not to be treated as delimiters in comma-separated-value (CSV) files used as Job Admin broadcast lists.
NO_XLS_EMPTY_COL_CHECK
[WO] Assigning a non-empty value to this variable suppresses the check on XLS files loaded using the USE_EXCEL option to ensure that the first column is not empty. This condition can cause BCF field numbers to be assigned incorrectly.
NODEID
[RO] Contains the node ID from the COPIAFACTS program options screen. It is possible, though not recommended, to use @NODEID in the CopiaFacts configuration file in order to define different configuration blocks for each node. If you do this, do not attempt to redefine any of the common folders such as $request_dir, $log_def etc. in conditional blocks. CopiaFacts does not currently prevent this happening and the results are unpredictable.
NQ_PIPE2TAB
[WO] Assignment of a non-empty value to this variable will cause all occurrences of the pipe symbol (|) in the configuration file NQL_... and NQM_... variable definitions (see below) to be changed to tab characters. This makes it easier for the application which reads the messages to handle values in the notify string which contain embedded pipe symbols. Tab characters cannot be used in the defined string itself because they do not survive CopiaFacts command parsing. The NQ_PIPE2TAB variable must be defined in a configuration file $var_def command which precedes the commands it is intended to affect.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when an email has been attempted and is then scheduled for retry. The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when an email is complete (sent or failed). The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when a fax has been attempted and is then scheduled for retry. The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when a fax is complete (sent or failed). The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when an SMS has been attempted and is then scheduled for retry. The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when an SMS is complete (submitted or failed). The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when a voice outbound operation has been attempted and is then scheduled for retry. The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
[RW] These variables control the content of messages written to the notify queue defined by $notify_qname when a voice outbound operation is complete (submitted or failed). The NQL value defines the label, the NQM_ value the message body, and the NQOK variable is set to a value of 'OK' if the queue operation succeeds. All outcome variables (OC_...) and any custom variables are available to be included in the message content.
OB_ANI
[WO] Set to override the number recorded as the originating phone for an outbound call. This variable can be set in an IVR session in advance of making a connected outbound call on another SC-Bus channel. It can also be set in an FS file (with $var_def) to affect the ANI for a single call. A special code of X can be used to suppress the ANI, when supported, and a code of 'none' can be used to override the value set as $outbound_ani in the USR or UJP file and instead use the normal phone number as the ANI. Your telephone company may ignore the value set by this variable. PRI boards only. If you are about to transfer a call using either the Dialogic SC-Bus or the Dialogic Diva line interconnect feature, the value will be applied on the outbound call. For Commetrex Bladeware this value is ignored: see the comment in the$outbound_ani topic. For Dialogic Diva, the X may be followed by a number which will be inserted as the calling number but coded as restricted.
OB_CALLSECONDS
[RW] Returns the time in seconds since the start of an outbound call, for use in postprocessing operations. Assigning any value to this variable resets it to zero.
OB_CONNSECONDS
[RW] Returns the time in seconds since the connection of an outbound call, for use in postprocessing operations. Assigning any value to this variable resets it to zero.
OC_...
These 'outcome' variables contain data about the transmission at the end of an outbound call. All except those beginning 'OC_A...' refer to a specific attempt number, which you can set in OC_INDEX. The OC_INDEX variable is initialised to the number of the final attempt (the same value as OC_ACOUNT).
OC_ACALLTIME
[RO] The aggregate call time in seconds for all attempts. For e-mail attempts, one decimal place of seconds is shown, and the time includes DNS/MX lookup and SMTP transmission time.
OC_ACLASS
[RO] A string containing all outcome class letters for all attempts.
OC_ACONNTIME
[RO] The aggregate connect time in seconds for all attempts. For e-mail attempts, one decimal place of seconds is shown, and the time reflects the SMTP transmit time only.
OC_ACOUNT
[RO] The total number of transmission attempts.
OC_APAGES
[RO] The aggregate number of pages sent in all attempts.
OC_BAUD
[RO] The baud rate of the attempt.
OC_BLINE
[RO] The board-type identifier letter and the line number used for the attempt. For the current board-type letters, see $attempt_record.
OC_CALLTIME
[RO] The call time in seconds for the attempt. For e-mail attempts, one decimal place of seconds is shown, and the time includes DNS/MX lookup and SMTP transmission time.
OC_CLASS
[RO] The outcome class letter of the attempt. The value will be a letter A to H, S or Z. If the special $log_options keyword 'atthistz' is not given, a lowercase letter indicates that the attempt was the final one.
OC_CLDESC
[RO] The text description of the outcome class of the attempt.
OC_CODE
[RO] The numeric outcome code of the attempt.
OC_CONNTIME
[RO] The connect time in seconds of the attempt. For e-mail attempts, one decimal place of seconds is shown, and the time reflects the SMTP transmit time only.
OC_CSID
[RO] The answerback code for the attempt. For e-mail transmissions. the domain name of the mail server used.
OC_DATE
[RO] The date at the start of the attempt (MM/DD/YYYY).
OC_DESC
[RO] The text description of the outcome code of the attempt.
OC_INDEX
[RW] The index (from 1 to OC_ACOUNT inclusive) of the attempt to be reported by OC_... variables. Initialised to the value in OC_ACOUNT.
OC_FINAL
[RO] The value is 1 if no further attempts were scheduled after this attempt, 0 otherwise.
OC_MANUAL
[RO] Returns an empty value if the transaction has not been manually resubmitted. Returns 'YES' if the transaction has been manually resubmitted (indicating more than one success and/or final failure in the attempt history). Returns 'THIS' if the attempt is the first after a manual resubmission.
OC_MXREC
[RO] The name of the MX record used for e-mail transmission
OC_NEXTDATE, OC_NEXTTIME [RO] return the date and time of the next attempt, if one has been scheduled.
OC_SCHEDPAGES
[RO] The number of pages scheduled for the attempt.
OC_SDATE
[RO] The date at the start of the attempt (system short date format).
OC_SENTPAGES
[RO] The number of pages sent in the attempt.
OC_TIME
[RO] The clock-time at the start of the attempt (HH:MM:SS).
ONECALL_...
[RO] These 'onecall' variables contain data about the fax sent in a one-call fax on demand transmission. They can only be used in an infobox reached after trapping states END_FAX or ABORT_FAX.
ONECALL_FAXCSID
[RO] The CSID (answerback) of the remote fax machine.
ONECALL_FAXNSF
[RO] The NSF data from the remote fax machine.
ONECALL_FAXPAGES
[RO] The number of pages sent.
ONECALL_FAXSTAT
[RO] The fax error code (or 0 for successfully transmitted fax).
ONECALLOK
[RO] Contains Y or N, depending on whether onecall is possible for this call. See also REQUESTOK.
OPSYS
[RO] Contains a string representing the operating system. Currently always returns "WINNT".
OTF_
These variables are used to supply specific parameters for the Bladeware SIP implementation:
OTF_RECEIVE_ANSWER_MEDIA (inbound calls)
OTF_RECEIVE_OFFER_MEDIA (inbound calls)
OTF_RED_DATAFRAMECOUNT Redundancy data frame count
OTF_RED_SIGNALFRAMECOUNT Signal data frame count
OTF_SEND_ANSWER_MEDIA (outbound calls)
OTF_SEND_OFFER_MEDIA (outbound calls)
OUTCOME_VALUE
[RO] Contains the internal code which directs processing of an outbound call outcome: 0 for a successful transmission, -1 for final failure, or a positive number of seconds representing the scheduled delay to the next attempt. This value may be accessed for special purposes in an infoboxall postprocess or after trapping a suitable state. If accessed before the outcome has been determined, the value returned will be @EMPTY.
OWNER
[RO] Contains the owner mailbox owner name from $owner_name.
PAGES
[RO] At request time, contains the total number of pages in the documents so far selected. This value is the same as that in @REQUESTS.
PAUSE_TIME
[WO] This variable controls pausing the line for a short time. A value (seconds or milliseconds depending on the TIME_MS variable setting) may be assigned, and will cause a delay after the current infobox has been completely processed.
PFC
[RO] Expands to the name of the Program Files\Copia folder (without trailing backslash).
PHONE_ACCOUNT
[WO] This variable can be set to up to two telephone account codes (white-space separated if more than one) which are substituted for @ sign(s) in a telephone dial string. This variable overrides the value(s) given on the $phone_account command. If the first of two values is "SIP:" then the expansion of any @ signs in the second value is suppressed.
PHONE_MIN, PHONE_MAX
[RW] These variables can be set with the phone number minimum and maximum length. Values from 1 to the maximum phone number length accepted by the fax board or voice board dialer are valid.
PLAYLENGTH
[RO] Contains the approximate total length of the last voice message file which was played. The value is in seconds unless the TIME_MS system variable has been enabled, in which case it is in milliseconds.
PLAYSTART
[WO] Used to set an approximate start position in the next voice message to be played. The value specified is discarded after the play operation, even if the message is skipped because of user key-ahead. Negative values are treated as zero and cause the file to be played from the start. Values greater than the file size cause the message to be skipped. The value is in seconds unless the TIME_MS system variable has been enabled, in which case it is in milliseconds.
PLAYSTOP
[RO] Contains the approximate position in the file at which the playing of the last voice message file finished or was interrupted. When the file was not started from the beginning this value is not the same as the number of seconds for which the file was actually played. If the message was not interrupted, the value will equal PLAYLENGTH. If the message was skipped, the value will equal that which was originally set in PLAYSTART, or will be zero if PLAYSTART was not used. The value is in seconds unless the TIME_MS system variable has been enabled, in which case it is in milliseconds.
POLLING
[RW] Contains values 0, 1 or 2 to indicate no polling, always expect polling, and automatic poll detection respectively. You can use this variable either to determine the mode currently in effect, or to set the mode. Setting a value other than 0, 1 or 2 reverts to the default mode for the line defined in the configuration file.
POST_DELAY
[WO] A positive value in minutes can be assigned to this variable during infobox or infoboxall post-processing, which will then cause the item to be set for retry after the specified delay time. The value is ignored if the FS file is already set for retry. Currently, this variable cannot be used (and is ignored) in conjunction with Job Administration.
POSTPROC_FAIL
[WO] A non-empty value assigned to this variable in an infobox or infoboxall post-process will cause the FS to be failed, even if already set for either success or retry. The outcome code 82 will be used for this failure. Currently, this variable cannot be used (and is ignored) in conjunction with Job Administration.
PR_...
[RO] These 'post-receive' variables contain data about the fax received and can be used in 'INFOBOX' post-receive processing. Note that the variables involving a filename will be empty if no received fax file is present (or if it has been moved from the location into which it was received).
PR_FAXCSID
[RO] The CSID (answerback) of the remote fax machine.
PR_FAXFILE
[RO] The filename part of the received fax file (e.g. 00012345.TIF).
PR_FAXFORMAT
[RO] The image type of the received fax, currently either 59 (TIF) or 93 (IPK containing color JPEG).
PR_FAXNSF
[RO] The NSF data from the remote fax machine.
PR_FAXPAGES
[RO] The number of pages received.
PR_FAXPATH
[RO] The full pathname of the received fax file.
PR_FAXPDF
[RO] The same value as in PR_FAXFILE, but with extension changed to PDF. This can be used in a name= clause in the content-type of an $email_attach command, so that the e-mail recipient sees a file which has the same name as the original MCF and TIF in a fax-to-email application. See also the $type fsfile examples.
PR_FAXSTAT
[RO] The fax error code (or 0 for successfully received fax).
PR_MAILBOX
[RO] The fax mailbox number (without leading zeros) of the mailbox that received the fax. To obtain a number with leading zeros, use $set_var ZBOX @PR_MAILBOX 0 8
PREPARE_FAX
[WO] Assign a value of 1, 2, or 3 to this variable to control whether the preparation of a fax transmission is done before dialling (1), after dialling, while waiting for a connect (2), or after the connection has been made (3). The variable currently only affects Dialogic Diva transmissions, and for these the default value is 2. All other boards are operated as if the value was 3. The 'preparation' operation includes Graphical Customization tasks, conversion of resolution, checking and building the transmission list, and copying files to a local folder if Fax Local Copy is enabled in COPIAFACTS options.
PREVIEW_FORMAT
[WO] Assign a value containing one or more of the keywords PDFV, PDF, A4, PNG, JPG or GIF to create a job preview in the corresponding format (one page per file) in addition to the TIF format. The A4 keyword sets the document size for PDF format (default US letter). The PDFV format (US letter or A4) sets the PDF height to match the the TIF height.
PRINTTHISFILE
[WO] Assigning a pathname to this system variable causes the fax file to be printed on the default printer, or, if set, the printer specified by USETHISPRINTER. Only faxable TIFF and JT-Fax format files can be printed. Assigning the name of an FS file or MCF file will print the associated fax file(s). This feature uses the FXPRINT.DLL file, which must be available.
PROBLEM_DONE
[RW] This variable contains a value '1' if the PROBLEM_CALL state has been visited in the current call after failure to detect an IVR response. You can also assign a value of 0 or 1 to this variable to override its value. This variable can be used to avoid looping when your IVR logic makes further attempts to obtain a response after problem call state has been visited.
RCVRFAX
[RW] After using $caller_id to look up the caller's fax number, or after the caller has entered his fax number in response to standard voice prompt 21, this variable will contain the fax number to be used. You can also set this variable to the caller's fax number when $fax_phone_last is in operation and you determine the information (and perhaps also the caller's routing information) using custom question-box processing. Setting this variable will then prevent CopiaFacts asking for the information at the end of the call. See also RFAX_FORMAT1 and RFAX_FORMAT2 for formatted versions of NANP numbers. Assignments to this variable are validated against exclusion phone masks in the USR file and global exclusions in the CFG file, as well as the DNS.NDX file, so this variable should not be used in normal IVR operations where such validation is inappropriate.
RECEIVE_FAX
[WO] You can assign a full pathname to this variable to specify the filename to receive a faxed-in document. After setting this variable you should use $next_box to transfer to state 148 (START_FAX_RMT) so that the caller is prompted to transmit the documents. CopiaFacts will hang up the line after receiving the document (unless you trap HANGUP with $set_state). No post-receive processing is performed.
RECORD_BUFFER
[WO] You can assign a numeric value to this variable to allocate a recording buffer of the specified size for the next voice record operation. The buffer will be used for recording operations for the remainder of the call or until you assign a value of 0 to this variable. The buffer may be passed to a DLL (for example in speech recognition applications) by assigning the special value (with no @) 'RECORD_BUFFER' to the DLL_PARM system variable. This passes the buffer, not the size you allocated to the variable. This variable is currently implemented for Dialogic and Dialogic Diva voice boards and for Brooktrout TR1034. The RECORDING_FORMAT should be set to a non-wave format when recording into a memory buffer.
RECORD_TERM
[RO] This variable will contain one of the keywords DTMF or HANGUP after the $error_exit has been taken during a recording operation in a $type record infobox. This determines the reason for the termination of the recording operation. The value of the variable at other times is indeterminate.
RECORD_TRCOUNT
[RO] This variable contains the number of bytes transferred in the immediately preceding voice record operation. It has a value of 0 if the most recent voice operation was not a record operation. The value is also 0 until an asynchronous record operation is complete.
RECORDING_FORMAT
[WO] This variable may be assigned as a value one of the voice formats allowed for the voice_format command. It remains in effect for the remainder of the call or until set again.
REDIR_NUMBER
[RO] This variable contains the phone number of a redirecting switch if a PRI call has been forwarded to the CopiaFacts system.
REQUESTOK
[RO] Contains Y or N, depending on whether request and callback is possible for this call. See also ONECALLOK.
REQUESTS
[RO] At request time, contains the total number of pages in the documents so far selected. This value is the same as that in @PAGES.
REQUIRED_BCX_FIELDS
[WO] Assigning a comma-separated list of field names (with no embedded blank space) to this variable adds these names to the list of field names which must be present to ensure a successful launch. This guards against the accidental use of a list without a header row in a job instance which uses the WordMerge or OmitListHeaders keywords for $job_options. Without this variable, the launch fails if any fields named in a WordMerge document are absent, or if the field named in the BCX variable on a $fax_phone, $voice_phone, $poll_phone or $email_address job template command is absent.
RFAX_FORMAT1, RFAX_FORMAT2
[RO] return the same phone number as RCVRFAX but formatted as "(630) 388-6902" and "630-388-6901" respectively. If the number is neither a ten-digit number nor an eleven-digit number starting '1', the value returned will be the same as RCVRFAX.
ROUTETO
[RW] After using $caller_id to look up the caller's name or routing information, or after the caller has entered his routing information in response to standard voice prompt 19, this variable will contain the routing data to be used. You can also set this variable to the routing data value $fax_phone_last is in operation and you determine the information (and perhaps also the caller's fax phone number) using custom question-box processing. Setting this variable will then prevent CopiaFacts asking for the information at the end of the call.
ROUTETO_MIN, ROUTETO_MAX [RW] These variables can be set with the route-to number minimum and maximum length. Values from 1 to the maximum phone number length accepted by the fax board or voice board dialer are valid.
RUN_VALUE
[RO] Set to the last value returned by the RUNVALUE program for the call. The value will be empty if RUNVALUE has not been executed during the call. This value should not be tested in the same infobox as the $run command that causes it to be set. You can also return a value from any program you have developed using the same method as RUNVALUE to do this. See the RUNVALUE topic for more information.
RXBAUD
[U] Set after a fax receive operation is complete, this value contains the baud rate used. The value is 0 if no fax receive started.
SAME_LINE
[WO] Set to a value of Y or N, this value controls whether a fax-on-demand callback must be made on the same line as the request.
SCAN_FS
[WO] A value of 1 assigned to this variable causes the FS scan to be restarted immediately for the node, even if the timeout period following a scan which found no FS files has not yet elapsed.
SELF_BUSY
[WO] This variable, when set to "enable" or "disable" will override the CopiaFacts 'self-busy' check. The self-busy check, when enabled, prevents more than one channel sending a fax to the same fax number at the same time. The default is to enable this option unless the 'No Self Busy Check' option is set in COPIAFACTS options. The variable may only be set in the FS file, not the USR, because the phone number will normally be checked before the user profile referenced in the FS file is processed. To make a setting for a whole broadcast, it may placed in an FS template file (FST) or in the template items of a job properties file, both of which cause a $var_def command to be copied into all FS files for the job.
SELFBUSY_COUNT
[RO] This variable will be added and set to "1" in an FS file which is delayed because another line is transmitting to the same fax phone number. The variable is incremented if the FS file is delayed multiple times.
SEND_ALERTING
[WO] Assigning a non-empty value to this variable causes an alerting message to be sent on a PRI-ISDN line (currently Dialogic or Dialogic Diva only). The assignment should normally be made from the call control DLL if you decide not to reject the call. It is only necessary when your FFDLLinit function in the call control DLL returns a 1 to indicate that an alerting message should not be sent before the FFCallNotify function is called in your DLL.
SENDER
[RO] At transmit time, contains the sender name from $fax_sender. If this command is not present, the variable returns the same as @COMPANY.
SF_DATE_FORMAT
[WO] This variable may be assigned a value to specify the date format to be used in output from the Application Support DLL. This overrides the default which is the system short date format.
SF_DATETIME_PARM
[WO] This variable may be assigned a value to specify the date and time format to be used for input to the Application Support DLL. The value can be USA or LOCAL. Note that the USA format is always used on CopiaFacts commands which take date and time parameters.
SF_TIME_FORMAT
[WO] This variable may be assigned a value to specify the time format to be used in output from the Application Support DLL. This overrides the default which is the system short time format.
SHUT_DOWN
[WO] Assigning 'CONTROLLED' or 'IMMEDIATE' to this variable will start a shutdown of the CopiaFacts engine. Other assigned values have no effect.
SINGLE_EMAIL_CT
[WO] Specifies the content type for an e-mail transmission which uses the $job_options keyword SingleEmailDoc. Typically this would be used to assign a value such as: "application/PDF; name=""special.pdf"""
SMALL_JOB_PRIORITY
[WO] specifies the launch priority to be applied to fax items in 'small' jobs as defined by SMALL_JOB_THRESHOLD. If the value of the variable is specified as 'TOSENDx' (with x in the range 1 to 9) this absolute priority will be used. If the value of the variable is specified as a single numeric digit from 0 to 8, this value will be subtracted from the assigned $priority or EMAIL_PRIORITY respectively number to boost the priority by the given amount. The priority cannot be boosted to be higher than TOSEND1 by this means and a higher boost value will be reduced automatically.
SMALL_JOB_EMAIL_PRIORITY
[WO] specifies the launch priority to be applied to e-mail items in 'small' jobs as defined by SMALL_JOB_THRESHOLD. If the value of the variable is specified as 'TOSENDx' (with x in the range 1 to 9) this absolute priority will be used. If the value of the variable is specified as a single numeric digit from 0 to 8, this value will be subtracted from the assigned $priority or EMAIL_PRIORITY respectively number to boost the priority by the given amount. The priority cannot be boosted to be higher than TOSEND1 by this means and a higher boost value will be reduced automatically. If EMAIL_PRIORITY is not assigned, SMALL_JOB_EMAIL_PRIORITY will be ignored.
SMALL_JOB_THRESHOLD
[WO] specifies the number of items above which a job will not be considered a small job for the purposes of the SMALL_JOB_PRIORITY and SMALL_JOB_EMAIL_PRIORITY variables. The default is zero, so that no job is considered 'small'.
SMENCRYPT_ALGORITHM
[WO] Specifies the algorithm to be used to S/MIME-encrypt an e-mail message. Values are DES_56, 3DES_168, RC2_128, RC4_40, RC4_128, AES_128, AES_192 and AES_256. DES_56 is the default, and will be used if any value other than those listed is specified.
SMSIGN_ALGORITHM
[WO] Specifies the algorithm to be used to S/MIME-sign an e-mail message. Values are MD5 and SHA1. The latter is the default, and will be used if any value other than MD5 is specified.
SNDRFAX
[RO] Contains the phone number from FAXCOUNT.HWL for the current line.
SMS_DELIVERY_OUTCOME
[RW] Contains one of the strings PENDING, SUCCESS or FAILURE. The first indicates that a pending SMS item is to be queried with the SMS provider to determine delivery outcome. The other two values are set when the delivery outcome has been obtained. Absence of this variable indicates that the SMS item is still to be submitted for delivery.
SMS_MSGID
[RW] Contains the message ID returned by an SMS provider when a message is accepted for delivery.
SMS_SERVICE
[RW] Contains a single internal service name, or a comma-separated list of service names, to select the service to which an SMS item is to be submitted or to which a delivery outcome request is to be addressed.
SPAGES
[RO] For a special "retry cover sheet", this variable indicates the number of pages scheduled for this retry. See the example retry cover sheet for more information. When a partial retry is not used, this variable has the same value as TPAGES.
SPEED
[WO] Set the playback speed for the remainder of the call or until a new assignment is made. The assigned value is added to the value set by the $speed command, if any, and the result set to the nearest point in the range -5 to 5. A value of -5 represents a reduction of 50% in the standard speed, and 5 represents an increase of 50%. The speed is changed without altering the pitch.
STRIP_MERGE_FIELDNAME_CHARS [WO] Specifies the characters (default: "<>#") which are to be stripped from header field names to ensure a match in WordMerge operations.
STRIP_MERGE_DATA_CHARS [WO] Specifies the characters (default: none) which are to be stripped from data fields in WordMerge operations. Some characters which are valid in Excel columns may cause problems when written to the temporary tab-separated-data file for each WordMerge recipient. This setting affects data written into BCFx variables during a WordMerge job launch.
STRIP_TOP
[WO] This variable is designed for use in a post-receive infobox to strip the fax header line from an incoming fax. It affects F7GCOVER image conversions only (e.g. fax to pdf), not GCT or GTT processing. The value represents the number of fine-resolution scan lines (at 198 per inch) to be stripped. The presence of this variable in a post-receive infobox sequence will also cause TIF files to be processed through F7GCOVER even if the Content-Type is specified as 'image/tif'.
SUPPRESS_FAX
[RW] This variable can be set to a non-empty value in an infobox pre-process sequence for a fax item. If set, the item will not be transmitted but will be treated as if a successful transmission attempt had been made.
SWITCHFROM
[RO] Returns the state number of the last state which was successfully trapped using a $set_state command. A value of -1 is returned if no switch has occurred. The value is set to -1 after the variable value is retrieved.
TCOST
[RO] At request time, this variable contains the current total cost of selected items. At transmit time, it contains the total cost of items to be transmitted.
TIME_MS
[WO] If set to 'Yes' (or any value other than one starting with 'N' or 'n') then times on the PLAY_LENGTH, PLAY_START and PLAY_STOP variables will be milliseconds instead of seconds. This setting also affects the max parameter on $get_var when used to specify the time for silence validation, and the value of MAXSIL and $record_limit. The setting lasts for the remainder of the call unless this variable is assigned to again.
TIME_OFFSET
[WO] A value in hours may be assigned to this variable to modify the date and time returned by the DATE0 to DATE9 and TIME1 to TIME4 variables by adding the specified number of hours (or subtracting if the number specified is negative). This allows time values in fax headers to reflect a different time zone. The number of hours offset must be 48 or less. The offset only affects a single call, and the DATEL and DATES (system date/time formats) are not affected. A suffix of 'M' after the value indicates that it is minutes, not hours, to allow its use for countries where the time zone offset from UTC is not a whole number of hours.
[WO] A number between 1 and 9 may be assigned to this variable to select one of the additional TOSENDx directories specified in the $request_dir command. The number assigned to TOSEND must be less than or equal to the count value on this command, or may be zero to revert to the standard TOSEND directory. Specifying the TOSEND directory during a 'request' call determines which directory the FS file will be written to. In a normal 'onecall' transaction it has no effect. This feature allows you to optionally delay callbacks based on caller response. For example you can assign 9 to TOSEND and then use the TOSEND9 environment variable to specify that files in TOSEND9 are only actioned during nighttime hours.
TOTAL_RECEIVED
[RO] Contains the number of transmissions received in a mailbox, at the time of infobox post-receive processing.
TPAGES
[RO] At transmit time, contains the number of pages to be sent, including the cover sheet, if any.
TRACE_EMAIL
[WO] A string value assigned to this variable will be copied to FFTRACE (if it is running) during e-mail operations. This only happens if F7EMAIL is selected for trace collection in FFTRACE or if the debug keyword is given in $email_options. This can be helpful to identify specific transactions in the trace.
TRACE_LINE
[WO] A string value assigned to this variable will be copied to the engine trace file nodename.TRx. This only happens if Trace to File is selected, but no other trace or debug flags need be specified. This can be helpful if you are debugging complex infobox sequences.
TXBAUD
[U] Set after a fax transmit operation is complete, this value contains the baud rate used. The value is 0 if no fax transmission started.
TXDATE, TXEND
[U] These values are written as user variables into the FS file after each transmission attempt. They contain respectively the date (MM/DD/YYYY) and the time (HH:MM:SS) of the end of the transmission.
USE_ALT_PREPROC_QUEUE
[WO] Assigning a non-empty value to this variable in and instance UJP causes the alternate preprocess queue to be used when job items are launched direct to PREPROC.
USE_EXCEL
[WO] Assigning a non-empty value to this variable causes an XLS broadcast list to be read (in Job Administration only, for FFBC see the USE_EXCEL environment variable) by automating Excel. The default is to read the XLS file directly. It is possible that very complex macro expansions in the list fields may not expand correctly unless Excel is used, and this variable must also be used to implement support for Excel 95 or earlier files. Excel 2000 or later is required. This variable need not be set for .XLSX files, for which Excel 2007 is always required and used.
USER
[U] Set by the CopiaFacts Client software in FS files to identify the user for whom the FS file has been created. Note that the presence of this variable causes any mis-spelled or not-defined variable reference starting "@USER..." to be expanded incorrectly, because the @USER will be expanded on its own and leave the rest of the incorrect variable name unchanged.
USER_CCOUNT
[RO] At request time, contains the count of lines currently active for requests, which have the same DID number as the line accessing the value of the variable. The count includes the current line. If no DID number is active for the current line, the value is zero. This count is equivalent to USER_COUNT plus the count of any outbound lines involved in linked calls connected over the SC-Bus, for which the call originated on the counted request lines.
USER_COUNT
[RO] At request time, contains the count of lines with user profiles currently active for requests which have the same DID number as the line accessing the value of the variable. The count includes the current line. If no DID number is active for the current line, the value is zero.
USER_DNS_DOMN
[WO] Assign a pathname to this variable on a user profile $var_def command to specify a user-specific NDX file or database specification to be used in addition to the global lookup to control do-not-send e-mail domain target addresses. A value of NONE may be specified in an FS file to override the value in the UJP or USR file. For FFBC and Job Administration broadcasts, consider using the new $dns_phone and $dns_email commands instead of this variable.
USER_DNS_MAIL
[WO] Assign a pathname to this variable on a user profile $var_def command to specify a user-specific NDX file or database specification to be used in addition to the global lookup to to control do-not-send e-mail target addresses. A value of NONE may be specified in an FS file to override the value in the UJP or USR file. For FFBC and Job Administration broadcasts, consider using the new $dns_phone and $dns_email commands instead of this variable.
USERINFO_xxx
[U] Set by the CopiaFacts Client software in FS files to identify the properties of the user for whom the FS file has been created. The valid values for the 'xxx' are: ADDR1, ADDR2, CITY, COMPANY, EMAIL, FAX, NAME, PHONE, STATE, ZIP. You should avoid using any similar variable name other than these.
USETHISPRINTER
[WO] Assign a printer name to this variable to cause it to be used for PRINTTHISFILE operations for the current call. Assigning an empty value reverts to the use of the system default printer.
UTF8_LISTS
[RW] Assign a non-empty value to this variable to specify that broadcast lists with any Unicode encoding, or with the Windows default encoding, are to be converted to UTF-8 as a job is launched. This setting overrides the existing default where Unicode lists are accepted and converted to ASCII, losing any non-ASCII characters; and in due course will itself become the default setting.
VALID_ASCII_EXTS
[RW] Assign a white-space-separated list of file extensions (each with a leading '.') to this variable to specify allowable file types which are to be treated as faxable if they appear to contain ASCII data. ASCII files with other file extensions will be rejected. When this variable is not defined, all such files will be treated as faxable ASCII files. Files with extensions .TXT, .ASC and .CVR are always treated as faxable ASCII files and are not affected by this variable.
VCARDNO
[WO] This is a 'smart' system variable to which a credit card number can be assigned for checking. If valid, the value is placed in the CARDNO system variable (see above). If invalid, the CARDNO variable is set to an empty value. You can determine whether the card number was valid by testing if the value in CARDNO is the same as the value you just assigned to VCARDNO. This variable is only available if your CopiaFacts system includes the Credit Card option.
VCEXPDATE
[WO] This is a 'smart' system variable to which a credit card expiration date ( MMYY) can be assigned for checking. If valid, the value is placed in the CEXPDATE system variable (see above). If invalid, the CEXPDATE variable is set to an empty value. You can determine whether the expiration date was valid by testing if the value in CEXPDATE is the same as the value you just assigned to VCEXPDATE. This variable is only available if your CopiaFacts system includes the Credit Card option.
VMAIL_INDEX
[RW] This variable should be set to a value between 1 and the number returned by VMAIL_SCAN (inclusive) to reference an entry in the table of message files created by referencing VMAIL_SCAN. If the number assigned to the variable is outside this range, the values returned by VMAIL_NAME and VMAIL_INFO will be empty. The VMAIL_INDEX variable is set to one when you reference VMAIL_SCAN, unless (a) there are no mail message files, in which case it is set to zero or (b) the VMAIL_START variable has been set to last in which case it is set to the number returned by VMAIL_SCAN.
VMAIL_INFO
[RO] After referencing VMAIL_SCAN and setting VMAIL_INDEX to a valid value, this variable contains information about the voice message file referenced, in the format described below. Otherwise, the value is empty. You may substring this variable and reference the components in $play_var commands (with custom algorithm files) to describe the file to the caller. The format of the information returned is YYYYMMDDHHMMWS, where YYYYMMDD represents the date of the file, HHMM the time of the file, W the day-of-week of the file (Sunday=1), and the remaining characters in the value are the file size in bytes. The provided VMAIL.ALG sample algorithm file will speak the day, date and time from this variable string in US or UK English.
VMAIL_MIN
[WO] This variable sets, for the remainder of the call, the minimum voice message file size in bytes, below which a message will be considered as 'noise' and deleted during a message scan. The default value is 4000, which represents just over a second in the normal recording format of 6kb ADPCM.
VMAIL_NAME
[RO] After referencing VMAIL_SCAN and setting VMAIL_INDEX to a valid value, this variable contains the full pathname of the voice message file referenced. Otherwise, the value is empty. You may reference this variable on a $image_desc command to play back the message to the caller.
VMAIL_SCAN
[RO] This variable returns the number of voice messages found in the current recorded message directory. Each time you reference this variable it re-scans the directory to obtain the names of all the message files and sorts them into call number sequence. File names and file information may then be retrieved using the VMAIL_NAME and VMAIL_INFO system variables, after you have set the VMAIL_INDEX variable to reference the specific table entry.
VMAIL_START
[WO] This variable can be set to a keyword of last to start from the most recent message after a VMAIL_SCAN. Any other value of assigned to this variable is treated as first, which is the default. This variable also affects the sequence of playback of messages initiated by a $type playback infobox or selecting the infobox defined in $playback in the user profile. The setting lasts for the remainder of the call or until a new value is assigned to this variable.
VMSG_DIR
[WO] You can set this variable to a new directory name you wish to use for CopiaFacts voice messages. The change takes place immediately and is effective until the end of the call or until changed again. If the value is not a valid directory name, the change will not be made. This feature allows you to change the language in which the call messages are spoken as a result of caller input in a question box. The variable name may also be specified as VMSGDIR, without the underscore. If there is no FAXFACTS.DIG file in the appropriate directory, the existing filename will not be changed.
VOICE_DELAY
[WO] Sets a value in minutes for the delay between voice outbound attempts when infobox logic transfers to state VOICE_RETRY. The value may be preceded by a prefix of 'A' to indicate that the alternate phone number is to be used on the next attempt. If no delay is specified, a default value of 3 minutes is used.
VOICE_PARMS
[WO] For calls transferred using $type transfer commands, values of the form "parm=number" may be assigned to this variable to set parameters for the current call transfer only. If any values are set, all $cpb_parm values in the configuration file are ignored for the call. The parameters are applied to the outbound call, not the incoming line, for SC-Bus transfers in which a second line is used. See the examples shown for $dial_cmd, and the list of parameters for $cpb_parm.
VOICEBC_HANGUP
[WO] Assigning a value in seconds to this variable in an infobox or FS file will cause a hangup by the called party in a voice broadcast to be treated as a successful conclusion of the call if the call duration exceeds the specified value. Assigning a value of 0 causes all calls to be treated as successful if the called party has hung up after connection. Assigning a keyword of fail will cause the call to be failed with outcome code 94 on hangup by the called party: this is the default. It is possible to assign different value at different times in an infobox sequence.
VOLUME
[WO] Set the playback volume for the remainder of the call or until a new assignment is made. The assigned value is added to the value set by the $volume command, if any, and the result set to the nearest point in the range -10 to 5. A value of -10 represents a reduction of 20db in the standard volume, and 5 represents an increase of 10db.
WFP_COVERFILE
[WO] This variable can be set in the configuration file to the name of a GTT file which will be used as the template for creating a single-page 'quick-cover' sheet for the CopiaFacts interface to Symantec WinFax Pro. The default name is WFPQUICK.GTT if this variable is not defined. If you expect to use multiple-page quick-cover sheets, you should also create suitable cover sheets with the correct number of pages. For example if you define MYQC.GTT in this variable (and create this file with a single page), you should also create MYQC2.GTT and MYQC3.GTT with two and three pages respectively if you expect that quick covers may extend to this length.
WFP_COVERLINES
[WO] This variable can be set in the configuration file to the number of lines which can be accommodated on the cover sheet template specified by WFP_COVERFILE as a quick-cover template. The default value is 60.
WFP_COVERCLINES
[WO] This variable can be set in the configuration file to the number of lines which can be accommodated on each of the continuation pages included in the ..2.GTT, ..3.GTT etc. files, if they are created to allow for multiple-page quick cover sheets.
WORDMERGE_ENCODING
[WO] This variable can be used to override the source code page used to create the temporary Unicode .DFS files created for a WordMerge operation. The value must currently be a keyword of the form ISO_8559_x where x is 1 through 8. If this variable is not specified, or specified with an invalid value, the encoding used will be the default for the system on which FFEXTERN is running.
WORKER_DAY_INTERVAL
[WO] This variable specifies the intervals at which a specific worker box is to be processed. See the detailed description of worker-box interval scheduling.
WORKER_MINUTE_INTERVAL
[WO] This variable specifies the intervals at which a specific worker box is to be processed. See the detailed description of worker-box interval scheduling.
