# SFTP Monitor

All component configurations are classified broadly into 3 section

* [Basic ](/bdb-documentation/data-pipeline/components/component-base-configuration.md)
* Metadata
* [Resource Configuration](/bdb-documentation/data-pipeline/components/resource-configuration.md)

Please follow the demonstration to configure the component.

![](/files/IS3XRBhlf0ONnFev6Q3r)

**SFTP Monitor**

i)  Drag and Drop the SFTP Monitor consumer component which is inside the consumer section of the system component part to the Workflow Editor.

ii)            Click the dragged ingestion component to get the component properties tabs.

![](/files/hI8mKhFiLoYav3ab4hX8)

iii)          Configure the **Basic Information Tab**.

a.      Select the invocation type (at present only the ‘**Real-Time**’ option is provided).

b.      Deployment Type: It comes preselected based on the component.

c.       Container Image Version: It comes preselected based on the component.

d.      Failover Event: Select a failover event from the drop-down menu.

e.       Batch Size (min 10): Provide the maximum number of records to be processed in one execution cycle (Min limit for this field is 10).

![](/files/CapgG7bHxp4bFbRHWBhH)

iv)  Configure the **Meta Information** **tab** for the dragged SFTP Monitor component.

a.   Host: Broker IP or URL

b.   Username: If authentication is required then give username

c.    Port: Provide the Port number

d.   Authentication: Select an authentication option using the drop-down list.

       i.    Password: Provide a password to authenticate the MQTT component.

       ii.    PEM/PPK File: Choose a file to authenticate the MQTT component

e.    Directory Path: Fill monitor folder path using forward-slash (/). E.g., **monitor/**

f.     Copy Directory Path: Fill in the copy folder name where you want to copy the uploaded file. E.g., **monitor\_copy/**

g.   Channel: Select a channel option from the drop-down menu (the supported channel is SFTP).

![](/files/PzJObS9VF3MccsrOXqeU)

Meta Information Fields when the Authentication option is Password

![](/files/WPJQNOkilXRXjVEYWRf8)

Meta Information Fields when the Authentication option is PEM/PPK

 

![](/files/M4y5ykeRnExJVGySklZb)

v)            Click the ‘**Save Component in Storage**’ icon to save configured details of the SFTP Monitor component.

![](/files/HX5Yat12NMCWh44nick8)

vi)           A notification message appears to confirm the same.

{% hint style="success" %}
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.
{% endhint %}

![](/files/EsxOFw03FikyzDL4NQmP)

                 

                 

 

 


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bdb.ai/bdb-documentation/data-pipeline/components/consumers/sftp-monitor.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.