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

SFTP Export

File Export Grooper.Messaging

Exports content using the SFTP protocol.

Remarks

Overview

The SftpExport class enables Grooper to export documents and folders to a remote server using the SFTP (SSH File Transfer Protocol) protocol. It extends File Export to provide secure file transfer capabilities over SSH.

Configuration

  • Host Name:
    Set the 'Host Name' property to specify the SFTP server address.
  • Port No:
    Set the 'Port No' property to specify the SFTP server port (default is 22).
  • User Name / Password:
    Provide credentials for authentication.
  • Target Folder:
    Set the 'Target Folder' property to specify the remote directory for exported files.
  • Timeout:
    Set the connection timeout in seconds.
  • Relative Path and Export Formats:
    Inherited from File Export, these properties allow you to define subfolder structure, filenames, and file types for exported content.

Usage Notes

  • The export operation creates directories as needed and uploads files to the specified remote location.
  • The 'Link Name' property (inherited from Export Definition) can be used to label the exported Content Link for tracking and round-trip scenarios.
  • SFTP provides secure, encrypted file transfer over SSH.

Example Scenarios

  • Exporting processed documents to a secure SFTP server for integration with business partners.
  • Archiving scanned images to a remote SFTP backup.
  • Automating delivery of exported files to a secure drop folder.

See Also

For more information on configuring SFTP exports, see the Grooper documentation on SFTP integration.

Properties

NameTypeDescription
General
Server Connection
Content Export

See Also

Notification