JADE Parameter Reference - General Logging

• Schema: JobResource, JobResource

JobScheduler releases starting from JS7 2.2.2

This element specifies a JS7 Job Resource.

• Schema: Fragments, Fragments

The branch element for reusable transfer configuration.

Subsequent fragments are used e.g. for file transfer specifications, notifications, mail server settings, that can be used in a number of file transfer Profiles.

A fragment specifies how a file transfer is carried out whereas a Profile specifies what should be transferred. Therefore multiple profiles can use the same fragments, e.g. to transfer different files from the same source or to reuse the same transfer specification as the source and the target in different transfer operations.

• Schema: ProtocolFragments, ProtocolFragments

Fragments are a means to organize file transfer settings in a reusable way:

• Fragments are created to define settings that are specific for a file transfer protocol, e.g. FTP, SFTP, WebDAV.
• File transfer protocols include settings for e.g. FTP BasicAuthentication, BasicConnection.
• Such fragments do not include settings for an individual file transfer, e.g. the file Selection, as such settings are used in a Profile that specifies parameters for a file transfer Operation.
• Each Profile references a fragment for the source and optionally for the target of a file transfer operation. Therefore multiple profiles can use the same connection that is specified in a fragment.

Any number of fragments can be configured. They are distinguished by their name attribute. References to a fragment use the value of the name attribute to identify the respective fragment.

• Schema: NotificationFragments, NotificationFragments

Notification fragments are used to specifiy how notifications will be sent to recipients in case of file transfers.

• Schema: CredentialStoreFragments, CredentialStoreFragments

Fragments for credential stores are a means to organize secure settings in a reusable way:

• Fragments are created to define settings that are specific for a file transfer protocol, e.g. FTP, SFTP, WebDAV.
• Each Profile references a number of CredentialStoreFragments for secure settings in ProtocolFragments of a file transfer operation.
• Multiple Profiles can use the same credential store that is specified in a fragment.
• A Profile can reference multiple CredentialStoreFragment elements.

Any number of fragments can be configured. They are distinguished by their name attribute. References to a fragment use the value of the name attribute to identify the respective fragment.

• Schema: MailServerFragments, MailServerFragments

Mail server fragments are used to specifiy by what mail server notifications will be sent to recipients in case of file transfers.

• Schema: Profiles, Profiles

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

• 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: General, General

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.

• 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: 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: 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: 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.

• 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.

• Schema: RetryOnConnectionError, RetryOnConnectionError
• Release:
  • YADE-556 Availability starting with 1.12.13, 1.13.4.

To control reconnect behavior, the YADE has two options:

• RetryCountMax - number of reconnection attempts (for each single file transfer) if there is a connection failure
• RetryInterval - the wait interval between attempts