Please enable JavaScript to view this site.

CopiaFacts Reference Manual

XC_USE_PLUS[CV >C] a non-empty value in this variable causes a number starting with the characters defined as $country_prefix to have those characters replaced by a + character immediately before the call is placed. When the country prefix is 011 (NANP) this setting also causes a + to be inserted ahead of an 11-digit number starting 1. It may be necessary to select "ab_H.323 ID", with no prefix, in the XCAPI configurator to enable this dialing style. It is set on the "Telephone numbers from application" tab of the Telephone Number Filter section. In the current version of the XCAPI configurator the H.323 value may not be reflected in the field after it has been set.

$var_def XC_USE_PLUS 011 ; *only use if so advised*

XCAPI_AUTO_B4[CV >G] The assignment of a non-empty value will cause an attempt to detect remote B4 page capability early in the fax negotiation.  If the transmission contains a B4-format fax page (width 2048 pixels) and the remote cannot be positively determined to support B4 reception (bits 17 and 18 of the T.30 DIS block are non-zero), then the fax file is re-sized on the fly to A4 in a file with _A4 appended to the filename.

$var_def XCAPI_AUTO_B4 ; convert (Japanese) B4 to A4

XCAPI_B4[CV C>] If XCAPI_REPORT_B4 is non-empty, the XCAPI_B4 variable will be set to one of CAPABLE, NO_CAP or NO_INFO, depending one whether the remote has B4 capability, has no B4 capability or we failed to determine the capability.
XCAPI_COMBINE_FAXFILES[CV C>] Setting this control variable to a non-empty value may be needed at some sites to resolve a timing issue in XCAPI. We recommend this setting for all sites using XCAPI, but see also environment variable USE_TIFCAT.
 From May 2025 a TE-Systems pre-release upgrade is available which avoids the need to use this variable.

$var_def XCAPI_COMBINE_FAXFILES yes ;recommended in CFG

XCAPI_DIAL_INTERVAL[CV C>] Can be set to a number of milliseconds to limit the rate of dials on each digital span.  A call will not be started sooner than the specified interval since the last call.  This feature can provide a finer level of control than $dial_limit, and only one of these rate-limit methods should be used.

$var_def XCAPI_DIAL_INTERVAL 200 ; normally not needed

XCAPI_DISABLE_ECM[CV >C] The assignment of a non-empty value will disable ECM for the current XCAPI outbound call. Note that this will also disable baud rates over 14400, which require ECM, and is it not recommended for general use.

$var_def XCAPI_DISABLE_ECM yes ; not recommended

XCAPI_DISABLE_HIGH[CV >C] The assignment of a non-empty value will disable high-resolution faxing for the current XCAPI 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.

$var_def XCAPI_DISABLE_HIGH yes ; *not recommended*

XCAPI_DISABLE_MMR, XCAPI_DISABLE_MR[CV >C] No longer used: see XCAPI SEND_FILE_ENC.
XCAPI_DTMF_MODE[CV >C]  Assigning a value between 0 and 3 to this variable affects the handling of DTMF tones. The default of 0 automatically negotiates the appropriate mode as RFC2833, SIP info messages, or inband depending on negotiation with the gateway.

$var_def XCAPI_DTMF_MODE 1 ; *not recommended*

XCAPI_FAX_DETAIL[CV >C]  Assigning a non-empty value to this variable causes additional low-level fax result information to be displayed in the CopiaFacts trace.

$var_def XCAPI_DISABLE_ECM yes ; normally not needed

XCAPI_MEDIA_MODE[CV C>] This value is automatically set in the FS file during outbound fax call outcome analysis to show the media mode that has been used, or in the MCF for an inbound fax call. The values may be Softfax, T.38 or Unknown.
XCAPI_NEGOTIATE_TIMEOUT_SECONDS [CV >C] Assigning a value to this call which is greater than 30 seconds sets the negotiation time limit. Otherwise the default value is 45 seconds.

$var_def XCAPI_NEGOTIATE_TIMEOUT_SECONDS 60

XCAPI_PAGE_SEND_TIMEOUT_SECONDS

