jazz-plugin-excelextractor

Jazz Plugin: Excel Extractor Documentation

If you want to be a contributor, write to us

Also, access the Jazz Documentation website for more information.

Plugin Pipeline

Tasks

extract

Purpose: extract task is responsable for extracting data from excel spreadsheet and convert this into a javascript array of objects.

Class: ExtractorTask

Parameters:

• source: represents the path of the excel spreadsheet file. References to the inputParameter sourceFile.

Ovewritables:

• none

validate

Note: this task is a Work in Progress. The execute() method still do not validates anything. This will be very useful when you want to validate the excel data before moving to a next step in the pipeline.

Purpose: validate task is responsable for validating the excel spreadsheet data.

Class: ExtractorTask

Parameters:

• none

Ovewritables:

• none

export const pipeline = [
  {
    id: "extract",
    description: " Extracts excel data into javascript array of objects",
    class: "ExtractorTask",
    params: ["source"]
  },
  {
    id: "validate",
    description: " Validates extracted excel data based on plugin rules",
    class: "ValidateTask"
  }
];

Input Parameters

export const inputParameters = {
  sourceFile: {
    alias: "s",
    describe: "Source File",
    demandOption: true,
    default: "source.xlsx",
    name: "source"
  }
};

• sourceFile: indicates the path of the excel file from whch the process will extract the data.Default is the source.xlsx. References to the parameter named source in the ExtractorTask Class.