Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Field Type

Description

Label*

Default Value: JSON Splitter

ExampleJSON Splitter

String

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.  

JSON Path to Split*

Default Value: None

Examples

  • $ordersjsonPath($, "orders[*].orderlines[*]$orders")

  • jsonPath($, "orders[*].orderlines[*].prod")

String/Suggestion

Enter the JSON path manually. Alternatively, click the Suggestion (blue star) icon to view the list of paths and select the required path. Defines a path to the list that holds the document entries. Each entry of the list will be written out as a separate document.

The Snap automatically prefixes jsonPath to the value.

Dynamic JSON Path

You can also include pipeline parameters in this property to be dynamic so that it picks values from the pipeline's properties. Use parentheses inside the square brackets to specify the pipeline parameter. For example, the JSON Path $orders[*].orderlines[*]can be written as $orders[*].[(_object)] where object is the pipeline parameter containing the value orderlines.

Include scalar parents

Default ValueDeselected



Checkbox

Select this checkbox to include scalar parents in each output document. 

Example input:

Code Block
{
    "add 1 data": [
        {
            "a": 1, "b": 2 }, {
            "a": 3, "b": 4 }
    ],
    "add 2 data": [
        {
            "a": 11, "b": 22 }, {
            "a": 33, "b": 44 }
    ],
    "id": 111 }

Using the split path on "add 1 data" will create 2 output documents.
doc 1:

Code Block
{
    "a": 1,
    "b": 2 }

doc 2:

Code Block
{
    "a": 3,
    "b": 4 }


Enabling Include scalar parents will lead to:
doc 1: 

Code Block
{
    "a": 1,
    "b": 2,
    "id": 111 }


doc 2: 

Code Block
{
    "a": 3,
    "b": 4,
    "id": 111 }

Null-safe access

Default Value: Deselected

Checkbox

Select this checkbox to skip invalid path definitions that are defined in the Include Paths property below. If disabled when the path does not exist in the input view, the Snap displays a DataException.

Include Paths


Select this checkbox to include objects from the input document in the resulting output document(s).
Example:
Input same as above.
A path such as  ['add 2 data'] will include the object in the output documents:

doc1:

Paste code macro
languagejson
{
    "a": 1,
    "b": 2,
    "id": 111,
    "add 2 data": [
        {
            "a": 11,
            "b": 22
        },
        {
            "a": 33,
            "b": 44
        }
    ],
}
doc2:
{
    "a": 3,
    "b": 4,
    "id": 111,
    "add 2 data": [
        {
            "a": 11,
            "b": 22
        },
        {
            "a": 33,
            "b": 44
        }
    ],
}

Exclude List from Output Documents

Default Value: Deselected

Checkbox

Select this checkbox to prevent the split list from being included in output documents. Select this checkbox to leverage the memory usage.

 

Show Null Values for Include Paths


Default Value: Deselected

Checkbox

Select this checkbox to show key-value entries of the null values for the objects added to the Include Paths field in the output documents. 

Snap Execution

 

Default Value: Execute only
Example: Validate & Execute

Dropdown list

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.

  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

...