CSV File Input
Description
CSV file input is a step in the Input Plugin for Process Studio Workflows.
The CSV File Input step reads data from a delimited CSV file for use in a workflow. Step supports custom delimiters (such as pipes, tabs, semicolons or commas). The step supports flexible column mapping to handle both fixed and dynamic CSV structures. Options for this step are a subset of the Text File Input step.
The step reads the csv input file based on the following ways:
Column index: Columns are mapped based on their position in the CSV file. For example, if the CSV file contains columns A, B, and C, column index 0 maps to A, index 1 maps to B, and index 2 maps to C.
OR
Column name: Columns are mapped using their header names, for example, A or C instead of index positions. This approach provides flexibility when the column order changes.
Configurations
| Field Name | Description |
|---|---|
| Step name | Specify name of the step. This name must be unique in a single workflow. |
| Accept filenames from previous step | Select the checkbox if you want to use files from the previous the step. |
| Filename | Specify the name of the CSV file to read from. Note: The field is unavailable if you selected Accept filenames from previous step. |
| OR | |
| The filename field (data from previous steps) | Select the fieldname that will contain the filename(s) to read from. If this step receives data from a previous step. Note: The field is available only if you select, Accept filenames from previous step checkbox. |
| Include the filename in the output? | Select the checkbox if you want the name of the file to be included in the output. Note: The field is available only if you select, Accept filenames from previous step checkbox. |
| Delimiter | Specify the file delimiter character used in the target file. Special characters (e.g. CHAR HEX01) can be set with the format $[value], e.g. $[01] or $[6F,FF,00,1F]. |
| Enclosure | Specify the enclosure character used in the target file. Special characters (e.g. CHAR HEX01) can be set with the format $[value], e.g. $[01] or $[6F,FF,00,1F]. |
| NIO buffer size | Specify the size of the read buffer in bytes, read from the disk each time. |
| Lazy conversion | Enable this checkbox to enable lazy conversion algorithm. The lazy conversion algorithm tries to avoid unnecessary data type conversions that could lead to significant performance improvements if possible. |
| Header row present? | Enable this option if the target file should contain a header row containing column names. |
| Add filename to result | Enabling this checkbox adds the CSV filename(s) read to the result of the workflow. Filenames in result is a unique list being kept in memory that can be used in the next steps or parent workflow steps or parent process entries. |
| The row number field name (optional) | Specify the name of the Integer field that will contain the row number in the output of this step. |
| New line possible in fields? | Select checkbox if data in fields may contain new line characters. Note: This checkbox is cleared and disabled when Read Based on Column Name is selected in the Fields tab. |
| Running in parallel? | Enable this checkbox if you will have multiple instances of this step running (step copies) and if you want each instance to read a separate part of the CSV file(s). Note: This checkbox is cleared and disabled when Read Based on Column Name is selected in the Fields tab. |
| File Encoding | Specify the encoding of the file being read. |
| Fields tab: | |
| Read Based on Column Name | Select the checkbox to read input fields using column names. If selected, the step dynamically identifies corresponding indexes at runtime by reading the header row and provides flexibility for CSV file with dynamic column orders. The field accepts fields from previous steps. Note: - If checkbox is unselected, existing index-based behaviour remains unchanged. - When selected, the Index Column table is disabled. |
| Fail on column name not found | Select the checkbox to fail the step if any required column name is missing or not found at runtime. Example: If the input data does not contain the column OrderID and the option is selected; the step fails during execution. |
| Ignore case for Column name and Alias names | Select the checkbox to ignore case sensitivity while matching column names and alias names at runtime. Example: If the column name is customerid and the alias is CustomerID, selecting this checkbox allows the system to match the names successfully. |
| Read Field Based on Column Name: | |
| Column Name | Specify the name of column from csv input file. |
| Field Name | Specify name for the column name. The system uses this name during execution and replaces the selected column name with the specified field name at runtime. The step generates next row with specified field name. |
| Alias Name | Specify an alternate column name that the system uses when the specified column name is not available in the input file. During execution, the system attempts to match the field using the alias name if the primary column name is missing. Note: You can configure a maximum of five alias names per field. Example: If the specified column name is customerID and it is not present in the input file, the system uses the alias name (for example, customer_id, customerid, CustomerId) to locate and read the corresponding column. |
| Type | Specify the data type of the field. - Number - String - Date - Boolean - Integer - BigNumber - Binary - Timestamp - Internet Address For example, Select Date when the field contains date values such as 25/12/2025 |
| Format | Specify format for the selected field type. The format is used to read or display field value based on the selected type. For example, Select MM/dd/yyyy to read a date value like 12/25/2025 correctly. |
| Length | Specify the maximum allowed characters for the field value. For example, Set Length to 10 to allow a maximum of 10 characters, such as INV1234567. |
| Precision | Specify the total number of digits allowed for numeric values. For example, Set Precision to 2 to store values like 123.45 |
| Currency | Specify the currency symbol used for field values. For example, enter ₹ to display amounts as ₹5000. |
| Decimal | Specify the number of digits allowed after the decimal point. For example, set Decimal to 2 to show numbers like 99.99 |
| Grouping | Specify whether the system groups digits when displaying numeric values. For example, Enable Grouping to display numbers as 1,00,000 instead of 100000 |
| Trim Type | Select how to remove spaces from the field value. Truncate spaces for the field by selecting one of the following. - None - Left - Right - Both For example, select Both to remove spaces from the beginning and end of a value such as " Order " |
| Read Field Based on Column Index: | Columns are identified using their sequential order in the CSV file. For example, in a CSV with columns A, B, and C, the first column (index 0) corresponds to A, the second column (index 1) corresponds to B, and the third column (index 2) corresponds to C. Default selection of the step. Notes: - The order of column names must not change. - Index mappings must be manually updated when the source CSV structure changes. |
| Name | Specify the name of the field. |
| Type | Select the data type of the field from the list. Available data types are: - Number - String - Date - Boolean - Integer - BigNumber - Binary - Timestamp - Internet Address For example, Select Date when the field contains date values such as 25/12/2025. |
| Format | Specify format for the selected field type. The format is used to read or display field value based on the selected type. For example, Select MM/dd/yyyy to read a date value like 12/25/2025 correctly. |
| Length | Specify the maximum allowed characters for the field value. For example, Set Length to 10 to allow a maximum of 10 characters, such as INV1234567. |
| Precision | Specify the total number of digits allowed for numeric values. For example, Set Precision to 2 to store values like 123.45 |
| Currency | Specify the currency symbol used for field values. For example, enter ₹ to display amounts as ₹5000. |
| Decimal | Specify the number of digits allowed after the decimal point. For example, set Decimal to 2 to show numbers like 99.99 |
| Group | Specify whether the system groups digits when displaying numeric values. For example, Enable Grouping to display numbers as 1,00,000 instead of 100000 |
| Trim Type | Select how to remove spaces from the field value. Truncate spaces for the field by selecting one of the following. - None - Left - Right - Both For example, select Both to remove spaces from the beginning and end of a value such as " Order " |
| Get Fields | Click to read the fields from the file based on the current settings (i.e. Delimiter, Enclosure, and so on) from previous step and add to the Read Field Based on Column Index or Read Field Based on Column name table. |
| Preview button | Click to preview the data coming from the file. |