Skip to content

Commit 7243379

Browse files
authored
Merge pull request #93 from mcode/ex-config-rename
Example config rename
2 parents 77dd962 + efe2ac3 commit 7243379

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ node_modules/
44
output/
55
logs/
66
config/*.json
7-
!config/mcode-csv-config.example.json
7+
!config/csv.config.example.json

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Examples files for these extractor can be found in the [`test/sample-client-data
8585

8686
#### Configuration Files: Step 3
8787

88-
After exporting your CSV files to the `data` directory, kickstart the creation of a configuration file by renaming the provided `mcode-csv-config.example.json` to `csv.config.json`. Then, ensure the following configuration parameters are properly set:
88+
After exporting your CSV files to the `data` directory, kickstart the creation of a configuration file by renaming the provided `csv.config.example.json` to `csv.config.json`. Then, ensure the following configuration parameters are properly set:
8989

9090
1. `patientIdCsvPath` should provide a file path to a CSV file containing MRN's for relevant patients;
9191
2. For each extractor, `filePath:` should provide a file path to a CSV file containing that corresponding extractor's data;
@@ -94,7 +94,7 @@ For instructions on setting up an email notification trigger whenever an error i
9494

9595
### Configuration Deep Dive
9696

97-
Each deployment of the mCODE Extraction Client needs a configuration file. This file will specify basic information that every run will use. The configuration file can live in the `config` directory or any directory you prefer. An illustrative example file can be found in [`config/mcode-csv-config.example.json`](config/mcode-csv-config.example.json).
97+
Each deployment of the mCODE Extraction Client needs a configuration file. This file will specify basic information that every run will use. The configuration file can live in the `config` directory or any directory you prefer. An illustrative example file can be found in [`config/csv.config.example.json`](config/csv.config.example.json).
9898

9999
To specify which patients the client should extract data for, the configuration file _must_ point to a CSV file containing MRNs for each patient. The format for this file can be found [here](https://github.com/mcode/mcode-extraction-framework/blob/master/docs). An example of this file can be found in [`test/sample-client-data/patient-mrns.csv`](test/sample-client-data/patient-mrns.csv).
100100

@@ -112,7 +112,7 @@ In order to send an email, users must specify the hostname or IP address of an S
112112
- `to`: Comma separated list or an array of recipients email addresses that will appear on the _To:_ field
113113
- `from`: (Optional) The email address of the sender. All email addresses can be plain `'sender@server.com'` or formatted `'"Sender Name" sender@server.com'` (defaults to mcode-extraction-errors@mitre.org, which cannot receive reply emails)
114114

115-
An example of this object can be found in [`config/mcode-csv-config.example.json`](config/mcode-csv-config.example.json).
115+
An example of this object can be found in [`config/csv.config.example.json`](config/csv.config.example.json).
116116

117117
If the `notificationInfo` object is provided in configuration, an email will be sent using the specified options if any errors occur during data extraction. If any required field is missing in the object (`host` or `to`), an email cannot be sent. If you prefer to not have an email sent even if errors occur, you can choose to not include the `notificationInfo` object in your configuration file.
118118

File renamed without changes.

0 commit comments

Comments
 (0)