EDI Formatter

reads incoming data objects and formats to selected EDIFACT type and version.

Overview

This Snap reads incoming data objects and formats to selected EDIFACT type and version.

Prerequisites

None.

Limitations and known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input Optional. This Snap has at least one input document.
  • Box Add Folder
  • EDI to JSON
Output Optional. The Snap has at least one output document.
  • AS2 Sender
  • Copybook Parser
Error

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. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • 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.

Snap settings

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (Plus Icon): Indicates that you can add fields in the field set.
  • Remove icon (Minus Icon): Indicates that you can remove fields from the field set.
Field / Field set Type Description
Label String Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if there are more than one of the same Snap in the pipeline.
Version Dropdown list Required. Select the version of the EDIFACT you want to use.

Default value: D10A

Example: D10A
EDIFACT Type String/Expression Specify the EDIFact types supported by this snap for the selected version. The type of the EDIFact to be used to format the input data object to EDIFact content.

Default value: D10A

Example: D10A
Validate Checkbox Select this checkbox to validate the input data against the EDI schema.

Default status: Deselected
Format each document Checkbox Select this checkbox if you want to formats each document into its own binary representation.

Default status: Deselected
UNA Segment The UNA segment in EDI (Electronic Data Interchange) refers to the Service String Advice segment. Use this field set to define UNA Segment values. This field set contains the following fields:
  • UNA segment Key Name
  • UNA segment Key Value
UNA segment Key Name String Specify the key name of the UNA segment. Available options are:
  • Component DataElement Separ
  • Release Indicator
  • Decimal Notation
  • DataElement Separator
  • Repetition Separator
  • Segment Terminator

Default value: Component DataElement Separator

Example: Segment Terminator
UNA segment Key Value String Specify the key value of the UNA segment.

Default value: N/A

Example: 234
UNB Segment The UNB segment in EDI (Electronic Data Interchange) stands for "Interchange Header Segment. Use this field set to override any of the default values for the elements in UNB Segment. This field set contains the following fields:
  • UNB segment Key Name
  • UNB segment Key Value
UNB segment Key Name String Specify the key name of the UNB segment. Available options are:
  • Syntax Version Number
  • Syntax Identifier
  • Interchange Sender Identification
  • Acknowledgement Request
  • Processing Priority Code
  • Time
  • Interchange Control Reference
  • Identification Recipient Code Qualifier
  • Application Reference
  • Service Code List Directory Version Number

Default value: Syntax Version Number

Example: Processing Priority Code
UNB segment Key Value String Specify the key value of the UNB segment.

Default value: N/A

Example: 234
UNH Segment The UNH segment in EDI stands for Message Header Segment. Use this field set to override any of the default values for the elements in UNH Segment. This field set contains the following fields:
  • UNH segment Key Name
  • UNH segment Key Value
UNH segment Key Name String Specify the key name of the UNH segment. Available options are:
  • Message reference number
  • Sequence of transfers
  • Controlling agency
  • Message release number
  • First and last transfer
  • Message type
  • Common access reference
  • Message version number

Default value: Message reference number

Example: Message type
UNH segment Key Value String Specify the key value of the UNH segment.

Default value: Message reference number

Example: Sequence of transfers
Snap execution 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.

Troubleshooting

None.