Connect-FTP method
Use this method to copy a file from one file system to another file system using File Transfer Protocol.
Parameters
The Connect-FTP method has four parameters:
| Parameter | Description |
| FTPServer | Select the name of an FTP server data instance to use for this file transfer. |
| RemotePath | Specify the relative path to the destination directory specified on the FTP
service. Use forward slashes regardless of whether the FTP Service is running on
Windows or Linux. For example, if the FTP directory on the FTP service is set to c:\ftp, specify the relative path as a blank path between quotes: If the c:\ftp directory on the FTP service has a documents directory under it, c:\ftp\documents, specify the relative path as: You can enter a property name, property reference or expression that at runtime evaluates to the remote file path. For Pega Cloud clients specifying a relative path in the Pega Cloud File storage folder, enter file://pegacloudfilestorage:/attachments, as an example. |
| LocalFile |
Identify the source file path and file name. Use syntax appropriate to the
operating system that hosts the
Pega Platform
server. If the path
contains backslash characters, escape each backslash character by doubling it.
You can enter a property name, property reference or expression that at runtime evaluates to the local file path and name. |
| TransferMode |
Select
ASCII
for character-mode data transfers, or
Binary
for binary data. The default is ASCII.
|
Results
The system uses information on the Environment tab of the FTP server data instance to log into the FTP server. Upon successful log-in, the system transfers the file identified in the LocalFile parameter to the filename and directory identified in the RemoteFile parameter, and then ends the FTP connection.
Checking the method status
This method updates the pxMethodStatus property. See How to test method results using a transition.
Previous topic Connect-File method Next topic Connect-HBase method