X12 Formatter

Overview

This Snap allows you to read JSON document data from its input view and format and write the data as an X12 binary stream to its output view. You can combine all JSON documents into a single X12 binary output and customize the ISA and GS segments and the delimiters.

The input data must be a JSON document that represents a valid X12 transaction set, and you must select the corresponding X12 type in the Snap settings.



Snap views

View Description Examples of upstream and downstream Snaps
Input JSON document containing valid X12 transaction sets.
Output Binary stream containing the formatted X12 data.
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

Legend:
  • Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
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.

Default value: X12 Formatter

Example: X12 Formatter
Segment delimiter String/Expression

Required. The character that separates the different segments of an EDI message. This delimiter enables the receiver to parse and interpret the various components of the message.

Default value: ~

Example: ~
Element delimiter String/Expression

Required. The character that separates data elements within a segment of an EDI message. These elements are the smallest units of information in the message. This delimiter helps parse and accurately interpret the message's content.

Default value: *

Example: *
Sub element delimiter String/Expression Required. The character inside an EDI segment that separates smaller parts of data within data elements. This delimiter helps organize and understand detailed information.

Default value: :

Example: :
X12 Type Dropdown list The specific transaction format for electronic business document exchange. Each type has a unique code for proper data interpretation; for example, X12 850 is used for purchase orders.

Default value: x12_835-5010

Example: x12_820-4010
Add new line after each segment Checkbox Adds a new line character at the end of each segment.

Default status: Selected
Build fixed length ISA segment Checkbox Ensures the ISA segment has a fixed length.

Default status: Selected
Group multiple transaction sets Checkbox Groups all incoming transaction sets into a single functional group in the output.

Default status: Selected
ISA The ISA segment provides key information for routing, identification, and processing of the EDI interchange.
ISA Name Dropdown list The name of the ISA segment element to add.. 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/Expression The value of the element.

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.
GS Name Dropdown list The name of the GS segment element to add. Available options are:
  • VersionAndRelease
  • ReceiverIDCode
  • GroupControlNumber
  • SenderIDCode
  • TransactionTypeCode
  • Time
  • Date
  • CodeIdentifyingInformationType

Default value: VersionAndRelease

Example: SenderIDCode
GS Value String/Expression The value of the GS segment.

Default value: N/A

Example: receiverXyz
Snap execution Dropdown list Choose 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.

Example: