Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

FTP / SFTP package

  • Updated: 9/29/2020
    • Automation 360 v.x
    • Build
    • RPA Workspace

FTP / SFTP package

Use the FTP / SFTP package to automate FTP / SFTP operations.

An FTP/SFTP server hosts the files to share. The client accesses, downloads, or uploads files to the server. The transfer of data between the client and server is done using a TCP/IP network, which is the standard protocol of communication over the internet.
  • The following are some forms of authentication for an FTP server:
    • User credentials: Requires an FTP username and password.
    • Anonymous: This form of authentication is enabled on sites where files are available for public access and the users need not identify themselves to the server.
    • Key-based: SFTP authentication is usually done with a private and public key. The key pair is automatically generated by the computer. The private key is kept with the SFTP client and the corresponding public key with the SFTP server. When establishing a connection, the client shares the private key to be matched with the corresponding public key on the server.
  • FTP can run in active or passive transfer mode.
    • In the active mode, the client informs the server about the port used for listening and starts listening for incoming data connections from the server.
    • In the passive mode, the client receives a server IP address and server port number from the server. The client opens a data connection to the server IP address and server port number that are received. Most organizations prefer the passive mode because it involves less or no alterations to the firewall settings.
  • FTP supports binary and ASCII file transfer types:
    • Use the binary option when transferring executable files.
    • Use the ASCII option when transferring text files.

Before you start

Perform the following actions within the FTP / SFTP package.

  1. Establish a connection with the FTP/SFTP server using the Connect action. When establishing a connection, associate the FTP/SFTP server details with a session name. Use the same session name for all corresponding actions.
  2. Use the FTP/SFTP actions to automate a task. The actions enable you to perform following tasks:
    • Upload, download, delete, or rename files.
    • Upload, download, create, or delete folders.
    • Navigate to the parent folder or a specific folder.
  3. After you have automated the tasks related to FTP / SFTP, terminate the connection to the server using the Disconnect action.
Note: SFTP with SSH1 protocol is no longer supported by SFTP.

Actions in the FTP / SFTP package

The FTP / SFTP package includes the following actions:
Action Description
Change folder Navigates to either the parent folder or another specific folder on an FTP/SFTP server.
  • Enter the session name.

    Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

  • Select either Go to parent folder or Specific folder in Navigate to options.

    If the Specific folder option is selected, enter the complete folder path.

Connect See Using Connect action for FTP/SFTP.
Create folder Creates a folder in an existing folder on the FTP/SFTP server.
  • Enter the session name.

    Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

  • Specify the folder name in the Remote folder field with the path to create a folder on the FTP server.
    Note: The system encounters an error if a folder with the same name exists in the parent folder.
Delete files Deletes files from an FTP/SFTP folder.
  • Enter the session name.

    Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

  • Specify file names in the Remote files field along with the complete path, separated by a semicolon.
Delete folder Deletes a folder (including all the subfolders and files within it) from an FTP/SFTP server.
  • Enter the session name.

    Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

  • Specify the folder name in the Remote folder field.
Disconnect Terminates the connection to the FTP/SFTP server.

Enter the session name – Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

Get files Downloads files from a remote FTP/SFTP folder to a specific folder on the client machine.
  • Enter the session name.

    Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

  • Select files on the remote FTP server that you want to download on the local system.
  • In the Local folder field, enter the name of the folder where you want to download files from the FTP/SFTP server.
  • Select the Transfer Type as Binary or ASCII.
  • You can also specify folders based on the date they are created or modified.
Get folders Downloads a folder from an FTP/SFTP server to a client machine.
  • Enter the session name.

    Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

  • Select folders on the remote FTP server that you want to download on the local system.

    Specify filters using wildcard characters to download only specific types of files.

  • In the Local folder field, enter the name of the folder where you want to download files from the FTP/SFTP server.
  • You can also specify folders based on the date they are created or modified.
Put files Uploads one or more files from the client machine to the FTP/SFTP server.
  • Enter the session name. Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.
  • Enter all the file names along with their location, separated by a semicolon.
  • Select the Transfer type to be either Binary or ASCII
Put folders Uploads a folder from the client machine to the FTP/SFTP server.
  • Enter the session name. Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.
  • Enter the folder name in the Local folder field which you want to upload on FTP/SFTP server.
  • Specify filters using wild card characters to restrict uploads to specific types of files.
Rename files Renames files in an FTP/SFTP folder.
  • Enter the session name.

    Use the same session name that you have provided when establishing a connection with the FTP/SFTP server using the Connect action.

  • In the Remote file field, enter the name of the file that you want to rename.
  • Enter the new name in the New remote file field.
Send Feedback