Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhancedjsonoutput.adoc: Fix grammar and examples #2192

Merged
merged 1 commit into from
Jan 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Currently available 3 types of operation:
Can be empty string that will affect output json structure, see detailed description below.
|Output value|This value will be used as a transform output field.
Will contain generated json output block depending on transform settings.
|Force Arrays In JSON| If checked, JSON output will be forced as a single item array.
|Force Arrays In JSON| If checked, JSON output will be forced as a single item whose content is an array.
|Pritty Print JSON|If checked, JSON output will be pritty printed.
|===

Expand All @@ -74,20 +74,20 @@ Will contain generated json output block depending on transform settings.
|===
|Option|Description
|Filename|full path to output file
|Append|If not checked new file will be created every time transform is running.
If file with specified name already existed - it will be replaced by a new one.
If checked - new json output will be appended at the end of existing file.
Or if existing file is not exists - it will be created as in previous case.
|Append|If not checked - new file will be created every time transform is running.
If file with specified name exists already, it will be replaced by a new one.
If checked - new json output will be appended to the end of existing file.
Or if file does not exist, it will be created as in previous case.
|Split JSON after n rows|If this number N is larger than zero, split the resulting JSON file into multiple parts of N rows.
|Create Parent folder|Usually file name contains some path folder as a parent folder.
If parent folder does not exists and this option is checked - parent folder will be created as a new folder.
If parent folder does not exist and this option is checked, parent folder will be created as a new folder.
Otherwise - file not be found and transform will fail.
|Do not open create at start|If not checked - file (and in some cases parent folder) will be created/opened to write during pipeline initialization.
If checked - file and parent folder will be created only after transform will get any first input data.
If checked - file and parent folder will be created only after transform gets any first input data.
|Extension|Output file extension.
Default value is 'js'
|Encoding|Output file encoding
|Include date in filename?|If checked - output file name will contains File name value + current date.
|Include date in filename?|If checked - output file name will contain File name value + current date.
This may help to generate unique output files.
|Include time in filename|If checked - output file name will contain file creation time.
Same as for 'Include date in filename' option
Expand Down Expand Up @@ -121,7 +121,7 @@ Use 'Get Fields' button to discover available input fields
For example "A":"B" - A is a element name, B is actual input value mapped for this Element name.
|JSON Fragment|If the value is set to Y the value contained in the filed is a JSON chunk and will be treated accordingly
|Remove Element name|If the value is set to Y it will ignore the Element name and insert the JSON Fragment without wrapping it. Only works with JSON Fragment = Y
|Remove if Blank|If the value is set to Y and value in incoming field is null the related attribute will be omitted from JSON output
|Remove if Blank|If the value is set to Y and value in incoming field is null, the related attribute will be omitted from JSON output

|===

Expand All @@ -148,7 +148,7 @@ As an example suppose we have, as input, a flow with the following fields and va
|Option|Assigned Value
|Operation|Write To File
|JSON Block Name|result
|Output Value|lvl1Detail
|Output Value|lvl1Details
|Pritty Print JSON|Checked
|Filename|Set to a convenient filename for JSON output
|===
Expand All @@ -160,12 +160,12 @@ As an example suppose we have, as input, a flow with the following fields and va
|field1|recordKey
|===

=== Fields Group Key - Configuration
=== Tab Fields - Configuration

|===
|Field Name|Element Name|JSON Fragment|Remove If Blank
|field3||N|N
|field3||N|N
|field2|campo2|N|N
|field3|campo3|N|N
|===

=== Output file result
Expand All @@ -174,7 +174,7 @@ As an example suppose we have, as input, a flow with the following fields and va
----
{
"result" : [ {
"key2" : "C",
"recordKey" : "C",
"lvl1Details" : {
"result" : [ {
"campo2" : "F",
Expand All @@ -191,7 +191,7 @@ As an example suppose we have, as input, a flow with the following fields and va
} ]
}
}, {
"key2" : "B",
"recordKey" : "B",
"lvl1Details" : {
"result" : [ {
"campo2" : "C",
Expand All @@ -205,7 +205,7 @@ As an example suppose we have, as input, a flow with the following fields and va
} ]
}
}, {
"key2" : "A",
"recordKey" : "A",
"lvl1Details" : {
"result" : [ {
"campo2" : "B",
Expand Down