From acac0b533076a8b48b9cdc38e52610140b6e89ce Mon Sep 17 00:00:00 2001 From: Paul Trowbridge Date: Mon, 25 Jun 2018 00:16:42 -0400 Subject: [PATCH] start work on updating readme --- readme.md | 130 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 119 insertions(+), 11 deletions(-) diff --git a/readme.md b/readme.md index b58a509..9f13ba5 100644 --- a/readme.md +++ b/readme.md @@ -1,20 +1,128 @@ ### Interaction Details -* Source Definitions (Maint/Inquire) - * list `/srce_list` - * set `/srce_set` +* Maintain source definitions + * List all sources + * change existing + * create new (with optional sample data to pre-poluate) + * option to step into regex config * Regex Instructions (Maint/Inquire) - - * list `/regex_list` - * set `/regex_set` + * select source + * list all targets for that source + * either edit existing target or make a new one + * target editing + * for each component of the instruction + * be able to run ad-hoc regex + * add additional components * Cross Reference List (Maint/Inquire) - - * list `/map_list` - * set `/map_set` - * show unampped `/unmapped` + + * for a given regex target + * list all output values (or only not yet mapped) and give oportunity to assign alternate value under a different key * Run Import - * run `/import_csv` takes a csv body \ No newline at end of file + * insert new data + +### source definition +``` + srce | jsonb_pretty +------+--------------------------------------------------- + hunt | { + + | "name": "hunt", + + | "source": "client_file", + + | "schemas": { + + | "default": [ + + | { + + | "path": "{Date}", + + | "type": "date", + + | "column_name": "Date" + + | }, + + | { + + | "path": "{Reference Number}", + + | "type": "numeric", + + | "column_name": "Reference Number"+ + | }, + + | { + + | "path": "{Payee Name}", + + | "type": "text", + + | "column_name": "Payee Name" + + | }, + + | { + + | "path": "{Memo}", + + | "type": "text", + + | "column_name": "Memo" + + | }, + + | { + + | "path": "{Amount}", + + | "type": "numeric", + + | "column_name": "Amount" + + | }, + + | { + + | "path": "{Category Name}", + + | "type": "text", + + | "column_name": "Cateogry Name" + + | } + + | ] + + | }, + + | "constraint": [ + + | "{Date}" + + | ], + + | "loading_function": "csv" + + | } +``` + +### regex definitions + +``` +srce | target | regex | seq +-------+----------+--------------------------------------------------------------------------------+----- + dcard | First 20 | { +| 2 + | | "name": "First 20", +| + | | "srce": "dcard", +| + | | "regex": { +| + | | "defn": [ +| + | | { +| + | | "key": "{Description}", +| + | | "map": "y", +| + | | "flag": "", +| + | | "field": "f20", +| + | | "regex": ".{1,20}", +| + | | "retain": "y" +| + | | } +| + | | ], +| + | | "name": "First 20", +| + | | "where": [ +| + | | { +| + | | } +| + | | ], +| + | | "function": "extract", +| + | | "description": "pull first 20 characters from description for mapping"+| + | | }, +| + | | "sequence": 2 +| + | | } | + hunt | First 20 | { +| 1 + | | "name": "First 20", +| + | | "srce": "hunt", +| + | | "regex": { +| + | | "defn": [ +| + | | { +| + | | "key": "{Memo}", +| + | | "map": "y", +| + | | "flag": "", +| + | | "field": "f20", +| + | | "regex": ".{1,20}", +| + | | "retain": "y" +| + | | } +| + | | ], +| + | | "name": "First 20", +| + | | "where": [ +| + | | { +| + | | } +| + | | ], +| + | | "function": "extract", +| + | | "description": "pull first 20 characters from description for mapping"+| + | | }, +| + | | "sequence": 1 +| + | | } | +``` \ No newline at end of file