| Table of Contents |
|---|
Scope
- The XML Editor can export an XML configuration as used for JADE 1.11 to a compatible .ini format as used for JADE 1.10 and earlier.
- This allows to use the the JADE - Reference Documentation - Parameter Reference and to create valid configuration files.
- You can use the XML Editor graphical GUI and at the same time continue to use .ini files for JADE releases before 1.11.
- The following examples have been created by use of the XML Editor
- Each sample file references the XSD schema from the JADE - Reference Documentation - XSD Schema Reference
- Each sample is available in compatible .xml and .ini formats for your reference.
- The samples are based on configuration examples as explained in the JADE - Tutorials.
Configuring the XML Editor
...
Activating the JADE Xml2Ini Converter Plugin
The XML Editor comes with a sub-folder plugins in the installation directory.
- By default all Plugins that are deployed with this folder are available with the XML Editor. Therefore the Xml2Ini Converter is active by default.
- Should the sub-folder
pluginsnot be available, e.g. should this folder have been renamed, then you cannot use the conversion feature. - If the Xml2Ini Converter is available then you can use the respective operation from the main menu and from the tab context menu.
- The XML Editor shows a file dialog and suggests an .ini export file with the same basename as the current .xml configuration file.
Configuring the XML Editor for automated Cconversion
The XML Editor comes with the feature to auto-save configuration files in the .ini format when saving to the .xml format, i.e. doing the conversion automatically.
- To activate this feature adjust the check-box "Autosave ini file" to be checked. We recommend to use this feature if you want to create compatible .xml and .ini configuration files for JADE releases 1.10 and 1.11.
- This allows to manage configurations for JADE 1.11 in XML format and to have a parallel .ini file being created for use with JADE 1.10. Keeping both .xml and .ini configuration files in sync will allow a smooth migration to JADE 1.11 - as long as you would not manually modify the .ini file.
- In autosave mode the .ini file will be overwritten whenever the .xml file is saved.
- In addition you can enable desktop notifications to be created if a .ini file is being saved.
Examples
- All examples are used for the JADE Configuration XSD schema http://www.sos-berlin.com/schema/jade/JADE_configuration_v1.0.xsd
- All examples are compatible for use with JADE 1.10 (.ini) and JADE 1.11 (.xml)
Getting Started
See tutorial The JADE Client Command Line Interface - Tutorial 1 - Getting Started
XML Configuration: getting_started.xml
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[protocol_fragment_ftp@ftp_server_2_local]
protocol = ftp
host = test.sos-berlin.com
port = 21
user = demo
password = demo
passive_mode = true
[protocol_fragment_sftp@sftp_server_2_local_pass]
protocol = sftp
host = test.sos-berlin.com
port = 22
user = demo
ssh_auth_method = password
password = demo
[profile@ftp_server_2_local]
operation = copy
source_include = protocol_fragment_ftp@ftp_server_2_local
file_spec = .*
source_dir = /
target_protocol = local
target_host = localhost
target_dir = ${USERPROFILE}\jade_demo\a
overwrite_files = true
transactional = true
[profile@sftp_server_2_local_pass]
operation = copy
source_include = protocol_fragment_sftp@sftp_server_2_local_pass
file_spec = .*
source_dir = /
target_protocol = local
target_host = localhost
target_dir = ${USERPROFILE}\jade_demo\a
overwrite_files = false
transactional = true |
Simple File Selection
- See tutorial The JADE Client Command Line Interface - Tutorial 2 - Simple File Selection
- XML Configuration: simple_file_selection.xml
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[protocol_fragment_sftp@sftp_server_2_local_select_recursive]
protocol = sftp
host = test.sos-berlin.com
port = 22
user = demo
ssh_auth_method = password
password = demo
[protocol_fragment_sftp@sftp_server_2_local_zero_byte]
protocol = sftp
host = test.sos-berlin.com
port = 22
user = demo
ssh_auth_method = password
password = demo
[profile@sftp_server_2_local_select_recursive]
operation = copy
source_include = protocol_fragment_sftp@sftp_server_2_local_select_recursive
file_spec = ^test_.\.txt$
source_dir = /rec
recursive = true
target_protocol = local
target_host = localhost
target_dir = ${USERPROFILE}\jade_demo\a
overwrite_files = false
[profile@sftp_server_2_local_zero_byte]
operation = copy
source_include = protocol_fragment_sftp@sftp_server_2_local_zero_byte
file_spec = ^test_[0-9]\.txt$
source_dir = /
zero_byte_transfer = relaxed
target_protocol = local
target_host = localhost
target_dir = ${USERPROFILE}\jade_demo\a |
More Advanced File Selection
- See tutorial The JADE Client Command Line Interface - Tutorial 3 - More Advanced File Selection
- XML Configuration: more_advanced_file_selection.xml
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[protocol_fragment_sftp@sftp_server_2_local_poll_minfiles]
protocol = sftp
host = test.sos-berlin.com
port = 22
user = demo
ssh_auth_method = password
password = demo
[profile@sftp_server_2_local_poll_minfiles]
operation = copy
source_include = protocol_fragment_sftp@sftp_server_2_local_poll_minfiles
file_spec = ^test_[0-9]\.txt$
source_dir = /
poll_interval = 20
poll_timeout = 1
poll_minfiles = 5
polling_server = false
polling_server_poll_forever = false
target_protocol = local
target_host = localhost
target_dir = ${USERPROFILE}\jade_demo\a |
File Transfer
- see tutorial The JADE Client Command Line Interface - Tutorial 4 - File Transfer
- XML Configuration: file_transfer.xml
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[protocol_fragment_sftp@sftp_server_2_local_cumulate]
protocol = sftp
host = test.sos-berlin.com
port = 22
user = demo
ssh_auth_method = password
password = demo
[profile@replace_local_datestamp]
operation = copy
source_protocol = local
source_host = localhost
replacing = ^(test)(_)[0-9]\.txt
replacement = file_;[date:yyyy-MM-dd]_
file_spec = ^test_[0-9]\.txt$
source_dir = ${USERPROFILE}\jade_demo\a
target_protocol = local
target_host = localhost
target_dir = ${USERPROFILE}\jade_demo\b
[profile@sftp_server_2_local_cumulate]
operation = copy
source_include = protocol_fragment_sftp@sftp_server_2_local_cumulate
file_spec = ^test_.\.txt$
source_dir = /
target_protocol = local
target_host = localhost
target_dir = ${USERPROFILE}\jade_demo\a
cumulate_files = true
cumulative_file_separator = --- File: %{SourceFileName} ---
cumulative_file_name = text-files.txt |
Checking Files for Completenss
- See tutorial The JADE Client Command Line Interface - Tutorial 5 - Checking files for completeness
- XML Configuration: checking_files_for_completeness.xml
...