SFTP Repository Configuration

Defines a SFTP server to be mounted as a repository.

Remarks

SftpRepositoryConfiguration specifies the connection and operational settings for a single SFTP repository exposed to Grooper as a CMIS Repository.

---

Overview

Each instance of this class represents a distinct SFTP root directory, with its own connection, authentication, and performance options.

---

Usage Notes

• Configure one or more repositories as needed for your environment.
• Use read-only mode for import-only or audit scenarios.
• Enable connection or directory listing caching for performance in large or slow environments.
• Passwords are stored encrypted; restrict access to configuration settings.

Properties

Name	Type		Description
Host Name	String	►	The SFTP hostname to be used as the root of this repository. EditorFile Directory Editor Requiredtrue Specifies the SFTP server's host name or IP address. Example: sftp.example.com or 192.168.1.100 All file and folder operations are relative to this server.
Repository Name	String	►	The name to be used for this repository. Displayed in Grooper when listing available repositories. Choose a descriptive name to help users identify the repository's purpose or contents.
User Name	String	►	The user account for accessing the SFTP directory. Requiredtrue Enter the username required by the SFTP server for authentication. The format may vary depending on your server (e.g., user, DOMAIN\\user, or user@domain.com).
Password	String	►	The password for the specified user name. The password is stored encrypted internally and is not displayed in the UI. Ensure the password matches the specified user account. For security, restrict access to configuration settings containing credentials.
Time Out	Int32	►	The time (in seconds) for connections to the SFTP server. Default30 Specifies the maximum duration to wait for SFTP operations before timing out. Default: 30 Increase this value for slow servers or large file transfers.
Maximum Connection Attempts	Int32	►	The maximum number of times a connection should be attempted before giving up. Default1 Specifies how many times Grooper will retry connecting to the SFTP server before failing. Default: 1 Increase for unreliable or high-latency networks.
Description	String	►	An optional description for this repository. Use this field to provide additional context or notes about the repository. The description is displayed in the Grooper UI for documentation purposes.
Read Only	Boolean	►	If set to true, all files and directories will be treated as readonly. DefaultFalse When enabled, write operations (create, update, delete) are blocked for this repository. Useful for import-only scenarios or to prevent accidental changes to SFTP content. Attempting to perform write operations will result in an access denied error.
Cache Connection	Boolean	►	If set to true, specifies that connection caching should be used to improve performance. DefaultFalse Enables reuse of the SFTP connection for multiple operations, reducing connection overhead. Recommended for SFTP servers with slow connection times or when processing large numbers of files. May cause issues with load-balanced SFTP servers; disable if unexpected behavior occurs.
Cache Directory Listings	Boolean	►	If set to true, specifies that directory listings should be cached to improve performance when iterating large directories. DefaultFalse Use this option when importing from largely static directories containing many thousands of files. Improves efficiency of paging through large result sets during browsing or import jobs. Disable if directory contents change frequently.

Used By

SFTP