Page History

Table of Contents

Introduction

Use of the JADE Client will be significantly changed with the introduction of an XSD schema and XML configuration files with version 1.11. The use of the schema is intended to simplify file transfer configuration for the Client - particularly for complex file transfer situations.

...

A parameter mapping is available for users wishing to compare settings file and XML file transfer configurations.

File transfer configuration up to Version 1.10.x

File transfer configurations are stored in a settings.ini file.

...

Parameters that can be defined separately for the source and target parts of the transfer - for example, the host name and port number - are set with the source_ and target_ prefixes.

...

[ftp_server_2_local]
;;
 operation               = copy
;;
 source_host             = test.sos-berlin.com
 source_protocol         = ftp
 source_port             = 21
 source_user             = demo
 source_password         = demo
 source_dir              = /
;;
 target_host             = localhost
 target_protocol         = local
 target_dir              = ${USERPROFILE}\jade_demo\a

Running a file transfer profile

A file transfer is started by specifying a settings.ini file and the profile in that file that is to be used.

For example, the profile listed above is called using:

jade.cmd -settings="%USERPROFILE%\jade_demo\jade_settings.ini" -profile="ftp_server_2_local"

./jade.sh -settings="${HOME}/jade_demo/jade_settings.ini" -profile="ftp_server_2_local"

Limitations of this approach

Whilst this approach is relatively straightforward to understand when used with simple file transfer situations:

• it is prone to configuration errors and
• becomes difficult to understand and therefore maintain when advanced and complex file transfer configurations are implemented.

More Information

• Detailed descriptions of the parameter configuration and the use of profiles is available in our JADE Tutorials. These include examples that can be tested using our

...

• demonstration FTP and SFTP servers. A download containing a configuration file for the tutorial examples is also available.
• Parameter Reference & Mapping

  Status
  colour Yellow title To be Completed

File transfer configuration from Version 1.11 onwards

The XML schema that will be file transfer configuration introduced with version 1.11 of JADE will allow allows parameter dependencies in JADE to be checked before transfer configurations are tested.validated before the configuration file is transferred to an operating environment.

Dependencies and conflicts between configuration elements are avoided through the use of an XSD schema

An XML editor is available that will simplify the creation and validation of schema-compatible file transfer configurations.

The basic principles behind the organization of the schema and parameters will be described in this document. A detailed description of individual parameters can be found in our Parameter Reference.

The following code block screen shot shows the same test host FTP file transfer example described in the previous section in XML form and ready for use in version 1.11 of the JADE Client. the SOS XML Editor:

Image Added

The following code block shows the XML configuration file for the test host FTP file transfer example shown in the XML Editor screen shot above in XML form:

<?xml version="1.0" encoding="UTF-8"?>
<Configurations>
  <Fragments>
    <ProtocolFragments>
      <FTPFragment name="test.sos-berlin.com">
        <BasicAuthentication>
          <Account><![CDATA[demo]]></Account>
          <Password><![CDATA[demo]]></Password>
        </BasicAuthentication>
        <BasicConnection>
          <Hostname><![CDATA[test.sos-berlin.com]]></Hostname>
          <Port><![CDATA[21]]></Port>
        </BasicConnection>
      </FTPFragment>
    </ProtocolFragments>
  </Fragments>
  <Profiles>
    <Profile profile_id="ftp_server_2_local">
      <Operation>
        <Copy>
          <CopySource>
            <CopySourceFragmentRef>
              <FTPFragmentRef ref="test.sos-berlin.com" />
            </CopySourceFragmentRef>
            <SourceFileOptions>
              <Selection>
                <FilePathSelection>
                  <FilePath><![CDATA[/]]></FilePath>
                </FilePathSelection>
              </Selection>
            </SourceFileOptions>
          </CopySource>
          <CopyTarget>
            <CopyTargetFragmentRef>
              <LocalTarget />
            </CopyTargetFragmentRef>
            <Directory><![CDATA[${USERPROFILE}\jade_demo\a]]></Directory>
          </CopyTarget>
        </Copy>
      </Operation>
    </Profile>
  </Profiles>
</Configurations>

Although longer and seemingly more complex than the settings file configuration version shown above, this example was produced using the graphical editor and therefore has been validated against the JADE Client XSD Schema. It is error and conflict free and dependencies are correctly specified.

Running a file transfer profile

A file transfer is started by specifying an XML configuration file and the profile in that file that is to be used.

For example, the profile listed above is called using:

jade.cmd -settings="%USERPROFILE%\jade_demo\jade_user_manual_configuration.xml" -profile="ftp_server_2_local"

./jade.sh -settings="${HOME}/jade_demo/jade_user_manual_configuration.xml" -profile="ftp_server_2_local"

More Information

Comparison of the two approaches reveal a significant difference in the concept behind the two approaches to configuration:

...