Navigation:  Appendices >

Appendix G: Environment Variables

Previous pageReturn to chapter overviewNext page

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 which makes maintenance easier. If you decide to use operating system variables, you should set these using the "system variables" part of the Control Panel dialog, not the "user variables" part.

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.
BNFAXL Sets the number of (low-resolution) scan lines in an ASCII text page sent from a Brooktrout fax board. Default 1143.
CFCONNECTSet to a value of DISABLE to retain the configuration method which uses a common drive letter for all machines.  The default is now to use a common UNC pathname for all machines.  See Standard Directories for more information.
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 normalize and add phone numbers to a do-not-send file.  This variable only affects PIN; use $country_prefix to specify an overide 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.
DEFAULT_CONVERTER_RESAssigning 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.
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_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.
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_CONSECUTIVE_ERRORS  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_ERRORSCan 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_TIMEOUTSCan be set to the numeric value of a limit on Document Converter timeouts, after which the FFEXTERN OMA file will stop being updated.
FFTIMESERVERSet 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 is used before FAXFACTS.CFG is read, so it must be set in the Windows environment, not using $environment.
FORCE_PORTRAIT When set to a non-empty value, this sets the Document Converter orientation to portrait before each conversion. This avoids incorrect formatting when the printer settings have been accidentally changed to landscape mode. A landscape-mode document should override this setting and be correctly rendered 'sideways' on the fax, but if you use this variable you should verify that this is the case with the specific Office or Adobe release you are using.
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.
GFAX Set to the directory name in which to create temporary files to control GammaLink fax transmissions. The Gammalink install will create this folder and environment variable. The environment variable must also be supplied and reference a local folder to use the Fax Local Copy option in the CopiaFacts engine.  The folder specified here is also used for temporary cover-sheet files if the COVERTMP environment variable is not set.
GFX_HEADERCan contain a value (typically "&header&user") which causes old-style header processing to be used for Gammalink boards. The first 52 characters of the entry on the $fax_header command are then expanded, twenty characters into the 'header' field and 32 into the 'user' field.  The use of this variable is unnecessary since CopiaFacts release 7.162, which can use as many header characters as will fit on the fax and does not limit the text from the $fax_header command to 52 characters.  See also the Gammalink hardware notes.
JOBMON_SKIPCan contain a list of comma-separated filenames (excluding path) which are to be ignored by JOBMON during folder scans.
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).
MOC_INSTALLEDSet using a $environment command 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.
NOIDLESet to a non-empty value to disable idle (sending a stream of silence) on a Dialogic DTI timeslot after dial.
NORMALIZE_DNSSet to a non-empty value to enable 'normalization' of fax numbers in do-not-send files. If you set NORMALIZE_DNS using a $environment command, it must apply to all nodes and have no day/time overrides.
NOTISDNSet to a non-empty value to set the CALL_NOT_END_TO_END_ISDN call progress option on a Dialogic PRI-ISDN channel.
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.
PFCTO, PFRINGS, PFVTO Set to the call timeout, number of rings and voice timeout for Powerfax call placement. If any of these values are set, all must be. Times are in seconds.
PFTIME Set to the time in seconds for Powerfax transmission timeout.
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 Overrides the default location for the StarOffice program 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).
USE_EXCELAssigning a non-empty value to this variable causes an XLS broadcast list to be read (in FFBC only, for Job Admin see the USE_EXCEL 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.
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 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.

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.

 


Topic url: http://www.copia.com/support/refmanual/index.html?environmentvariables.htm