Skip to main content

Atrius CSV (SFTP Method)

Updated over a week ago

👍 This article will help you:

  • Set up SFTP credentials and configure your CSV integration

  • Understand CSV formatting requirements and data flow

  • Map discovered data points to buildings in Atrius

  • Automate recurring file uploads

  • Troubleshoot your Atrius CSV (SFTP) integration


Overview

Many building systems are capable of trending data to a CSV file, which can then be pushed via SFTP to Atrius on a recurring basis. Your Atrius point of contact (Customer Success Manager, Project Manager, or Customer Support) can supply SFTP credentials for your organization to enable secure file transfer.

To view your current Atrius CSV integration details and status, go to Settings on the left side menu, select Integrations, then select Atrius CSV.

Integration Methods

This article covers the SFTP CSV Push Method, which requires SFTP credentials to securely transmit CSV files to Atrius. This method is suitable for systems that can generate CSV files locally and push them via an SFTP client on a scheduled basis.

Looking for a different method?

  • If your system supports or is already configured for direct HTTPS data transmission without SFTP credentials - refer to the Atrius CSV article instead.

Setup Process Overview

The order of steps is critical for successful integration. You must push data two times at specific stages before readings will appear in Atrius.

Step-by-step workflow:

  1. Request SFTP Credentials - Submit a request to your Atrius point of contact

  2. Receive Credentials - Allow up to 10 business days for Atrius to provide your SFTP username and password

  3. First File Upload - Connect to the SFTP server and upload your CSV file to the root directory

  4. Wait for Processing - Allow approximately 15 minutes for automatic file processing and archival

  5. Create Gateway - Add the Atrius CSV integration in Atrius to generate your Gateway ID

  6. Verify Gateway - Confirm your gateway appears on the Atrius CSV integrations page

  7. Discover Points - Navigate to Point Discovery, filter by your gateway, and view newly discovered points

  8. Connect Points - Connect each point to a building and add required metadata (Building Name, Data Type, Source Unit, Display Unit, Reading Type)

  9. Second File Upload - Upload your CSV file again to populate actual readings

  10. Verify Readings - Refresh your browser to see time series data on newly connected points

  11. Automate Uploads - Configure automated SFTP uploads using a script (Python, VBScript) and task scheduler

Each of these steps is detailed in the sections below.


SFTP CSV Push Method

This method uses secure file transfer protocol (SFTP) with authentication credentials to push CSV files to Atrius. An SFTP client and scheduling tool are used to automate file uploads. When configured with a task scheduler (Windows Task Scheduler, cron), your system can automatically transmit CSV files to the Atrius SFTP server on a recurring basis. Automating your data pushes to Atrius is recommended, but optional.

When to use this method:

  • Your organization allows SFTP outbound connections (port 22)

  • You need credential-based authentication for security compliance

  • Your system can generate CSV files locally but cannot push data via direct HTTPS

  • You're using systems that support SFTP clients


Prerequisites

  • Active Atrius Energy account

  • Network access to sftp://ftp.buildingos.com

  • Outbound SSH File Transfer Protocol (port 22) access

  • SFTP client software (e.g., FileZilla, WinSCP)

  • Structured CSV files that follow Atrius CSV format requirements


Request SFTP Credentials

Submit a request to your Atrius point of contact with the following information:

  • Organization Name

  • Customer Integration ID

  • Suggested Gateway Name (format: [YourOrgName]_FTP)

    • The gateway name determined in this step will be used in the Create Gateway step below

    • Be specific with your Gateway name. You may want to identify the building and/or subsystem relying on the gateway for easy identification in the future
      Suggested format: CustomerIntegrationNameftp

  • Sample CSV files in your planned format

Note: SFTP account setup typically takes 5-10 business days.



CSV File Format Requirements

Atrius can generate points from two types of CSV schemas, to reflect the two most common formats found in existing building automation exports.

Understanding the Atrius ID

The Atrius ID uniquely identifies a point within Atrius

  • If you are pushing points for the first time:

    • The point name from your building automation system will automatically become the Catalog Point ID in Atrius.

  • After the point has been created:

    • You may use either the Catalog Point ID or the Atrius ID to uniquely identify the point in subsequent data pushes.

  • You can assign a more user‑friendly Point Name once the point is connected to Atrius.

    • Example: A unique ID of 'flr_3_lightingkWh' can appear in Atrius as “Third Floor Lighting.”

  • You can find the Atrius ID for an existing point on its Point Profile.

Your CSV file must meet these specifications:

  • Plain text format only (no Excel formulas or formatting)

  • If you are pushing data for existing points, the unique IDs in the header (header‑based) or first column (tuple‑based) must match existing Atrius IDs or Catalog Point IDs.

  • Date & Time must be in the same column

  • Date & Time must be in order of oldest to newest (ascending)

  • Preferred timestamp format: ISO YYYY/MM/DD HH:MM:SS

    • Example: September 27, 2025 at 6 p.m. → 2025/09/27 18:00:00

  • Alternative formats accepted:

    • MM/DD/YYYY HH:MM:SS

    • DD/MM/YYYY HH:MM:SS (If using this format, set Days first in dates = Yes in the gateway profile)

  • Note: ISO format works regardless of the Days first in dates setting

