Application Log – Guidelines for Developers (BC-SRV-BAL)

This documentation provides a quick start for developers who want to integrate the Application Log in their applications.

Detailed documentation on all function modules, and so on, can be found in the system by executing the program SBAL_DOCUMENTATION.

Use

The Application Log is a tool for collecting messages, saving, reading and deleting logs in the database and displaying logs.

Situations can arise at runtime in application programs which must be brought to the attention of the user in some way. These are usually errors. It can also be useful to report a successful completion (this should not be so often as to overload the user with unimportant information).

We are not distinguishing here between Exceptions, Errors, Messages, etc. It is only important that information arises (usually a T100 message or a message text for an exception) that has to be logged either immediately or later. We call this information a message.

These messages are not to be output individually (with the ABAP commands MESSAGEand Raise), they are to be collected and displayed later as a log.

The set of messages is a log. A log usually also has header information (log type, creator, creation time, etc.). A transaction can generate several logs.

The Application Log provides an infrastructure for collecting messages, saving them in the database and displaying them as a log.

The application log is used to temporarily store messages. The logs should be deleted in intervals. Data that, for reasons of revision security, have to be available for a long period of time, should not be stored with the application log but with the change documents.

This Quickstart explains this infrastructure and some conventions.