Versions Compared

Key

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

...

Field Name

Field Type

Field Dependency

Description

Label*

Default ValuePivot
ExamplePivot contract emps

String

None.

Specify a unique name for the Snap.

Selected Fields

Use this fieldset to select fields to be pivoted or remain unchanged in the output document based on the value of the Treat selected fields as static checkbox.

Selected Field

Default Value: N/A
Example: $StudentName

String/Suggestion

None.

Specify or select the field to be included in the action.

If Field Absent

Default Value: N/A
Example: Ignore

Dropdown list

None.

Select one of the following options to apply for the selected field:

  • Ignore

  • Substitute null

  • Substitute empty string

  • Substitute zero

Treat selected fields as static

Default Value: Deselected

Checkbox

None.

Select this checkbox to treat selected fields as static in the output document. Selecting this checkbox enables the following fields:

  • No Pivots Target Field Behavior

  • No Pivots Target Value Behavior

Selecting this checkbox affects the processing of the input documents and preserves the structure of the selected fields when the remaining fields are pivoted.

Target Pivoted Field*

Default Value: N/A
Example: $Student

String/Suggestion

None.

Specify or select the target pivoted field.

Target Pivoted Value*

Default Value: N/A
Example: Score

String/Suggestion

None.

Specify or select the target pivoted value.

No Pivots Target Field Behavior*

Default Value: Substitute null
Example: Ignore

Dropdown list

Appears when you select the Treat selected fields as static checkbox.

Select one of the following options (behavior) you want to apply on the target fields—by default if no fields remain to be pivoted (all fields selected as static).

  • Ignore

  • Substitute null

  • Substitute empty string

  • Substitute zero

No Pivots Target Value Behavior*

Default Value: Substitute null
Example: Ignore

Dropdown list

Appears when you select the Treat selected fields as static checkbox.

Select one of the following options (behavior) you want to apply on the target fields—by default if no fields remain to be pivoted (all fields selected as static).

  • Ignore

  • Substitute null

  • Substitute empty string

  • Substitute zero

Target field full path

Default Value: Deselected

Checkbox

Appears when you deselect Treat selected fields as static checkbox.

Select this checkbox to include the target field as a full path when the Pivot field property value is nested.

Snap Execution

Default Value
Example: Validate & Execute

Dropdown list

N/A

Select one of the following three modes in which the Snap executes:

  • 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.

...

Error

Reason

Resolution

If a Selected Field has a space in the name, an error is displayed and the Snap fails.

The Selected field does not support empty spaces.

Enclose the field value in braces and single quotes ( [' ']). For example, $['House Rent'] instead of $House Rent.

Invalid default behavior for pivoted target field and target value.

Behavior for one of the Target field or Target value fields cannot be Ignore when the other is not Ignore, and there are no fields available to pivot

Select Ignore behavior or non-Ignore behavior for both target field and target value and retry

Examples

Behavior of Pivot Snap when the

...

Treat selected fields as static

...

checkbox is

...

Deselected

This example Pipeline demonstrates the expected behavior of Pivot Snap when the Treat selected fields as static checkbox is deselected (default option).

...

On validating the Snap, the Snap returns all the fields in the output as per the configured behavior for the Selected fields.

...

Download this Pipeline.

...

Behavior of Pivot Snap when the

...

Treat selected fields as static

...

Checkbox is

...

Selected

Scenario 1: Selected fields are present in the input document

...

Related Links