FTP facility: Difference between revisions

1,000 bytes added ,  14:22, 26 March 2021
additional info
(Initial edit)
 
(additional info)
Line 3: Line 3:


== Operation ==
== Operation ==
The operation is implicit and has no specific commandline or module name. When CumulusUtils is run, with whatever command, the output is copied directly to the required URL when the application is required to do so.
The operation is implicit and has no specific commandline or module name. When CumulusUtils is run, with whatever command, the output is copied directly to the specified URL when the application is required to do so. All protocols supported by CumulusMX are also supported by CumulusUtils that is: FTP, FTPS and SFTP.


The FTP upload operation is subject to the optimisation parameter [[Thrifty]], see also the [[CumulusUtils#Running_CumulusUtils|commandline]]. The [[Thrifty]] command qualifier finds its origin in the presence of low debit payed lines over which the output has to be transferred. This called for reduction of the output size. For details see [[Thrifty]].
The FTP upload operation is subject to the optimisation parameter [[Thrifty]], see also the [[CumulusUtils#Running_CumulusUtils|commandline]]. The [[Thrifty]] command qualifier finds its origin in the presence of low debit payed lines over which the output has to be transferred. This called for reduction of the output size. For details see [[Thrifty]].
Line 14: Line 14:
     DoUploadFTP=true | false                          (when '''false''' no Uploads take place, when '''true''' it is otherwise)
     DoUploadFTP=true | false                          (when '''false''' no Uploads take place, when '''true''' it is otherwise)
     UploadDir=                                        (specification of the FTP directory where to upload the output files without trailing slash)
     UploadDir=                                        (specification of the FTP directory where to upload the output files without trailing slash)
                                                      (When empty
     FtpLog=on | off                                  (If '''on''' the additional FTP logging is done, when '''off''' otherwise)
     FtpLog=on | off                                  (If '''on''' the additional FTP logging is done, when '''off''' otherwise)


== Inner working ==
== Inner working ==
If DoUploadFTP equals true, then the FTP username and password the other parameters for the FTP site are taken from the [[Cumulus.ini]] file will be used to upload the output files.
So beside the username and password the '''Host''', '''Port number''', '''Directory''', '''ActiveFTP''', '''Sslftp''' are used. All other parameters are ignored. The '''UTF8encode''' setting is irrelevant because ''CumulusUtils'' uses UTF8 for all its files so can't be optional.
If the required '''Host''' inifile parameter is empty, then no upload  takes place.
If the destination in ''CumulusUtils'' is NOT specified (''UploadDir'' is empty) then the destination specified in [[Cumulus.ini]] is used ('''Directory''').
Then next, in a loop over all output files entitled , the upload takes place as the final stage of the ''CumulusUtils'' run.