Skip to main content

Test111 - SFTP Integration

Judi Zietsman avatar
Written by Judi Zietsman
Updated yesterday

Quick Summary: The SFTP integration enables secure file-based data exchange between your SFTP server and the app. Source files are retrieved, validated, staged, and imported to generate recommendations, while output files are returned to the SFTP server.

Purpose

Provide a technical overview and implementation guidance for configuring file-based integration using an SFTP server.


Prerequisites

Netstock App instance:
Your Netstock SaaS environment must be provisioned and configured.

SFTP server:
A customer-hosted SFTP server must be available to host integration files. Files must conform to defined data interface requirements.


Technical Architecture

The SFTP integration uses a multi-component architecture designed to support secure file-based data exchange, validation, orchestration, staging, and analytics processing.

The integration consists of four primary components:

  1. SFTP server

  2. Netstock IA Data Orchestration Service (DOS)

  3. Customer staging database

  4. App instance


Data Flow

Inbound data

  1. Customer systems generate CSV files and place them on the SFTP server

  2. Netstock IA Data Orchestration Service (DOS) extracts a configured subset of files

  3. File structure is validated

  4. Data is consolidated, transformed, and stored in the staging database

  5. CSV files are generated from staging data

  6. Netstock retrieves and imports generated CSV files

  7. Data is processed and analyzed to produce recommendations

Outbound data

  1. The app generates output such as purchase orders, transfers, work orders, logs, and reports

  2. Output files are published to the SFTP server


SFTP Server

Details

A customer-hosted SFTP server is used for CSV files needed by DOS.

Files to be extracted can be limited by defining a subset list of files in the DOS configuration.

Two directories are required:

  • One directory used to extract files from

  • One directory used to send files to, from the app

Security

Ensuring data security on the SFTP server falls under the customer's responsibility.


Data Orchestration Service

Details

DOS connects to the SFTP server to fetch all generated CSV files required.

DOS validates the file structure.

DOS consolidates, transforms, and stores the data in the customer staging database. The data received from the SFTP server is not manipulated by DOS in any way.

DOS can push all app-generated purchase orders, transfers, work orders, logs, and reports back to the SFTP server.

Security

Each supported region runs an independent DOS instance. The customer staging database forms part of this instance, and customer data stays within the designated region and is not shared across regions.

Data is handled in accordance with the defined Personal Data Protection Policy.

Two forms of authentication from DOS to the SFTP server are supported:

  • Username and password

  • Username and private SSH key

DOS software is developed in accordance with the defined Secure Software Development Policy and in a manner that reduces the likelihood and impact of software vulnerabilities.

All protocols, third-party libraries, and frameworks used are vetted and approved by the security team as outlined in the defined Secure Software Development Policy.

Credentials are protected by a vault that requires a secondary level of authentication to access.


Customer Staging Database

Details

A MySQL database is used.

The database is in the same region as the rest of the DOS instance.

Security

Strong credentials are generated per customer and protected by a vault, which requires a secondary level of authentication to access.


Forget about these πŸ‘‡ 😞 😐 πŸ˜ƒ Have your say here!

Did this answer your question?