[RO] These variables are used only in the JOBDDATA and JOBXDATA 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_1_2_7 will show for a job item the aggregate call time over attempts in queues 1, 2 and 7. CONN_10_11 will show connect time in queues 10 and 11. 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 numbers 1 to 15 may be used to form a variable name as in the examples above.
CALLDATEx
[SRO] Call request date set at transmit time from $fax_request_date:
CALLDATE0
yyyymmdd (example: 20001225)
CALLDATE1
mm/dd/yy (example: 12/25/95)
CALLDATE2
dd/mm/yy (example: 25/12/95)
CALLDATE3
dd/xx/yy (example: 25/DC/95)
CALLDATE4
mm/dd/yyyy (example: 12/25/1995)
CALLDATE5
dd mon yyyy (example: 25 Dec 1995)
CALLDATE6
xxxxx dd, yyyy(example: December 25, 1995)
CALLDATE7
yy mm dd (example: 95 12 25)
CALLDATE8
yy-mm-dd (example: 95-12-25)
CALLDATE9
yymmdd (example: 951225)
CALLERID
[SRW] 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
[SRW] 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
[SRO] 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, or a SIP provider sending name data when available with an incoming call. This data can be placed in a custom variable such as DATA5 to make it available in the DBF log file.
For BladeWare calls, this variable receives the same value as FOIP_FROM.
For XCAPI calls, uses the caller name extracted by XCAPI if present.
CALLNO
[SRO] Contains the current call number with leading zeros, for use in forming unique filenames at request time.
CALLNUM
[SRO] Contains the current call number, of the inbound call at request time, from the $fax_callno command at transmit time.
CALLP_ACTION
[CV >C] 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.
CALLS
[CV C>] Set after a fax transmission to the time of the call start (hh:mm:ss). This variable will appear in the SENT FS file.
CALLSECONDS
[SRO] 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.
CALLSTART
[CV >C] Assigning a value of DIAL to this variable in FAXFACTS.CFG causes call start times and durations to be calculated from the start of dialing the call. The default is to measure CopiaFacts channel utilization by calculating from the time the channel is prepared for use: this includes time spent waiting to dial as a result of the $dial_limit value and time spent preparing the fax for transmission before dialing. If no dial takes place on a call, this setting is ignored. When set to a value of DIALV, a variable named PRE_DIAL_MS is set (and added to the FS file) containing the time between the 'normal' start of the call and the start of the dial operation, in milliseconds.
CALLTIMEx
[SRO] call request time set at transmit time from $fax_request_time:
CALLTIME1
HH:MM (example: 17:30)
CALLTIME2
HH:MM:SS (example: 17:30:00)
CALLTIME3
HH:MMxx (example: 05:30PM)
CALLTIME4
HHMM (example: 1730)
CALLTYPE
[SRW] 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.
CATERM
[SRO] 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 CF9.SMR.
CATYPE
[SRO] For Diva boards and XCAPI ports, the CATYPE variable contains for dial failures a Q.931 cause code plus 6000.
CAUSE_VALUE
[SRO] Contains the ISDN PRI cause value (Q.931 cause code) from the disconnect of a telephony channel attached to the line. For Dialogic ISDN only.
CB_DELAY
[SRO] The system maintains information about the time delay from fax-on-demand 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.
CERT_VALIDITY
This is a special variable which can typically be defined in $var_def command for expansion in e-mail body text or alternate body text, or in a script which creates such an FS file. It is then used in an encrypted e-mail to report the validity of the certificate used. When you reference the variable, for example in an e-mail body, then if the e-mail content is not encrypted, the variable expands to empty. The variable value is double-expanded, so can contain variables VDATEx and VTIMEx which are expanded to the validity expiration date and time of the public key certificate used to encrypt the e-mail content. a Examples: in a CFG file (or override in USR or FS file): $var_def CERT_VALIDITY "Your encryption certificate expires on `vdate6 at `vtime3" in a $type FSFILE script, where ` ` ensures that the value is not expanded immediately $set_var CERT_VALIDITY "Your encryption certificate expires on ``vdate6 at ``vtime3"
then to use the variable value in a notification: $email_text `CERT_VALIDITY $email_alttext `CERT_VALIDITY
CF_DATELOCALE
[SWS CV >G] A Windows locale number can be assigned to this variable, in an FS file only, to localize the output of the DATE_L, DATE_S, DATE_C and TIME_C variables on a fax cover sheet. Locale numbers can be found in the third column of the tablehere. Note that many of these numbers are not available in older OS versions. The value may also be set to "auto" in which case a value will be set for the most common destinations by reference to the country code in the dial string. For countries with multiple locales, or without an obvious corresponding Windows locale, the values will be output in the system default locale of the sending machine. You need to select a Unicode-enabled font for the annotation in order to render the output correctly for some locales, but this feature does not require command file encodings to be specified as Unicode. This feature can also be used in a fax header applied with $apply_gct.
CF_FORCE_MX
[CV >E] Used to force the use of an MX record for outbound e-mail, overriding all those returned by the DNS server and their priority sequence. This variable is required for special situations only and is applied only to destination domains specified in CF_FORCEMX_DOMAINS. The value should be the required IP address or domain name.
CF_FORCEMX_DOMAINS
[CV >E] Used to specify the destination domains to be affected by CF_FORCE_MX. The value should be a comma-separated list of e-mail destination domain names.
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
[CV >C] For Commetrex BladeWare, the contents of this variable override the value in the BladeWare configuration file for a specific call.
CFSIP_USERNAME
[CV >C] For Commetrex BladeWare, the contents of this variable override the value in the BladeWare configuration file for a specific call.
CFSIP_OUTBOUNDPROXY
[CV >C] For Commetrex BladeWare, the contents of this variable are passed to the SIP_OTF_OutboundProxy parameter for an outbound call.
CFSIP_CALLINGNUM
[CV >C] For Commetrex BladeWare, the contents of this variable are used as the outbound calling number (ANI). The part between the 'sip:' and the '@' in the string can then be replaced using OB_ANI or OB_TF_ANI variables.
CFSIP_SIPIP
[CV >C] For Commetrex BladeWare, the contents of this variable are used to form the outbound dialed number (following the '@').
CHAIN_END
[SRW] 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
[SRO] Contains a value 1 or 0 to indicate whether the 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. Applies to Dialogic, Dialogic Diva, TE-Systems or Copia VoIP ports only.
CHANNEL_ERROR_MAX
[SW] If set to a numeric value in FAXFACTS.CFG specifies the number of channels that can go to LINE_ERROR state before a Controlled Shutdown will be initiated. If not specified or zero, only a notification message will be sent on each LINE_ERROR if an EMSETUP trigger is set for this.
CHECK_BLANK_TIF
[CV>C] 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 loading every TIF file ro check for non-white pixels. An empty value or a numeric value less than or equal to '0' omits the check.
From build 9.1.9.379, a positive numeric value such as "2" checks only a document of two pages or fewer and omits it if both pages are blank. A non-numeric value such as "YES" checks all documents (not recommended).
CLASS
[SRO] Contains the caller class of service from the caller-id data file.
CNUM
[SRO] Contains the number of the current CopiaFacts channel processing the call.
[CV >GEXS] Defines keywords which specify what types of conditional text expansion are to be used. See the Conditional Text topic for details.
CONDITIONAL_LIMIT
[CV >EX] In Conditional Text, this numeric value sets a limit on the number of times a $repeat loop can be executed. The default is no limit.
CONSOLIDATED_TRANSMISSION [CV>C] See the Consolidation topic.
CONVERT_HTML_LIST
[CV >J] Set to a non-empty value to force pre-conversion of all documents in an HTML broadcast list.
CONVERT_PROOF, CONVERT_FORCE
[CV J> >X] These variables are used internally to communicate between CF9JOBADM and FFEXTERN.
CONVERTER_PAGE
[CV >X] Assigning a valid keyword or number from the table in the Printer Driver topic will override the default Copia Fax Converter paper size set by the environment variable DEFAULT_CONVERTER_PAGE.
CONVERTER_RES
[CV >X] 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 used, unless overridden by environment variable DEFAULT_CONVERTER_RES. Some applications maintain their own printer settings and ignore the values set by these variables.
COPIA_SERIAL
[SRO] The CopiaFacts serial number.
COPIED_GW_FILES
[SRO] The CopiaFacts SMTP Gateway will use the presence of this variable on a $var_def command in a Recipient Template worker-box FS file to indicate that the e-mail files are to be copied to the specified folder. This ensures that they are available to be forwarded by a COPIAFACTS instance on another machine. Unlike for most other $var_def variables, variables will be expanded by the Gateway in the value.
COUNT_0
[SRW] 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
[SRO] 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. This variable uses the same counter as COUNT_0. See also AG_PAGE.
CP_...
These variables control code page (encoding) checking and conversion. See the topic Handling Multiple Encodings for details.
CP_COPIAEDIT
[CV] Allows COPIAEDIT to detect, load and save files with non-standard encodings. This applies only to files other than CopiaFacts control files.
CP_EMAILHTMLATTACH
[CV E>] Controls the automatic detection of encoding in e-mail attach files with content type text/html (which may need to be processed for embedded variables).
[CV E>] Controls the automatic detection of encoding on files containing the e-mail subject line (specified on an EMAIL_PSUBJECT variable).
CP_GCOVER
[CV G>] Allows automatic detection of the encoding of text files used in 'ASCII' cover sheets. The variable should be defined in a USR or FS file, or set in a preprocess, before the cover sheet is processed.
CP_HTMLEXPAND
[CV X>] Controls the automatic detection of encoding in an HTML job document file for which variable content is to be expanded before processing (specified by job options keyword HtmlExpandVars).
CP_LIST
[CV >JB] Controls the processing of text-format broadcast lists (not Excel or dBase) in Job Administration and FFBC. The text to be checked is the entire list file.
CREATETHISFILE
[SW] 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!
CUSTOM_CV_CMD
[CV >X] when defined in an FS file to an executable or batch file pathname, will cause the file to be executed instead of CVSINGLE in a document conversion operation. The parameters passed are the input and output pathnames, the FS number and the contents of the CUSTOM_CV_OPTS variable.
CUSTOM_CV_OPTS
[CV >X] see CUSTOM_CV_CMD.
CUSTOM_LIST_DLL
[CV >J] 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
[CV X>] This variable is set (as an FS file $var_def) by FFEXTERN to the machine name of the instance of FFEXTERN which pre-processed the file for document conversion.
CVSINGLE_OPEN_TIMEOUT
[CV >V] When defined in an FS file, overrides the environment variable CVSINGLE_OPEN_TIMEOUT. The value is seconds.
CVSINGLE_SCALESTEP
[CV >V] No longer used by the internal image converter. See IMAGE_OPTIONS keyword scimg.
CVT_NOSIGCHECK
[CV >V] Assign one or both of the strings DOC and PDF to this variable to suppress the check for a valid DOC or PDF file signature prior to a document conversion.
CVT_PRECHECKPDF
[CV >V] Assign a non-empty value to this variable in an FS file passed to the Document Converter, to do a test open of a source PDF in the built-in PDF converter (without rendering it to TIF) before passing the file to Acrobat. This may prevent Acrobat from blocking the conversion with a pop-up reporting an invalid file or missing password. This variable is ignored for conversions not involving Acrobat. If the file is invalid or cannot be opened, the outcome code will be 671. If it is opened successfully it will be closed immediately but the conversion will have been delayed by half a second or so. An assignment of the value 'ALLOW409' will exclude invalid files which return this internal error code and treat them as valid.
CVT_XLS_OPTIONS
[CV >V] This variable provides options for sheet selection to control Excel document conversions. See the Using Excel topic for details of the supported keywords. The variable can be specified in the environment for use with standalone CVSINGLE operations.
It is recommended that this variable should only be used when a blank document might be expected, to avoid loading every TIF file ro check for non-white pixels. An empty value or a numeric value less than or equal to '0' omits the check.