Introduction
JADE Command Line Interface
JADE API
JADE JITL Jobs
About these tutorials
- The JADE tutorials provide a basis for learning how to use the JADE Client. They service as a Getting Started Guide and proceed 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:
- using the JADE API
- using the JobScheduler's JADE JITL Jobs
- The examples have been written for use in Windows and Unix environments. 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 public 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.
- Comments in JADE settings profiles are added using double semi-colons (";;").
Using the tutorials with the JADE Client Command Line Interface
The JADE Client should be installed
- You can download the JADE Client from our JADE Download Page or from SourceForge.
- Installation of JADE on Unix systems is covered in the How to install JADE article.
Setting up the examples
- For Windows users:
- Create a jade_demo folder in your user home directory with a and b sub-folders like this:
mkdir %USERPROFILE%\jade_demo
mkdir %USERPROFILE%\jade_demo\a
mkdir %USERPROFILE%\jade_demo\b
- Download the jade_settings_windows.ini file containing the example profiles presented in this article to the %USERPROFILE%/jade_demo folder and rename it to jade_settings.ini
- Create a jade_demo folder in your user home directory with a and b sub-folders like this:
- For Unix users:
- Create a jade_demo folder in your user home directory with a and b sub-folders like this:
mkdir ~/jade_demo
mkdir ~/jade_demo/a
mkdir ~/jade_demo/b
- Download the jade_settings_unix.ini file containing the example profiles presented in this article to the ~/jade_demo folder and rename it to jade_settings.ini
- Create a jade_demo folder in your user home directory with a and b sub-folders like this:
:
- For Windows users the location for the jade.cmd file is:
C:\Program Files\sos-berlin.com\jade\client\bin
- or the location that was specified when installing JADE
- for Unix users the location for the jade.sh file is:
~/sos-berlin.com/jade/client/bin
- or the location that was specified when installing JADE
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 jade.sh 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:
Windows
jade.cmd -settings="%USERPROFILE%\jade_demo\jade_settings.ini" -profile="ftp_server_2_local"
Unix
./jade.sh -settings="${HOME}/jade_demo/jade_settings.ini" -profile="ftp_server_2_local"
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
TODO
Pages
Navigation