Diagram
The General configuration options refer to central settings that are applied to all file transfer configuratons such as use of the YADE Background Service and logging. Some settings from the General branch can be superseeded by Profile settings that apply to an individual file transfer configuration. The specification of General configuration parameters is not mandatory. YADE allows to specify Java property files at a global level and individually per transfer fragment. Properties from Java property files are applied as system properties by YADE. YADE uses the log4j framework for logging and makes use of the following loggers: These loggers are configured by a log4j configuration file which determines that the If the log4j configuration file is not found then a log4j base configuration is used which logs to stdout. YADE makes use of the following log4j loggers: This parameter specifies the location of the file to which the log output of the reportLogger will be written. Should the file not exist then it will be created. If the file already exists then all log output will be appended. Without specifying this parameter all log output of the reportLogger will be written to This parameter specifies the location of a log4j configuration file. Without this parameter the following configuration is used: YADE makes use of the following log4j loggers: The debug level specifies the verbosity of the rootLogger log entries. A value between 1 and 9 can be specified. Higher values cause more detailed information to be logged. YADE makes use of the following log4j loggers: This parameter activates the logging of the Apache Commons FTP Client. All output will be written by the rootLogger to stdout. Notifications can be sent by e-mail or by use of the YADE Background Service. The Notifications element allows included elements to reference NotificationFragments such as a MailServerFragment or a BackgroundServiceFragment. Notifications can be added either at Profile level or at General level: This element references the fragment that is used for mail servers in case of notification of a file transfer operation. Any number of reusable MailServerFragment elements can be configured and are distinguished by YADE based on their name attribute. The reference to a fragment is based on the value of the ref attribute of this element to the corresponding name attribute of the MailServerFragment element. This attribute identifies the fragment that is used for mail servers in case of notification about file transfers. This element does not specify parameters for file transfers but assertions regarding the performance of file transfers. Assertions specify performance indicators that can be checked by a test suite. This element does not specify a parameter for file transfer operations but an Assertion regarding the expected performance of file transfers. Assertions specify performance indicators that can be checked by a test suite. The ReturnCode assertion specifies the exit code that is expected as the result of a file transfer. The ReturnCode is a numeric value between 0 and 255. For YADE a ReturnCode value 0 signals a successful transfer, other values signal a failed transfer. This element does not specify a parameter for file transfer operation but an Assertion regarding the expected performance of file transfers. Assertions specify performance indicators that can be checked by a test suite. The Timeout assertion specifies the max. duration of a file transfer that is expected. The Timeout is specified in seconds. A Documentation can be added to a file transfer configuration that includes a description and a number of links. The Documentation can be added either at Profile level or at General level: A Description can be added to a Documentation that explains the use of the file transfer configuration. Descriptions include plain text, i.e. no formatting is applied. A number of Links can be added to a Documentation that explains the use of the file transfer configuration. To control reconnect behavior, the YADE has two options: Sets for each single file transfer the number of reconnection attempts if there is a connection failure. This option specifies the wait interval between attempts. Possible values: Combined values (with blank as separator):
General
Element
Type
Required
Description
SystemPropertyFiles
[SystemPropertyFilesType]
Optional
Notes
SystemPropertyFilesType / SystemPropertyFile
string
Required
Notes
Logging
[LoggingType]
Optional
where the output of the reportLogger is more compact than the rootLogger output.
LoggingType / LogFile
string
Optional
Notes
LoggingType / Log4JPropertyFile
string
Optional
Notes
log4j.logger.JadeReportLog=info, JadeReportLog
log4j.logger.JadeReportLog.SOSVfsReportLog=info, JadeReportLog
#log4j.logger.JadeReportLog=info, JadeReportLog, JadeReportLogHTML
#log4j.logger.JadeReportLog.SOSVfsReportLog=info, JadeReportLog, JadeReportLogHTML
log4j.additivity.JadeReportLog = false
log4j.additivity.JadeReportLog.SOSVfsReportLog = false
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%t %-5p %-14d{HH:mm:ss,SSS} (%F:%L) ::%M %m %n
# Configuration of JadeHTMLReportLog
log4j.appender.JadeReportLogHTML=org.apache.log4j.FileAppender
log4j.appender.JadeReportLogHTML.layout=com.sos.JSHelper.Logging.SOSHtmlLayout
log4j.appender.JadeReportLogHTML.File=${java.io.tmpdir}/Jade-client.html
log4j.appender.JadeReportLogHTML.Append=false
log4j.appender.JadeReportLogHTML.layout.Title=YADE Report Log
# Configuration of JadeReportLog
log4j.appender.JadeReportLog=org.apache.log4j.RollingFileAppender
log4j.appender.JadeReportLog.File=${java.io.tmpdir}/Jade-client.log
log4j.appender.JadeReportLog.MaxFileSize=5000KB
log4j.appender.JadeReportLog.MaxBackupIndex=30
log4j.appender.JadeReportLog.layout=org.apache.log4j.PatternLayout
log4j.appender.JadeReportLog.layout.ConversionPattern=%-21d{HH:mm:ss,SSS}%m %n
LoggingType / DebugLevel
integer
Optional
Notes
LoggingType / ProtocolCommandListener
boolean
Optional
Notes
Notifications
[NotificationType]
Optional
Notes
The more sppecific notification settings from a Profile are used if available. Otherwise the General settings are applied.
NotificationType / MailServerFragmentRef
Optional
Assertions
[AssertionType]
Optional
Notes
AssertionType / ReturnCode
long
Optional
AssertionType / Timeout
positiveInteger
Optional
Documentation
[DocumentationType]
Optional
Notes
The more sppecific Documentation settings from a Profile are used if available. Otherwise the General settings are applied.
DocumentationType / Description
string
Optional
DocumentationType / Links
[LinksType]
Optional
RetryOnConnectionError
Optional
Notes
RetryCountMax
int
Required
Notes
RetryInterval
string
Optional
Notes
References Notes
References
References
References Notes
References
References
References
References
References
References Notes
References
References
References
References
References
Overview
Content Tools