Specify Delays and Processing for Retries

$retry_delays class "retry_list"

This command is used to specify the number of retries of unsuccessful transmissions, and the intervals between attempts.

Important note: this command affects all outbound operations done with this user profile, including broadcasts and server operations.

For special applications this command may also be placed in an individual FS file as an override to that in the user profile.

When processing the outcome of an e-mail attempt, if there are any $email_retry_delays commands in the hierarchy CFG - USR/UJP - FS, then $retry_delays commands are ignored for all outcome classes.  Otherwise, $retry_delays commands are used for all outcome classes. The $retry_delays commands are also used for transmissions where there are both fax and e-mail destinations in the same FS file (for example, broadcasts of type FEB2).

Each command provides the specification for one class of "outcome" of the preceding attempt. The "outcome" is the call placement or fax transmission status. The outcome class is looked up in the default retry parameters or those in the file specified using the $retry_parms command. The outcome class is identified using a letter from A to H or J to O. You may change the meanings of these letters for special applications by modifying the retry parameters file, but the supplied files define the following outcome classes:

A Call placement: no Answer
B Call placement: Busy
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
G User defined
H Fax failure at receiving station, e.g. remote Hang-up
J User defined
K User defined
L User defined
M User defined
N User defined
O User defined

Note that for 'user-defined' entries you must also create a custom retry parameters file using $retry_parms.  The built-in default retry parameters have no outcome codes with 'user-defined' outcome class letters.

The parameters on this command are used as follows:

class Outcome class letter for this class. Only one command may be specified for each class. The next entry in the retry_list for this class is used each time a call attempt results in an outcome of this class, until the retry list is exhausted, at which time the call is treated as failed.
retry_list List of delay periods or times, one for each retry. An empty list (or no $retry_delays command for a class) implies that any attempt which has an outcome of this class will not be retried at all (i.e. it will be treated as a failed call). The default unit for each list entry is minutes, but a suffix of H or S can be used to specify hours or seconds respectively. The following prefix letters may also be used (in any sequence if more than one):
Aindicates that the alternate phone number or alternate e-mail address should be used for the attempt. If no alternate phone number has been specified, the regular phone number is used. For example a specification "A5 5 A5 5" would make four retries at five-minute intervals, alternating between two phone numbers. This feature may be used when a recipient is known to have alternate fax phone numbers which can be used interchangeably; or it could be used, on the last delay value only, to specify a fax forwarding service to be used when all the other retry options have failed. To cope with this last situation, it is also possible to specify an 'alternate cover sheet' using $alternate_cover which is to be used when the alternate phone number is selected.
Eindicates for a fax transmission on a Diva Server board only, that error correction mode (ECM) is to be suppressed for the attempt.  This prefix is deprecated: use a variable group as in this example.
Iindicates for an e-mail operation that the ISP specified in EMSETUP is to be used as a mailserver for the attempt.  The retry class which contains 'I' prefixes should be selected in a custom SMR file for outcome codes for which this option makes sense.  For example a missing attachment (outcome code 150) is always going to cause a failure, whatever routing you specify for it.
Gn/activate variable-group n on the next retry (where n is from 1 to 15).  If this option immediately precedes the delay value, use the / delimiter to separate them. See this example of using this feature in conjunction with $action_phone.
Pindicates that the second TOSEND directory (priority) on the $retry_tosend command is to be used for this attempt.  This prefix is deprecated: use the T prefix instead to specify a TOSEND directory explicitly.
Tn/perform the next retry in directory TOSENDn (where n is from 1 to 15, or to the value specified on the $request_dir command).  If this option immediately precedes the delay value, use the / delimiter to separate them.  In a Job Administration environment where Extended TOSEND Queues are in use, the change will only be processed if the defined content for the queue is compatible with the job item.
X Y R Q inserts a $convert_options command in the FS file to change the options for the next attempt after a Document Conversion failure.  The Y code adds option InterPDF; R adds option ResConv; Q adds option QPDF; X removes these three options.  The base value for the options is taken from the USR or UJP file.  The values set will remain in place for remaining attempts unless further prefixes from this set are applied for subsequent attempts. You should us a pair of prefixes, X followed by a new prefix, to reset the options on a subsequent attempt, as in the example below.

