Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Examples moved to JADE Examples area

...

An example configuration using the 'Copy' Operation was shown on the Configuring File Transfers with the JADE Client page.

The example was generated using the SOS XML Editor and is shown both as a configuration tree in the editor and as a JADE XML configuration file.

Example Configuration using the '

...

GetList' Operation

An example configuration using the 'GetList' Operation is shown on the Example: Configuration using the 'GetList' Operation page

The getlist operation requires two child elements:

  • GetListSourceFragmentRef, which includes parameters specifying the fragment parameters to be used to connect to the directory/directories to be listed and
  • SourceFileOptions, which includes parameters specifying the directory/directories to be listed, file selection criteria and whether polling should be carried out.

A target fragment is not required:

  • the ResultSetFile parameter can be used specify a file in which the results of the getlist operation are saved
  • if a ResultSetFile is not specified the default output for getlist is the JADE log4j logger

A simple getlist configuration in the SOS XML Editor is shown in the screenshot below.

Image Removed

The above configuration looks for two files on the 'demo' FTP server on the SOS 'test' subdomain and lists their occurrence in the JADE log file.

Status
colourYellow
titleBLEIBT SO?

The configuration uses an FTPFragment with a basic connection and password authentication to log onto the server.

Two files are specified in the FilePath element.

The following listing shows the XML configuration file generated by the Editor.

Code Block
titleA simple profile that looks for 2 files and creates a list showing their occurrence
collapsetrue
 <?xml version="1.0" encoding="UTF-8"?>
<Configurations>
  <Fragments>
    <ProtocolFragments>
      <FTPFragment name="demo-test.sos-berlin.com">
        <BasicAuthentication>
          <Account><![CDATA[demo]]></Account>
          <Password><![CDATA[demo]]></Password>
        </BasicAuthentication>
        <BasicConnection>
          <Hostname><![CDATA[test.sos-berlin.com]]></Hostname>
        </BasicConnection>
      </FTPFragment>
    </ProtocolFragments>
  </Fragments>
  <Profiles>
    <Profile profile_id="ftp_demo_getlist_lorem_ipsum">
      <Operation>
        <GetList>
          <GetListSourceFragmentRef>
            <FTPFragmentRef ref="demo-test.sos-berlin.com" />
          </GetListSourceFragmentRef>
          <SourceFileOptions>
            <Selection>
              <FilePathSelection>
                <FilePath><![CDATA[a/lorem_ipsum_medium.pdf.gz,a/lorem_ipsum_large.pdf.gz]]></FilePath>
              </FilePathSelection>
            </Selection>
          </SourceFileOptions>
        </GetList>
      </Operation>
    </Profile>
  </Profiles>
</Configurations>

A simple profile that uses FTP to look for 2 files on a test host and lists their occurrence in the the JADE log file.