[CV >C] The assignment of a value (in seconds) to this variable will change the default limit of 600 seconds (ten minutes) per transmitted page. Assignment of values less than 60 (one minute) will be silently ignored and will result in the default value being used. You may also need to add an $active_life command to extend the life of lock files in the ACTIVE folder.

$var_def XCAPI_PAGE_SEND_TIMEOUT_SECONDS 400

XCAPI_RECEIVE_BAUD_MAX

[CV >C] An assignment to this variable in the USR file controlling the receive will limit the negotiated rate.

$var_def XCAPI_RECEIVE_BAUD MAX 9600 ; normally not needed

XCAPI_RECEIVE_DISABLE_ECM

[CV >C] Assignment of a non-empty value to this variable in the USR file controlling the receive will disable Error Correction Mode. Do not disable ECM for receive if you expect to receive faxes transmitted with MMR compression.

$var_def XCAPI_RECEIVE_DISABLE_ECM yes ; normally not needed

XCAPI_RECEIVE_FILE_CMP

[CV >C] Assignment of an encoding value MH, MR or MMR to this variable overrides the default compression with which a received document is saved. This only affects the size of the saved file, not the transmission time or the image quality. The default is MMR.
 
Using the values MHS, MRS or MMRS will also cause faxes received in "low-resolution" to be saved with each scan line duplicated, and described in the headers as normal (high) resolution. This is only needed if you plan to use the received files in an application which does not support low-resolution files and shows them at half their intended height.

$var_def XCAPI_RECEIVE_FILE_CMP MMRS ; expand low-res

XCAPI_RECEIVE_NEGOTIATE_MS

[CV >C] The assignment of a millisecond value provides control of the delay before an incoming call (perhaps a voice call) is abandoned on failure to negotiate. Values below 5000 or over 45000 are ignored and the default wait is 45s (45000). Setting this value below 15 seconds risks losing some genuine fax calls.

XCAPI_RECEIVE_TIMEOUT_MINUTES

[CV >C] The assignment of a value (in minutes) to this variable will change the default limit of 30 minutes for the receipt of a fax. Assignment of values less than 5 minutes will be silently ignored and will result in the default value being used. Error 8628 results when the time is exceeded.

$var_def XCAPI_RECEIVE_TIMEOUT_MINUTES 60 

XCAPI_REPORT_B4[CV >C] When set to a non-empty value, causes the XCAPI_B4 variable to be set to indicate the B4 capability of the remote fax.  In addition, the trace with 'debug fax board' enabled shows the raw DIS bytes returned from the remote.  You will need a copy of the ITU Recommendation T.30 (see Table 2) to interpret these (or contact Copia support).

$var_def XCAPI_REPORT_B4 ; normally not needed

XCAPI_SEND_FILE_CMP [CV >C] Assignment of a compression value MH, MR or MMR to this variable overrides the default compression with which a fax is transmitted, which is taken from the TIF header of the first or only file in the transmission. The compression affects only the size of the file sent, and therefore the transmission time, but not the image quality. For documents converted to faxable TIF by CopiaFacts, the compression defaults to MMR, otherwise known as CCITT GROUP4 or ITU T6.  If you receive TIF files to be faxed which have lower compression, we recommend setting this variable to MMR, because re-compressing the file (if needed) will take less time than sending it with poorer compression.
XLS_KEEP_NL[CV >J]  A non-empty value in this variable causes newlines to be preserved in XLS cells of a broadcast list.  This allows them to be used in Word Merge fields.  While the cell data is in a BCFx variable, the newline is replaced by a paragraph character ¶ if FS file encoding is not Unicode, or a Unicode line separator U+2028 (which may show as a square in some fonts) if FS file encoding is UTF-8 or Unicode.  The newline is restored in the Word Merge temporary data source.

$var_def XLS_KEEP_NL yes

XLS_OPTIONS[CV >J] This variable provides options for sheet and row selection to control either the built-in Excel file handler, or Excel, for broadcast lists.  See the Using Excel topic for details of the supported keywords.  For use with FFBC, the variable can be specified in the template file.

$var_def XLS_OPTIONS "AllSheets ExcludeHiddenRows"