Click or drag to resize
* Logging

[This is preliminary documentation and is subject to change.]

The TOPICA Framework implements three kinds of logging:

Log name

Description

Purpose

User interface (search)

Configurable

Transaction Log

Structured information on all basic transactions / events in the framework.

The structured information contains keys to the related objects. This makes it easy to search for and link to the objects.

Typically, national legislation REQUIRES logging of access to health care data - the Transaction Log exists to fulfil this requirement.

Naturally, this log may also be used for debugging purposes.

Yes.

No.

Always on - CANNOT be turned off.

Performance Log

Collects elapsed times for each page display (server- and client-side).

Primarily: performance optimization.

Secondly: debugging.

Yes.

Yes.

Per default, logging server-side times is ON, logging client-side times is OFF.

Log4net log

Useful for debugging "custom" server-side code (e.g. custom webservices and custom webforms ).

The application developer must call the Log4Net-API in strategic places in order to create log entries.

The TOPICA framework writes to the Log4Net-log in a few select places (used for debugging the framework).

This log contains less structured information than transaction log and the performance log. Basically, the Log4Net log only contains time stamps and text strings - which makes searching difficult.

Primarily: debugging / recording errors.

Secondly: performance optimization.

No.

In the simplest scenarios, Log4Net is configured to write to text files (on the web server).

When set up to log to database table, the configurator may design a report to display data logged by Log4Net.

Yes.

Per default, Log4net logging is OFF.

Different log levels (FATAL, ERROR, WARN, INFO, DEBUG) and destinations (text files, database table) may be configured.