Introduction
Status of Documentation
- 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.
- 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.
Mapping Tables
| old Parameter | new Elements |
|---|---|
| accept_untrusted_certificate | |
| alternative_protocol | Parameter: YADE Parameter Reference - ProtocolFragments Schema:ProtocolFragments |
| append_files | AppendFiles Schema:AppendFiles |
| atomic_prefix | Parameter: YADE Parameter Reference - Atomicity Schema:AtomicityParameter: YADE Parameter Reference - AtomicPrefix Schema:AtomicPrefix |
| atomic_suffix | Parameter: YADE Parameter Reference - Atomicity Schema:AtomicityParameter: YADE Parameter Reference - AtomicSuffix Schema:AtomicSuffix |
| attachment | Attachment Schema:Attachment |
| Background_Service_Host | BackgroundServiceHost Schema:BackgroundServiceHost |
| Background_Service_Port | BackgroundServicePort Schema:BackgroundServicePort |
| Background_Service_PortNumber | BackgroundServicePort Schema:BackgroundServicePort |
| Background_Service_Transfer_Method | BackgroundServiceProtocol Schema:BackgroundServiceProtocol |
| BackgroundServiceHost | BackgroundServiceHost Schema:BackgroundServiceHost |
| BackgroundServiceJobChainName | BackgroundServiceJobChainName |
| BackgroundServicePort | BackgroundServicePort Schema:BackgroundServicePort |
| bcc | BCC Schema:BCC |
| body | Body Schema:Body |
| buffer_size | BufferSize Schema:BufferSize |
| BufferSize | BufferSize Schema:BufferSize |
| cc | CC Schema:CC |
| Check_Security_Hash | Parameter: YADE Parameter Reference - CheckIntegrityHash Schema:CheckIntegrityHash |
| check_size | CheckSize Schema:CheckSize |
| check_steady_count | CheckSteadyStateCount Schema:CheckSteadyStateCount |
| check_steady_state_interval | CheckSteadyStateInterval Schema:CheckSteadyStateInterval |
| Check_Steady_State_Of_Files | Parameter: YADE Parameter Reference - CheckSteadyState Schema:CheckSteadyState |
| CheckFileSizeAfterTransfer | CheckSize Schema:CheckSize |
| CheckSecurityHash | Parameter: YADE Parameter Reference - CheckIntegrityHash Schema:CheckIntegrityHash |
| CheckSteadyCount | CheckSteadyStateCount Schema:CheckSteadyStateCount |
| CheckSteadyStateOfFiles | Parameter: YADE Parameter Reference - CheckSteadyState Schema:CheckSteadyState |
| compress_files | Parameter: YADE Parameter Reference - CompressFiles Schema:CompressFiles |
| compressed_file_extension | Parameter: YADE Parameter Reference - CompressFiles Schema:CompressFilesCompressedFileExtension Schema:CompressedFileExtension |
| Concurrent_Transfer | Parameter: YADE Parameter Reference - ConcurrentTransfer Schema:ConcurrentTransfer |
| ConcurrentTransfer | Parameter: YADE Parameter Reference - ConcurrentTransfer Schema:ConcurrentTransfer |
| configuration_files | ConfigurationFiles Schema:ConfigurationFiles |
| content_type | ContentType Schema:ContentType |
| ControlEncoding | ControlEncoding Schema:ControlEncoding |
| create_folders_on_target | DisableMakeDirectories Schema:DisableMakeDirectories |
| create_order | CreateOrder Schema:CreateOrder |
| create_order_on_remote_jobscheduler | CreateOrderOnRemoteJobScheduler |
| create_orders_for_all_files | CreateOrderForAllFiles Schema:CreateOrderForAllFiles |
| create_result_list | Parameter: YADE Parameter Reference - ResultSet Schema:ResultSet |
| Create_Result_Set | Parameter: YADE Parameter Reference - ResultSet Schema:ResultSet |
| create_security_hash_file | CreateIntegrityHashFile Schema:CreateIntegrityHashFile |
| createFoldersOnTarget | DisableMakeDirectories Schema:DisableMakeDirectories |
| CreateOrderOnRemoteJobScheduler | CreateOrderOnRemoteJobScheduler |
| CreateResultList | Parameter: YADE Parameter Reference - ResultSet Schema:ResultSet |
| CreateResultSet | Parameter: YADE Parameter Reference - ResultSet Schema:ResultSet |
| CreateSecurityHashFile | CreateIntegrityHashFile Schema:CreateIntegrityHashFile |
| cumulate_files | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFiles |
| CumulateFiles | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFiles |
| cumulative_file_delete | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFilesCumulativeFileDelete Schema:CumulativeFileDelete |
| cumulative_file_name | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFilesCumulativeFilename Schema:CumulativeFilename |
| cumulative_file_separator | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFilesCumulativeFileSeparator Schema:CumulativeFileSeparator |
| CumulativeFileDelete | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFilesCumulativeFileDelete Schema:CumulativeFileDelete |
| CumulativeFileName | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFilesCumulativeFilename Schema:CumulativeFilename |
| CumulativeFileSeparator | Parameter: YADE Parameter Reference - CumulateFiles Schema:CumulateFilesCumulativeFileSeparator Schema:CumulativeFileSeparator |
| dir | FileSpecSelection Schema:FileSpecSelectionFileListSelection Schema:FileListSelectionParameter: YADE Parameter Reference - CopyTarget Schema:CopyTargetParameter: YADE Parameter Reference - MoveTarget Schema:MoveTarget |
| domain | Domain Schema:Domain |
| encoding | Encoding Schema:Encoding |
| error_on_no_data_found | |
| error_when_no_data_found | |
| ErrorOnNoDataFound | |
expected_size_of_result_set | ExpectedSizeOfResultSet Schema:ExpectedSizeOfResultSet |
| File_List_Name | Parameter: YADE Parameter Reference - FileList Schema:FileList |
| file_names | Parameter: YADE Parameter Reference - FilePath Schema:FilePath |
| file_path | Parameter: YADE Parameter Reference - FilePath Schema:FilePath |
| file_spec | Parameter: YADE Parameter Reference - FileSpec Schema:FileSpec |
| FileAgeMaximum | MaxFileAge Schema:MaxFileAge |
| FileAgeMinimum | MinFileAge Schema:MinFileAge |
| FileListName | Parameter: YADE Parameter Reference - FileList Schema:FileList |
| FileNamePatternRegExp | Parameter: YADE Parameter Reference - FileSpec Schema:FileSpec |
| FileNameRegExp | Parameter: YADE Parameter Reference - FileSpec Schema:FileSpec |
| FileNames | Parameter: YADE Parameter Reference - FilePath Schema:FilePath |
| FileSizeMaximum | MaxFileSize Schema:MaxFileSize |
| FileSizeMinimum | MinFileSize Schema:MinFileSize |
| force_files | |
| from | From Schema:From |
| ftps_client_security | SecurityMode Schema:SecurityMode |
| ftps_protocol | Parameter: YADE Parameter Reference - FTPSProtocol Schema:FTPSProtocol |
| FTPTransferModeIsPassive | Parameter: YADE Parameter Reference - PassiveMode Schema:PassiveMode |
| history | HistoryFile Schema:HistoryFile |
| history_file_name | HistoryFile Schema:HistoryFile |
| HistoryFileName | HistoryFile Schema:HistoryFile |
| host | Hostname Schema:HostnameParameter: YADE Parameter Reference - BasicConnection Schema:BasicConnectionParameter: YADE Parameter Reference - URLConnection Schema:URLConnectionMailServer Schema:MailServerURL Schema:URL |
| include_sub_directories | Parameter: YADE Parameter Reference - Recursive Schema:Recursive |
| IncludeSubdirectories | Parameter: YADE Parameter Reference - Recursive Schema:Recursive |
| jump_dir | JumpDirectory Schema:JumpDirectory |
| jump_host | Parameter: YADE Parameter Reference - JumpFragment Schema:JumpFragment |
| jump_password | Parameter: YADE Parameter Reference - JumpFragment Schema:JumpFragment |
| jump_port | Parameter: YADE Parameter Reference - JumpFragment Schema:JumpFragment |
| jump_ssh_auth_file | Parameter: YADE Parameter Reference - JumpFragment Schema:JumpFragment |
| jump_ssh_auth_method | Parameter: YADE Parameter Reference - JumpFragment Schema:JumpFragment |
| jump_user | Parameter: YADE Parameter Reference - JumpFragment Schema:JumpFragment |
| keep_modification_date | KeepModificationDate Schema:KeepModificationDate |
| keystore_file | KeyStoreFile Schema:KeyStoreFile |
| keystore_password | KeyStorePassword Schema:KeyStorePassword |
| keystore_type | KeyStoreType Schema:KeyStoreType |
| local_dir | |
| mail_on_empty_files | |
| mail_on_error | |
| mail_on_success | |
| make_Dirs | DisableMakeDirectories Schema:DisableMakeDirectories |
| Max_Concurrent_Transfers | MaxConcurrentTransfers Schema:MaxConcurrentTransfers |
| max_file_age | MaxFileAge Schema:MaxFileAge |
| max_file_size | MaxFileSize Schema:MaxFileSize |
| Max_Files | MaxFiles Schema:MaxFiles |
| MaxConcurrentTransfers | MaxConcurrentTransfers Schema:MaxConcurrentTransfers |
| MaxFiles | MaxFiles Schema:MaxFiles |
| MergeOrderParameter | MergeOrderParameters Schema:MergeOrderParameters |
| min_file_age | MinFileAge Schema:MinFileAge |
| min_file_size | MinFileSize Schema:MinFileSize |
| next_state | NextState Schema:NextState |
| No_files_state | |
| NoOfFirstFiles2Skip | SkipFirstFiles Schema:SkipFirstFiles |
| NoOfLastFiles2Skip | SkipLastFiles Schema:SkipLastFiles |
| on_empty_result_set | EmptyResultSetState Schema:EmptyResultSetState |
| operation | Parameter: YADE Parameter Reference - Operation Schema:Operation |
| order_jobchain_name | OrderJobChainName Schema:OrderJobChainName |
| order_jobscheduler_host_name | JobSchedulerHostname Schema:JobSchedulerHostname |
| order_jobscheduler_port_number | JobSchedulerPort Schema:JobSchedulerPort |
| overwrite_files | DisableOverwriteFiles Schema:DisableOverwriteFiles |
| passive_mode | Parameter: YADE Parameter Reference - PassiveMode Schema:PassiveMode |
| password | Password Schema:PasswordParameter: YADE Parameter Reference - BasicAuthentication Schema:BasicAuthenticationParameter: YADE Parameter Reference - SSHAuthentication Schema:SSHAuthenticationPassphrase Schema:PassphraseMailServer Schema:MailServer |
| Poll_Error_State | |
| poll_interval | |
| poll_keep_connection | not implemented |
| poll_minfiles | |
| poll_timeout | |
| PollErrorState | |
| polling_server | |
| polling_server_duration | Parameter: YADE Parameter Reference - Polling Schema:PollingPollingServerDuration Schema:PollingServerDuration |
| polling_server_poll_forever | |
| polling_wait_4_Source_Folder | Parameter: YADE Parameter Reference - Polling Schema:PollingWaitForSourceFolder Schema:WaitForSourceFolder |
| PollingServer | |
| pollingServerDuration | Parameter: YADE Parameter Reference - Polling Schema:PollingPollingServerDuration Schema:PollingServerDuration |
| PollingServerPollForever | |
| pollingWait4SourceFolder | Parameter: YADE Parameter Reference - Polling Schema:PollingWaitForSourceFolder Schema:WaitForSourceFolder |
| PollKeepConnection | KeepConnection Schema:KeepConnection |
| port | Port Schema:PortParameter: YADE Parameter Reference - BasicConnection Schema:BasicConnectionParameter: YADE Parameter Reference - URLConnection Schema:URLConnectionMailServer Schema:MailServerURL Schema:URL |
| post_command | CommandAfterFile Schema:CommandAfterFile |
| post_transfer_commands | CommandAfterOperation Schema:CommandAfterOperation |
| pre_command | CommandBeforeFile Schema:CommandBeforeFile |
| pre_transfer_commands | CommandBeforeOperation Schema:CommandBeforeOperation |
| PreFtpCommands | CommandBeforeOperation Schema:CommandBeforeOperation |
| profile | Parameter: YADE Parameter Reference - Profile Schema:Profile |
| protocol | Parameter: YADE Parameter Reference - ProtocolFragments Schema:ProtocolFragmentsParameter: YADE Parameter Reference - CopySourceFragmentRef Schema:CopySourceFragmentRefParameter: YADE Parameter Reference - GetListSourceFragmentRef Schema:GetListSourceFragmentRefParameter: YADE Parameter Reference - MoveSourceFragmentRef Schema:MoveSourceFragmentRefParameter: YADE Parameter Reference - RemoveSourceFragmentRef Schema:RemoveSourceFragmentRefZip Schema:ZipReadableAlternativeFragmentRef Schema:ReadableAlternativeFragmentRefWriteableAlternativeFragmentRef Schema:WriteableAlternativeFragmentRefParameter: YADE Parameter Reference - CopyTargetFragmentRef Schema:CopyTargetFragmentRefParameter: YADE Parameter Reference - MoveTargetFragmentRef Schema:MoveTargetFragmentRef |
| proxy_host | Parameter: YADE Parameter Reference - HTTPProxy Schema:HTTPProxyParameter: YADE Parameter Reference - SOCKS4Proxy Schema:SOCKS4ProxyParameter: YADE Parameter Reference - SOCKS5Proxy Schema:SOCKS5Proxy |
| proxy_password | Parameter: YADE Parameter Reference - HTTPProxy Schema:HTTPProxyParameter: YADE Parameter Reference - SOCKS4Proxy Schema:SOCKS4ProxyParameter: YADE Parameter Reference - SOCKS5Proxy Schema:SOCKS5Proxy |
| proxy_port | Parameter: YADE Parameter Reference - HTTPProxy Schema:HTTPProxyParameter: YADE Parameter Reference - SOCKS4Proxy Schema:SOCKS4ProxyParameter: YADE Parameter Reference - SOCKS5Proxy Schema:SOCKS5Proxy |
| proxy_protocol | ProxyForFTP Schema:ProxyForFTPProxyForWebDAV Schema:ProxyForWebDAVProxyForHTTP Schema:ProxyForHTTPProxyForSFTP Schema:ProxyForSFTPProxyForFTPS Schema:ProxyForFTPSParameter: YADE Parameter Reference - HTTPProxy Schema:HTTPProxyParameter: YADE Parameter Reference - SOCKS4Proxy Schema:SOCKS4ProxyParameter: YADE Parameter Reference - SOCKS5Proxy Schema:SOCKS5Proxy |
| proxy_user | Parameter: YADE Parameter Reference - HTTPProxy Schema:HTTPProxyParameter: YADE Parameter Reference - SOCKS4Proxy Schema:SOCKS4ProxyParameter: YADE Parameter Reference - SOCKS5Proxy Schema:SOCKS5Proxy |
| queue_directory | QueueDirectory Schema:QueueDirectory |
| raise_error_if_result_set_is | RaiseErrorIfResultSetIs Schema:RaiseErrorIfResultSetIs |
| RecurseSubFolders | Parameter: YADE Parameter Reference - Recursive Schema:Recursive |
| recursive | Parameter: YADE Parameter Reference - Recursive Schema:Recursive |
| replacement | ReplaceWith Schema:ReplaceWith |
| ReplaceWhat | ReplaceWhat Schema:ReplaceWhat |
| ReplaceWith | ReplaceWith Schema:ReplaceWith |
| replacing | ReplaceWhat Schema:ReplaceWhat |
| result_list_file | ResultSetFile Schema:ResultSetFile |
| scheduler_host | BackgroundServiceHost Schema:BackgroundServiceHost |
| scheduler_job_chain | BackgroundServiceJobChainName |
| scheduler_port | BackgroundServicePort Schema:BackgroundServicePort |
| scheduler_sosftp_history | BackgroundServiceJobChainName |
| Scheduler_Transfer_Method | BackgroundServiceProtocol Schema:BackgroundServiceProtocol |
| security_hash_type | Parameter: YADE Parameter Reference - CheckIntegrityHash Schema:CheckIntegrityHashParameter: YADE Parameter Reference - HashAlgorithm Schema:HashAlgorithm |
| SecurityHashType | Parameter: YADE Parameter Reference - CheckIntegrityHash Schema:CheckIntegrityHashParameter: YADE Parameter Reference - HashAlgorithm Schema:HashAlgorithm |
| settings | Configurations Schema:Configurations |
| skip_first_files | SkipFirstFiles Schema:SkipFirstFiles |
| skip_last_files | SkipLastFiles Schema:SkipLastFiles |
| SOSFtpHistoryFileName | HistoryFile Schema:HistoryFile |
| source_dir | |
| ssh_auth_file | Parameter: YADE Parameter Reference - SSHAuthentication Schema:SSHAuthenticationParameter: YADE Parameter Reference - AuthenticationFile Schema:AuthenticationFile |
| ssh_auth_method | Parameter: YADE Parameter Reference - SSHAuthentication Schema:SSHAuthentication |
| Steady_state_error_state | CheckSteadyStateErrorState Schema:CheckSteadyStateErrorState |
| SteadyErrorState | CheckSteadyStateErrorState Schema:CheckSteadyStateErrorState |
| SteadyStateErrorState | CheckSteadyStateErrorState Schema:CheckSteadyStateErrorState |
| strict_host_key_checking | Parameter: YADE Parameter Reference - StrictHostkeyChecking Schema:StrictHostkeyChecking |
| StrictHostKeyChecking | Parameter: YADE Parameter Reference - StrictHostkeyChecking Schema:StrictHostkeyChecking |
| subject | Subject Schema:Subject |
| system_property_files | SystemPropertyFiles Schema:SystemPropertyFiles |
| target_dir | Parameter: YADE Parameter Reference - CopyTarget Schema:CopyTargetParameter: YADE Parameter Reference - MoveTarget Schema:MoveTarget |
| TargetDir | Parameter: YADE Parameter Reference - CopyTarget Schema:CopyTargetParameter: YADE Parameter Reference - MoveTarget Schema:MoveTarget |
| TFN_Post_Command | CommandBeforeRename Schema:CommandBeforeRename |
| to | To Schema:To |
| transactional | Parameter: YADE Parameter Reference - Transactional Schema:Transactional |
| TransactionMode | Parameter: YADE Parameter Reference - Transactional Schema:Transactional |
| transfer_mode | Parameter: YADE Parameter Reference - TransferMode Schema:TransferMode |
| transfer_zero_byte_files | Parameter: YADE Parameter Reference - TransferZeroByteFiles Schema:TransferZeroByteFiles |
| TransferZeroByteFiles | Parameter: YADE Parameter Reference - TransferZeroByteFiles Schema:TransferZeroByteFiles |
| use_zlib_compression | ZlibCompression Schema:ZlibCompression |
| user | Account Schema:AccountParameter: YADE Parameter Reference - BasicAuthentication Schema:BasicAuthenticationParameter: YADE Parameter Reference - SSHAuthentication Schema:SSHAuthenticationMailServer Schema:MailServer |
| zero_byte_transfer | Parameter: YADE Parameter Reference - TransferZeroByteFiles Schema:TransferZeroByteFiles |
| zlib_compression_level | ZlibCompressionLevel Schema:ZlibCompressionLevel |