Excel

Discover more about the Excel component and how to use it on the Digibee Integration Platform.

Excel reads and saves Excel files.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Parameter	Description	Default value	Data type
Operation	Action to be executed by the component (Read, Create, Read Specific Sheets, Read One Cell, Read Multiple Cell, and Update One Cell).	Read	String
Excel Full Path	Path in which the Excel file is located.	/Users/example.xlsx	String
File Name (DB)	File name or full file path (i.e. tmp/processed/file.txt).	example.xlsx	String
Sheet Name	Name of the sheet.	Planilha1	String
Cell	Specification of the sheet cell.	A:1	String
Cells	List of sheet cells.	["A:1", "B:2", "C:6"]	Array of Strings
Cell Value	Value to be replaced in a specific cell.	example	String
Sheets	List of sheet names.	["Planilha2", "Planilha4"]	Array of Strings
JSON Data	JSON to be used in the generation of the Excel file.	[{"src":"Images/Sun.png","name":"sun1","hOffset":250,"vOffset":250,"alignment":"center"},{"src":"Images/Sun.png","name":"sun1","hOffset":250,"vOffset":250,"alignment":"center"},{"src":"Images/Sun.png","name":"sun1","hOffset":250,"vOffset":250,"alignment":"center"},{"src":"Images/Sun.png","name":"sun1","hOffset":250,"vOffset":250,"alignment":"center"},{"src":"Images/Sun.png","name":"sun1","hOffset":250,"vOffset":250,"alignment":"center"}]	Array of Objects (JSON)
Read All Sheets	If the option is activated, all the Excel file sheets will be read.	False	Boolean
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.	True	Boolean

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"
}
}