Difference between revisions of "OS4X plugin os4xplugin ftp upload"
Jump to navigation
Jump to search
| Line 11: | Line 11: | ||
Configuration parameters are: | Configuration parameters are: | ||
*Server: server incl. protocol being used. Supported protocols are (at least, but not limited to) "ftp". | *Server: server incl. protocol being used. Supported protocols are (at least, but not limited to) "ftp". | ||
| − | **Syntax: | + | **Syntax: <nowiki>ftp://<ip or hostname></nowiki> |
| − | |||
**Traling slashed are being eliminated automatically, but you should not configure these. | **Traling slashed are being eliminated automatically, but you should not configure these. | ||
**Example: <code>ftp://192.168.1.2</code> or <code>ftp://ftp.myserver.com</code> | **Example: <code>ftp://192.168.1.2</code> or <code>ftp://ftp.myserver.com</code> | ||
| + | *Path: target path where to upload files to. | ||
| + | **Syntax: /<pathToUpload> | ||
| + | **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 == | == 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 ("<code>.</code>") 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]]). | ||
Revision as of 08:38, 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".
- Syntax: ftp://<ip or hostname>
- Traling slashed are being eliminated automatically, but you should not configure these.
- Example:
ftp://192.168.1.2orftp://ftp.myserver.com
- Path: target path where to upload files to.
- Syntax: /<pathToUpload>
- 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).