Logging events and errors: Overview

FYI, DOCUMENTS API Help refers to this topic by name and links to it.

In the Administration and Production modules, you can choose from the below logging levels, depending on how much you want to keep track of. Error level is the most basic level. The more detail you include, the larger the resulting log files:

• Error level

  Only application errors are logged.

• Application level

  Only application events are logged:

  • Errors.

  • Starting and ending the program.

  • Opening and closing the main program windows.

  • Opening and closing the databases.

• Function level

  In addition to the application-level events, these events are also logged:

  • Menu calls.

  • API calls (and events fired).

  • Production events: production task loaded, activity executed, and so on.

• Object level

  In addition to the events included in the application-level and function-level logs, this level includes changes made to program objects (solutions, documents, fields, and so on).

• Debug level

  In addition to the events included in all of the above levels, these events are also logged:

  • When function calls start and end.

  • Exceptions.

  Note: This alternative results in very large log files. It is only for advanced debugging.

You can also specify whether the log information is stored to file or in the Windows Event log.

The log files have an XML structure so that you can more easily pick out specific messages, such as errors. You can view these files using Notepad. However, the XML structure is more beneficial when you view them using a web browser or XML viewer.

The Invoice modules also have logs: Error logs for Invoice modules

Related topics

Location of log files

Setting up logging

Clearing log file information

Viewing document audit trail records

Viewing system audit trail records