Appendix G: Environment Variables

The following operating system environment variables are used by CopiaFacts programs, drivers and utilities. However it is strongly recommended that you use instead the $environment configuration command in FAXFACTS.CFG which makes maintenance easier.  For example, you could add to FAXFACTS.CFG:

$environment * GFAX  "C:\FAXTEMP"

When a value is set in the Windows environment, it overrides any value on a $environment command, some variables must only be set as Windows system environment variables, and are so indicated.

If you decide to use operating system variables, you should set these using the "system variables" part of the system advance properties dialog, not the "user variables" part.

Some CopiaFacts components support expansion of external variables containing references in the form %varname%.  Such references only match variables in the Windows environment, not those on a $environment command.

In the list below, variables affecting only one CopiaFacts component are indicated with the component name (CF indicates the COPIAFACTS engine).

ACTIVE If set to a directory, then the active files will be placed in this directory, not in the ACTIVE subdirectory of the $request_dir directory. You may wish to choose an alternate location to improve network performance. The directory must be accessible to all network machines running COPIAFACTS or other CopiaFacts programs, and this variable must be set identically on all machines. Avoid changing this variable while CopiaFacts programs are running.  If you set ACTIVE using a $environment command, it must apply to all nodes and have no day/time overrides.
BLADEWARESERVICEWhen set to a value of none, this suppresses the running of OFTSTART to start the BladeWare service at COPIAFACTS startup.  This variable must be set as a Windows system environment variable, not by using $environment. For example:
SET BLADEWARESERVICE=none
BNFAXL Sets the number of (low-resolution) scan lines in an ASCII text page sent from a Brooktrout fax board. Default 1143.
CFCONNECTNo longer supported.
CF_UPDATE_LINKS[CVSINGLE] When set to a value between 0 and 3, causes Excel conversions to apply this value to the Update Links option parameter on a file open in Excel automation..
CFSIP_These variables are described in Appendix D.  The values on the $environment commands for the node (set by OTFCONFIG) are overridden by any defined variables of the same name.
COPIACONNECTINIPATHContains an override pathname for the local configuration file normally stored as Documents and Settings\All Users\Application Data\Copia\CopiaConnect.ini.  See Advanced Configuration Features for more information.
COUNTRY_PREFIXCan be set to override the default value of 011 when using the PIN program to add phone numbers to a do-not-send file.  This variable only affects PIN; use $country_prefix to specify an override while checking do-not-send numbers.
COVERTMP If set to a directory, then the cover sheet files generated from the template at call time will be placed in this directory, not the $request_dir directory or the Job Owner temporary directory. You may wish to choose an alternate location such as a local disk to improve network performance. This variable affects both ASCII and Graphical Cover Sheet files generated at call time.
CVSDELAY[CVSINGLE] Defines a number of milliseconds for which CVSINGLE will wait before terminating.
CVSINGLE_OPEN_TIMEOUT[CVSINGLE] When defined as a numeric value from 1 to 90, specifies the timeout value in seconds when CVSINGLE opens a Word or Excel document, or a WordMerge Datasource file.  The default value is 10 if this environment variable is not defined.  This feature is intended to catch documents which cause a pop-up to be displayed on opening, for example a password request, which blocks the document conversion.  To suppress file-open monitoring, set this value to 0.  For document converter applications, this value can also be overridden by a CVSINGLE_OPEN_TIMEOUT variable in the FS file.
CVT_GLOBAL_NAMESPACEWhen defined as a Windows system environment variable with a non-empty value, this will cause the communication between CVSINGLE and FFCVRT to use object names in the Global Namespace. This is needed when an application in Windows Vista, Windows 7 or Windows Server 2008 runs CVSINGLE in a separate session, for example when it is called from a web service.  You should reboot your system after changing this setting.
CVT_LOCAL_COPYCan be set to the name of a local folder to which CVSINGLE will copy the merge master document of a Word Merge operation if the local copy is not already present or if it has an earlier timestamp.  You must arrange to delete such copies after the job is complete using a utility such as DELETEOLDER.  The folder is created if it does not already exist.  If the copy fails, the original document file will be used.
CVT_XLS_OPTIONS[CVSINGLE] See variable CVT_XLS_OPTIONS.
CVTOPTS[FFEXTERN, CVSINGLE] A string of option letters can be specified which are used as if they had been specified as CVSINGLE command-line options.  For example:
$environment * CVTOPTS "Q"    ; selects internal PDF converter
$environment * CVTOPTS "KUVW" ; use Office-defined page size
DEFAULT_CONVERTER_PAGE[CVSINGLE] Assigning a valid keyword or number from the table in the Printer Driver topic will define the default Copia Fax Converter paper size, used when variable CONVERTER_PAGE is not defined and when the setting has not been taken from the original document.  If this environment variable is not set, the default is Letter in the USA locale and A4 elsewhere.
DEFAULT_CONVERTER_RES[CVSINGLE] Assigning one of the values '200x200', '204x196' or '204x98' to this variable will define the default Copia Fax Converter resolution, used when variable CONVERTER_RES is not defined.  If this environment variable is not set, '200x200' is the default.
DIVA_EXTENSIONSWhen set to a non-zero value, this enables support for superfine and ultrafine fax formats on Diva boards.
DIVA_OFFERED_SCANCOUNTThis variable controls the number of times (between 1 and 10, default 1) the system scans (at average 500ms intervals) to find an available line on an incoming call.  This may be needed on a fully-loaded system handling inbound calls, when the CO offers a new incoming call before the Diva channel recovers following the dropping of an earlier call.  Careful tuning of this variable may be needed: set too high, more calls may be lost than are occasionally rejected when no line is available.
DTI1 Set to any non-empty value to indicate in a Dialogic system that only the first span on a dual-span telephony board is to be used.
EICON_DELAYSet to a value in milliseconds (max 2000, default 5) to delay processing a Diva disconnect event.
EICON_NO_INBOUND Set to a comma-separated list of board numbers, this variable forces the board to ignore incoming calls on the specified Diva boards.
EN_EXTENSIONSSet to a non-empty value, this variable enables DIva superfine and ultrafine fax support. This is a global setting.

