ISM Manual
  • Overview
  • Features
  • Components
  • Directory Structure
  • Startup/Shutdown
  • ISM Admin UI
    • Dashboard
    • Flow
    • Job
      • Schedule
    • Channel
      • AMQP
      • Mqtt
      • sFTP
    • Interface
      • System
      • Data Structure
      • Field Group
      • Field
    • Web Service
    • Utility
    • Admin
    • Result
  • Tasks
    • Control Task
      • Route
      • Split/Join
      • Mapping
    • FTP
      • FTP Input
      • FTP Output
      • FTP Transfer
    • DB
      • SQL Executor
      • SQL Batch Executor
    • File
      • File Input
      • File Output
      • File Validator
      • Record Extractor
    • Excel
      • Excel Reader
      • Excel Writer
    • Flow
      • Flow Execution
      • Wait Sub
    • Web Service
      • REST Client
      • Web service Client
    • PGP
      • Encrypt
      • Decrypt
    • Cloud
      • SharePoint
      • Amazon S3
      • Google Cloud Storage
    • Others
      • Email Sender
      • LDAP Client
      • Function
      • Script
      • Java Class
  • REST Service
  • Trouble Shooting
  • Logging Configuration
  • Implementing a Task
  • Custom Class
  • Frequently Asked Questions (FAQ)
    • What is XNARUM Integration Service Mastery (ISM)?
    • What is the purpose of XNARUM?
    • Can XNARUM be customized to specific integration requirements?
    • Is XNARUM scalable?
    • Does XNARUM provide support and maintenance?
Powered by GitBook
On this page
  • Input
  • Output
  • Example
  • Single
  • All
  1. Tasks
  2. Excel

Excel Writer

PreviousExcel ReaderNextFlow

Last updated 1 year ago

This component is used to write data to an Excel file. It can be used to create new Excel files or append data to existing files.

Input

Attribute
Description

Input Param

Input parameter of the excel data

Sheet Name

Sheet name to write

Extension

Excel format .xls/.xlsx

Header Exists

Does header row exist?

If yes, the column names will be written in the first row.

The first row means the starting row.

Starting Row

Row number starts from 0.

If starting row is 0 and header exists, the data row will be written from the second row(1).

Output Path

The path of the output excel file

Output File

The name of the excel file

Mode

Write mode.

· Overwrite

· Append

In the case where the input data has more than 50K records, the overwrite mode is always applied, and the previous contents of the target file are completely replaced with the new data.

Output

Attribute
Description

ExcelOutFile

The output file name

ExcelOutCount

Record count

Example

This example demonstrates the ExcelReader and the ExcelWriter in a flow. The ExcelReader loads data from the sheets and The ExcelWriter writes those data to an excel file.

This flow has two paths. One is single and the other is all. Single path will load the data from one sheet and write that data to the output excel file. All path will load the data from all the sheets and write all the input data to the output excel file.

Single

Read Excel

This component reads an excel file and loads data from the sheet - Sheet1. The name of the excel file is parameterized. These parameters can come from the request.

Input
Output

Excel Writer

Input
Output

This sample is invoked with these data.

URL
http://localhost:8080/api/ExcelReaderTest/v1?__RoutingPath=single

Method

POST

Request Body

{

"FilePath": "/data/send/",

"FileName": "salaries.xlsx",

"SheetName": "salaries"

}

All

Read Excel

This component reads an excel file and loads data from all the sheets. The name of the excel file is parameterized. These parameters can come from the request. This component loads all the sheets from the input excel file.

Input
Output

The output data of this component are these.

ExcelResultCount with the sheetname appended outputs are generated.

ExcelResultCount-sheetname : record count

ExcelResultArray is a map of the data of the sheets

Excel Writer

Input
Output

The output data of the Writer component are these.

ExcelOutCount with the sheet name appended outputs are generated.

This sample is invoked with these data.

URL
http://localhost:8080/api/ExcelReaderTest/v1?__RoutingPath=all

Method

POST

Request Body

{

"FilePath": "/data/send/",

"FileName": "salaries.xlsx",

}

Graphical user interface, text, application, email

Description automatically generated
A picture containing application

Description automatically generated
Chart

Description automatically generated with medium confidence