Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
john-c-houser authored May 24, 2023
1 parent e8b84cf commit 9cdb786
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,12 +188,12 @@ bin/randomize_checksum_ages.pl config.yaml
# Configuration Notes

## Field Definition Keywords
When configuring client districts, there a number of keywords that may be used
When configuring client districts, a number of keywords may be used
to define the way the software will handle incoming data and derivative fields:
* `type`: Symphony field type (used to determine data structure needed in JSON)
* `overlay`: If true, update field when updating existing record
* `validate`: Field validation rule to apply to incoming data (ingestor will throw error and skip record if validation fails)
* `transform`: Transformation function (in ingestor.pl) which takes validated input from one field and returns a valid value
* `transform`: Transformation function (in ingestor.pl) which takes validated input from one or more fields in the incoming or existing record data and returns a valid value
* `overlay_default`: Value to use in update IF FIELD CURRENTLY EMPTY
* `overlay_value`: Value to ALWAYS overlay existing value during update
* `new_default`: Value to use in create IF FIELD CURRENTLY EMPTY
Expand Down

0 comments on commit 9cdb786

Please sign in to comment.