EN_MAXCONN, EN_RXBUFFERS, EN_MAXBUFFERSIZE  Set these low-level Diva board parameters only on specific instructions from Copia support.

FAX40BASERSet to the value (0 or 1) for the page number base in fax reception on a Dialogic VFX/40 board.
FAX40BASETSet to the value (0 or 1) for the page number base in fax transmission on a Dialogic VFX/40 board.
FAXFACTSDIRSet to the full UNC pathname of the CopiaFacts Application Data folder, with a trailing backslash.  In systems running with a system environment variable named CFCONNECT set to a value of Disable, the value of FAXFACTSDIR will be the mapped drive letter path.  This environment variable may be useful in Windows batch/command files.  The variable is set by SERCONF at installation time and updated if necessary by COPIACONNECT.
FAXFACTSDRIVESet to first two bytes (drive letter and colon) of the value of the FAXFACTSLOCAL variable (only set if the folder is local). This environment variable may be useful in Windows batch/command files.  The variable is set by SERCONF at installation time and updated if necessary by COPIACONNECT.
FAXFACTSLOCALSet to the full local pathname of the CopiaFacts Application Data folder, with a trailing backslash, if this folder is local.  Otherwise the variable will not be set.  This environment variable may be useful in Windows batch/command files.  The variable is set by SERCONF at installation time and updated if necessary by COPIACONNECT.
FAXMSG Set to a directory specification to be searched for CopiaFacts FAXMSG.n voice messages and for FAXFACTS.DIG, FAXFACTS.AMT, FAXFACTS.ABC and FAXFACTS.RST multiple-segment voice files. Multiple directories may be separated by semi-colons in the manner of the PATH command. These directories, if specified, are searched after the directories named in the user profile command $vmsg_dir. and after those of the SVP environment variable.  If any of the folder names contain the string 'WAV', then the multiple-segment voice files will be taken to be the wave versions (for example FAXFACTW.DIG).
FF_BTCALL_CFGSpecifies a local position for the BTCALL.CFG file in a  Brooktrout system which requires different CFG settings for different nodes. This overrides the default of looking for this file first in the CopiaFacts Application Data folder and then in C:\BROOKTRT.
FF_BTCALL_1034_PATHSpecifies a local position for the BTCALL.CFG file in a  Brooktrout system which requires different CFG settings for different nodes. This overrides the default of looking for this file first in the location specified in the BostonService registry entries and then in the Boston\BIN folder.
FF_LOCAL_LOG Specifies a local log directory for the DBF log file written by a specific CopiaFacts node, overriding the $log_def command. Note that the position of the OMA files is not affected by this variable.
FF4EXIT# If set to a non-empty value then entering a # more than once at Standard Voice Prompt 4 will cause CopiaFacts to end the call.
FFDEBUG Set to a hexadecimal value to override the debug settings on the COPIAFACTS program options page. Set this variable only when requested by Copia technical support.
FFEXTERN_ADJUST_LIMIT[FFEXTERN] Can be set to the numeric value of a limit on Document Converter future-dated source files for which the output file time stamp is adjusted, after which the FFEXTERN OMA file will stop being updated.  The problem usually manifests itself when the computer time has drifted relative to other network machines and will result in outcome 129 errors if not corrected and the discrepancy reaches five minutes.
FFEXTERN_ADJUST_REPORT[FFEXTERN] Can be set to a numeric value N to cause a report in the FFEXTERN OMA file on every Nth occasion when a time-adjustment (see FFEXTERN_ADJUST_LIMIT) is done.
FFEXTERN_CONSECUTIVE_ERRORS[FFEXTERN] Can be set to the numeric value of a limit on Document Converter consecutive errors, after which the FFEXTERN OMA file will stop being updated.
FFEXTERN_QUEUE_ERRORS[FFEXTERN] Can be set to the numeric value of a limit on Document Converter errors reading the Preprocess Queue, after which the FFEXTERN OMA file will stop being updated.
FFEXTERN_TIMEOUTS[FFEXTERN] Can be set to the numeric value of a limit on Document Converter timeouts, after which the FFEXTERN OMA file will stop being updated.
FFTIMESERVERNo longer used: use an external timeserver instead. Set to the machine name of a Windows network node which will be used to synchronize a machine running COPIAFACTS, FFEXTERN or JOBMON with others on the network. Normally the named value will be the fileserver on which the CopiaFacts files reside. The time is checked every fifteen minutes. Enter the machine name using two initial backslash characters: e.g. \\FFSERVER.  To use this feature successfully, all machines must be set to the same country and timezone, and all the Windows summer-time checkbox settings must be the same.
FFTRCSet to a directory name to be used for CopiaFacts trace files (*.TR?). This allows such files to be written to a local drive to minimize network traffic. This variable may be used before FAXFACTS.CFG is read, so it must be set as a Windows system environment variable, not using $environment.
FORCE_FS_WRITESet to any non-empty value, this variable overrides and suppresses $delete_option keywords FAIL and SENT.  It allows sites which use these options to temporarily override them to investigate problems, without needing to change applications which create FS files with these keywords.  If you use this variable, make sure that the SENT and FAIL folders are present under CALLBACK.  See also LOCAL_FS_COPY_PATH below.
FORCE_PORTRAIT (obsolete)
FTPUPLOAD_FOLDER[FTPUPLOAD] Setting a value of RELATIVE or ROOT causes the first folder element to be taken as being respectively relative to the login folder, or a root folder of the site.  This overrides the -rel FTPUPLOAD command-line option if different.  The default is ROOT.
FTPUPLOAD_METHOD[FTPUPLOAD] Setting a value of PASSIVE or ACTIVE specifies the FTP method. This overrides the -p FTPUPLOAD command-line option if different.  The default is ACTIVE
FSLMACROIf set to a non-empty value, variables will be expanded in the parameter on the $fax_send_line command. This is rarely beneficial, because the expanded value will remain in place for subsequent attempts and will not be re-expanded.
FX_TEXT_EXT[FFEXTERN] Allows the file extension to be overridden for the 'Text File' FFEXTERN special process.
GFAX Set to the directory name in which to create temporary files for the Fax Local Copy feature, this variable is now a required setting for all fax operations (originally it was used for GammaLink fax transmissions only).  The folder specified here is also used for temporary cover-sheet files if the COVERTMP environment variable is not set.  C:\FAXTEMP will be used (and created if necessary) if absent.  If the local folder specified does not exist, it will be created, but if a network folder is specified, COPIAFACTS will not start.
HTML_MARGINSThis environment variable provides a default for the MARGINS keyword in QPDF_OPTIONS.  The value should consist of four numeric values separated by forward slash characters, for example 10/60/10/60.
JOBADMIN_DELETION[JOBADMIN] Set to a value of 'Allowed', permits potentially unsafe deletion of owners, jobtypes and job instances from JOBADMIN.  For example:
$environment * JOBADMIN_DELETETION "allowed:
JOBMON_SKIP[JOBMON] Can contain a list of comma-separated folder names (excluding path) which are to be ignored by JOBMON during folder scans.  If not defined, the list defaults to the single item TEMP.
LOCAL_FS_COPY_PATHCan contain a local pathname which will contain a copy of each FS written to SENT or FAIL.  When a path is set in this variable, a checkbox 'FS Copy' will appear on the CopiaFacts engine Options tab, which can be used to enabled the file copies for temporary debugging purposes.  See also FORCE_FS_WRITE above.
MAIL_DELETE_THRESHOLDSet to the size in bytes of a received fax file above which it will not be deleted on a failed receive operation (default 200).
MAX_GDI_OBJECT_INCRSet to a value (typically 500 or more) which will cause COPIAFACTS to restart if the WIndows GDI Object count increases by more than this value.  This works around a problem encountered with some fax modem drivers where Windows GDI Objects are not released.  You can view the count by pressing Control-H in the COPIAFACTS application.
MAX_HANDLE_INCRSet to a value (typically 1000 or more) which will cause COPIAFACTS to restart if the WIndows handle count increases by more than this value.  This works around a problem encountered with some fax modem drivers where Windows handles are not closed.  You can view the handle count by pressing Control-H in the COPIAFACTS application.
MAX_VAR_SPACEA value above 16 assigned to this variable in FAXFACTS.CFG specifies the maximum space (in kilobytes) for variables for a single FS file in all CopiaFacts programs. The value of 'max variable space' on the COPIAFACTS Options/Options page is overridden by the value of this variable, if it is larger.
MAXRES_ACTION[CVSINGLE] The variable controls the detection of errors when the resolution parameter of the Document Converter printer driver has been set to 300 by an errant application (this causes created TIF files to be non-faxable). A value of 1 will cause the conversion to fail if the registry value is 300. A value of 2 will reset the value to 204 if it is 300 (but will not fix the conversion just done). A value of 4 will add 100 to the 'consecutive errors' counter, effectively causing this to trigger, if the registry value is 300. The values in the variable are additive.
MINUTESLIMITSet to a small integer value greater than one, causes the timeout on no screen messages in the COPIAFACTS program to be extended.  The default is to time out after 1 minute and then wait 15 seconds for a response to the pop-up message.
MOC_INSTALLED[CVSINGLE] Set to a value of either YES or NO, this variable can be used to override the automatic detection of the presence of the Microsoft Office Compatibility pack. The compatibility pack allows the Copia Document Converter to handle Office 2007 documents with specific earlier releases of Office installed.
NEXTCALLNO_FOLDERCan be set to a folder name to override the FAXFACTS\SYSTEM folder where the NEXTCALLNO file is located. Do not set this variable.  It should only be used on advice from Copia support staff and with a full understanding of the implications.
NEXTMCF_FOLDERCan be set to a folder name to override the FAXFACTS\SYSTEM folder where the NEXTCALLNO file is located. Do not set this variable.  It should only be used on advice from Copia support staff and with a full understanding of the implications.
NO_CV_PRINT[CVSINGLE] When set to a non-empty, non-blank value, suppresses the check that the Copia Fax Converter print driver is installed.  Conversions which require this driver will fail with error code -25.
NO_JOB_LAUNCHSet to a non-empty value, prevents an engine picking up a job workerbox FS file (jobbot) for actions 3 or 21.  (Auto-launch after proof, and delay-launch). This may be necessary to avoid installing Excel on all nodes to process job lists, or to avoid installing Word to allow REMOVEDS to prepare a document for Word Merge. Do not set this variable for all nodes, otherwise these actions will never be processed.
NOIDLESet to a non-empty value to disable idle (sending a stream of silence) on a Dialogic DTI timeslot after dial.
NORMALIZE_DNSThis variable is no longer used.  See the Telephone Number Formats topic.
NOTISDNSet to a non-empty value to set the CALL_NOT_END_TO_END_ISDN call progress option on a Dialogic PRI-ISDN channel.
OPENOFFICE3PATH [CVSINGLE] Overrides the default location for the Open Office 3 or LibreOffice 3.5 program (SOFFICE.EXE) when used for conversion of Word, Excel or Powerpoint documents.
OTF_..._MEDIAThese variables are set as environment variables by OTFCONFIG in FAXFACTS.CFG.  See Appendix D and Media Preferences for details.
OTF_OK_DELAYSet to a value of 1, this variable affects BladeWare only.  This is a temporary solution to address an interoperability problem with some behaviorally atypical fax systems.  Typically fax sessions will repeat early negotiations until a handshake is established.  Field trials have shown that not all fax systems adhere to this industry standard practice.  Symptoms of this behavior include frequent fax failures with error code FAX_OTF_T30ErrT1Timeout.
OTF_ROOTUsed by BladeWare to designate the base install folder.  This is a Windows environment variable only.
PAD Set to a non-empty value to force padding of ASCII files on a VFX/40 fax board.
PAGELENGTHSet to a value of tenths of an inch to override the page length of ASCII files on a VFX/40 fax board.
POLLTIMEOUT Set to a value in seconds to adjust the timeout for automatic detection of polling or manual receive operation with Dialogic boards. Set this variable only when requested by Copia technical support.
STAROFFICEPATH [CVSINGLE] Overrides the default location for the Star Office program (SOFFICE.EXE) when used for conversion of Word, Excel or Powerpoint documents.
SVP Set to a directory specification to be searched for CopiaFacts SVPn.VOX and SVPn.WAV voice messages and for FAXFACTS.DIG, FAXFACTS.AMT, FAXFACTS.ABC and FAXFACTS.RST multiple-segment voice files. Multiple directories may be separated by semi-colons in the manner of the PATH command. These directories, if specified, are searched after the directories named in the user profile command $vmsg_dir.   If any of the folder names contain the string 'WAV', then the multiple-segment voice files will be taken to be the wave versions (for example FAXFACTW.DIG).
VOICETMPSet to a local folder name to be used to save a temporary voice-format file resulting from processing a multi-segment voice file which has a sample rate of 6000 on a Dialogic Diva board.  The default is the Windows temporary folder. This folder is not used if you use multi-segment files with 8k sample rates (such as the supplied WAV-format multi-segment files).
WMTMP [FFEXTERN] If set to a directory, then the temporary datasource files for a job which has job option WordMerge will be placed in this directory, not the same folder as the FS file. You may wish to choose an alternate location such as a local disk to improve network performance.
XCAPI_EXTENSIONSWhen set to a non-zero value, this enables support for superfine and ultrafine fax formats on TE Systems ports.  It also enables reporting of the the fax media mode used for a transmission, in variable XCAPI_MEDIA_MODE.
XCAPI_SDK_LOGWhen set to a valid pathname, will enable the TE Systems SDK log file to be written to the named file.
XLS_OPTIONS[CVSINGLE] See variable XLS_OPTIONS.

Note that the value of any environment variable is also available in a .IIF file using the @varname syntax. You can also specify any environment variable name instead of the node name on the COPIAFACTS program options page, and if found in the environment the contents of the variable will be used as the node name.