Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »


Error rendering macro 'excerpt-include'

No link could be created for 'JADE Client'.

JADE Command Line Interface

Error rendering macro 'excerpt-include'

No link could be created for 'JADE Command Line Interface'.

Read more ...


Error rendering macro 'excerpt-include'

No link could be created for 'JADE API'.

Read more ...


Error rendering macro 'excerpt-include'

No link could be created for 'JADE JITL Jobs'.

Read more ...

About these tutorials

Tutorial Scope

  • The JADE tutorials provide a basis for learning how to use the JADE Client via the Command Line Interface mentioned above. They are intended to function as a Getting Started Guide before proceeding to increasingly complex examples.
  • The tutorials describe operation of the JADE Client from the command line, e.g. by using a batch script. The other methods of operating the Client are:

Operating Environment

  • The examples have been written for use on Windows and Unix systems. Settings files for Windows and Unix systems are available for download via the links in the next section.
  • The examples presented on this page use demonstration FTP and SFTP servers that we have configured for this purpose on our web site.
    • Both servers have the same address:
    • A user demo can log on with password demo and download demonstration files. They cannot upload or delete files.

Configuration file Format and Editor

Configurations for the JADE Client up to and including Release 1.10 are saved in text-based  settings.ini files. From Release 1.11 onwards XML configuration will be used, which will significantly reduce the complexity of more extensive configurations.

The SOS GmbH has developed the XML Editor which provides an easy to follow graphical representation of JADE XML configurations and uses forms to guide users through the process of developing configurations. The XML Editor saves JADE configurations in the XML format and can generate a working settings.ini configuration file. A comparison of both formats can be found in the JADE User Manual - Configuration Formats & Tools article.

We strongly recommend the use of this editor which uses an XSD schema to validate should bring a significant reduction in configuration errors and debugging time.

  • Comments in JADE settings.ini profiles are added using double semi-colons (";;"). CAN DELETE?

Using the tutorials with the JADE Client Command Line Interface

The JADE Client should be installed

The XML Editor should be installed.

Setting up the examples

  • For Windows users the location for the jade.cmd file is:
    • C:\Program Files\\jade\client\bin
    • or the location that was specified when installing JADE
  • for Unix users the location for the file is:

Note that comments in the JADE settings profiles are added using double semi-colons (";;").

Running the examples

  • Either open the command line interface in the location where you have installed the jade.cmd or files or use suitable path name prefixes.
  • The command line parameterization is identical for both the Windows and the Unix command line.
  • Run the examples by entering the following in the command line, e.g. for the first of the examples listed below:
jade.cmd -settings="%USERPROFILE%\jade_demo\jade_settings.ini" -profile="ftp_server_2_local"
./ -settings="${HOME}/jade_demo/jade_settings.ini" -profile="ftp_server_2_local"

Results of the first example

Running the first example using the ftp_server_2_local profile listed in the code blocks above will cause six test*.txt files to be downloaded to the a sub-folder of the jade_demo folder created following the instructions in the Setting up the Examples section above.

Note for Unix Users

All other examples in this series of articles list the profile settings and command line call for Windows environments. Unix users will find suitable profile settings in the Unix version of the jade_settings.ini file which was linked above and will be able to adapt the Windows command line calls in the manner shown above.

Using the tutorials with the JobScheduler JADE JITL Job

The JADE JITL job tutorial is available with JobScheduler - Tutorial 5 - The JADE JITL Job - Configuring and running file transfer jobs.





  • No labels