# Excel

Category: Transformation
|
Runtime: 0.2
|
Available: Free

# Overview

Excel node is a tranformation node that helps in parsing an excel workbook having one or more worksheet and it can also write a existing excel workbook .

# Setup

# Prerequisites

NA

# Installation

To install the node from designer:

  1. Go to Add more nodes option on the palette section.
  2. Check for the excel node and click install.
  3. Once installed, the designer is required to be restarted.

To install the node from CLI:

  1. Go to your project workspace where you can see your package.json file.
  2. Run the below give npm command.
    npm i @kumologica/kumologica-contrib-excel

# Technical Details

Properties

  • Content (Required)
    XLSX data be passed as a Buffer content when choosing the read operation. For write operation the content should be JSON with a specific data structure.Example: [ { sheet: "Adults", columns: [ { "label": "User", value: "User" }, { "label": "Age", value: "Age" }, { "label": "Phone", value: "Phone" } ], content: [ { "User": "Andrea", "Age": 20, "Phone": "11111111" }, { "User": "Luis", "Age": 21, "Phone": "12345678" } ] }]

Supported Operations

  • Read
  • Write

Throws

  • ExcelError

Returns

Payload will be overwritten by this node. For read operation the node returns a transformed JSON payload and for write operation the node returns a buffer content. None of the variables will be overwritten or enriched by this node. Response from the node can be accessed using msg.payload.