Logging possibilities

Last update: 7 February 2018

There are multiple logging mechanisms for Fabasoft Folio that can be activated in order to make analysis easier

Information

In this section the logging possibilities and the way to activate them are listed.

Conversion Logging

If you encounter problems while converting documents then you can enable the conversion logging mode to log the SOAP-requests of the conversion to the file system.

Conversion Logging saves the input and output files of a conversion to a directory to analyse the transfered data. In the directory you find the input.* file and the converted output.* file. If no output-File exists, conversion has failed.

The logging can be activated both on the Fabasoft web server and on the Fabasoft conversion server, depending on which part shall be analyzed. The activation and deactivation of this logging can be done live.

Note: Please be aware of possible performance issues during conversion when logging.

Registry Keys

To activate the logging you have to create the key

KEY_LOCAL_MACHINE\Software\Fabasoft\FSCCONV@1.1001

and add the following values:

  • LogDetailFolder (REG_SZ) with "Value Data: e. g. <"c:\Test">
    This specifies an existing folder on the file system where the logging information should be placed.
  • LogDetailCount (REG_DWORD) "Value Data: e. g. <"5"> within this key. (5 procedures )
    This specifies the number of logging entries to be made. This value is decremented each time a conversion operation is logged. If the counter reaches zero, the logging mode will be disabled
Microsoft Windows

On a Microsoft Windows Server you may use the following registry key:

Note: This parts are exports of Windows Registry. In case you edit the Registry with regedit.exe, use single backslash for path assignments.

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Fabasoft\FSCCONV@1.1001]
"LogDetailFolder"="c:\\temp"
"LogDetailCount"=dword:0000005
Linux (starting with Fabasoft Folio 2016)

On Linux with Fabasoft Folio 2016 or higher, use the following commands to enable the logging

su - fscsrv
fscsrv> mkdir /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FSCCONV@1.1001
fscsrv> mkdir /tmp/conv-logs
fscsrv> echo -n "/tmp/conv-logs" > /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FSCCONV\@1.1001/LogDetailFolder
fscsrv> echo -n "10" > /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FSCCONV\@1.1001/LogDetailCount 
Linux (prior Fabasoft Folio 2016)

On Linux with Fabasoft Folio prior Version 2016, use the following commands to enable the logging

su - fscsrv
fscsrv> mkdir /etc/fabasoft/settings/machine/Software/Fabasoft/FSCCONV@1.1001
fscsrv> mkdir /tmp/conv-logs
fscsrv> echo -n "/tmp/conv-logs" > /etc/fabasoft/settings/machine/Software/Fabasoft/FSCCONV\@1.1001/LogDetailFolder
fscsrv> echo -n "10" > /etc/fabasoft/settings/machine/Software/Fabasoft/FSCCONV\@1.1001/LogDetailCount 

Created Files

output description
input.* Source file of the conversion
output.* File created in the conversion (if not existent the conversion failed)
status.log Status log of the conversion progress

SOAP Logging

If you encounter problems with a business application integration via SOAP you can enable the OWS logging.

In the LogDetailFolder, one folder, containing the received and sent XML files as well as the accompanying HTTP header, will be created for each SOAP call received by the web server.

Note: Please be aware of possible performance issues during SOAP calls when logging.

Registry Keys

To activate the logging you have to create the key 

 HKEY_LOCAL_MACHINE\SOFTWARE\Fabasoft\FSCOWS@1.1001

and add the following values:

  • LogDetailFolder (REG_SZ) with "Value Data: e. g. <"c:\Test">
    This specifies an existing folder on the file system where the logging information should be placed.
  • LogDetailCount (REG_DWORD) "Value Data: e. g. <"5"> within this key. (5 procedures )
    This specifies the number of logging entries to be made. This value is decremented each time a SOAP request is logged. If the counter reaches zero, the logging mode will be disabled
Microsoft Windows

On a Microsoft Windows Server you may use the following registry key:

Note: This parts are exports of Windows Registry. In case you edit the Registry with regedit.exe, use single backslash for path assignments.

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Fabasoft\FSCOWS@1.1001]
"LogDetailFolder"="c:\\temp"
"LogDetailCount"=dword:00000005

Linux (starting with Fabasoft Folio 2016)

On Linux use the following commands to enable the logging

su - fscsrv
fscsrv> mkdir /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FSCOWS@1.1001
fscsrv> mkdir /tmp/conv-logs
fscsrv> echo -n "/tmp/conv-logs" > /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FSCOWS\@1.1001/LogDetailFolder
fscsrv> echo -n "10" > /etc/fabasoft/settings/machine/SOFTWARE/Fabasoft/FSCOWS\@1.1001/LogDetailCount 
Linux (prior Fabasoft Folio 2016)

On Linux use the following commands to enable the logging

su - fscsrv
fscsrv> mkdir /etc/fabasoft/settings/machine/Software/Fabasoft/FSCOWS@1.1001
fscsrv> mkdir /tmp/conv-logs
fscsrv> echo -n "/tmp/conv-logs" > /etc/fabasoft/settings/machine/Software/Fabasoft/FSCOWS\@1.1001/LogDetailFolder
fscsrv> echo -n "10" > /etc/fabasoft/settings/machine/Software/Fabasoft/FSCOWS\@1.1001/LogDetailCount 

Mailmerge Logging

If you encounter problems while creating serial letters with mail merge you can enable mail merge logging on the client for the current user.

Registry Keys

To activate the logging you have to create the key HKEY_CURRENT_USER\Software\Fabasoft\COOCIS and add the followin value:

  • LogMailMerge (REG_SZ) with "Value Data: e. g. <"c:\temp\mailmerge">
    This specifies an existing folder on the file system where the logging information should be placed.
Microsoft Windows

On a Microsoft Windows Server you may use the following registry key:

Note: This parts are exports of Windows Registry. In case you edit the Registry with regedit.exe, use single backslash for path assignments.

Windows Registry Editor Version 5.00

[HKEY_CURRENT_USER\Software\Fabasoft\COOCIS]
"LogMailMerge"="c:\\temp"

Created Files

output description
datasource.doc datasource of series letter (list of addressees)
series<Nr.>.doc one series letter per addressee
soapreq<Nr.>.xml one SOAP-request per addressee
soapresp<Nr>.xml one SOAP-response per addressee
template.doc template for series letters

Fabasoft Folio Plug-in

The Fabasoft Folio Plug-in writes trace statements by default. Therefore, you only have to activate the Fabasoft tracer on the client machine .

Fabasoft Folio / Fabasoft eGov-Suite software components

For each software component of Fabasoft Folio / Fabasoft eGov-Suite you can activate a logging. Just set the desired level of logging in the property "Trace" of an object of the class "Software Component" and start the Fabasoft tracer.

Note: Please be aware of possible performance issues during logging.

Other

There are various other logging possibilities and information outside the Fabasoft products like logs of the operating system (Microsoft Windows eventlog, /var/log/messages), database logs, the Process Monitor (file-, registry- and process/thread-activities) or Wireshark (network protocol analyzer).

Fabasoft app.telemetry  is a perfect tool for analyzing. Give it a try.

See also:

Further questions?