[SRW] These variable names are special only when used on a $set_var command in a $type decision infobox. Since release 7.110 such variables have been saved in the subsequent normal log records for the transaction; however the $log_options keyword datadoc causes a special log file record to be written with the value in the in the named field. In this mode, if you assign more than one of these values in the same IIF, only one log record will be generated. If you assign values in more than one IIF, multiple log records will be generated. The log file records will have a D in the fourth flag position (see Transaction Log File Format). Values will be truncated if necessary to fit in the field. There are an additional five fields (DATA5 to DATA9) available if you use the $log_field command. Assignments to all these fields are recorded in the FS file generated for a callback as well as in the log records as already documented. Assignments at request time are not carried through to the later log records which report fax transmission data; in these records the DATA2, DATA3, and DATA4 fields may carry additional data about the transmission. The use of these fields in this way is different for different fax boards (see Transaction Log File Format). For fax broadcasts, where the $fax_origin code in the FS file is user_request, you may assign values to the DATAx fields using $var_def commands in the FS file. In this case any such assignment will override the use of the same field for fax-board-specific system data such as call seconds.
The four digit year followed by the three-digit day number in the year (example: 2015359)
[SW] Assign an action string to this variable to perform an action on the current database file associated with the line. See Database Interface in the Features chapter for examples of using a database.
[CV >D] Override the timeout for database queries or stored procedures that do not return record sets.
[CV >D] Override the timeout for database queries or stored procedures that return record sets
[SW] Assign a string of the form "prefix%=filename" to this variable to select the database to be associated with the line. See Extended Database Support in the Features chapter for examples of using a database.
[SRO] Receives the value (zero = success, non-zero = error) returned from CF8DATABASE after the last file specification, record selection or database action. See Extended Database Support in the Features chapter for examples of using a database.
[SW] Assign a string to this variable to select a record from the database associated with this line. See Extended Database Support in the Features chapter for examples of using a database.
[SW] Assign a value to this variable to change the number of decimal places used for currency and value items spoken using $play_var from a custom algorithm file. Using the default or override amounts playback file will reset the decimal places to the default value of 2, and the default is also restored at the end of a call. Note that the supplied sample amount algorithm files assume the default value of 2 decimal places.
[CV >J] This variable is used to specify (blank-separated) the BCF field numbers which are to be added to the target (number or address) tested in a job admin 'de-dupe' operation. A value of "none" causes no fields to be added; a value such as "3 7" causes fields BCF3 and BCF7 to be added, if there are sufficient available list columns to do so. When this variable is not set, the value specified for $fax_receiver is added. A value of "none" causes a list containing items for different named people at the same telephone number to only result in one call being made.
[SRW] Set this variable to a non-empty value from a call-control DLL to delay the answering of an incoming voice call on Diva or TE-Systems. The call proceeds until there is an operation such as playing a message or linking to another line, which will cause the call to be answered first. Going to state REJECT_CALL will reject the call and free the CopiaFacts line (variable REJECT_CAUSE can override the default cause code of 1). Reading the value of @DELAY_ANSWER in an infobox will return 0 if the answer is no longer pending, or was not specified to be delayed, or if the call has already hung up; 1 if the call has not yet been answered; or 2 if it has been answered but not yet connected.
[CV >J] When set to a non-empty value in a job instance, and if the job schedule date is in the future at launch time, causes a single workerbox FS file to be written instead of a full launch. When it is time to process the workerbox, it then launches the job. This can avoid large numbers of forward-scheduled files in the TOSEND folders which may delay other work. A special value of a negative integer in this variable signifies the time in minutes by which the launch will be brought forward, ahead of the scheduled launch time, to allow per-item preprocessing such as WordMerge to get started before the first transmissions. The number of minutes should be kept as small as possible to avoid defeating the purpose of this feature. Note that if you use XLS or XLSX files and specify USE_EXCEL to use Excel to read them, Excel must be installed on the engine node which will perform the delayed launch (but see also the NO_JOB_LAUNCH environment variable).
[SW] This variable can be assigned a string containing any of the keywords defined for the $delete_option command. This variable is typically used in an infobox post-process to dynamically change the settings on the command. The values given completely replace the specification on the command, and an empty string value removes all options.
[SW] Assigning a full pathname to this system variable will cause the named file to be deleted from the disk. If the pathname does not exist or cannot be deleted, no error indication is made. Use this variable with care!
[CV C>] Written into an FS file after transmission, this variable shows the actual digits dialed after phone mask and phone-account processing. This variable is now deprecated because over the years various changes have caused it to be suppressed in certain circumstances. Use DIALED_DIGITS instead.
[CV C>] Written into an FS file after transmission, this variable shows the actual digits dialed after phone mask and phone-account processing
[SRW] Contains the DID number used on the inbound call. If the CopiaFacts DID option has been enabled, you may also assign a new number to this variable to change user profiles during the call. This is only effective when the assignment is followed immediately by a $next_box command which transfers to state 117 (setup user).
[CV >C] When set to a non-empty value this variable causes standard-width TIF images of larger than A4 or letter size to be rejected as non-faxable.
[SW] This variable (you can also spell it DISPLAY_COLOUR) allows setting of the foreground and background colors in the line status display in COPIAFACTS. The value must consist of two color names separated by a comma, forward slash or pipe symbol, with no embedded space (e.g. White,Blue). The first is the foreground and the second the background color. The available names are: Black, Maroon, Green, Olive, Navy, Purple, Teal, Gray (or Grey), Silver, Red, Lime, Yellow, Blue, Fuchsia, Aqua, White. In addition you may specify any color by its hexadecimal R-G-B value (e.g. FFFFFF/0000FF for White,Blue). Invalid values (or identical foreground and background colors) result in the default black on white, which is also reset at the end of each call. The assignment to this variable may be made in user profiles, FS files, or infoboxes.
[SRW] A value can be assigned to this variable which will be displayed on the COPIAFACTS screen if the corresponding $display_box has been enabled. The value read from this variable also represents the current numeric contents of the display box. The x value can be 0 to 9 or A to H, corresponding to the fields shown in the $display_box topic.
[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 resized on the fly to A4 in a file with _A4 appended to the filename.
[CV C>] If DIVA_REPORT_B4 is non-empty, the DIVA_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.
[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.
[CV >C] The assignment of a non-empty value will disable ECM for the current Dialogic Diva fax outbound call. Note that this will also disable baud rates over 14400, which require ECM.
[CV >C] The assignment of a non-empty value will disable high-resolution faxing for the current Dialogic Diva 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.
[CV >C] The assignment of a non-empty value will disable the use of MMR (Modified Modified Read) or MR (Modified Read) fax compression for the current Dialogic Diva fax outbound call.
[CV >C] Assigning a value between 0 and 3 to this variable affects the handling of DTMF tones in a SIP/HMP environment. The default of 0 automatically negotiates the appropriate mode as RFC2833, SIP info messages, or inband depending on negotiation with the gateway. For more information on the options, please contact Copia support. This variable requires Diva SDK 5.5 and is ignored when you use CF8EN50.DLL or F7EN.DLL.
[CV >C] Assigning a non-empty value to this variable causes additional low-level fax result information to be displayed in the trace. This variable requires CF8EN.DLL 22.214.171.124 or later and Diva 8.5 SR9 or later.
[CV >C] When set to a number of milliseconds, causes a delay of this period of time on releasing the outbound half of a Diva Line-Interconnect call so that it cannot be re-used for another call before the line has completed hangup.
[CV >C] This value must be specified to enable answering machine detection for a Dialogic Diva voice outbound call or (when specified in an infobox in the original call) for the second call in a Dialogic Diva line-interconnect call. It specifies the maximum time in milliseconds that a human would speak when answering the phone. If the announcement from the called party is longer, the value retrieved in AM_RESULT will be set to 2.
[CV >C] This value must be specified to enable answering machine detection for a Dialogic Diva voice outbound call or (when specified in an infobox in the original call) for the second call in a Dialogic Diva line-interconnect call. It specifies the maximum time in milliseconds that the human speech (see DIVA_MAXHUMAN) can be interrupted for it still to be interpreted as continuous speech.
[CV >C] This value must be specified to enable answering machine detection for a Dialogic Diva voice outbound call or (when specified in an infobox in the original call) for the second call in a Dialogic Diva line-interconnect call. It specifies the time in milliseconds until the remote side starts speaking. When this timeout is reached without detecting a speaker, the value retrieved in AM_RESULT will be set to 4.
DIVA_NEGOTIATE_TIMEOUT_SECONDS [CV >C] The assignment of a value (in seconds) to this variable will change the default limit of 45 seconds to wait for an outbound fax negotiation to complete on a Diva Server board. Assignment of values less than 30 will be silently ignored and will result in the default value being used.
DIVA_PAGE_SEND_TIMEOUT_SECONDS [CV >C] The assignment of a value (in seconds) to this variable will change the default limit of 300 seconds (five minutes) per transmitted page on a Diva Server board. Assignment of values less than 60 (one minute) will be silently ignored and will result in the default value being used.
[CV >C] An assignment to this variable in the USR file controlling the receive will limit the negotiated rate.
[CV >C] Assignment of a non-empty value to this variable in the USR file controlling the receive will disable Error Correction Mode.
[CV >C] Assignment of a non-empty value to this variable in the USR file controlling the receive will cause the received TIF file to be saved with MMR (group 4) compression.
[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 on a Diva Server board. Assignment of values less than 5 minutes will be silently ignored and will result in the default value being used. Outcome 8627 results when the time is exceeded.
[CV >C] When set to a non-empty value, causes the DIVA_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).
[CV >CE] The keyword assigned to this variable specifies whether the DKIM verifier is to verify that the signed content is exactly the same (DKSIMPLE) or to tolerate common modifications such as whitespace replacement and header field line rewrapping (DKRELAXED). The latter is the default. The canonicalization can be specified separately for the headers and the body by separating two keywords with a vertical bar, for example "DKRELAXED|DKSIMPLE" specifies relaxed checking for the headers and simple checking for the body. Note that the keyword DKNOFWS (for 'no folding white spaces') is a synonym for DKRELAXED.
[CV >CE] The value is a colon-separated list of header names which specify which headers are to be encrypted (and should match their sequence in the message). You can add unused header names to the list to prevent the message from being accepted if the header has been added en-route.
[CV >CE] Specifies the Selector parameter for DKIM signing. The value is placed in the "s=" parameter of the DomainKey-Signature: header. This is a required variable for DKIM signing. It specifies which public key in the sender's DNS records is to be used by the receiving MTA to verify the message key.
[CV >CE] A non-empty value specifies that the sha-256 algorithm is to be used for DKIM signing. The default is sha-1.
[SW] To call a DLL entry-point in the currently selected DLL for the line, assign the name of the entry-point to this variable. For examples of DLL calls, see the Features section.
[SRW] Before calling a DLL entry-point, you should assign a value to this variable which will be passed to the DLL as a null-terminated string. After the DLL has been called, this variable can be read and will contain whatever the DLL has placed in the passed string buffer. Unpredictable results will occur if your DLL returns a string which is not null-terminated or which is longer than 8192 bytes (including the terminating null). If the DLL number is invalid the parameter will be set to "errorlib" and if the entry-point is invalid the parameter will be set to "errorentry".
[SRO] The integer (converted to a string value) value returned by the last DLL call. Before making a call, or if the call fails, the value is set to -1 and the DLL_PARM value will indicate the type of failure.
[SRO] Contains the same value as DLL_RESULT.
[SW] A number between 1 and 8 to select the DLL loaded with that number using the configuration command $load_dll. Or a letter 'C' to select the DLL which also contains the call control DLL entry points. The selection remains in effect for the line and for the call, until overridden by a further assignment. The number is reset (no active DLL) at the end of each call.
[SRO] The full Dialed Number Identification String available from the digital network interface.
[SRO] The part of the DNIS (Dialed Number Identification String) used for document selection in HDID type 3.
[CV JBC>] Set to the data value for the phone, e-mail or domain obtained from the launch-time, or global pre-loaded run-time, do-not-send look-up.
[CV >CE] These variables can be set (normally in the configuration file only) to provide a full pathname or look-up-table specification for each of the global 'do-not-send' files. If the value ends in '.NDX' it is taken to be a simple pathname; otherwise it is parsed as a database look-up specification as described in Do-Not-Send Files.
These specifications override the use of the standard NDX file names in the folder specified by $log_def. When you use these variables to specify the do-not-send look-up, the transmission will fail if the corresponding file cannot be found; without the variables the absence of the default NDX file causes the transmission to go ahead.
A special value of NONE will cause the corresponding do-not-send check to be skipped, and this is the only value that can be specified in a $var_def command in an FS file; any other override attempt will be ignored. A 'none' entry in an FS file may be useful when sending a fax or email to the target to confirm that the exclusion has been recorded.
The specification for domain look-ups (default DNS_DOMN.NDX)
The specification for email look-ups (default DNS_MAIL.NDX)
The specification for phone look-ups (default DNS.NDX)
[CV >J] A non empty value in this variable prevents the InsertDocument job function from rejecting duplicate filenames.
[SRO] Contains a day of week code calculated from the system date. Sunday = 1.
[SRO] Contains a 1 if there is a Dialogic telephony channel attached to the line which is not in idle state. More information about the channel state for a PRI channel can be obtained from the CC_CSTATUS variable.
[SRO] A vector of 1 and 0 digits, one for each Dialogic DTI channel, showing whether the corresponding channel is active or not. More information about the channel state for PRI channels can be obtained from the CC_STATUS variable.
[CV E>] Set to a number of milliseconds, this variable in a USR or UJP file causes a second DTMF event for the same DTMF key to be ignored if the interval between the key events is less than the specified value. Currently Diva only.