You are here: Reference > Activity methods > Connect-FTP

  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.
RemoteFile

Identify the destination file path. Use syntax appropriate to the operating system on the FTP server. For example:

"C:/temp"

If the path contains any backslash characters, escape each backslash character by doubling it:

"D:\\PRTemp\\StaticContent\\common"

You can enter a property name, property reference or expression that at runtime evaluates to the remote file path.
LocalFile

Identify the source file path and file name. Use syntax appropriate to the operating system that hosts the Pega 7 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.

Example

For an example use of this facility, see the PDN article How to copy files to remote systems using File Transfer Protocol.

Related topicsAbout FTP Server data instances

Methods and instructions by function

Open topic with navigation