Set Options for the Log File
$log_options keyword [keyword...]
This command is used to specify logging options for the .DBF log file.
The parameter on this command is used as follows:
| keyword | one of the following keywords, separated by white space: |
| atthistz | write the attempt record outcome class as Z on failure, instead of the default which is the lower-case value of the class letter. |
| datadoc | causes the writing of 'D' log records (assignments to variables DATAx) to result in separate log records. Since release 7.110 the DATAx values have been amalgamated into the next normally-written log record for the call. |
| diddataX | causes the DID (DNIS) value to be saved in DATAx (if defined) in addition to the DID field. X may have a value of 1 or from 5 to 9 inclusive. You can define DATAx (using $log_field) to accommodate a value longer than the 4-byte limit of DID. Only one of these keywords may be used. This keyword overrides any other specification of a value for the corresponding DATAx. |
| didlsd | logs the least significant four digits of the DID value in the DID field. |
| dtiname | use the GROUPN field to log the telephony channel in use for the call. This is applicable to E-1 primary-rate ISDN applications only, where the telephony channel number and the CopiaFacts line number are not the same. |
| emtenths | log in DATA3 the number of tenths of a second of e-mail 'connect' time. |
| encoding | log the encoding method for outbound faxes in DATA2 (currently Brooktrout and Commetrex only). |
| groupnx | use the GROUPN field to contain an index (00000001, 00000002 etc.) to distinguish the records corresponding to each of the $fax_filename lines. This can be useful to identify the first or only record for a set, or if the filenames from the IMAGEN field have the same leading characters. |
| imgdata5 | causes the image name/number to be saved in DATA5 (if defined) in addition to the IMAGEN field. You can define DATA5 (using $log_field) to accommodate a value longer than the 8-byte limit of IMAGEN. |
| jobowner | use the CALLID field for the job owner name (truncated if necessary). The default is to use this field (in Job-system log records) for the Job Instance number. |
| logall | on call placement failure, write a log record for each of the documents to be transmitted. The default is to log the first document only in this case. |
| logignore | write a log record for attempts with outcome class (override) set to 'I' (ignore failure). The default is that these attempts are not logged. |
| logz | the outcome class for a final transmission attempt is shown as 'Z' in the FLAGS field. The default is to use the actual outcome class letter ('a' to 'h') with a lower-case value indicating that it is the final attempt (which resulted in the call being 'failed'). |
| nodata3 | do not use the DATA3 field at all for time logging. The default is to use it only if there is no DATA3 variable defined in the FS file. |
| nodata4 | do not use the DATA4 field at all for page-count logging. The default is to use it only if there is no DATA4 variable defined in the FS file. |
| none | the writing of the log file is suppressed. This option can be used if you are writing a custom log from infobox logic. |
| nooffhook | On Brooktrout TR1034 boards only, this option restores the earlier method of setting of both connect time and TXST time at the start of fax transmission. From release 7.336, the TR1034 interface starts counting the logged connect time for outbound calls, and sets the TXST time, from the time that a remote-off-hook is signalled in Call Progress results. If, exceptionally, the CP results cause a fax to be started but no off-hook has been signalled, the time starts from the transmit start time instead. |
| rescode | prepends the fax resolution code to the encoding method, producing for example 3MMRe for a 300x300 T6 transmission (currently Brooktrout only). This option is ignored if the encoding keyword is not present. |
| ringstart | On Brooktrout TR114 boards only, this option starts counting the logged connect time for outbound calls from the time of the last ring event before the connection was completed. If no ring events are detected (for example on an ISDN call to an ISDN fax machine), the connect start time is counted (as is the case when this option is not given) from the time that the call placement is completed and the fax transmission, if any, starts. Note that setting this option will result in some cases where a small connect time is recorded even though no connection has been made and no call charges have been incurred. This small error is offset by the greater accuracy for connect time on successful fax calls where it may take a few seconds to detect the remote CED tone before the fax is started and the connection time counter starts, and on fax calls accidentally made to voice lines, where detection of the human or other tone may take several chargeable seconds. |
| totalcall | log in DATA3 the total call time for the call on all log records for the call. The default is to log a call time for each single document (which may be estimated if the board software does not make available a per-page time). |
| totalconn | log in DATA3 the total connect time for the call on all log records for the call. The default is to log a connect time for each single document (which may be estimated if the board software does not make available a per-page time). |
| v34 | modify the codes for logging encoding in DATA2 by changing the first character to 'V' if the remote fax has V.34 capability (Brooktrout TR114 API 4.3 only). The encoding keyword is assumed and need not be added as well as v34. |
Default: (as described above for each option)
Example:
$log_options nodata3 nodata4
Topic url:
http://www.copia.com/support/refmanual/index.html?%24log_options.htm
