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

SFTP Import

File Import Grooper.Messaging

Provides import connectivity to SSH/SFTP servers.

Remarks

The SFTP Import provider allows you to import files and folders from SSH/SFTP servers into Batches in Grooper.

You can configure the connection to use a specific host, port, and authentication credentials, and control how files are handled after import (such as moving or deleting them).

Server Connection

  • Set the 'Host Name' to specify the address of the SFTP server.
  • Set the 'Port No' (default is 22 for SFTP).
  • Provide the 'User Name' and 'Password' for authentication.

Import Source

  • Set the 'Base Directory' to specify the root folder on the SFTP server to import from.
  • Optionally, include subfolders to import files from all nested directories by enabling 'Include Subfolders' (inherited).

Disposition

  • Choose how files are handled after import using the 'File Disposition' property:
    • Move: Move files to a new directory after import.
    • Delete: Delete files after import.
    • NoChange: Leave files in place.
  • When moving files, specify the 'Move Location' directory.

File Filtering

  • You can filter files by allowed or excluded file extensions, maximum file size, or exclusion patterns (inherited).

Authentication

  • Only password authentication is supported by this provider.
  • Ensure the user account has read/write permissions for the specified directories.

Usage Notes

  • The SFTP server must be accessible from the Grooper service host.
  • Avoid setting the 'Move Location' to the same path as the 'Base Directory'.
  • Zero-length files and files exceeding the maximum file size are always ignored.
  • If 'Sparse Import' is enabled, files are not downloaded, but a link is created to the SFTP location.
  • When 'File Disposition' is set to Delete, 'Sparse Import' is not allowed.

Properties

NameTypeDescription
Server Connection
Import Source
Disposition
File Filtering
Processing Options

See Also

Used By

Notification