To look up or import files to an on-premise system, you must first create an on-premise file connection. After, you can create a flow and add a lookup or import, or create an import by navigating to → .
To create your lookup or import:
Name your transfer *: Name your resource so that you can easily reference it from other parts of the application.
Description: Describe your resource so that other users can quickly understand what it is doing without having to read through all the fields and settings. Be sure to highlight any nuances that a user should be aware of before using your resource in their flows. Also, keep this field up to date as you make changes to the resource.
Connection *: Find an existing connection to apply to this import or lookup, or you can click Create connection to define a new resource that you can use here and in other flow steps. Each connection contains securely stored credentials and information needed to access this application. All connections displayed in this list are specific to this application and registered to you for this integration.
One to many *: There are advanced use cases where a parent record is being passed around in a flow, but you actually need to process child records contained within the parent record context. For example, if you're exporting Sales Order records out of NetSuite and importing them into Salesforce as Opportunity and Opportunity Line Item records, then you will need to import the Opportunity Line Item records using this option. One to many is used in cases where you have a single record which internally needs to create multiple records. This field cannot be used when importing a CSV file.
Generate files from records *: Choose Yes to build a new CSV, XML, JSON, or other file. Choose No to transfer raw files as-is (such as PDFs or JPGs).
File type (required): Select the type of file that you want to generate. For example, choose CSV if you are importing a flat, delimited text file, or XLSX for a binary Microsoft Excel file. The file name you specify can include a file extension, but it does not affect this setting. You can then choose a sample file to define the record structure. For example, if you are importing CSV files (i.e. files containing Comma Separated Value data), choose CSV. Each file type includes additional settings to customize your import. Acceptable file types include:
-
CSV (or any delimited text file): See File generation for structured data in CSV and XLSX.
Custom header rows (optional): In rare cases it is necessary to include one or more custom header rows before the CSV data. Add any such prefix rows in this setting.
-
EDIFACT
-
Fixed width
-
JSON
-
XLSX
-
XML
Sample file (that would be generated): If you have a sample file that represents the record structure of the files to transfer, you can upload the sample file here. We will use the sample file to auto-set various fields (where possible), and also help you map data in a subsequent step. The sample file that you provide does not need to be overly large (at max 5 records), but it should contain all the fields that you want to work with, and also be in the same format that the transfer will need to generate when running in a production capacity.
How many files would you like to generate?: Select how the flow should generate output files. Select One file per flow run to create a single file that contains all of the records processed during the flow run. If the flow includes more than one export, one file will be generated for each export. For real-time flows, a file is created using all of the records received in the current request. Select One file per page of records to generate a separate file for each page of records processed during the flow run. This setting appears only when you select CSV, XML, JSON, or XLSX file type.
Directory path *: Use this field to specify the directory path of the folder where you want files to be transferred. For example, if you set this field to C:\Users\Administrator\Desktop\load, integrator.io will first look for a parent folder Users and child folders Administrator\Desktop\load.
File name *: Specify how to name files that are uploaded to the on-prem system. If you want to upload data as multiple files to the on-prem system, check Skip aggregation in the Advanced section. To provide unique filenames, express them according to the following handlebars templates:
-
Timestamp: For example,
FileXYZ-{{timestamp "YYYY-MM-DD-HH-mm-ss-SSS" "America/Los_Angeles"}}.csvwill upload files with the following naming pattern:FileXYZ-2024-09-16-07-33-54-443.csvNote
Use a timestamp with the milliseconds token to avoid overwriting files.
-
Random: For example,
FileXYZ-{{random "uuid"}}.txtwill upload files with the following naming pattern:FileXYZ-69368e91d9a440f79165b73afd46859d.txt. While you can include any file extension you like, it will not change the type of data generated.
Encrypt files: Use this cryptographic system to encrypt generated files. This option is enabled only when you have configured at least one cryptographic system in the connection. If it is unchecked, then encryption will not be performed on generated files.
Backup files path: Add the directory path to the on-premise folder where your files will be backed up after being transferred successfully.
File encoding: The file encoding indicates how the individual characters in your data are represented on the file system. Leave this field blank if you do not know what the encoding format is. The default encoding is UTF-8 and the other supported format is: UTF-8, Windows-1252 and UTF-16LE.
Number of files per batch (optional): Enter the maximum number of files (from 1 to 1000) that can be processed in a single batch request. This setting doesn’t limit the total number of files that you can process in a flow; instead, it allows you to optimize for really big files where bigger batches might cause network timeout errors. If you are importing very small files, increasing the batch size to include several files at a time will improve flow performance.
Compress files: If you would like to compress files before they are posted to the import application, set this field to True. Once you check this field, a dropdown field appears for you to choose the compression format.