Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
FTP connector
The Create Directory Component allows users to create a directory on an FTP server, ensuring that the specified path exists by creating any missing subdirectories.
This component connects to an FTP server and creates a directory at the specified path, making it useful for workflows that require structured file storage.
in
Receives the directory path to create.
out
Confirms successful directory creation.
path
string
The directory path to create. Missing parent directories will also be created if they do not exist.
Establishes FTP Connection: Connects to the FTP server using provided credentials.
Creates Directory:
Checks if the specified path exists.
If not, creates the directory and any required parent directories.
Confirms Completion: Returns a confirmation response upon successful directory creation.
status
string
Confirms successful directory creation.
Recursive Directory Creation: Ensures all missing parent directories are created.
Secure FTP Connection: Uses authentication details to establish a secure connection.
Ideal for Automated File Management: Supports structured directory creation within FTP workflows.
This component is essential for workflows that require automated directory management on an FTP server.
The Remove Directory Component allows users to delete a directory from an FTP or SFTP server. It ensures efficient directory management within automated workflows.
This component connects to an FTP/SFTP server and removes the specified directory.
path
string
The directory path to be removed.
in
Accepts the directory path for removal.
out
Emits success confirmation when the directory is removed.
notFound
Emits an error if the directory does not exist or permission is denied.
Establishes FTP/SFTP Connection: Securely connects to the remote server using provided authentication credentials.
Attempts to Remove Directory:
Tries to delete the directory at the specified path.
Ensures proper handling of directory permissions.
Handles Success & Errors:
If successful, sends confirmation to the out port.
If the directory does not exist or permission is denied, emits an error to notFound.
Closes Connection: Ensures the FTP/SFTP session is properly terminated.
path
string
The directory path that was processed.
errorCode (if error)
string
FTP/SFTP error code.
errorMessage (if error)
string
Description of the error encountered.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.
Error Handling: Properly manages missing directories and permission-related issues.
Efficient Directory Management: Enables automated cleanup of remote directories.
This component is essential for workflows that require automated directory management and cleanup on remote servers.
The Get File Info Component retrieves metadata about a specific file from an FTP or SFTP server, allowing workflows to analyze file details before further processing.
This component connects to an FTP/SFTP server, fetches metadata for a specified file, and provides information about its name, size, modification time, and permissions.
in
Receives the file path for which metadata is to be retrieved.
out
Emits the file's metadata, including name, type, size, and timestamps.
notFound
Emits an error if the file is not found or access is denied.
path
string
The full remote file path for which metadata is requested.
Establishes FTP/SFTP Connection: Connects to the remote server using provided authentication.
Retrieves File Metadata:
Checks if the specified file exists.
Retrieves details such as name, size, and modification time.
Handles Success & Errors:
If successful, outputs file metadata to the out port.
If the file is missing or access is denied, sends an error message to notFound.
Closes Connection: Ensures the connection is terminated after execution.
name
string
The name of the file.
type
number
Indicates whether it is a file or directory.
size
number
The size of the file in bytes.
modifiedAt
number
The timestamp of the last modification.
rawModifiedAt (FTP only)
number
The raw modification timestamp.
modifyTime (SFTP only)
number
The modification time of the file.
accessTime (SFTP only)
number
The last access time of the file.
rights (SFTP only)
object
The file's access permissions (user, group, other).
longname (SFTP only)
string
A detailed description of file properties.
path (if error)
string
The requested file path if not found.
errorCode (if error)
string
The FTP/SFTP error code.
errorMessage (if error)
string
Description of the error encountered.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.
Comprehensive Metadata: Retrieves essential details like size, timestamps, and permissions.
Error Handling: Detects missing files and permission errors, sending appropriate error messages.
This component is useful for workflows requiring file validation before downloading or processing.
The Download File Component retrieves a file from a remote FTP or SFTP server and saves it locally, allowing seamless file transfer automation.
This component connects to an FTP/SFTP server, downloads a specified file, and provides metadata upon successful retrieval.
in
Receives the file path to be downloaded.
out
Emits the downloaded file's metadata including file ID, filename, checksum (MD5), and file size.
notFound
Emits an error if the file is not found or if access is denied.
path
string
The full remote file path to be downloaded.
Establishes FTP/SFTP Connection: Connects to the remote server using provided authentication.
Initiates File Download:
Retrieves the specified file using the given path.
Streams the file content for local storage.
Handles Success & Errors:
If successful, outputs file metadata to the out port.
If the file is missing or access is denied, sends an error message to notFound.
Closes Connection: Ensures the connection is terminated after execution.
fileId
string
Unique identifier of the downloaded file.
filename
string
Name of the downloaded file.
md5
string
MD5 checksum of the file to ensure integrity.
length
number
Size of the file in bytes.
path (if error)
string
The requested file path if not found.
errorCode (if error)
string
The FTP/SFTP error code.
errorMessage (if error)
string
Description of the error encountered.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.
Error Handling: Detects missing files and permission errors, sending appropriate error messages.
Efficient File Transfer: Uses streaming for optimized file downloads.
This component is ideal for workflows requiring automated file retrieval from remote servers.
The Upload File Component enables users to upload files to a remote FTP or SFTP server. It ensures seamless file transfer for automated workflows requiring remote storage management.
This component connects to an FTP/SFTP server and uploads a specified file to a given path.
fileId
string
The unique identifier of the file to upload.
path
string
The full path where the file should be stored, including the filename. If a file already exists at the path, it will be overwritten.
in
Accepts the file ID and target path for upload.
out
Emits the uploaded file’s ID upon successful transfer.
error
Emits an error if the upload fails due to invalid paths, missing files, or permission issues.
Establishes FTP/SFTP Connection: Securely connects to the remote server using provided authentication credentials.
Reads the Input File:
Retrieves the file stream from the provided fileId.
Uploads the File:
Transfers the file to the specified path.
If a file with the same name exists, it is overwritten.
Handles Success & Errors:
If successful, sends the uploaded file’s fileId to the out port.
If an error occurs (e.g., path is an existing directory or lacks permissions), emits a descriptive error to the error port.
Closes Connection: Ensures the FTP/SFTP session is properly terminated.
fileId
string
The unique identifier of the uploaded file.
errorCode (if error)
string
FTP/SFTP error code.
errorMessage (if error)
string
Description of the error encountered.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.
Overwrites Existing Files: If a file exists at the target path, it will be replaced.
Error Handling: Properly manages missing files, invalid paths, and permission-related issues.
Efficient File Transfer: Enables automated file uploads to remote servers.
This component is ideal for workflows that require seamless file transfers to remote FTP/SFTP servers.
The List Component retrieves a list of files and directories from an FTP or SFTP server at a specified path, enabling workflows to manage and process remote files dynamically.
This component connects to an FTP/SFTP server, lists the contents of a specified directory, and provides information about the files and folders.
in
Receives the directory path for which the listing is to be retrieved.
out
Emits the list of files and directories within the specified path.
path
string
The remote directory path for which the listing is requested.
Establishes FTP/SFTP Connection: Connects to the remote server using provided authentication.
Lists Directory Contents:
Checks if the specified path exists.
Retrieves details such as filenames, file types, and sizes.
Handles Success & Errors:
If successful, outputs the directory contents to the out port.
If the path is invalid or access is denied, an error is thrown.
Closes Connection: Ensures the connection is terminated after execution.
content
array
A list of files and directories in the specified path. Each entry contains metadata such as name, type, size, and timestamps.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.
Efficient File Management: Enables dynamic file and directory processing within workflows.
Error Handling: Detects invalid paths and permission errors, sending appropriate error messages.
This component is essential for workflows that require automated remote file and directory listing.
The Remove File Component allows users to delete a file from an FTP or SFTP server. It ensures efficient file management within automated workflows.
This component connects to an FTP/SFTP server and removes the specified file.
path
string
The file path to be removed.
in
Accepts the file path for removal.
out
Emits success confirmation when the file is removed.
notFound
Emits an error if the file does not exist or permission is denied.
Establishes FTP/SFTP Connection: Securely connects to the remote server using provided authentication credentials.
Attempts to Remove File:
Tries to delete the file at the specified path.
Ensures proper handling of file permissions.
Handles Success & Errors:
If successful, sends confirmation to the out port.
If the file does not exist or permission is denied, emits an error to notFound with details.
Closes Connection: Ensures the FTP/SFTP session is properly terminated.
path
string
The file path that was processed.
errorCode (if error)
string
FTP/SFTP error code.
errorMessage (if error)
string
Description of the error encountered.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.
Error Handling: Properly manages missing files and permission-related issues.
Efficient File Management: Enables automated cleanup of remote files.
This component is essential for workflows that require automated file deletion on remote servers.
The Rename File Component allows users to rename or move a file within an FTP or SFTP server by providing the original path and a new path.
This component connects to an FTP/SFTP server and renames a file or moves it to a different directory.
path
string
The current file path.
newPath
string
The new path or name for the file.
in
Accepts the original file path and the new file path for renaming or moving.
out
Emits success confirmation when the file is renamed or moved.
notFound
Emits an error if the file does not exist or permission is denied.
Establishes FTP/SFTP Connection: Securely connects to the remote server using provided authentication credentials.
Attempts to Rename or Move File:
Renames the file if the new path is in the same directory.
Moves the file if the new path specifies a different directory.
Ensures proper handling of file permissions.
Handles Success & Errors:
If successful, sends confirmation to the out port.
If the file does not exist or permission is denied, emits an error to notFound with details.
Closes Connection: Ensures the FTP/SFTP session is properly terminated.
path
string
The original file path.
newPath
string
The new file path after renaming or moving.
errorCode (if error)
string
FTP/SFTP error code.
errorMessage (if error)
string
Description of the error encountered.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) connections.
Error Handling: Properly manages missing files and permission-related issues.
File Management: Enables renaming or moving files within the remote server structure.
This component is essential for workflows that require automated file renaming or relocation on remote servers.
The New File Component monitors an FTP or SFTP server for newly created files and directories within a specified path, enabling workflows to react dynamically to file changes.
This component connects to an FTP/SFTP server, watches a directory for new files and folders, and emits metadata whenever a new item appears.
Establishes FTP/SFTP Connection: Connects securely to the remote server using authentication credentials.
Monitors Directory for Changes:
Lists all current files in the specified path.
Compares against previously seen files.
Detects new files and directories.
Handles Detected Changes:
If new files or directories are found, outputs their metadata to the out port.
Saves the current state for future comparisons.
Closes Connection: Ensures the connection is terminated after execution.
Supports FTP & SFTP: Works with both FTP and secure FTP (SFTP) servers.
Automated File Monitoring: Continuously detects and processes new files or directories.
Error Handling: Ensures reliable detection by maintaining a known file state.
This component is useful for workflows requiring automatic response to file additions in remote directories.
path
string
The directory path to monitor for new files or directories.
out
Emits metadata for newly detected files or directories.
name
string
Name of the new file or directory.
size
number
Size of the file in bytes.
type
string
Indicates if it's a file or directory.
modifiedAt
number
Timestamp of the last modification.
permissions
string
File permissions.
hardLinkCount
number
Number of hard links to the file.
link
string
Link to the file, if applicable.
group
string
Group ownership of the file.
user
string
User ownership of the file.
uniqueID
string
Unique identifier of the file.