Difference between revisions of "OS4X plugin os4xplugin ftp upload"

From OS4X
Jump to navigation Jump to search
Line 16: Line 16:
 
*Path: target path where to upload files to.
 
*Path: target path where to upload files to.
 
**Syntax: /<pathToUpload>
 
**Syntax: /<pathToUpload>
 +
**Example: <code>/upload</code>
 
**Missing leading slashes will be appended automatically, but you should configure this.
 
**Missing leading slashes will be appended automatically, but you should configure this.
 
**Trailing slashes will be removed automatically, but you should not configure these.
 
**Trailing slashes will be removed automatically, but you should not configure these.

Revision as of 08:39, 20 November 2014


Purpose

For simple FTP upload tasks, this plugin can transfer all job files to a target FTP server


Configuration

The plugin must be configured on per-partner level and has no global configuration.

Configuration parameters are:

  • Server: server incl. protocol being used. Supported protocols are (at least, but not limited to) "ftp".
  • Path: target path where to upload files to.
    • Syntax: /<pathToUpload>
    • Example: /upload
    • Missing leading slashes will be appended automatically, but you should configure this.
    • Trailing slashes will be removed automatically, but you should not configure these.
  • (optionally) Username: The username used for login to the server.
  • (optionally) Password: The password used for login to the server.

Bevahiour

The plugin loops over all files of the job and handles them separately (one after another). For each file, the plugin

  • connects to the FTP server
  • uploads the file to the target directory with the temporary name with a leading dot (".") in front of the virtual filename
  • after upload, the file is being renamed to the virtual filename without the leading dot.

Since the plugin has no specific configuration for proxies, the plugin uses the system-wide proxy settings of your system (see OS4X HTTP Proxy support).