X12 Formatter

reads incoming data objects and formats to selected the X12 type and version.

Overview

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


X12 Formatter Snap Settings

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.
  • Constant
  • JSON Parser
Output Optional. The Pipeline has at least one output document.
  • AS2 Sender
  • File Writer
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 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.

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 (): Indicates that you can add fields in the field set.
  • Remove 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.
Segment delimiter String

A character used to separate different segments in an Electronic Data Interchange (EDI) message allowing the receiver to parse and interpret the various components of the message. It's represented by the tilde (~) character.

Default value: ~

Example: ~
Element delimiter String

A character that separates data elements into segments of an EDI message. These elements are the smallest units of information in the message. The delimiter aids in parsing and accurately interpreting the message's content.

The most common element delimiter in X12 is the asterisk (*) character. Some other element delimiters include the caret (^) and the pipe (|).

Default value: *

Example: |
Sub element delimiter String A subelement delimiter is a character inside an EDI segment that separates smaller parts of data in data elements. It helps organize and understand detailed information. In X12, a common subelement delimiter is the colon (:).

Default value: :

Example: :
X12 Type Dropdown list Select the specific transaction formats in electronic business document exchange. Each type, like X12 850 for Purchase Orders, has a unique code for proper data interpretation.
Add new line after each segment Checkbox Select this checkbox if you want to add a line break after each segment.

Default status: Deselected
Build fixed length ISA segment Checkbox Select this checkbox if you want to build fixed length Interchange Control Header (ISA) segment.

Default status: Deselected
Group multiple transaction sets Checkbox Select this checkbox if you want to group multiple transaction sets per their category.

Default status: Deselected
ISA The ISA segment provides key information for routing, identification, and processing of the EDI interchange. This field set contains the following fields:
  • ISA Name
  • ISA Value
ISA Name String Specify the name of the ISA segment. Available options are:
  • InterchangeSenderID
  • UsageIndicator
  • SecurityInformationQualifier
  • InterchangeTime
  • SecurityInformation
  • InterchangeReceiverID
  • InterchangeDate
  • AcknowledgementRequested
  • InterchangeControlNumber
  • ReceiverIDQualifier
  • ComponentElementSeparator
  • InterchangeControlStandardsIdentifier
  • AuthorizationInformationQualifier
  • SenderIDQualifier
  • InterchangeControlVersionNumber
  • AuthorizationInformation

Default value: InterchangeSenderID

Example: AuthorizationInformation
ISA Value String Specify the key value of the UNB segment.

Default value: N/A

Example: SenderAbc
GS The GS segment is used to indicate the start of a functional group, which is a collection of related transactions in an EDI interchange. This field set contains the following fields:
  • GS Name
  • GS Value
GS Name String Specify the name of the GS segment. Available options are:
  • VersionAndRelease
  • ReceiverIDCode
  • GroupControlNumber
  • SenderIDCode
  • TransactionTypeCode
  • Time
  • Date
  • CodeIdentifyingInformationType

Default value: VersionAndRelease

Example: SenderIDCode
GS Value String Specify the value of the GS segment.

Default value: N/A

Example: receiverXyz
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.