Skip to end of metadata
Go to start of metadata

Introduction

  • The Parameter Reference is used for configuring YADE file transfer settings.
  • The Parameter Reference is generated from the YADE - Reference Documentation - XSD Schema Reference and includes additional explanations of configuration elements.
  • The YADE - User Manual provides an overview of features, explains use cases and includes references to this documentation.

Status of Documentation

Icon
  • The Parameter Reference explains the structure of configuration elements that is intended for future YADE releases.
    • FEATURE AVAILABILITY STARTING FROM RELEASE 1.11
    • YADE shifts from plain text configuration files (.ini format) to XML Configuration files.
      • For releases 1.9 and 1.10 the plain text configuration files are maintained.
      • For releases 1.11 and later XML Configuration will be available as documented.
  • The Parameter Reference for releases 1.10 and older is available for reference.
  • The Parameter Mapping is intended for users of YADE releases before 1.11 who want to benefit from the Parameter Reference documentation.
    • Mapping tables assist to identify XML configuration elements and plain text configuration items (.ini format).
  • The XML Editor is schema-aware and can be used to create valid XML configurations.
  • The YADE - User Manual is available and under continuous extension.

Parameter Reference

Diagram

Elements

Configurations
References

Notes

The root element of a YADE configuration file.

This element can be assigned the location of the XSD schema, e.g. http://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd

We recommend to assign the XSD schema version for which the YADE configuration has been created. This allows to validate a YADE configuration file with the XSD schema version that is was designed for.

Element Type Required Description
Fragments
  • Occurrence: 1
Required
References

Notes

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.

Profiles
  • Occurrence: 1
Required
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.

General
  • Occurrence: 0..1
Optional
References

Notes

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.

Explanations

The XML file transfer configuration that is introduced with version 1.11 of the YADE Client uses an XSD schema to define relationships between parameters and which parameters can be used together.

The top two levels of the schema are shown in the diagram at the top of this page:

The Configurations element is the top level element in the transfer configuration and has three child elements, representing three main branches of the configuration:

  • Fragments branch:
    • Parameters set in the Fragments configuration branch specify how the transfer is to be carried out.
    • An example transfer fragment could specify that FTP protocol should be used, via a SOCKS5 proxy on a particular port, with password authentication.
    • At least a minimum set of Fragments parameters is required.
    • More than one transfer method can be specified in the Fragments branch.
    • ProtocolFragments can be thought of as a library of predefined transfer configurations that can be called up as required.
    • The transfer method that will be used is specified as a reference in the Profiles configuration branch.
  • Profiles branch:
    • Profiles are the central defining file transfer elements - it is a profile that is called when a file transfer is to be carried out.
    • The Profiles element specifies what is to be done – i.e. the operations involved.
    • An example transfer Profile could specify that files are to be moved from a source to a target and renamed.
    • At least a minimum set of Profile parameters is required.
  • General branch:
    • 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.

In addition there are:

  • Reusable elements
    • (Not shown on the diagram above.) Reusable Elements can be included at different points in the configuration as allowed in the schema - eventually more than once.
    • Example Reusable Elements are:
      • the BasicConnection element, which requires a Hostname and optionally a Port and can be used, for example, in an FTPFragment and FTPSFragment but not in a HTTPFragment.
      • the ProxyForFTPS element, which requires that either a SOCKS4Proxy or a SOCKS5Proxy is specified and can only be used in an FTPSFragment.
        Note that both the SOCKS4Proxy and SOCKS5Proxy elements are themselves Reusable Elements.
 

 

  • No labels