> For the complete documentation index, see [llms.txt](https://brightwind.gitbook.io/brighthub-user-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://brightwind.gitbook.io/brighthub-user-docs/data-monitoring-guide/data-retrieval-setup.md).

# Data Retrieval Setup

Configuring the Data Retrieval Setup enables BrightHub to automatically retrieve data files for a station. There are multiple options for file retrieval including email, BOX, Google Cloud Storage, SFTP and FTP, all of which can be set up by entering the required credentials. 

***

{% tabs %}
{% tab title="First Tab" %}

{% endtab %}

{% tab title="Second Tab" %}

{% endtab %}
{% endtabs %}

## Configure automated data retrieval

{% hint style="info" %}
**Before you start:**

To access this service, the BrightHub Owner of the measurement station must be an organisation with billing enabled. To enable billing, or request additional data retrieval methods not listed here, contact BrightHub at <support@brighthub.io>.&#x20;

To configure data retrieval for a measurement station you (the user) must have at least "Manage" permission for the measurement station, either via your Organisation or via direct user access.&#x20;
{% endhint %}

Follow the simple steps below to set up data retrieval from one of the available methods:

{% stepper %}
{% step %}

### Go to the Data Monitoring tab for your measurement station.

{% endstep %}

{% step %}

### Select your required data retrieval method from the tabs in the Data Retrieval Setup section.

{% endstep %}

{% step %}

### Configure the data retrieval credentials for your chosen data retrieval method.

Follow the steps outlined in the tab below corresponding to your chosen data retrieval method.

{% tabs %}
{% tab title="Email" %}
In order to allow email data retrieval at the station level, a data retrieval method must be set up at the organisation level. See [Organisation - Data Monitoring](/brighthub-user-docs/reference-user-manual/brighthub-organisations/organisation-data-monitoring.md) for more details.&#x20;

1. Select the email address previously configured in your Organisation view from the drop down box.
2. Provide the email address that the data will be sent from under the "From address" section.&#x20;
3. Paste the subject line from the regular data emails that does not change each day. An example is provided when hovering over the information icon on BrightHub.

{% hint style="info" %}
For example, if logger emails arrive with the subject line:

<p align="center"><mark style="color:$success;">[External]: Daily data email from site_name logger-1234</mark> <mark style="color:red;">01/01/2000 00:00</mark></p>

In the **subject line text** field on BrightHub, you should enter:

<p align="center">[External]: Daily data email from site_name logger-1234</p>

<mark style="color:$success;">Include</mark> any text which is **common to all daily emails** from the logger, such as the serial number, site\_name, logger OEM, client name etc.

<mark style="color:$success;">Include</mark> \[External], or any other similar flag which your IT security system appends to the subject line of emails from external addresses (if applicable).

<mark style="color:red;">Exclude</mark> any text which is not common in all daily emails, in particular the **date / time** as this will change with each new email.

**Example for ZX Lidar:**

Full Subject Line Received:

<p align="center">FW: Daily Data: Wind10_9999@Y2024_M01_D01.ZPH (Averaged data)</p>

Subject Line Text for BrightHub:

<p align="center">FW: Daily Data: Wind10_9999@</p>
{% endhint %}
{% endtab %}

{% tab title="BOX" %}

1. Enter your Client ID, Client Secret, Enterprise ID and Account ID. Further help is found in the information icons next to each field.
2. Enter the Box Folder ID. Files in this folder must be unique to this measurement station.

{% hint style="info" %}
BrightHub will only retrieve files from this folder that have been added or modified after the data retrieval is configured.
\
Ensure the client credentials provided have the correct permissions to download files from this folder path.
{% endhint %}
{% endtab %}

{% tab title="Google Cloud Storage" %}

1. Enter the storage client credentials. These should be in Google Cloud's JSON formatted Service Account Key. Google Cloud's documentation provides more information for creating service account keys: <https://cloud.google.com/iam/docs/keys-create-delete>.
2. Provide your Google Cloud Storage project name, bucket name and folder prefix.

{% hint style="info" %}
BrightHub will only retrieve files from this folder that have been added or modified after the data retrieval is configured.&#x20;

Ensure the client credentials provided have the correct permissions to download files from this folder path.
{% endhint %}
{% endtab %}

{% tab title="SFTP/FTP" %}

1. Provide your SFTP/FTP client credentials - Host name, Port, Username and Password.
2. Provide the SFTP/FTP folder path.

{% hint style="info" %}
BrightHub will only retrieve will only retrieve files from this folder that have been added or modified after the data retrieval is configured.&#x20;

Ensure that the client credentials provided have the correct permissions to download files from this folder path.
{% endhint %}
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

### Optionally select the file extension to retrieve

For each retrieval method, there is an option under "Advanced" to select the specific file extensions you wish BrightHub to process. The default setting is "All extensions". If a specific file extension is selected, files with other extensions will be placed into the "ignored" folder (see [Reference User Manual](/brighthub-user-docs/reference-user-manual.md#file-manager-tab) for detailed on the file manager).
{% endstep %}

{% step %}

### Click the "Save Changes" button.

{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://brightwind.gitbook.io/brighthub-user-docs/data-monitoring-guide/data-retrieval-setup.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.