Skip to end of metadata
Go to start of metadata

Introduction

YADE comes with a number of optional logging and event-triggered notification features.

Logging

YADE uses standardized log files with a structured and configurable format. This allows detailed logging of all characteristics of a file transfer, e.g. renaming of files, transfer duration, resolution of host names for source systems and target systems.

Notifications

YADE can be configured to send e-mail notifications to one or more recipients when specific file handling events such as file transfer ends in error occur.

Logging Settings

YADE 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 YADE 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 directory of the YADE 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, YADE 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.

Logging configuration

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

  • Fragments
    • etc.
  • Profiles
    • etc.
  • General
    • History
    • BackgroundService
    • Logging (optional)
      • LogFile
      • Log4JPropertyFile
      • DebugLevel
      • ProtocolCommandListener

All logging parameters are optional and covered by default settings.

Further information about logging

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

Notifications

YADE can be configured to send notifications to one or more recipients according to file transfer events.

E-mails are sent using the Java mail client, which is a part of the Java Runtime Environment and thereby a requirement for the installation of YADE.

Mails are sent by activating NotificationFragments containing the e-mail configuration .

Specifying Notifications

Notifications are operation-independent and therefor transfer protocol-independent. They are specified in the YADE XML hierarchy as descendants of Profile elements and siblings of the Operation element as shown below:

  • Fragments
    • ProtocolFragments
    • NotificationFragments
      • MailFragment (name="Addressee 1")
        • Header (Required)
          • To (Required)
          • etc.
        • Body
        • etc.
      • MailFragment (name="Addressee 2")
      • etc.
  • Profile
    • Operation (required)
    • Notifications (optional)
      • NotificationTriggers
        • OnSuccess
        • OnError
        • OnEmptyFile
      • NotificationFragmentRefs
        • NotificationFragmentRef (ref="Addressee 1")
        • NotificationFragmentRef (ref="Addressee 2")
    • other optional Profile elements

As can be seen in the diagram above, the configuration of mail notification fragments follows the same principles as used for file transfer protocol fragments: one or more NotificationFragments are defined in the Fragments branch of the configuration and these are called as required by corresponding NotificationFragmentRef elements in the file transfer profile. The NotificationFragmentRef elements are activated by the events defined for the NotificationTriggers child elements (OnSuccess etc.).

Further information about notifications

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

See also

The YADE BackgroundService, which collects the transfer history and log files from a number of YADE Clients and adds this information to a transfer history database.

It can be configured to send notifications when detecting errors that have been reported in the file transfer history.