If your CSV file contains text placeholders ("none"), null values ("null"), or blank values (" ") instead of numeric data, those values will NOT be ingested and the corresponding points will appear offline in Atrius.

Standard CSV Format (Header-based)

  • The header row consists of Timestamp, followed by the unique identifier for each point (Atrius ID or Catalog Point ID)

  • The first column contains the timestamps, ordered from oldest to newest

  • Each subsequent column contains the data for the unique identifier in the column header

Timestamp

Unique_Meter_ID1

Unique_Meter_ID2

6/2/2025 0:15

4

8.72

6/2/2025 0:30

5

9.53

6/2/2025 0:45

6

10.24

Alternative CSV Format (Tuple-based)

This should only be used for special circumstances where your system cannot produce the standard header-based format.

If your data is not available in the Standard CSV Format, you may alternatively use the Tuple Format, however it requires some additional configuration on the Gateway profile. Note, the header row displayed below should not be included in the data push.

Meter

Time

kWh

Unique_Meter_ID1

6/2/2025 0:15

8.72

Unique_Meter_ID1

6/2/2025 0:30

8.24

Unique_Meter_ID2

6/2/2025 0:15

3

Each row contains the Atrius ID or Catalog Point ID, timestamp and value, ordered from oldest to newest (ascending). Data for multiple points can be pushed in the same file.

Configuring the gateway for Tuple-based format:

  1. Navigate to the Atrius CSV gateway profile

  2. Under Configuration, add the appropriate parsing parameters:

    • advancelines: Number of header rows to skip

    • timestamp: Column index for timestamps (0-based)

    • channel: Column index for meter/point identifier

    • value: Column index for the reading value

  3. Save the configuration and push your CSV again

Tuple-based configuration: advancelines=1;timestamp=1;channel=0;value=2;


Uploading CSV Files via SFTP

  1. Launch your SFTP client - we will use FileZilla for demonstration purposes

  2. Log onto the FileZilla app and enter the following:

    1. SFTP address: sFTP://FTP.buildingos.com

    2. Port 22

    3. SFTP username

    4. SFTP password

  3. Post the CSV file in the root of the directory

  4. Wait approximately 15 minutes for automatic processing

After processing, the file will be moved to an archive folder organized by date. To reprocess data, move the archived file back to the root directory as needed.

Setting Up Your CSV Gateway

You must push data at least once before setting up your gateway in Atrius. Complete the Uploading CSV Files via SFTP section above first.

You must push data at least once before setting up your gateway in Atrius. Complete the Uploading CSV Files via SFTP section above first.

Step 1: Obtain Your Gateway ID

Your Gateway ID is the unique gateway ID used in the step Requesting SFTP Credentials.

Step 2: Add the Integration in Atrius

  1. Navigate to Settings > Integrations

  2. Click Add an Integration

  3. Select Atrius CSV from the list of available integrations

  4. Enter your Gateway ID, YourUniqueGatewayName, in the CSV Gateway ID field

  5. Click Connect

Your gateway is now configured. You will now see your recently created gateway in Atrius. Refresh your browser to see the newly discovered point(s).

Connecting Discovered Points

After pushing your CSV file, you will need to map discovered data points to buildings in Atrius.

Step 1: View Discovered Points

This step is to locate the points you would like to connect.

  1. Navigate to Integrations > Atrius CSV

  2. Use the Filter button to view points under your specific gateway

Step 2: Connect and Configure Points

This step is to connect points and configure the point profiles. It is expected that readings will not appear on the data manager yet.

For each point you want to add to Atrius:

  1. Click the Connect button next to the point

  2. Provide the required information:

    • Building Name: Select the building where this meter is located

    • Data Type: Select the type of data (e.g., electricity, gas, water)

    • Source Unit: The unit of measurement in your CSV file

    • Display Unit: The unit you want displayed in the Atrius data manager

    • Reading Type: Select the appropriate reading type

      • Learn more about Reading Types here

The Reading Type is critical for proper data interpretation. The reading type should match the configuration at the source. You may need to test different options to find the correct setting.

3. Click Connect to save the point profile configuration

Step 3: Push Time Series Data

This step is to push the actual time series data to the recently connected points in Atrius.

  1. Once you have connected the desired points and completed the point profile configuration, post data in FileZilla one last time

  2. Navigate to the Source tab of each recently connected Point to verify your data is being received correctly

Now, readings will be available on the data manager of the recently connected points in Atrius.

Easily access the recently connected points by navigating to Settings > Integrations > Atrius CSV > Gateways > select the desired gateway > select the Points tab.

If timestamps appear incorrect, navigate to the gateway profile and toggle the "Convert Time to UTC" setting > Save.

