Skip to main content
Kofax

Trace guidelines for Link Problems

Article # 3038319 - Page views: 39

Issue

What can I do when I have problems with the message transfer over TC/Links?

Solution

When you have problems sending a message over a Link and the non-delivery notification does not yield enough information, then you have to enable traces for the Link or the ‘Link Document Converter’ (TCDCLINK).

These traces have to be activated in the Windows Registry.  Go to: “START” -> “Run…” -> enter “regedit”.

All Link registry keys are located in this registry hive:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\

followed by the name of the affected Link instance.
E.g.: registry settings for a TCLINKMX:

Registry settings for a TCLINKMX

For general problems, the following trace settings are recommended:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\General\Tracelevel           = 0xFF (hex)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\General\MailDebug          = 0x01 (hex)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\General\TraceSmall         = 0x01 (hex)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\Topcall\TCSIDebug          = 0x01 (hex)

In addition, if you have some larger throughput over this Link, you should also increase the trace file size and amount of trace files. 
To do this, change the following keys:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\MaxTraceFileSize             = 0x2710 (hex) (this is 10 Mbyte)        HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\MaxTraceFiles                  = 0x0A (hex) (10 files)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\AppendTrace                    = 0x01 (hex)

Be sure to check your available disk space, as 10 files at 10 Mbyte consume 100 Mbyte of space (and this applies to every link for which you have enabled these traces).

After making the needed changes in the registry, stop and start your Link process in the “KCS MONITOR” and try to reproduce the problem.

Then backup the trace file(s) that cover the timeframe of your test. 
The trace files are located under ‘C:\TCOSS\Trace’ and are named like the Link instance followed by a number. 
In the case of a TCLINKMX, this would be ‘TCLINKMX0.trc’ up to ‘TCLINKMX9.trc’, because we configured 10 files.

If you want to limit the amount of traces that need to be copied away and you’re not sure in which of the files the problem is located, then you can stop the Link, delete all related trace files, start the Link, reproduce the problem and then stop the Link again to copy the newly written traces away.  In this way it is guaranteed, that only the necessary timeframe is covered.

Special cases

TCDCLINK

When you have problems during the document conversion, and the normal Link trace doesn’t provide you with enough information, you can also enable the trace for the document converter, the TCDCLINK.

You can find the settings for this under the TCDCLINK sub key in the TOPCALL registry hive. To enable the trace, set:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCDCLINK\Tracelevel                        = 0xFF (hex)


Restart the TCDCLINK and TCLink after making this change.
These traces are also stored in the normal directory and are named TCDCLINKx.trc.

As with the link trace, the TCDCLINK trace also has the possibility to stretch over more trace files.  File size and amount can be increased:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCDCLINK\MaxTraceFileSize           = 0x2710 (hex)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCDCLINK\MaxTraceFiles                = 0x0A (hex)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCDCLINK\AppendTrace                  = 0x01 (hex)

When you have problems with corrupted files, or you are unsure if the file passed through TCOSS really matches with the input file, you should set the following:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\General\TraceSmall         = 0x00 (hex) (default is 0x01)

With this setting, every file attachment that goes through the link has its binary dump stored in the trace before and after message conversion. 
Please beware that setting this key to 0 will dramatically increase the trace output, so be sure to set the trace size according to the size of the file attachment. This means that you should increase the maximal file size and amount of trace files accordingly.


In the following sections, trace settings for specific links are described.
These additional traces are also stored in the TCLINKxxyy.trc files.

TCLINK-SM based Links (SM / MX7 / SC7 / MFP / OC / SDD)

As these Links are based on an SMTP connection, you have the possibility to also trace the native SMTP communication as output in the trace.  This can be especially interesting, if you want to know how the message exactly arrived at the Link.

To do this, you have to set the following registry key:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKxx\TCLSM\TCPTrace            = 0x01 (hex)

As this is a complete SMTP conversation dump, trace output will be large when attachments are sent over SMTP.


TCLINK-LN

For the TCLINK-LN, there is a special trace for the communication with the NOTES API.  This can be enabled by setting the following key:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKLN\NOTES\TraceLevel         = 0x64 (hex) (=100 decimal)


TCLINK-SC

For the TCLINK-SC, there are some settings which enable more trace possibilities in the SAP direction.  Not all of them are set in the registry though:
In the registry you have to switch off TCSIDebug.

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKSC\Topcall\TCSIDebug        = 0x00 (hex)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKSC\SAP\TraceLevel              = 0x07 (hex)


In this file: ‘C:\tcoss\tclp\SAPRFC.INI’ set ‘RFC_Trace=1’ (2 sections for each TC/LINK-SC instance, set to 1 in both sections)

With this change in the SAPRFC.ini you will then, in addition to the normal Link trace file, get in the ‘C:\TCOSS\TCLP’ folder some RFCxxxxx_yyyyy.trc files.
The x and y represent an ascending number.
Additionally there may also be some DEV_RFC.trc files. Both of these file are created every time some trace needs to be written. This means, the trace may fill up the disk.  It is possible to limit the size of the DEV_RFC.trc trace file, by adding “RFC_MAX_TRACE=1” (size in MB) to every section in the SAPRFC.INI file. The trace will grow until the desired size and then does not grow any further.  Unfortunately, it is not possible to limit the RFCxxxxx_yyyyy.trc trace files.
 

TCLINK-MQ

The TCLINK-MQ also has some special trace settings, which can be enabled.  This is done by setting the following registry keys:

HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKMQ\General\Tracelevel        = 0x1fff (hex)
HKEY_LOCAL_MACHINE\Software\WoW6432Node\TOPCALL\TCLINKMQ\Options\MQTrace          = 0x01 (hex)

Level of Complexity 

Moderate

 

Applies to  

Product Version Build Environment Hardware
Kofax Communication Server All      
  • Was this article helpful?