Articles in this section

Import files into an on-premise system

Gogula R Bhavana
Updated

Use an import to write files to a server on your private network through an on-premise agent, or a lookup to read files from it during a flow. You can generate new files from the flow's records, such as CSV, XML, or JSON, or transfer files as they are, such as PDFs or images. This article describes each import setting so you can choose the file format, location, and naming that your on-premise system expects.

Important: Before you create the import, create an on-premise file connection.

To add the import, open your flow in Flow Builder and add an import or lookup that uses the connection. Then configure these settings. Settings marked * are required.

  • Name your transfer * — A name that identifies the import when you reference it elsewhere in integrator.io.
  • Description — What the import does and anything other users should know before they use it in their flows.
  • Connection * — The on-premise file connection the import uses. To create one here, select Create connection.
  • One to many * — Processes child records inside each parent record as separate records. For example, to import NetSuite sales order lines as Salesforce opportunity line items, use this setting so each line becomes its own record. You can't use this setting when you import a CSV file.
  • Generate files from records * — Select Yes to build a new file, such as CSV, XML, or JSON, from the records. Select No to transfer raw files as they are, such as PDFs or JPGs.
import.png

Note: If the connection uses an agent group, an import that's in progress when an agent goes offline continues on the next available agent, and integrator.io can send some of its records a second time. See How failover works.

File generation settings

These settings appear in the How would you like to generate files? section when Generate files from records is Yes.

Import1.png
  • File type * — The format of the files to generate. The file name's extension doesn't change this setting. Each file type adds its own settings. Accepted values:
  • Sample file (that would be generated) — A small file, up to five records, that shows the structure of the files to generate. integrator.io uses it to fill in settings where it can and to help you map data later. Include every field you want to work with, in the same format the import generates.
  • How many files would you like to generate? — Select One file per flow run to put every record from the flow run in a single file. If the flow has more than one export, each export gets its own file. For real-time flows, each request produces one file. Select One file per page of records to create a file for each page of records. This setting appears only for the CSV, XML, JSON, and XLSX file types.

File location and name settings

These settings appear in the Where would you like the files transferred? section.

  • Directory path * — The folder on the on-premise system that receives the files. For example, if you enter C:\Users\Administrator\Desktop\load, integrator.io looks for the parent folder Users and then the child folders Administrator\Desktop\load.
  • File name * — The name of each uploaded file. To upload data as several files, select Skip aggregation in the Advanced section. To give each file a unique name, use a handlebars template:
    • Timestamp — For example, FileXYZ-{{timestamp "YYYY-MM-DD-HH-mm-ss-SSS" "America/Los_Angeles"}}.csv produces names like FileXYZ-2024-09-16-07-33-54-443.csv.
    • Random — For example, FileXYZ-{{random "uuid"}}.txt produces names like FileXYZ-69368e91d9a440f79165b73afd46859d.txt. The extension doesn't change the type of data generated.

Note: Include the milliseconds token in a timestamp to avoid overwriting files.

transfer_files_import.png

Advanced settings

  • Encrypt files — The cryptographic system that encrypts generated files. Available only when the connection has at least one cryptographic system configured. Leave it blank to skip encryption.
  • Backup files path — The folder on the on-premise system where files are backed up after a successful transfer.
  • File encoding — How characters in your data are represented in the file. Default: UTF-8. Accepted values: UTF-8, Windows-1252, UTF-16LE. Leave it blank if you don't know the encoding.
  • Number of files per batch — The maximum number of files, from 1 to 1000, in a single batch request. It doesn't limit the total number of files a flow processes. Lower it for large files that time out; raise it for many small files to improve flow performance.
  • Compress files — Compresses files before they're transferred. When you select Compress files, choose a compression format.