Scope
- The Parameter Reference is used when configuring JADE file transfer settings
Parameter Reference
Document: JADE Parameter Reference
Diagram
The root element of a YADE configuration. This element specifies a JS7 Job Resource. This element specifies the name of a JS7 Job Resource. This element specifies the environment variable name of a JS7 Job Resource. This element specifies the variable name of a JS7 Job Resource. 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. Fragments are a means to organize file transfer settings in a reusable way: 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. Notification fragments are used to specifiy how notifications will be sent to recipients in case of file transfers. Fragments for credential stores are a means to organize secure settings in a reusable way: 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. Mail server fragments are used to specifiy by what mail server notifications will be sent to recipients in case of file transfers. 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. 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. 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. 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. 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 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. 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: To control reconnect behavior, the YADE has two options:
Configurations
Notes
Element
Type
Required
Description
JobResource
Optional
Notes
JobScheduler releases starting from JS7 2.2.2
Fragments
Required
ProtocolFragments
Required
Notes
NotificationFragments
Optional
CredentialStoreFragments
Optional
MailServerFragments
Optional
Notes
Profiles
Required
Profile
Optional
General
Optional
SystemPropertyFiles
[SystemPropertyFilesType]
Optional
Notes
Logging
[LoggingType]
Optional
where the output of the reportLogger is more compact than the rootLogger output.
Notifications
[NotificationType]
Optional
Notes
The more sppecific notification settings from a Profile are used if available. Otherwise the General settings are applied.
Assertions
[AssertionType]
Optional
Notes
Documentation
[DocumentationType]
Optional
Notes
The more sppecific Documentation settings from a Profile are used if available. Otherwise the General settings are applied.
RetryOnConnectionError
Optional
Notes