Skip to end of metadata
Go to start of metadata

Diagram

Elements

Profile
References Notes

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.

profile_id

A profile is identified by this attribute value that is specified when invoking YADE. As multiple profiles can be stored in a YADE configuration this value is a unique identifier for the settings that are grouped in a profile.

Element Type Required Description
Attribute: profile_id NMTOKEN
Required

A profile is identified by this attribute value that is specified when invoking YADE. As multiple profiles can be stored in a YADE configuration this value is a unique identifier for the settings that are grouped in a profile.

Operation
  • Occurrence: 1
Required
References Notes

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

Client
  • Occurrence: 0..1
Optional
References Notes

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
JobScheduler
  • Occurrence: 0..1
Optional
References Notes

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.

Logging [LoggingType]
  • Occurrence: 0..1
Optional
References Notes

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

  • rootLogger
  • reportLogger
where the output of the reportLogger is more compact than the rootLogger output.

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

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

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

NotificationTriggers
  • Occurrence: 0..1
Optional
References Notes

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.
Notifications [NotificationType]
  • Occurrence: 0..1
Optional
References Notes

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.
The more sppecific notification settings from a Profile are used if available. Otherwise the General settings are applied.
Assertions [AssertionType]
  • Occurrence: 0..1
Optional
References Notes

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.

Documentation [DocumentationType]
  • Occurrence: 0..1
Optional
References Notes

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.
The more sppecific Documentation settings from a Profile are used if available. Otherwise the General settings are applied.
SystemPropertyFiles [SystemPropertyFilesType]
  • Occurrence: 0..1
Optional
References Notes

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.

 

  • No labels
Write a comment…