Bulk Data component and column settings
A Bulk Data component validates a CSV or XLSX supplied through a linked single-file upload. People can review validation feedback and, if allowed, correct values before confirming the dataset.
Configure the upload and dataset
- Add a single File component accepting the required CSV/XLSX formats.
- Add Bulk Data and choose that existing file field as the source.
- Set the one-based header row and define the dataset's columns.
- Choose whether respondents may edit values, then test valid and invalid files through confirmation.
| Property | Setting / default |
|---|---|
bulkDataSourceFileFieldId | Required ID of an existing single File component in this service. A multiple-file upload is not a valid source. |
bulkDataHeaderRow | Header row number, starting at 1; default 1. |
bulkDataAllowRespondentEdits | String true/false; default false. Confirmed corrections form part of the current validated CSV. |
bulkDataColumns | Between 1 and 200 dataset columns. Column definitions are not nested Govform fields. |
Column reference
| Column property | Meaning |
|---|---|
id, heading, label | A stable ID beginning with a letter, the expected file heading, and the displayed label. IDs must be unique; headings must be unique ignoring case and surrounding spaces. |
type | text, integer, decimal, date, boolean or fixedChoice. |
required, unique | JSON boolean flags for a required value and values unique within that column. |
maxLength | A positive whole-number character limit where relevant. |
minimum, maximum | Numeric bounds; maximum cannot be below minimum. |
dateFormat | The accepted date format; required for a date column. |
allowedValues | Allowed values for boolean/fixed-choice columns; at least two non-empty values are required. |
Use the confirmed data
The Bulk Data answer is compact metadata, not an array of spreadsheet rows. Do not loop over it to obtain cell values. For an API payload use {{ "returnData" | file_to_base64 }}, replacing returnData with the Bulk Data field ID. This sends the confirmed current CSV, including edits. Applying the filter to the source File field sends the original upload instead.
For Upload files actions, choose the Bulk Data field, evidence version and artifact: current validated CSV or original source upload. Submitted revision numbers refer to Response history, not internal dataset versions. For repeating fields choose the correct zero-based repeat row.
Test and retain evidence
Test missing/duplicate headings, invalid types, boundaries, duplicate unique values, blank required cells, corrections, replacement uploads and resumed journeys. Bulk Data cannot be placed in a Data Grid. Submitted revisions and retained artifacts may differ from the current draft; select the intended evidence when exporting.
See Bulk Data files API and Data, files and SharePoint.
Header matching and changed rules
Column order may vary, but every configured heading must appear exactly once and unexpected headings are rejected. After changing rules, save and apply/deploy the service to the intended test environment, then upload again for a fresh check. An earlier successful file check does not prove compliance with the new rules.