FTP Repository Configuration

Defines the configuration for a single FTP directory to be exposed as a CMIS Repository in Grooper.

Remarks

Each instance of this class specifies the connection and behavior for one FTP repository, including its root path, credentials, security options, and operational mode.

---

Configuration Properties

• BasePath: The FTP URL to use as the root of the repository.
• RepositoryName: The display name for this repository in Grooper.
• UserName / Password: Credentials for accessing the FTP directory.
• TimeOut: Timeout (in seconds) for FTP operations.
• EnableSSL: Enables SSL/TLS for secure connections.
• Description: Optional description for documentation or identification.
• ReadOnly: If true, all files and directories are treated as read-only.

---

Usage Notes

• Configure one or more repositories as needed for your environment.
• Use read-only mode to prevent accidental changes when importing or auditing FTP content.
• Ensure credentials and SSL settings match your FTP server's requirements.
• Passwords are stored encrypted for security.

---

Example

Properties

Name	Type		Description
Base Path	String	►	The FTP URL to be used as the root of this repository. EditorFile Directory Editor Requiredtrue Specifies the base directory on the FTP server that will be exposed as the root of the CMIS repository. Example: ftp://ftp.example.com/data All file and folder operations are relative to this path.
Repository Name	String	►	The name to be used for this repository. Requiredtrue This name is 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 FTP directory. Enter the username required by the FTP 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 timeout (in seconds) for calls to the FTP server. Default30 Specifies the maximum duration to wait for FTP operations before timing out. Default: 30 Increase this value for slow servers or large file transfers.
Enable SSL	Boolean	►	If true, secured socket layers (SSL/TLS) will be enabled. DefaultFalse Enable this option to encrypt FTP traffic and credentials. The FTP server must support SSL/TLS for this setting to be effective. Strongly recommended for production environments.
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 FTP content. Attempting to perform write operations will result in an access denied error.

Used By

FTP