SFTP Documentation
Introduction
SFTP (Secure File Transfer Protocol) is a secure method for transferring files between clients and our system. It enables clients to upload their master data in CSV format, encoded in UTF-8
with semicolon separators (;)
. The SFTP service allows clients to both upload and download files from our system.
Folders
1. Export Folder
The export folder contains daily exports of all article lists. Each file in this folder follows a specific naming convention: cuta_server___<slug>.<YYYY.MM.DD.hh.mm>.csv
, where:
cuta_server___
is prefix added for purposes of administration<slug>
represents the article list slug associated with the file.<YYYY.MM.DD.hh.mm>
represents the date of export (in the format of YYYY.MM.DD.hh.mm). ::Filename example:
cuta_server\_\_\_warenstamm.2023.06.20.12.00.csv
These exported files are automatically deleted after two weeks, providing a temporary storage solution.
2. Import Folder
Here you can download an Import Sample File
The import folder is where users can add their files for masterdata import. The files in this folder follow the naming convention:
<slug>.<YYYY.MM.DD.hh.mm>.csv
, where:<slug>
represents the article list name associated with the file.<YYYY.MM.DD.hh.mm>
is an optional date or identifier that can be used for better logging and auditing purposes. ::Filename mandatory:
Artikelliste.csv
The primary purpose of
<YYYY.MM.DD.hh.mm>
is to provide additional context or information and is NOT mandatory for mapping the file to the correct article list.Filename suggested pattern:
Artikelliste.2023.06.20.12.00.csv
Interface Description
When uploading, the part or item number is required as a unique assignment criterion; other elements are designation and, in the area of characteristics, particularly helpful specifications that can considerably facilitate the process of classification.
Sample File Import Sample File
Field on Mask (English) Field Name in CSV File Import (CU-TA Incoming) Mandatory for Import Export (CU-TA Outgoing) Article Number article_number Yes Yes Yes Article Description description1 Yes Yes Yes Article Description B description2 Yes Yes Feature 1 feature1 Yes Yes Feature 2 feature2 Yes Yes Feature 3 feature3 Yes Yes Feature 4 feature4 Yes Yes Feature 5 feature5 Yes Yes Feature 6 feature6 Yes Yes Manufacturer manufacturer Yes Yes Priority Administration is_prio Yes Yes Archive archive Yes No Import Article import_article Yes No Is Military is_military Yes No Is Nuclear is_nuclear Yes No Machine Type machine_type Yes No Is ECCN is_eccn Yes No ECCN Comment eccn_comment Yes No System Material system_material Yes No Supplier CTN supplier_ctn Yes No Presystem CTN presystem_ctn Yes No Assembly Group assembly_group Yes No Type Of Sourcing type_of_sourcing Yes No Country Of Origin Made In country_of_origin_made_in Yes No Country Of Origin Preferential country_of_origin_preferential Yes No Country Of Origin Non Preferential country_of_origin_non_preferential Yes No Type of Classification type No Yes Customs Tariff Number ctn_eu No Yes VZTA Number bti_eu No Yes Valid From valid_from No Yes Valid Until valid_until No Yes Fixed is_fixed No Yes Trade Designation commercial_designation1 No Yes Trade Designation B commercial_designation2 No Yes Classification Comment tariff_classification_comment No Yes AL Numbers list_of_goods No Yes Dual-Use Comment list_of_goods_comment No Yes The file is provided as a .csv file in "UTF-8" or "UTF-8 with BOM" format. Please ensure the correct spelling of the column names when providing the file.
Processed Files
Once processed the files are prefixed with
cuta_server___processed_
and stored in the system for documentation purposes. Clients can retrieve these files if necessary, as the also are retained for 2 weeks and then automatically deleted.Logs
Below are some log examples, which can be found under protokoll for debugging purposes.
File found for import <slug>.csv
- Once a new file is found in the export folderProcessing <slug>.csv for import
- When file is being processedStarted importing products. Initiated by SFTP Product Importer
- When articles start importing successfuly.CSV incorrect headers, aborting.
- If file has incorrect headersProduct with ID: 1 has been created. Status: Gray. Initiated by Auto Updater
- when successfuly created.Article KP-100 already exists in the database, skipping
- if an article with the same article number already exists.Finished importing products
- When articles import finishes. ::SFTP Access
For SFTP communication, a port is named on a manadant-specific basis and set up by CU-TA. This address is used for the delivery and collection of the article master data.
Host: app.cu-ta.de Port: 22 Username: Username or email address. Password: Your password
Summary
SFTP provides a secure means for clients to upload and download master data files in CSV format. The export folder contains daily exports of all article lists, while the import folder allows users to add their files for import. Processed files are retained for 2-weeks for documentation purposes and can be retrieved if needed.
For further assistance or inquiries regarding the SFTP functionality, please reach out to our support team at support@cu-ta.de