JADE User Manual - Logging & Notification

Introduction

JADE comes with a number of optional logging and event-triggerred notifcation

Logging is specified in the JADE XML hierarchy in the General branch of the configuration, which is used to specify parameters that are neither related with specific file transfer operations.

• General
  • History
  • BackgroundService
  • Logging
    • LogFile
    • Log4JPropertyFile
    • DebugLevel
    • ProtocolCommandListener

All logging parameters are optional and covered by default settings, which are described in the next section.

Logging Settings

JADE uses the log4j framework and logs to two locations:

• stdout using the relatively compact rootLogger and
• a file using the more detailed reportLogger.
  
  • The location of this file is specified in the LogFile configuration element.
  • The default location for this file is the JADE logs directory.

These default logging settings themselves are specified in a log4j.properties file, whose location is specified using the Log4JPropertyFile configuration element. The default location of this log4j.properties file is the bin file of the JADE installation.

The detail of logging is specified using the DebugLevel element - the default level is "info" - more detailed levels can be specified if required.

In addition, JADE can use the Apache Commons FTP Client to receive detailed information about transfers carried out using FTP. This information is activated using the ProtocolCommandListener element.

Further information about logging

More detailed information about the JADE logging settings can be found in the JADE Parameter Reference - Logging article.

Notifications TO BE DONE

JADE can be optionally configured to send e-mails and/or a file to a recipient.

E-mails are sent ...

Files are sent by activating (connection) Fragments that cause a file to be sent to a recipient

Specifying Notifications

Notifications are protocol-specific and are specified in the JADE XML hierarchy as descendants of Profile elements as shown below:

• Profile
  • Operation (required)
  • Notifications (optional)
    • NotificationTriggers (for e-mains)
      
      • OnSuccess
      • OnError
      • OnEmptyFile
    • NotificationFragmentRefs (for file transfer)
  • other optional Profile elements

Notification Configuration TO BE DONE

E-Mail configuration - Where config.?

File Transfer configuration - Where config.?

Further information about notifications

More detailed information about the JADE notifications settings can be found in the JADE Parameter Reference - Notifications article.

See also

BackgroundService