Please enable JavaScript to view this site.

CopiaFacts Reference Manual

TCOST [SRO] 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.
THUMB_BLANK[CV >U] the pathname of a full-page A4 or Letter sized faxable TIF file may be assigned to this variable before the application support function CreateThumbnail is called. This image will then be used to create the thumbnail when the source TIF document is missing or invalid. If loading the specified image also fails, the function will return 'F' to indicate failure.
THUMB_CUSTOM[CV >U] a complete Windows command-line can be assigned to this variable, and will then be called when the custom keyword is specified on the CreateThumbnail application support function. In the value, %1 will be replaced by the first function parameter and %2 will replaced by the second function parameter. If %1DEL is used instead of %1, then the file named in the parameter will be deleted after the command has been executed. The file extension of neither file is checked when a custom conversion is specified. See this topic for an example.
THUMB_REPLACED[CV <U] This variable will be set to a non-empty value when the application support function CreateThumbnail has either substituted a blank page or the document specified by THUMB_BLANK on finding the source document to be missing or invalid.
TIF_X200[SW] If set in FAXFACTS.CFG to any value, this variable causes fax files containing pages with resolution 200x200 or 200x100 to be corrected to 204x196 or 204x98 respectively, before attempting transmission using BladeWare, for which those resolutions are rejected.  Note that only the resolution values are changed and the image is not re-rasterized. On a receiving fax machine that accurately renders a received image, it will therefore be subject to slight distortion.
TIME_MS [SW] If set to 'Yes' (or any value other than one starting with 'N' or 'n')  then times on the PAUSE_TIME, PLAYLENGTH, PLAYSTART and PLAYSTOP 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 [SWS CV >G] A value in hours may be assigned to this variable to modify the date and time returned by the DATE0 to DATE9, DATE_L, DATE_S, DATE_C, DATE_J and TIME1 to TIME4, TIME_C variables by adding the specified number of hours (or subtracting if the number specified is negative). This allows time values in fax headers and notifications to reflect a different time zone. The number of hours offset must be 48 or less. The offset only affects a single call. 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.  This variable does not affect TIMEUNIX. The calculated value in minutes can be retrieved in the TIMEOFFSET_MINS variable.
You may also assign to this variable the keyword DEST (if a phone number is present in the FS file) or the State, GMT or country-code options described under $fax_send_time. This automatically calculates the offset from your local time based on the destination phone number, GMT time-zone, or state/province abbreviation. A country code with a leading + sign can also be explicitly entered. Be sure to use an = on the $set_var command to avoid an arithmetic operation being inferred.
The value can be assigned in a USR or FS $var_def command, or in a script using $set_var.  In the latter case, if you use an absolute value of hours or minutes, you must use an = sign in the  command:
       $set_var TIME_OFFSET = -1    ; adjust times by one hour
       $set_var TIME_OFFSET = CA    ; adjust to California time
       $set_var TIME_OFFSET = +1415 ; adjust to 415 area US area code
       $set_var TIME_OFFSET = +44   ; adjust to UK time
       $set_var TIME_OFFSET = +612  ; adjust to Sydney, Australia time
TIMEOFFSET_MINS[SRO]  This variable contains the offset in minutes set by or calculated from the assignment to TIME_OFFSET.
TIMEx [SRO] from system time:
TIME1 HH:MM        (example: 17:30)
TIME2 HH:MM:SS        (example: 17:30:00)
TIME3 HH:MMxx        (example: 05:30PM)
TIME4 HHMM        (example: 1730)
TIME_CThe custom format set in SF_TIME_FORMAT is used (with optional locale override CF_DATELOCALE)
TIMEUNIX[SRO] The (UTC) date and time expressed as seconds since 1970-01-01T00:00:00Z ISO 8601.
TITLE [SRO] title from $title_line.
TLS_OPTION[CV >E] This option value modifies the validation of certificates presented by a remote mail server for TLS transmission of outbound e-mail.  The current additive option value settings are shown in the TLS options documentation for EMSETUP.  Note that a value of 0 disables all the 'ignore' options; to disable all the validations, you need a value of -1.
TMPV_User variables with this prefix to their names are not written to an FS file created in the COPIAFACTS program. They may therefore be used for temporary variables which would not be needed if the FS file has been retried.
TOLL_FREE[SRO] expands to TF if the destination number has been detected as toll-free following phone-mask processing, or empty otherwise.  If an $outbound_tf_ani or OB_TF_ANI has also been defined, it will then be used as ANI for the outbound call.
TOSEND [SW] A number between 1 and the highest TOSEND number may be assigned to this variable, only during a fax-on-demand request, to select one of the additional TOSENDx directories specified in the $request_dir command.
This variable should not be set during an outbound call: it will not be effective.  Use $retry_tosend or $retry_delays to change the priority of an FS file on retry.  Before the first attempt, the TOSEND queue can only be changed using an action group based on its destination, or overridden during launch.
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' FoD call determines which directory the FS file will be written to. In a normal 'onecall' FoD 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.  To find the TOSEND queue number from which an FS file was loaded, use variable FS_TOSEND, not TOSEND.
TOTAL_RECEIVED [SRO] Contains the number of transmissions received in a mailbox, at the time of infobox post-receive processing.
TPAGES [SRO] At transmit time, contains the number of pages to be sent, including the cover sheet, if any.  See also Fax Page Counters.  Note that you cannot use this variable on the first page of an ASCII_TEMPLATE file because the number of continuation pages will not have been determined at the time the first page is completely processed.
TR_RESULT[SRO] Records the result code from a Diva call transfer.
TRACE_EMAIL[CV >C] A string value assigned to this variable will be copied to FFTRACE (if it is running) during e-mail operations. This only happens if CF9EMAIL 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 [SW] 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.  See also $trace_line, which allows more control over custom tracing.
TTS_...Variable names starting TTS_ are used internally by the Text To Speech implementation.  All such variable names are reserved names, but may be used by user applications.
TTS_BEFORE, TTS_AFTER[CV] These variables are referenced in each of the provided standard voice prompts (SVPn.XML).  They may be used for example to define a prosody element to alter the pitch or the speaking rate of all prompts.
TTS_OPTIONS[CV] This variable contains one of more of the keywords IsXML, IsSSML, NoXML, or SAPI.  For details, see the descriptions in $tts_text and $tts_file.
TTS_PREFIX, TTS_SUFFIX[CV] These variables are available for use in the digits playback file and in an amounts playback file, and correspond to the values set from the $play_var prefix and suffix parameters, originally used to control the output of the CopiaFacts Phrase-Speaking feature.
TTS_VALUE[CV] This variable contains the value used by the digits playback file DIGITS.XML
TTS_VOICE[SRO] This variable returns the name of the speaker file selected by the TTS engine, after a phrase has been spoken.
TXBAUD[CV C>] 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[CV C>] These values are written as user variables into the FS file after each transmission attempt, and into the MCF file after receipt of a fax.  They contain respectively the date (MM/DD/YYYY) and the time (HH:MM:SS) of the end of the transmission. The values are also available at post-process and post-receive process time in a script.
TX_SIPCALLID[CV C>] Set after a BladeWare fax transmit operation is complete, this value contains the SIP Call ID value of the most recent attempt.