If the delay is entered as a time (hh:mm format), then the retry will be deferred until the next occasion on which that time comes around on the clock (i.e. later the same day or earlier the next day). If this absolute time has a suffix of N or W then the calculated time will be moved forward if necessary to the next non-working or working day respectively. Standard and special non-working days are set using the COPIAFACTS program. Once a fixed-time delay has been actioned, any later fixed-time delay in the sequence of retries will be replaced by a three-minute delay.

The fixed time delay (or the N or the W) may be followed by a slash and a number of minutes for which the delay is 'conditional'.  In other words a value of 09:00/20 will be taken to mean "Delay until the next clock occurrence of 9 a.m. UNLESS the clock time is between 09:00 and 09:20, in which case used a standard 3-minute delay".

The delay period is used to specify the earliest time at which the next attempt will occur: the call will then be retried when there is first a suitable free line after the delay period. Note that attempted calls in and to certain countries may be subject to minimum delay intervals in order to comply with local regulations.

If the 'A' prefix is used and no alternate phone number exists for the call, then for certain ISDN telephony boards an alternate method of placing the call may be used. Consult Copia or your CopiaFacts reseller about the use of this facility for special purposes.

An ellipsis ('...'), separated by white space from the previous entry in the retry-list, causes the preceding retry delay specification to be repeated without limit. If there is no preceding retry delay specification in the list the ellipsis is treated as ending the list and the call fails. If the preceding delay specification specifies a time of less than one minute it is automatically increased to one minute.

Separate attempt counters are maintained for each class, so that for example a no-dial-tone outcome in the middle of a sequence of busy outcomes will only affect the next retry; a subsequent busy will revert to being processed following the specifications in the retry-list for the busy class. The attempt counters for a transmission are maintained using the $attempt_record commands added to the FS file on each attempt.

Default: As specified by the $retry_delays configuration commands. The commands in an owner UJP are also overridden by those in the SYSTEM.UJP file.

Examples:

Retry 'no answer' three times at intervals of five minutes:

$retry_delays A "5 5 5"

Retry 'busy' four times at intervals of two minutes, using the alternate phone number (if available) every other time:

$retry_delays B "A2 2 A2 2"

Retry 'busy' once after waiting three minutes, then if still busy wait for 8 hours and retry again up to three times at three-minute intervals:

$retry_delays B "3 8H 3 3"

Retry 'busy' once after waiting three minutes, then if still busy wait until 9 a.m on the next working day and retry again up to three times at three-minute intervals:

$retry_delays B "3 09:00W 3 3"

Ignore no-dial-tone and always retry the call until a line is found with dial-tone:

$retry_delays D "1 ..." ; (note space preceding ellipsis)

Fail the call on system error:

$retry_delays E " "

Retry fax transmission errors once, after five minutes:

$retry_delays F 5

After one normal retry, suppress Diva ECM and use TOSEND6 for subsequent retries (TOSEND3 is used for normal retries):

$retry_tosend 3 6

$retry_delays F "5 EP5 EP5 EP5"

Do the first two retries in TOSEND10, then revert to TOSEND3:

$retry_tosend 3

$retry_delays F "T10/5 T10/5 5 5"

With conversion outcome 692 overridden in a custom SMR file to have outcome class J (the default is Z), retry a PowerPoint failure immediately (10 seconds) with convert option InterPDF:

$retry_delays J "Y10s"

With conversion outcome 691 overridden in a custom SMR file to have outcome class K (the default is Z), retry an Excel failure immediately (10 seconds), first with convert option InterPDF, then with convert option ResConv:

$retry_delays K "Y10s XR10s"

Do retries using standard reducing baud rates (see Action Codes and Variable Groups) but also use TOSEND7 for last retry:

$retry_delays F "G1/2 G2/2 T7G3/2"