Skip to main content

TCOSS Break Codes and retries

Article # 3036094 - Page views: 61


In TCOSS, every message that runs into an error gets a certain amount of retries, before it is put in either "Inactive Problems" or "Canceled" state (depending on the termination settings). The amount of retries is defined by the type of error the sending module (Link, Fax channel, TCOSS) has encountered.

Technically there are 5 types of "retry patterns" defined, the so called BREAK codes. The type of error defines which BREAK code category is taken.


BREAK code retry behaviour is defined either in the specific channels used for sending (e.g. FAX channel) or the hidden TCOSS channel "ATAMCONFACTC" (used for Link generated messages f.e.). The config lines in question are 43 - 47.

For example, the default for the ATAMCONFACTC channel, these configuration lines have the following values:

43 '87654321-,
44 '87654321-,
45 '-------1-,
46 '-------10,
47 '--------0,

Default values for FAX or other channels might vary.

The first line is the definition for BREAK 1 while the last is BREAK 5.

Basically, a message that gets an error which puts it in either BREAK 1, 2 or 3, will never be set to "Inactive Problems" or "Canceled". Only messages with errors that fall into category BREAK 4 or 5 will stop being sent out.

To explain more in-depth:

There are 10 "states" of retries a message can have. Each new message is sent with 9 retries left. If a message has a failed send attempt, corresponding to the BREAK code it received, it searches one of the 5 lines for the next status. The positions in the lines correspond to the retry amount a message had left.

Position 1 would correspond to a message, that had 9 retries left. TCOSS will check the first position, if there is entered a digit or a dash "-". If its a digit, this will become the new retry count. If it is a dash, it will be ignored and the next position is searched. If no further digits are found, the retry count does not change.

In addition to the number of retries, the actual "number" of the retry itself also has influence on the time TCOSS waits between retries.

The time interval between two send attempts is calculated in minutes according to the following formula:

                                                 (9 – new status) * (9 – new status) * (ASC(config value) – 48)
time interval = --------------------------------------------------------------------------------------------[minutes]

where "ASC(config value)" is the ASCII value of the character entered in the config line 13.
For more details on this, please see the TCOSS Application Module Manual chapter "Send Status".

Below you can see a table that describes errors and the corresponding BREAK codes:

Error Code Description Similar UTF     Break Code
Error Code Normal ext. Dialing
IA Call collosion XA 1 1
IC No channel available XU 2 1
IF No answer from distant station (time-out = config line 26) XF 2 1
II Error in selection number XI 5 5
IJ No connection to local exchange (layer 1 or lower layer protocol problem) XJ 2 1
IN Wrong number (number changed, call barred, ..) XL, XU 5 5
IS Service or Function not supported by network or user - 5 5
IP Procedural error - 5 5
IU User Busy XU 2 1
IX Unknown error - 2 1
X0 call collision in layer 7   1 1
X1 attempt to send an empty document   5 5
X2 error when opening back-recieved file   5 5
X3 error in back reception   5 5
X5 error during reception   y) y)
X8 At least one recieved page has not confirmed   y) y)
X9 failed to send chained document (G send switch)   2 1
XA call collision in layer 6   1 1
XB data error within TCI-block   5 5
XC form buffer is out of memory   5 5
XE Error during 2nd dial stage with DMTF   3 3
XG recieved not ready timeout   4 4
XF no answer from the distant station   2 1
XH line occupied by local telefax unit   1 1
XI error in selection number   5 5
XJ no dial tone   2 1
XK answer back mismatch   5 5
XL no answer from distant telefax   5 1
XM illegal identification od called station   4 1
XN illegal response during training phase   4 1
XO three learn attempts unsuccessful   4 1
XP illegal page confirmation   4 1
XQ page transmitted incorrectly   41) 41)
XR illegal frame recieved   4 1
XS unable to find appropriate baud rate   4 1
XT no response recieved   4 1
XU busy or no dial tone on PBX connection   2 1
XV unexpected end of document   y) y)
XW to many line distortions at training sequence   y) y)
XX illegal identification recieved   y) y)
XY no command recieved   y) y)
XZ illegal command recieved   y) y)
Y0 the receiving fax machine does not support fax sub-addresses   5 5
Y1 the specified fax sub address is too long (max. 20 digits are allowed)   5 5

break code for transmission
break code for extended dialing mode (switch x)
y) error code for reception only

  1. Fax channels on TC29/32/33 hardware uses break code 3 instead of 4 if error XQ happens

Level of Complexity 


Applies to  

Product Version Build Environment Hardware
Kofax Communication Server All      


More information can be found the TCOSS Application Module Manual, this manual can be found in the documentation section


  • Was this article helpful?