│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

SFTP Link

Document Link Grooper.Messaging

Represents a reference to a file on an SSH/SFTP file server.

Remarks

The 'SFTP Link' class is used to connect Batch Folder objects to files located on remote SSH/SFTP servers. This allows Grooper to process, extract, and manage documents stored externally, supporting both sparse import scenarios and dynamic content access.

When a document is imported using an SFTP-based Import Provider in sparse mode, a SFTP Link is created and attached to the Batch Folder instead of copying the file. This enables Grooper to defer content loading until it is needed, optimizing storage and performance for high-volume or distributed environments.

SFTP Link exposes properties such as 'File Path', 'Host Name', 'Port No', 'User Name', and 'Password', which must be configured to establish a secure connection to the SFTP server and locate the desired file. These properties are typically set during import or can be edited manually to update connection details.

The class provides commands for loading, saving, and deleting content on the SFTP server, supporting full lifecycle management of external documents from within Grooper. When content is accessed, Grooper uses the configured connection information to authenticate and stream the file as needed.

Usage Guidance

  • Use SFTP Link to reference files stored on SSH/SFTP servers, enabling integration with external content repositories and file systems.
  • Configure the connection properties to match your SFTP server's address, port, and authentication requirements.
  • Use the provided commands to load content into Grooper, save changes back to the server, or delete files as part of your workflow.
  • SFTP Link is essential for scenarios where documents must remain in external storage, or where rapid ingestion of large volumes is required without duplicating file data.

For more information, see the documentation for Batch Folder, Content Link, and Import Provider.

Properties

NameTypeDescription
General
Server Connection
ContentLink
Linked File Info
Document Link

Context Menu Commands

Command Shortcut Description
description Delete File Deletes the linked file from the SFTP server and removes the SFTP Link from the Batch Folder.
file_copy Load Content Loads the linked file from the SFTP server and stores it locally as the attachment for the Batch Folder.
file_copy Save Content Writes the local attachment from the Batch Folder to the SSH/SFTP file server, updating or creating the external file.
Notification