Skip to content

Commit

Permalink
📝 docs: Update readMe and comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Okanmercan99 committed Sep 23, 2024
1 parent 17b57e7 commit 606b0ce
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,8 @@ Example of a Mapping Job definition file with csv source type:
"sourceBinding": {
"patient": {
"jsonClass": "FileSystemSource",
"path": "patients.csv"
"path": "patients.csv",
"contentType": "csv"
}
}
},
Expand All @@ -560,7 +561,8 @@ Example of a Mapping Job definition file with csv source type:
"sourceBinding": {
"practitioner": {
"jsonClass": "FileSystemSource",
"path": "practitioners.csv"
"path": "practitioners.csv",
"contentType": "csv"
}
}
}
Expand Down Expand Up @@ -649,7 +651,6 @@ The json snippet above illustrates the structure of an example mapping job in st
Similar to the batch mode, most of the fields are the same. The only differences are:
- `asStream` field in the source settings
- `path` in the source binding of the mapping. `path` should be the name of the **folder** this time, and it is where toFHIR will monitor the changes.
- `contentType` in the source binding of the mapping. `contentType` field is mandatory.

##### SQL

Expand Down Expand Up @@ -1001,7 +1002,8 @@ Or you can use a local file system to persist the generated FHIR resources:
{
"sinkSettings": {
"jsonClass": "FileSystemSinkSettings",
"path": "sink/project1"
"path": "sink/project1",
"contentType": "csv"
}
}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ trait MappingSourceBinding extends Serializable {
* field. It reads the files with the specified content type in the given folder.
*
* Example for Batch Jobs:
* - With extension in path:
* FileSystemSource(path = "data/patients.csv") => Will read the "data/patients.csv" file.
* - Providing folder name and content type:
* FileSystemSource(path = "data/patients", contentType = "csv") => Will read all files in the "data/patients" folder and interpret them as a csv.
*
Expand Down

0 comments on commit 606b0ce

Please sign in to comment.