Links

Excel

Learn more about the component and how to use it.
Excel reads and saves Excel files.
Take a look at the configuration parameters of the component:
  • Operation: action to be executed by the component.
  • Excel Full Path: path in which the Excel file is located.
  • File Name: name of the created file.
  • Sheet Name: name of the sheet.
  • Cell: specification of the sheet cell.
  • Cells: list of sheet cells.
  • Cell Value: value to be replaced in a specific cell.
  • Sheets: list of sheet names.
  • JSON Data: JSON to be used in the generation of the Excel file.
  • Read All Sheets: if the option is activated, all the Excel file sheets will be read.
  • Fail On Error: if the option is enabled, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.

Messages flow

Operation READ

Reads an Excel file and generates a JSON object with sheets and rows.
Its parameters are:
  • Read All Sheets (mandatory)
  • Excel Full Path (mandatory)
  • Sheet Name (mandatory only if the Read All Sheets option isn't activated)
Output
  • If you want to read all the sheets
{
"Sheet1": [{"A1": "A1 Content"},{"A2": "A2 Content"} ...],
"Sheet2": [{"A1": "A1 Content"},{"A2": "A2 Content"} ...],
...
}
  • If you want to read a specific sheet only
{
"Sheet_Specified": [{"A1": "A1 Content"},{"A2": "A2 Content"} ...]
}

Operation READ SPECIFIC SHEETS

Reads specific sheets passed through a list.
Its parameters are:
  • Excel Full Path (mandatory)
  • Sheets (mandatory)
Output
{
"Sheet_Specified1": [{"A1": "A1 Content"},{"A2": "A2 Content"} ...],
"Sheet_Specified2": [{"A1": "A1 Content"},{"A2": "A2 Content"} ...],
...
}

Operation READ ONE CELL

Reads a specific cell of an Excel file.
Its parameters are:
  • Sheet Name (mandatory)
  • Excel Full Path (mandatory)
  • Cell (mandatory)
Output
{
"A1": "A1 Content"
}

Operation READ MULTIPLE CELLS

Reads multiple cells of a sheet from an Excel file passed through a list.
Its parameters are:
  • Sheet Name (mandatory)
  • Excel Full Path (mandatory)
  • Cells (mandatory)
Output
{
"A1": "A1 Content",
"B1": "B1 Content",
"X1": "X1 Content"
}

Operation CREATE

Creates an Excel file from the passed JSON.
Its parameters are:
  • Sheet Name
  • JSON Data (mandatory)
  • File Name
Output
{
"localFilename": "path/to/the/file",
"success": true
}

Operation ONE CELL

Updates a specific cell of an Excel file.
Its parameters are:
  • Excel Full Path (mandatory)
  • Cell (mandatory)
  • Cell Value (mandatory)
Output
{
"localFilename": "path/to/the/file",
"success": true,
"cellUpdated": {
"A1": "A1 new Content"
}
}