Import Excel or CSV

Updated on 29 Jul 2024
2 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Step Details
Introduced in Version	---
Last Modified in Version	8.21.0
Location	Data > Excel & CSV

The Import Excel or CSV step Imports/loads data from CSV or Excel files. In turn, this imported data is then converted into the user-determined Output Data Type. The step operates off the assumption that the imported data has properties corresponding to the File Columns. The Input File Type is selected via the Property of the same name. Users then define which Row in the spreadsheet the step reads from via the Start On Row Input. Information from the File's Columns is determined via the Number of Columns Input and by Mapping Properties for each. Due to its effectiveness and speed, this step functions well for importing large amounts of CSV data.

Password Protection

Sheets with password protection will fail in every version before v8.21 or v9.2.

Properties

Inputs

Property	Description	Data Type
File Data	File to Import	File Data

Input Data

Property	Description	Data Type
Input File Type	Defines the type of file used as an input to the step. Currently, the options are Csv, Excel_xls, Excel_xlsx and AutoSelect.	---
Start on Row	Define which Row is the first row to begin importing data from.	Int32
CSV Delimiter	Determines which delimiter is used in the CSV files.	---
Ignore Quotes (Do not treat as escaped)	Ignores quotes within the data that is imported.	Boolean
Input File Encoding	Set which encoding type the File has, ASCII or UTF8	---
Number of Columns	The number of columns within the Excel or CSV file.	Int32
Worksheet Index (only inv8.21+ and v9.2+)	This is the index of a particular sheet in an Excel file that is password protected. For protected CSVs this would be 0.	Int32
Document Password (only inv8.21+ and v9.2+)	For password protected files, the password will need to be supplied in this field.	String

Import Raw Lines

Property	Description	Data Type
Import Raw Lines	Import the data within the file as raw lines.	Boolean
Into Property	Pick one of the properties on the datatype being mapped to and have that property take in all the values of the excel sheet as a comma-separated list.	---

Output Data

Property		Description	Data Type
Output Data Type		Define the data type to import the Excel or CSV data to.	---
	Mapping	Define which columns equate to which data fields.	---

Error Handling

Property	Description	Data Type
Extra Columns in Input	Will provide an error if extra columns are found in the input (Add Outcome: provides an outcome path, Throw Exception will throw an exception on reaching error, Ignore and Continue: will add an outcome path and ignore the error.)	---
Less Columns in Input	Will provide an error if the columns found are less than expected (Add Outcome: provides an outcome path, Throw Exception will throw an exception on reaching error, Ignore and Continue: add an outcome path and ignore the error.)	---
Value Conversion in Input	Will send an error if a value can not be converted (Add Outcome: provides an outcome path, Throw Exception will throw an exception on reaching error, Ignore and Continue: add an outcome path and ignore the error.)	---

Outputs

Property		Description	Data Type
Imported Data		Returns the data that was successfully imported	List of [Data Type]
Extra Columns Error
	Actual Columns Number	Returns the number of columns	Int32
	Input Line	Returns the input line or error	Int32
	Line Number	Returns the line number of the error	Int32
Less Columns Error
	Actual Columns Number	Returns the number of columns	Int32
	Input Line	Returns the input line or error	Int32
	Line Number	Returns the line number of the error	Int32
Value Conversion Error
	Column Number	Returns the column number of the error	Int32
	Error Message	Returns the error message	String
	Input Line	Returns the input line or error	Int32
	Line Number	Returns the line number of the error	Int32
	Source Value	Returns what the source value is	String
	Target Type	Returns the expected data type	String