SFTP

Defines a connection to an SSH File Transfer Protocol (SFTP) server.

Remarks

SftpBinding provides a CMIS+ binding for integrating SFTP servers into Grooper as external content repositories.

---

Overview

• Exposes one or more SFTP directories as CMIS Repositories within Grooper.
• Each repository presents a hierarchical file system (HFS) where SFTP folders and files are mapped to CMIS cmis:folder and cmis:document objects.
• Enables browsing, importing, and exporting of files and folders between Grooper and SFTP servers.

---

Supported Operations

• Browse: Navigate SFTP directories and view files/folders as CMIS objects.
• Import: Use the Import Descendants provider to bring SFTP content into Grooper.
• Export: Configure Export Behaviors or Export activities to send Grooper content to SFTP folders.
• Create: Create new folders and upload new documents to the SFTP server.
• Delete: Remove files, folders, or entire directory trees from the SFTP server.
• Move/Rename: Move files/folders or rename them within the SFTP hierarchy, with conflict resolution options.
• Update Properties: Update supported CMIS properties (e.g., name).

---

Repository Configuration

• Multiple SFTP repositories can be defined via the Repositories property.
• Each repository is configured with:
  • Host name and root path
  • User credentials (username/password or SSH key)
  • Timeout and security options
  • Optional description and read-only mode
• Read-only mode prevents write operations for safety.

---

Security and Authentication

• Supports SFTP authentication using username/password or SSH key (depending on configuration).
• All communication is encrypted via SSH.
• Passwords are stored encrypted internally.
• For best security, use SSH keys and restrict access to configuration settings.

---

Limitations and Notes

• Advanced CMIS features such as versioning, ACLs, and policies are not supported.
• All files and folders are represented as simple types; custom metadata is not mapped.
• The ability to perform write operations depends on repository configuration and user permissions.
• SFTP protocol limitations (e.g., no server-side search) may affect behavior.

---

Usage Example

1. Add an SFTP connection in Grooper and select the SFTP binding.
2. Configure one or more repositories with the desired SFTP root paths and credentials.
3. Use Grooper's import/export features to move content between Grooper and the SFTP server.

---

For more information, see the Grooper documentation on CMIS+ and external repository integration.

Properties

Name	Type		Description
Repositories	SFTP Repository Configuration[]	►	Defines the collection of SFTP repositories to be exposed as CMIS Repositories in Grooper. EditorObject Collection Editor ConverterCollection Converter Each entry in this list represents a separate SFTP repository configuration, allowing Grooper to treat multiple SFTP root directories as independent CMIS repositories. Usage Notes Add, edit, or remove repositories using the property grid or collection editor in the Grooper UI. Each configured repository appears as a separate CMIS repository in Grooper, with its own root folder and file hierarchy. Use read-only mode for import-only scenarios or to prevent accidental changes to SFTP content. Enable connection or directory listing caching for performance in large or slow environments. Ensure credentials and security settings match your SFTP server's requirements. Security Considerations All SFTP communication is encrypted via SSH. Store only necessary credentials and restrict access to configuration settings. For best security, use SSH keys where possible and avoid sharing passwords. Example Add an SFTP connection in Grooper and select the SFTP binding. Add one or more repositories, specifying the host name, credentials, and options. Use Grooper's import/export features to move content between Grooper and the SFTP server.

See Also

SFTP Repository Configuration

Used By

CMIS Connection