Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinh1. true
outlinh1. true
1printablefalse
2stylh1. none
3indent20px
h1. Modularizing Profiles: include directive

YADE profiles with settings for transfer history, log file and Background Service

General

JADE do log YADE logs each and every file transfer in a local CSV history file and in a log4j format file. The transfer file history can be sent to the YADE Background Service.
The Background Service will insert the transfer

An Example Transfer Profile

history into a table of its database.

Example for transfer profile with global settings for transfer history, log file and Background Service

jade_settings.ini file with settings for history CSV, log file and Background ServiceA profile definition for Server to Server transfer, from a sftp to a ftp server:

Code Block

 [ftp_server_2_serverMailSettings]
 sshfile_auth_method=password
 
 source_user=kb
 source_password=*****
 source_ssh_auth_method=password
 source_host=wilma.sos
 source_protocol=sftp
 source_port=22
 
 target_user=test
 target_password=*****
 target_host=8of9.sos
 target_protocol=ftp
 target_port=21
 
 file_spec=^.*\.txt$
 operation=copy
 
 log_filename=$\{TEMP\}/sosftphistory.lognotification_to      = admin@example.com
 file_notification_subject = YADE Client mail
 file_notification_body    = This is a test.
 mail_smtp                 = mail.example.com
 
 [BackgroundService]
 BackgroundServiceHost     = 8of9.sos
 BackgroundServicePort     = 4210
 SendTransferHistory       = true
 TransferMethod            = TCP

 [JADEHistory]
 log_filename      = ${basedir}/jade_history.log
 HistoryFileName   = ${basedir}/jade_history.csv

 [globals]
 include           = MailSettings , JADEHistory, BackgroundService
 title             = Global Profile
 basedir           = C:\sos-berlin.com\jade

In this example all files with the file name extension ".txt" should be transfered transferred from the server "wilma" via sftp SFTP to the server 8of9 by ftpFTP. the folders are not explicitely explicitly specified and therefore the "home" folders of the user are is selected.

Profile fragments

To make the profile more reusable and readable it is possible to reuse profiles snipets in the way like this:

YADE will write the transfer history into a CSV file and will send the log entry to the Background Service

Define profiles using the include directive

The include parameter will include the named profiles in the order they are defined. The globals profile is included automatically, no need to specific it in an include parameter.
The profiles have to be defined in the same settings file:

Code Block
[ftp_server_2_server] 
 include                = globals 
 source_user            = kb
 source_password        = 
Code Block

 [wilma]
 user=kb
 password=***** 
 source_ssh_auth_method = password
 source_host            = wilma.sos
 source_protocol        = sftp
 source_port            = 22

 [8of9]
 user= target_user            = test
 target_password        = *****
 target_host            = 8of9.sos
 target_protocol        = ftp
 target_port            = 21

 [globals]
 log_filename=$\{TEMP\}/sosftphistory.log

The profiles for wilma and 8of9 are defined only once. They could be used as many time as needed in different transfer profiles. There is a "globals" profile as well.

Define Profiles using the include directive

Now we will specify the transfer profile again:

Code Block

 [ftp_server_2_server]
 source_include=wilma
 target_include=8of9
 operation= operation              = copy
 file_spec=^.*\.txt$
          
 [ftp_more]
 target_include=wilma
 source_include=8of9
 operation=move
 file_spec=^.*\.(txt|pdf|dat)$
 source_folder=/outbound/daily
 target_folder=/inbound/transfer

The "include" parameter will include the named profiles in the order they are defined. In the first example wilma will be included as source and in the second example as target. The "globals" profile is included automatically, no need to specifiy it in an include parameter.
The profiles must be defined in the same settings file.

txt$
   

See also

 For infos about the parameters see the parameter documentation on jadeParameterReference.