Input 

Document

• Min: 1

• Max: 1

• Mapper

• JSON Generator

JSON data to be split, in the form of a JSON array.

Output

Document

• Min: 1

• Max: 1

• Mapper

• Copy

• File Reader

• Filter

This Snap has exactly one document output view, where it provides the JSON document data stream.

Error

If the Snap fails during the operation, an error document is sent to the error view containing the fields error, reason, original, resolution, and stacktrace:

{
    "error": "Json Splitter expects a list",
    "reason": "Found an object of type class java.lang.String",
    "original": {
      "prod": "p2",
      "price": "13"
    },
    "resolution": "The path $price needs to refer to a list in the incoming document",
    "stacktrace": "com.Snaplogic.Snap.api.SnapDataException: ... }

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Label*

Default Value: JSON Splitter

Example: JSON 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: 

• $orders[*].orderlines[*]

• $orders[*].orderlines[*].prod

String/Suggestion

Enter the JSON path manually. Alternatively, click the Suggestion  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.

Include scalar parents

Default Value: Deselected

Checkbox

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

Example input:

{
    "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:

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

doc 2:

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

Enabling Include scalar parents will lead to:
doc 1: 

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

doc 2: 

{
    "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:

{
    "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.