ImportFromExcel@1
Node ImportFromExcel@1 is used to import data from an Excel file. This node is useful when you want to import data from an Excel file and use it in the pipeline.
This node is used by the Excel Add-In to import data from an Excel file.
Adapter Prerequisites
Node Configuration
Fields path, targetPath, targetValueWriteMode, and targetValueKind are unavailable for this node.
transformations:
- type: ImportFromExcel@1 # Import data from an Excel file, no configuration required
The payload is custom to the Excel Add-In and is not documented here.
Example
The following example shows how to import data from an Excel file. This pipeline is triggered by an HTTP request and imports data from an Excel file.
triggers:
- type: FromHttpRequest@1
path: /import/tree
method: POST
transformations:
- type: ImportFromExcel@1
Types whose create is replaced by a method
The node refuses to insert an entity of a type whose CK method declares replacesGenericCreate (own or inherited), unless the pipeline run is the run that was started to execute that very method. Importing a workbook that would create such an entity in any other run fails the whole import with the error GENERIC_CREATE_REPLACED_BY_METHOD before anything is written (rows that update existing entities are not affected); if the CK cache of the tenant cannot be loaded, the import is refused with the retryable error GENERIC_CREATE_CHECK_UNAVAILABLE. The refusal applies in dry runs as well. See Pipelines that insert entities for the rules and the rollout order.
Dry run
When a pipeline is executed as a dry run, ImportFromExcel@1 reads and validates the file and checks the import against the Construction Kit rules exactly as in a real run, but it does not write anything: no entities and no associations are created. The dry-run result records what would have been written: the number of entities (entityCount), the number of associations (associationCount) and the ids of the entities that would be created (wouldInsert). The check described above runs first, so refusals still apply in a dry run: if the import would create entities of a type whose creation is replaced by a CK method, the dry run fails with GENERIC_CREATE_REPLACED_BY_METHOD instead of reporting success.