Table of Contents

Connections

Commands

Connections

FTPS

BizApp for connecting to FTP servers through both encrypted and non-encrypted connections.

Inputs

Input

Type

Detail

Notes

Hostname

TextField

The hostname of your FTP server.

Port

NumberField

The port to connect to

Username

TextField

The username to connect with.

Password

TextField

The password for the FTP user.

Protocol

DropdownField

The protocol to use

PROT Value

DropdownField

When connecting using the FTPS protocol, data transfers can either be encrypted or not encrypted. Some servers require that the data transfers be encrypted, in that case select 'P'

Commands

Delete Files/Directories

Delete a list of files and directories based on path search text. You may use * as a wildcard. NOTE: Directories must be empty

Inputs

Input

Type

Detail

Notes

Files

TextField

The path search text to use (i.e. /my/ftp/folder/*.txt)

Include Directories

BooleanField

If this is checked, directories that match the Files input will also be deleted.

Delete Recursively

BooleanField

If checked, any directories that match the Files input will be recursively deleted. NOTE: This only applies if Include Directories is checked.

Outputs

Output

Output Type

Notes

Files Deleted

Json

Exit Codes

Code

Type

Detail

0

Success

Success

2

Error

There was an error running the command

1

Error

Unable to connect to the FTP server

Download File

Download a file from the FTP server

Inputs

Input

Type

Detail

Notes

File

TextField

The full path to the file to download (Use unix based path separators i.e. /my/file/to/download)

Outputs

Output

Output Type

Notes

Downloaded File

File

Exit Codes

Code

Type

Detail

0

Success

Success

2

Error

There was an error running the command

1

Error

Unable to connect to the FTP server

Download Files

Download multiple files from the FTP server. NOTE: This can only be used with a GroundRunner

Inputs

Input

Type

Detail

Notes

Files

TextField

The path search text to use (i.e. /my/ftp/folder/*.txt)

Destination

TextField

The full path to the download location. This must be an absolute path.

Create Destination

BooleanField

If this is checked, the destination directory will be created.

Outputs

Output

Output Type

Notes

Downloaded File Paths

Json

Exit Codes

Code

Type

Detail

0

Success

Success

2

Error

There was an error running the command

1

Error

Unable to connect to the FTP server

List Files/Folders

Get a list of files and folders based on path search text. You may use * as a wildcard.

Inputs

Input

Type

Detail

Notes

Directory

TextField

The path search text to use (i.e. /my/ftp/folder/*.txt)

Outputs

Output

Output Type

Notes

Files

Json

Exit Codes

Code

Type

Detail

0

Success

Success

2

Error

There was an error running the command

1

Error

Unable to connect to the FTP server

Make Directory

Create a new directory on the FTP server

Inputs

Input

Type

Detail

Notes

Directory

TextField

The full path to the directory (i.e. /my/ftp/folder/*.txt)

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

2

Error

There was an error running the command

1

Error

Unable to connect to the FTP server

Move/Copy Files

Move or copy files from one location on the FTP server to another

Inputs

Input

Type

Detail

Notes

Files

TextField

The path search text to use (i.e. /my/ftp/folder/*.txt)

Destination

TextField

The full path to the destination directory. This must be a directory and not a file.

Create Destination

BooleanField

If this is checked, the destination directory will be created.

Copy

BooleanField

If this is checked, the files will be copied to the new location and not renamed.

Outputs

Output

Output Type

Notes

Create file locations

Json

Exit Codes

Code

Type

Detail

0

Success

Success

2

Error

There was an error running the command

1

Error

Unable to connect to the FTP server

Upload File

Upload a file to the FTP server

Inputs

Input

Type

Detail

Notes

Destination

TextField

The full path to the upload location (Use unix based path separators i.e. /my/file/to/download)

File

FileField

The file to upload

Create path

BooleanField

If this is checked, the directory that the destination file is specified to be in will be created if it does not exist.

Content is binary

BooleanField

Check this if the file content is binary. (Examples would be .zip files or executable binaries)

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Success

2

Error

There was an error running the command

1

Error

Unable to connect to the FTP server

Did this answer your question?