Most users will not need to change the pre-defined classes, which for voice, fax, and poll calls are as follows:
| A | Call placement: no Answer |
| C | Call placement: Call failure other than no answer, busy, no dial tone |
| D | Call placement: no Dial tone or no circuits |
| E | System Error: missing files, etc |
| F | Fax transmission failure |
| H | Fax failure at receiving station, e.g. remote Hang-up |
| I | Special 'ignore failure' class, which is always retried, and therefore for which delays cannot be set |
| J, K, L, M, N, O | User defined |
Different categories apply for e-mail calls:
| I | Special 'ignore failure' class, which is always retried, and therefore for which delays cannot be set |
| J, K, L, M, N, O | User defined |
The Retry Parameters File
If you wish to change the description or outcome class for an outcome code, you must specify a custom retry parameters file and name it on a $retry_parms configuration command. This file should be created using the supplied file CF9.SMR as a pattern, but with a different name. The file is editable with a text editor such as Notepad and has comments at the top describing the syntax.
 | If you delete unwanted entries (for example for hardware or ports you do not use), it is important to check that you have a full set of entries if your hardware changes. You should also compare your custom file to the latest CF9.SMR file after every upgrade, to ensure that you add any entries for new outcome codes. |
| An abridged version of the retry parameters file, (CF9_ABRIDGED.SMR, is also provided provided, which can be named on a $retry_parms CFG command. This omits outcome codes for boards and features which are no longer supported. It makes maintenance simpler, and may save a millisecond or so on lookups. |
The supplied CF9.SMR file is a sample only. Its contents correspond to the internal tables which are actually used by the COPIAFACTS program. The COPIAFACTS program makes no use of CF9.SMR in its operations, and editing this file has no effect on retry operations. The CF9.SMR file is used (and is overridden by a $retry_parms custom SMR file) to translate outcome codes to descriptions in some other programs such as STATUS, JOBADMIN and job data extraction applications.
The fields are as follows:
| Outcome Code | The status code corresponding to the call placement outcome or the fax transmission outcome. |
| Outcome Type | This special code is used to indicate that an entry is to be used only for fax-call placement, voice-call placement or poll-call placement. For example a call outcome indicating detection of a remote receiving fax machine would signify success for a fax transmit call, but failure for a voice call or fax poll call. Smart Retry is not yet implemented for voice and poll calls. |
| Outcome Class | The class letter you wish to allocate for this outcome (A to H, I, J to O, S or Z). |
| Page Adjust | A value of +1 or -1 to adjust the page-count for specific error outcome codes. You would use a value of +1 for an error code which is returned by the fax board (between pages) in which the preceding page has normally been sent correctly but not counted by the board interface. You would use a value of -1 for an error code normally signaled late by the board interface, after an incorrectly-sent page has been counted as sent. The successful use of this field is an art, not a science: its use may only be recommended if your fax recipients tend to have particular types of machine (e.g. home or office fax machines). A -1 value can also be used to forcibly fail a transmission for which an error code is reported even when the correct number of pages has been reported as sent (which normally causes success to be assumed). |
| Retry Action | A special action code to modify the retry operation: |
| 1 | the retry is to be sent all at the resolution of the first page. This code is useful if the outcome indicates that the remote fax is one of those which cannot change resolution during a transmission. |
| 2 | the retry is to be sent all at low resolution. |
| 3 | automatically override the outcome class to B (busy) for quick call drops when using an ATA. |
| 9 | the channel is to be taken out of service. This code should only be applied when the error outcome is specific to a telephone line, usually an analog line. |
| 101-115 | these codes are used to specify that the retry (and subsequent retries) are to be done in TOSEND1 to TOSEND15 respectively after this outcome has been encountered. A value greater than 100 plus the maximum defined TOSEND queue folder will be rejected and CopiaFacts will not start. A $retry_tosend command will be added (or replaced) in the FS file to ensure that subsequent outcome codes which do not specify a TOSEND folder do not cause the selected folder to change. You should be careful when using this option that a retry channel group is not also specified with a group which not configured to handle the wanted TOSEND queue. |
The use of a special retry parameters file is specified using the $retry_parms command in the CopiaFacts configuration file. A different file may be specified for each channel group.
Note that CF9.SMR lists for convenience a number of codes which can arise on receive operations only. These are for reference only and have no connection with 'retry' procedures.
