SFTP Monitor
SFTP (Secure File Transfer Protocol) Monitor is used to monitor and manage files transfer over SFTP servers. It is designed to keep track of file transfers over SFTP.
All component configurations are classified broadly into the following sections:
Meta Information
Please follow the below demonstration to configure SFTP Monitor component.
Steps to configure the SFTP Monitor Component
Drag and Drop the SFTP Monitor consumer component which is inside the consumer section of the system component part to the Workflow Editor.
Click the dragged ingestion component to get the component properties tabs.
Basic Information Tab
The Basic Information Tab is the default tab for the component.
Select the Invocation Type (at present only the Real-Time option is provided).
Deployment Type: It comes preselected based on the component.
Container Image Version: It comes preselected based on the component.
Failover Event: Select a failover event from the drop-down menu.
Batch Size (min 10): Provide the maximum number of records to be processed in one execution cycle (Min limit for this field is 10).
Meta Information Tab
Configure the Meta Information tab for the dragged SFTP Monitor component.
Host: Broker IP or URL
Username: If authentication is required then give username
Port: Provide the Port number
Authentication: Select an authentication option using the drop-down list.
Password: Provide a password to authenticate SFTP Monitor.
PEM/PPK File: Choose a file to authenticate the SFTP Monitor component. The user needs to upload a file if this authentication option has been selected.
Directory Path: Fill the monitor folder path using forward-slash (/). E.g., /home/monitor
Copy Directory Path: Fill in the copy folder name where you want to copy the uploaded file. E.g., /home/monitor_copy
Please Note: Don't use a nested directory structure in the directory path and copy directory path. Else the component won't behave in an expected manner.
Don't use the dirpath and copy-path as follows: dirpath: home/monitor/datacopy-dir:home/monitor/data/copy_data
Channel: Select a channel option from the drop-down menu (the supported channel is SFTP).
Meta Information Fields when the Authentication option is Password
Meta Information Fields when the Authentication option is PEM/PPK
Saving the Component Configuration
Click the Save Component in Storage icon to save configured details of the SFTP Monitor component.
A notification message appears to confirm the same.
Please Note:
a. The SFTP Monitor component monitors the file coming to the monitored path and copies the file in the Copy Path location for SFTP Reader to read.
b. The SFTP Monitor component requires an Event to send output.
c. The SFTP Monitor send the file name to the out event along with File size, last modified time and ingestion time (Refer the below image).
d. Only one SFTP monitor will read and move the file if multiple monitors are set up to monitor the same file path at the same time.
Last updated
