diff --git a/docs/excel.md b/docs/excel.md index ca47825..9bf87a8 100644 --- a/docs/excel.md +++ b/docs/excel.md @@ -85,7 +85,39 @@ Configuration is made in the following tables: 1. [MPE_XLMAP_RULES](tables/mpe_xlmap_rules.md) - detailed extraction rules for a particular map 2. [MPE_XLMAP_INFO](tables/mpe_xlmap_info.md) - optional map-level attributes -Each [rule](tables/mpe_xlmap_rules.md) will extract either a single cell or a rectangular range from the source workbook. +Each [rule](tables/mpe_xlmap_rules.md) will extract either a single cell or a rectangular range from the source workbook. The target will be [MPE_XLMAP_DATA](tables/mpe_xlmap_data.md), or whichever table is configured in [MPE_XLMAP_INFO](tables/mpe_xlmap_info.md). + +To illustrate with an example - consider the following excel. The yellow cells need to be imported. + +![](img/xlmap_example.png) + +The [MPE_XLMAP_RULES](tables/mpe_xlmap_rules.md) configuration entries _might_ (as there are multiple ways) be as follows: + +|XLMAP_ID|XLMAP_RANGE_ID|XLMAP_SHEET|XLMAP_START|XLMAP_FINISH| +|---|---|---|---|---| +|MAP01|MI_ITEM|Current Month|`MATCH B R[1]C[0]: ITEM`|`LASTDOWN`| +|MAP01|MI_AMT|Current Month|`MATCH C R[1]C[0]: AMOUNT`|`LASTDOWN`| +|MAP01|TMI|Current Month|`ABSOLUTE F6`|| +|MAP01|CB|Current Month|`MATCH F R[2]C[0]: CASH BALANCE`|| +|MAP01|RENT|/1|`MATCH E R[0]C[2]: Rent/mortgage`|| +|MAP01|CELL|/1|`MATCH E R[0]C[2]: Cell phone`|| + +To import the excel, the end user simply needs to navigate to the LOAD tab, Chooses "Files", select the appropriate map (eg MAP01), and upload. This will stage the new records in [MPE_XLMAP_DATA](tables/mpe_xlmap_data.md) which will go through the usual approval process and quality checks. A copy of the source excel file will be attached to each upload. + +The corresponding [MPE_XLMAP_DATA](tables/mpe_xlmap_data.md) table will appear as follows: + +| LOAD_REF | XLMAP_ID | XLMAP_RANGE_ID | ROW_NO | COL_NO | VALUE_TXT | +|---------------|----------|----------------|--------|--------|-----------------| +| DC20231212T154611798_648613_3895 | MAP01 | MI_ITEM | 1 | 1 | Income Source 1 | +| DC20231212T154611798_648613_3895 | MAP01 | MI_ITEM | 2 | 1 | Income Source 2 | +| DC20231212T154611798_648613_3895 | MAP01 | MI_ITEM | 3 | 1 | Other | +| DC20231212T154611798_648613_3895 | MAP01 | MI_AMT | 1 | 1 | £2,500.00 | +| DC20231212T154611798_648613_3895 | MAP01 | MI_AMT | 2 | 1 | £1,000.00 | +| DC20231212T154611798_648613_3895 | MAP01 | MI_AMT | 3 | 1 | £250.00 | +| DC20231212T154611798_648613_3895 | MAP01 | TMI | 1 | 1 | £3750 | +| DC20231212T154611798_648613_3895 | MAP01 | CB | 1 | 1 | £864 | +| DC20231212T154611798_648613_3895 | MAP01 | RENT | 1 | 1 | £800.00 | +| DC20231212T154611798_648613_3895 | MAP01 | CELL | 1 | 1 | £45.00 | diff --git a/docs/img/xlmap_example.png b/docs/img/xlmap_example.png new file mode 100644 index 0000000..38461c5 Binary files /dev/null and b/docs/img/xlmap_example.png differ