From 554f511e16fc3c5eed9ab46a43af330f344a4613 Mon Sep 17 00:00:00 2001 From: Dylan Mendelowitz Date: Fri, 23 Apr 2021 14:07:37 -0400 Subject: [PATCH 1/3] adding troubleshooting guide for BOMs --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 718272ad..85d6c293 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ A Node.js framework for extracting mCODE FHIR resources. All resources are profi - [Masking Patient Data](#masking-patient-data) - [Extraction Date Range](#extraction-date-range) - [CLI From-Date and To-Date (NOT recommended use)](#cli-from-date-and-to-date-not-recommended-use) + - [Troubleshooting](#troubleshooting) + - [Byte Order Markers in CSV Files](#byte-order-markers-in-csv-files) - [Terminology and Architecture](#terminology-and-architecture) - [Glossary](#glossary) - [High Level Diagram](#high-level-diagram) @@ -161,6 +163,18 @@ If a `from-date` is provided as an option when running the mCODE Extraction Clie npm start -- --entries-filter --from-date --to-date --config-filepath ``` +### Troubleshooting + +#### Byte Order Markers in CSV Files + +The extraction client has built-in handling of byte order markers for CSV files in UTF-8 and UTF-16 encodings. When using CSV files in other encodings, if you experience unexpected errors be sure to check for a byte order marker at the beginning of the file. One way to check is to run the following command from the command line: + +```bash +cat -v file.csv +``` + +If there is an unexpected symbol at the beginning of the file, then there is a byte order marker that needs to be removed. + ## Terminology and Architecture This framework consists of three key components: Extractors, Modules and Templates. Below is, in order: From ff24b922f6fa1262ce6a2e8f03ef8875ea766889 Mon Sep 17 00:00:00 2001 From: Dylan Mendelowitz Date: Mon, 26 Apr 2021 09:17:25 -0400 Subject: [PATCH 2/3] fixing UTF-16 version and command line example --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 85d6c293..ac59f615 100644 --- a/README.md +++ b/README.md @@ -167,10 +167,10 @@ npm start -- --entries-filter --from-date --to-date -- #### Byte Order Markers in CSV Files -The extraction client has built-in handling of byte order markers for CSV files in UTF-8 and UTF-16 encodings. When using CSV files in other encodings, if you experience unexpected errors be sure to check for a byte order marker at the beginning of the file. One way to check is to run the following command from the command line: +The extraction client has built-in handling of byte order markers for CSV files in UTF-8 and UTF-16LE encodings. When using CSV files in other encodings, if you experience unexpected errors be sure to check for a byte order marker at the beginning of the file. One way to check is to run the following command from the command line: ```bash -cat -v file.csv +cat -v ``` If there is an unexpected symbol at the beginning of the file, then there is a byte order marker that needs to be removed. From c6e82081a2ecd9f073cee39533e72097f1b3f21f Mon Sep 17 00:00:00 2001 From: Dylan Mendelowitz Date: Tue, 27 Apr 2021 09:06:10 -0400 Subject: [PATCH 3/3] changing 'is' to 'may be' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac59f615..fdd5a1cd 100644 --- a/README.md +++ b/README.md @@ -173,7 +173,7 @@ The extraction client has built-in handling of byte order markers for CSV files cat -v ``` -If there is an unexpected symbol at the beginning of the file, then there is a byte order marker that needs to be removed. +If there is an unexpected symbol at the beginning of the file, then there may be a byte order marker that needs to be removed. ## Terminology and Architecture