User Settings #Common Structure #Basic Type operation

Description:

Basic type operations refer to the simple operations between the work in progress (WIP) template and the final template.

The general steps can be distilled down to the following steps:

1. Load input files data onto the WIP template respective data sheet.
2. Process the input file data based on the WIP template.

There are no further steps required to communicate with final sheet objects.

(TODO) Link to Basic Type operation object in the class notes list.

Example:

//JSON object for Basic Type operation settings
"BitreportSettings": {
      "WipSettings": {
        "WorksheetName": "Ttl_Inv",
        "HeaderRow": 1,
        "WritingRow": 1,
        "ReadingAddress": "A:E"
      }
    }

WipSettings:

This setting give basic set of information for the program's operation. It includes the following:

Worksheetname

Name of the worksheet in WIP template.

HeaderRow

This row is used as the search row to find all the column headers to operate column wise operations. If any header is missing or mismatches from the header names pre-defined in the code, the program will crush.

WritingRow

This row is used as guideline for program to write its output after calculations. The end result of calculations are often 2-dimentional data tables that needs to be written to specific row. The column will be automatically matched based on the HeaderRow values read.

ReadingAddress

The reading address is generic term for area being read into the operation calculations, it varies based on the calculations. For specific information on individual calculation, please refer to the banner specific documentations.