FTP Task / Publisher¶
The ftp task / publisher allows to download or upload files/ folders, for example, uploading a new version of a web page to ftp site of an ISP.
Version¶
Available from version 1.5
Examples¶
1<ftp>
2 <serverName>ftp.isp.com</serverName>
3 <userName>john</userName>
4 <password>doe</password>
5 <action>UploadFolder</action>
6 <ftpFolderName>site/config</ftpFolderName>
7 <localFolderName>d:\website\config</localFolderName>
8 <recursiveCopy>true</recursiveCopy>
9</ftp>Configuration Elements¶
| Element | Description | Type | Required | Default | Version |
| action | The action to perform. | String - one of: * UploadFolder * DownloadFolder |
No | DownloadFolder | 1.5 |
| description | Description used for the visualisation of the buildstage, if left empty the process name will be shown. | String | No | The task/publisher name. | 1.5 |
| dynamicValues | The dynamic values to use for the task. | Dynamic Values array | No | None | 1.5 |
| environment | A set of environment variables set for commands that are executed. Each variable should be specified as . |
Environment Variable array | No | ||
| ftpFolderName | The path to the folder to use on the FTP server. | String | Yes | n/a | 1.5 |
| localFolderName | The to the folder to use on the local machine. | String | Yes | n/a | 1.5 |
| password | The password to use. | String | Yes | n/a | 1.5 |
| recursiveCopy | Whether to perform a recursive copy or not. | Boolean | No | true | 1.5 |
| serverName | The name of the server to connect to. | String | Yes | n/a | 1.5 |
| timeDifference | Time difference between server and client (relative to client) in hours. | Int32 | No | 0 | 1.6 |
| useActiveConnectionMode | Whether to use active connection mode or not. | Boolean | No | true | 1.5 |
| userName | The username to log in with. | String | Yes | n/a | 1.5 |
Notes¶
Integration Properties¶
| Label | Description | Example | Version |
| CCNetArtifactDirectory | The project artifact directory (as an absolute path) | C:\Program Files\CruiseControl.NET\Server\MyProject\Artifacts | 1.0 |
| CCNetBuildCondition | The condition used to trigger the build, indicating if the build was triggered by new modifications or if it was forced. Legal values are: IfModificationExists or ForceBuild | ForceBuild | 1.0 |
| CCNetBuildDate | The date of the build (in yyyy-MM-dd format) | 2005-08-10 | 1.0 |
| CCNetBuildTime | The time of the start of the build (in HH:mm:ss format) | 08:45:12 | 1.0 |
| CCNetFailureTasks | The list of name of tasks which have contributed to the current build failure. When the description of the task is filled in, this will be shown. | Exec Task | 1.7 |
| CCNetFailureUsers | The list of users who have contributed modifications to a sequence of builds that has failed. | John, Smith | 1.0 |
| CCNetIntegrationStatus | The status of the current integration. Could be Success, Failure, Exception or Unknown | Success | 1.0 |
| CCNetLabel | The label used to identify the CCNet build. This label is generated by the CCNet labeller. | 1.0.2.120 | 1.0 |
| CCNetLastIntegrationStatus | The status of the previous integration. Could be Success, Failure, Exception or Unknown | Success | 1.0 |
| CCNetListenerFile | View build progress : task output that shows how far the build is | c:\Project\Artifact\listener.xml | 1.4.0 |
| CCNetModifyingUsers | The list of users who have contributed to the current build only | Smith | 1.0 |
| CCNetNumericLabel | Contains the label as an integer if conversion is possible, otherwise zero. | 1 | 1.0 |
| CCNetProject | The name of the CCNet project that is being integrated. | MyProject | 1.0 |
| CCNetProjectUrl | The URL where the project is located | http://myhost/ccnet/server/ | 1.0 |
| CCNetRequestSource | The source of the integration request; this will generally be the name of the trigger that raised the request. | IntervalTrigger | 1.1.0 |
| CCNetUser | The user who forced the build. If security is off, or the build is not forced, then this will not be set. | John Doe | 1.5.0 |
| CCNetWorkingDirectory | The project working directory (as an absolute path) | C:\Program Files\CruiseControl.NET\Server\MyProject\WorkingDirectory | 1.0 |
Automatically Generated¶
Documentation generated on Monday, 26 May 2014 at 7:18:03 AM