Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content added

...

The following code block 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. 

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.

Code Block
languagexml
titleA simple profile for transferring files by FTP from a test host to the local file system
<?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.

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

  • Settings file configuration
    Parameters such as host, protocol, user, password and dir (directory) are usually grouped separately in the settings file configuration according to whether they apply to the transfer source or target. This usually has no functional meaning (the files are processed from top to bottom) and is partly simply for convenience (grouping parameters together makes them easier to find) and partly to allow their reuse in the form of so-called profile fragments if required.
  • XML configuration
    • Parameters are divided up between profile and fragment branches. (Note that these expressions are defined differently to elements in the settings file configuration with the same names.)
      • authentication and connection parameters (Account & Password and Hostname & Port respectively) and the protocol (defined through the use of FTP) are part of the Fragments branch of the configuration.
      • the operation (copy) and the source and target file paths (FilePath and LocalTarget respectively) are specified in the Profiles branch.
      • the CopySourceFragmentRef element refers to the FTPFragment specified in the Fragments branch
    • The division between Fragments and Profiles branches allows the reuse of elements whilst working within the strict hierarchical structure of XML.
      • The use of a reference in the Profiles branch (in the example, using the CopySourceFragmentRef element) to specify the authentication and connection parameters in the Profiles branch allows any number of Profiles elements to be defined and specified as required.

 

Display children header