Page History

Introduction

YADE is a tool for complex file transfer operations and consequently provides complex configuration options.
The YADE Reference Documentation is designed to provide structural information in addition to textual explanations and to assist you in creating valid file transfer configurations.
YADE is evolving from a standalone tool towards tight integration with other services, JobScheduler being the component that automates and orchestrates file transfers.

Components

The YADE Reference Documentation is organized by the following components:

Flowchart

XSDSchema [label="YADE XSD Schema\n(.xsd)",URL="YADE - XSD Schema Reference - XSD Schema Source",tooltip="XSD Schema Source for use with an XSD Editor",fillcolor="lightskyblue"]
XSDDocumentation [label="YADE XSD Schema Documentation\n(.html)",URL="YADE - XSD Schema Reference - XSD Schema Documentation",tooltip="XSD Schema documentation in HTML format",fillcolor="lightskyblue"]
SourceCode [label="YADE Source Code\n(Java)",fillcolor="violet"]
APIReference [label="YADE API Reference\n(JavaDoc)",URL="YADE - Reference Documentation - API Reference",tooltip="API Reference in JavaDoc HTML format",fillcolor="violet"]
ParameterReference [label="YADE Parameter Reference\n(Wiki)",URL="YADE - Reference Documentation - Parameter Reference",tooltip="Parameter Reference in Product Knowledge Base",fillcolor="orange"]
#ParameterExplanations [label="YADE Parameter Explanations",fillcolor="white"]
ParameterDiagrams [label="YADE Parameter Diagrams",fillcolor="white"]
ParameterTables [label="YADE Parameter Tables",fillcolor="white"]
UserManual [label="YADE User Manual\n(Wiki)",URL="YADE - User Manual",tooltip="User Manual in Product Knowledge Base",fillcolor="palegreen"]
#UserManualExplanations [label="YADE User Manual Explanations",fillcolor="white"]
ParameterMappings [label="YADE Parameter Mapping\n(Wiki)",URL="YADE - Reference Documentation - Parameter Mapping",tooltip="Parameter Mapping in Product Knowledge",fillcolor="lightgrey"]
ParameterMappingTables [label="YADE Parameter Mapping Tables",fillcolor="white"]
 
XSDSchema -> XSDDocumentation
XSDSchema -> SourceCode
XSDSchema -> ParameterDiagrams
XSDSchema -> ParameterTables
XSDSchema -> ParameterMappingTables

SourceCode -> APIReference
ParameterDiagrams -> ParameterReference 
ParameterTables -> ParameterReference 
#ParameterExplanations -> ParameterReference 

#ParameterDiagrams -> UserManual
#ParameterTables -> UserManual
#ParameterExplanations  -> UserManual
#UserManualExplanations -> UserManual

ParameterMappingTables -> ParameterMappings
ParameterReference -> UserManual

Excerpt

Info

title	Status of Documentation

The Parameter Reference explains the structure of configuration elements that is intended for future YADE releases.
- Display feature availability
  StartingFromRelease 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.
- YADE releases correspond to the following XSD schema file versions:
  - YADE releases 1.9 up to 1.11 use https://www.sos-berlin.com/schema/yade/YADE_configuration_v1.0.xsd
  - YADE releases 1.12, 1.13, JS7 use https://www.sos-berlin.com/schema/yade/YADE_configuration_v1.12.xsd
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.

Usage

YADE - User Manual
- For users intending to configure and to manage file transfer operations
YADE - Reference Documentation - Parameter Reference
- For browsing the structure of configuration elements
- For detailed information on individual parameters
YADE - Reference Documentation - Parameter Mapping
- For users of YADE releases with plain text configuration files
YADE - Reference Documentation - XSD Schema Reference
- YADE - XSD Schema Reference - XSD Schema Source
- YADE - XSD Schema Reference - XSD Schema Documentation
- For experienced users with knowledge of XSD Schema

Display children header

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Introduction

Components

Usage