Not all users have access to the gateway profile. If you need assistance, please reach out to Customer Support.


Automating Your Data Push

Python VB Script

For automated uploads, you can use a Python VB script with the pysftp library.

Example script:

 #
import pysFTP
cnopts = pysFTP.CnOpts()
cnopts.hostkeys = None
with pysFTP.Connection(
'FTP.buildingos.com',
username='REDACTED',
password='REDACTED',
# log=1 # uncomment for debug logging
cnopts=cnopts) as sFTP:
sFTP.put(
'./file_001.CSV', # Source
'./file_001.CSV', # Target
)

Then, use Windows Task Scheduler or cron (Linux/Mac) to schedule your data pushes.

Example bash command (cron):

# Run daily at 1:00 AM 0 1 * * * /usr/bin/python3 /path/to/your_script.py

Troubleshooting

Common Error Codes

400 Error - Bad Request

  • Check your CSV file format

  • Verify your Gateway ID is correct

  • Ensure the datasource parameter in your URL matches your Gateway ID

500 Error - Server Error

  • Server-side issue; try again later

If all Atrius CSV points are offline

  • Reboot the dedicated server that is generating the CSV data file(s)

  • Verify that port 443 outbound is enabled for HTTPS

  • Verify any scheduled tasks that either generate or deliver the CSV data file

  • Verify and/or correct any recent formatting changes to the CSV data file, including:

    • Timestamp format

    • Header formatting

    • Atrius ID (Point ID) Names

Important: For existing points, the unique identifier (Atrius ID or Catalog Point ID) in your CSV file must match the unique identifier on the point profile. See CSV File Format Requirements for Point ID best practices.

If only a partial list of Atrius CSV points are offline

  • Ensure individual Atrius IDs and Point Values exist within your CSV data file

  • Verify that CSV cells do not contain text ("none"), null values ("null"), or blank values (" ")

  • Verify that the individual metering hardware/devices are reporting expected values

If any Atrius CSV points are flatlined

  • Verify that the individual metering hardware/devices are reporting expected values

  • Check that new data is being written to your CSV files on the expected schedule

Points Not Appearing

  • Verify the CSV file was successfully pushed (check for error messages in FileZilla)

  • Ensure new points are not filtered out in the discovery view

  • Refresh your browser after data push

Incorrect Time Values

If timestamps in Atrius don't match your source data:

  1. Navigate to Settings > Integrations > Atrius CSV or: https://buildingos.com/gateways/service/30

  2. Select your CSV gateway

  3. Toggle the Convert Time to UTC setting

  4. Push your CSV file again to verify the timestamps are correct

If you receive an error when entering Gateway ID

This typically means your SFTP account has not been created yet. Contact Customer Support to verify your setup request has been completed (typically takes 5-10 business days).

Non-Standard CSV Format

If your data is not in one of the accepted formats listed above in CSV File Format Requirements, please reach out to Customer Support for assistance with your configuration.


Additional Resources

  • A Facilities or Controls point of contact would be able to determine if individual metering hardware/devices have lost power or network connectivity.

  • A Network or IT point of contact would be able to determine if the dedicated CSV server is down or impacted by recent network/firewall changes.


🚧 Forward to Additional Contacts

Please forward this information to any additional Facilities, Controls, Network or IT points of contact at your organization for on-site support.


Frequently Asked Questions

Q: How long does it take to set up SFTP credentials?
A: SFTP account setup typically takes 5-10 business days after submitting your request to Customer Support.

Q: Can I upload multiple CSV files at once?
A: Yes, you can upload multiple files to the root directory. Each file will be processed independently within approximately 15 minutes.

Q: What happens to my files after they're uploaded?
A: After processing (approximately 15 minutes), files are automatically moved to an archive folder organized by date. This confirms successful processing.

Q: Can I reprocess old data?
A: Yes, simply move the archived file back to the root directory and it will be reprocessed within approximately 15 minutes.

Q: Do Point IDs in my CSV need to match existing points in Atrius?
A: For initial setup, Point IDs in your CSV will create new points in Atrius. For ongoing uploads, Point IDs must match existing points.

Q: What file formats are supported?
A: Only .csv files are supported. The file must be plain text with no formulas or special formatting.

Q: How do I know if my file was processed successfully?
A: Check that the file has been moved from the root directory to the archive folder. You can also verify in Atrius by checking for newly discovered points or updated readings.

Q: Can I automate file uploads?
A: Yes, you can use Python scripts, VBScript, or other automation tools combined with a task scheduler to automate recurring uploads.

Q: What if my timestamps are showing up incorrectly?
A: Navigate to your CSV Gateway settings and toggle the "Convert Time to UTC" option.

Q: Where can I find my Gateway ID?
A: Go to Settings > Integrations > Atrius CSV and click on your gateway to view the Gateway ID.


👍 Contact Customer Support

For additional questions regarding your integration with Atrius, please contact Customer Support at support@atrius.com

Did this answer your question?