JADE Parameter Reference - Profiles

• Schema: Profile, Profile
• Mapping:
  • profile

A Profile specifies the operation and the settings that are used for a file transfer. Multiple profiles can be included in a YADE configuration.

Profiles are distinguished by YADE based on their profile_id.

When invoking YADE the respective Profile for the file transfer operation is specified.

• Schema: Operation, Operation

A file transfer Operation represents activities such as Copy, Move, Remove, GetList etc. that are specified with a transfer Profile.

• Schema: Copy, Copy
• Mapping:
  • operation

A Copy operation performs the transfer of files between a source and a target host.

Two settings groups are available to specify a Copy operation:

• CopySource: specifies the source of a file transfer operation.
• CopyTarget: specifies the file transfer target.

• Schema: Move, Move
• Mapping:
  • operation
  • remove_files

The Move operation is similar to the Copy operation except that the source files will be removed after successful transfer.

Two settings groups are available to specify a Move operation:

• MoveSource: specifies the source of a file transfer operation.
• MoveTarget: specifies the file transfer target.

• Schema: Remove, Remove
• Mapping:
  • operation

A Remove operation removes files from a source host.

The following frequently used settings groups are available:

• RemoveSource: specifies the source from which files should be removed.

Support for a jump host.

Note: Availability starting with YADE-356.

• Schema: GetList, GetList
• Mapping:
  • operation

A GetList operation performs no transfer of files. Instead a list of files is retrieved that are available for transfer.

The same file selection mechanisms apply as for Copy operations.

• Schema: Client, Client

A file transfer includes roles that can be specified by use of the Client elements. The Client information is not required to perform the file transfer but is used for the transfer history.

• SupplyingClient: the client that is responsible for providing the source files
• ReceivingClient: the client that is responsible for accepting the target files

• Schema: ReceivingClient
• Mapping:
  • mandator

A file transfer includes the role of the receiving client that is responsible for accepting the source files.

The ReceivingClient information is not required to perform the file transfer but is used for the transfer history.

• Schema: JobScheduler, JobScheduler

YADE can be configured for use with JobScheduler. In this case the YADE JITL Job is used. Parameters can be specified to control the workflow of files processed by YADE.

• Schema: CreateOrder
• Mapping:
  • create_order

With this parameter it is possible to specify a file order to be created and launched for execution by JobScheduler. A file order is created for the first filename in the result list of a Selection.

To create a file order for all files see CreateOrderForAllFiles parameter.

To create a file order for new files see CreateOrderForNewFiles parameter.

• Schema: Logging, Logging

YADE uses the log4j framework for logging and makes use of the following loggers:

• rootLogger
• reportLogger

These loggers are configured by a log4j configuration file which determines that the

• rootLogger logs to stdout.
• reportLogger optionally logs to a file.

If the log4j configuration file is not found then a log4j base configuration is used which logs to stdout.

• Schema: LogFile
• Mapping:
  • log_filename

YADE makes use of the following log4j loggers:

• rootLogger which logs to stdout
• reportLogger which logs to a file

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

• JobScheduler releases starting from 1.13.3
  • JobScheduler Master / Agent
    • ${scheduler_data}/logs/YADE.log
  • YADE Client
    • Windows - ${java.io.tmpdir}/YADE.log
    • Unix - ${java.io.tmpdir}/${user.name}/YADE.log
• JobScheduler releases before 1.13.3
  • Windows - ${java.io.tmpdir}/Jade-client.log
  • Unix - ${java.io.tmpdir}/${user.name}/Jade-client.log

• Schema: Log4JPropertyFile
• Mapping:
  • log4jPropertyFileName

This parameter specifies the location of a log4j configuration file. Without this parameter the following configuration is used:

• JobScheduler releases starting from 1.13.3 (Log4j 2)
  • JobScheduler Master / Agent
    • JadeReportLog logger in the ${scheduler_install}/lib/log4j2.xml configuration file.
  • YADE Client
    • JadeReportLog logger in the <yade client>/bin/log4j2.xml configuration file.

• JobScheduler releases before 1.13.3 (Log4j)
  • log4j.rootLogger=info, stdout
    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

• Schema: DebugLevel
• Mapping:
  • verbose

YADE makes use of the following log4j loggers:

• rootLogger which logs to stdout
• reportLogger which logs to a file

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.

• Schema: ProtocolCommandListener
• Mapping:
  • protocol_command_listener
  • ProtocolCommandListener

YADE makes use of the following log4j loggers:

• rootLogger which logs to stdout
• reportLogger which logs to a file

This parameter activates the logging of the Apache Commons FTP Client. All output will be written by the rootLogger to stdout.

• Schema: NotificationTriggers, NotificationTriggers

E-mail can be specified to be sent in case of events that are configured with this element:

• OnSuccess: in case of successful execution of a file tansfer operation.
• OnError: in case of failed execution of a file tansfer operation.
• OnEmptyFiles: in case of exclusively empty files being detected during the execution of a file tansfer operation.

• Schema: OnSuccess
• Mapping:
  • mail_on_success

Send a notification in case of success.

• Schema: OnError
• Mapping:
  • mail_on_error

Send a notification in case of error.

• Schema: OnEmptyFiles
• Mapping:
  • mail_on_empty_files

Send a notification if empty files are detected.

• Schema: Notifications, Notifications

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:

• Profile: a specific mail server or Background Service is used for notifications of file transfers from this profile.
• General: one mail server or Background Service is used for notifications from all Profiles.

• Schema: MailServerFragmentRef, MailServerFragmentRef

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.

• Schema: Assertions, Assertions

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.

• Schema: Documentation, Documentation

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:

• Profile: a specific documentation is used for file transfers from this profile.
• General: a general documentation is used for file transfers from all Profiles.

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.

• Schema: SystemPropertyFiles
• Mapping:
  • system_property_files
• Release:
  • YADE-400 Availability starting with 1.11.

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.
• Java property files are processed in the specified sequence. Properties that have previously been set will be overwritten by subsquent Java property files.
• First the global Java property files are applied, next the Java property files specified for a transfer fragment are applied.

• Schema: SystemPropertyFile, SystemPropertyFile

Properties from Java property files are applied as system properties by YADE.