Fragments - Split transactions
Split inbound EDI files with fragments
- Changelog
- Configuration overview
- Partnerships
Connections
Transaction settings
Guides
- EDI settings
- File processing overview
- Parse EDI
Generate EDI
Guide JSON
Fragments - Split transactions
- Monitor transactions
- Events
Destination webhooks
Mappings - Transform JSON
Manage trading partners
Exchange EDI
Connect business systems
Fragments - Split transactions
Split inbound EDI files with fragments
This functionality is available in a Stedi module. Contact us for details.
Once you configure fragments for an inbound transaction setting, Stedi splits the translated transaction payload into chunks based on the selected segment.
Processing events
Stedi emits two types of events for inbound transactions with fragments enabled: transaction.processed.v2 and fragment.processed.v2.
For example, if you enable fragments on the LIN loop in an 846 Inventory Inquiry/Advice, Stedi will fragment a translated 846 file and emit the following events:
- One
transaction.processed.v2event for each unique transaction set that was included in the original file. - One or more
fragment.processed.v2events containing several iterations of theLINloop (inventory items).
Ingest fragments
You have two options for ingesting fragments from processed inbound transactions into your downstream system.
Push-based
Configure a Destination webhook for fragment.processed.v2 events and ingest fragments as Stedi emits these events.
When you receive fragment.processed.v2 events through a Destination webhook, the payload contains the fragment as well as general information about the transaction.
{
"event": {
"version": "0",
"id": "1c0872a3-dfcc-4b63-9ce7-08ce9ebd9170",
"detail-type": "fragment.processed.v2",
"source": "stedi.core",
"account": "012345678910",
"time": "2023-11-13T15:47:09Z",
"region": "us-east-1",
"resources": [
"https://core.us.stedi.com/2023-08-01/transactions/1b1d2424-72ba-4157-bcfa-3e1620430a3f"
],
"detail": {
"fileExecutionId": "bb141a6f-79f8-9c88-9b91-37609ddd90f9",
"transactionId": "1b1d2424-72ba-4157-bcfa-3e1620430a3f",
"direction": "INBOUND",
"mode": "production",
"processedAt": "2023-11-13T15:47:09.231Z",
"fragments": {
"batchSize": 800,
"fragmentCount": 1,
"keyName": "item_identification_LIN_loop"
},
"fragmentIndex": 0,
"artifacts": [
{
"artifactType": "application/json",
"usage": "output",
"url": "https://core.us.stedi.com/2023-08-01/transactions/1b1d2424-72ba-4157-bcfa-3e1620430a3f/fragments/0/output",
"model": "fragment",
"sizeBytes": 4802
}
],
"partnership": {
"partnershipId": "wormpotato_amazonds",
"partnershipType": "x12",
"sender": { "profileId": "amazonds" },
"receiver": { "profileId": "wormpotato" }
},
"x12": {
"transactionSetting": {
"guideId": "01H9JMMG4839VQG9QQVSZ6X29G",
"transactionSettingId": "01HF4N77F5YWA2RXEDMMF5FF6J"
},
"metadata": {
"interchange": {
"acknowledgmentRequestedCode": "0",
"controlNumber": 76
},
"functionalGroup": {
"controlNumber": 76,
"release": "004010",
"date": "2022-09-24",
"time": "20:01",
"functionalIdentifierCode": "IB"
},
"transaction": {
"controlNumber": "319101",
"transactionSetIdentifier": "846"
},
"receiver": {
"applicationCode": "ACME",
"isa": { "qualifier": "ZZ", "id": "WORMPOTATO" }
},
"sender": {
"applicationCode": "SENDERID",
"isa": { "qualifier": "ZZ", "id": "AMAZONDS" }
}
}
}
}
},
"artifact": {
"artifactType": "application/json",
"usage": "output",
"attachedReason": "WITHIN_SIZE_LIMIT",
"detail": {
"item_identification_LIN_loop": [
{
"item_identification_LIN": {
"assigned_identification_01": "1",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "M3199W"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 9
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "2",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "M8010A"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 52
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "3",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "M4799V"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 3
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "4",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "M4899Q"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 0
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "5",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5155C"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 0
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "6",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5152N"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 16
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "7",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5101O"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 4
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "8",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5101C"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 10
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "9",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5152O"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 9
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "10",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5101N"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 24
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "11",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5155O"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 11
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "12",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5155N"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 15
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "13",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5152C"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 10
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "14",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5101W"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 13
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "15",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5152W"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 15
}
]
},
{
"item_identification_LIN": {
"assigned_identification_01": "16",
"product_service_id_qualifier_02": "SK",
"product_service_id_03": "K5155W"
},
"destination_quantity_SDQ": [
{
"unit_or_basis_for_measurement_code_01": "EA",
"identification_code_qualifier_02": "92",
"identification_code_03": "WHSE",
"quantity_04": 15
}
]
}
]
}
}
}
Pull-based
Configure a Destination webhook for transaction.processed.v2 events only. After you receive a transaction.processed.v2 event, you can use the API to retrieve associated fragments in batches according to your system’s requirements.
When you receive a transaction.processed.v2 event through a Destination webhook, the transaction payload contains the fragment wrapper - the transaction with an an empty array in the position of the fragmented segment. Adjacent to that segment, the payload also includes an x-stedi-fragment-detail section with general information about the fragments that Stedi created.
{
"event": {
"version": "0",
"id": "85634bf9-8359-4a9b-b8f3-66616d896f51",
"detail-type": "transaction.processed.v2",
"source": "stedi.core",
"account": "012345678910",
"time": "2023-11-13T15:47:09Z",
"region": "us-east-1",
"resources": [
"https://core.us.stedi.com/2023-08-01/transactions/1b1d2424-72ba-4157-bcfa-3e1620430a3f"
],
"detail": {
"transactionId": "1b1d2424-72ba-4157-bcfa-3e1620430a3f",
"direction": "INBOUND",
"mode": "production",
"fileExecutionId": "bb141a6f-79f8-9c88-9b91-37609ddd90f9",
"processedAt": "2023-11-13T15:47:09.231Z",
"fragments": {
"batchSize": 800,
"fragmentCount": 1,
"keyName": "item_identification_LIN_loop"
},
"artifacts": [
{
"artifactType": "application/edi-x12",
"usage": "input",
"url": "https://core.us.stedi.com/2023-08-01/transactions/1b1d2424-72ba-4157-bcfa-3e1620430a3f/input",
"sizeBytes": 665,
"model": "transaction"
},
{
"artifactType": "application/json",
"usage": "output",
"url": "https://core.us.stedi.com/2023-08-01/transactions/1b1d2424-72ba-4157-bcfa-3e1620430a3f/output",
"sizeBytes": 825,
"model": "transaction"
}
],
"partnership": {
"partnershipId": "senderid_acme",
"partnershipType": "x12",
"sender": { "profileId": "senderid" },
"receiver": { "profileId": "acme" }
},
"x12": {
"transactionSetting": {
"guideId": "01H9JMMG4839VQG9QQVSZ6X29G",
"transactionSettingId": "01HF4N77F5YWA2RXEDMMF5FF6J"
},
"metadata": {
"interchange": {
"acknowledgmentRequestedCode": "0",
"controlNumber": 76
},
"functionalGroup": {
"controlNumber": 76,
"release": "004010",
"date": "2022-09-24",
"time": "20:01",
"functionalIdentifierCode": "IB"
},
"transaction": {
"controlNumber": "319101",
"transactionSetIdentifier": "846"
},
"receiver": {
"applicationCode": "ACME",
"isa": { "qualifier": "ZZ", "id": "ACME" }
},
"sender": {
"applicationCode": "SENDERID",
"isa": { "qualifier": "ZZ", "id": "SENDERID" }
}
}
},
"connectionId": "01H1CH2ZES1Z8AW94A3RQSRWRW" // optional
}
},
"artifact": {
"artifactType": "application/json",
"usage": "output",
"attachedReason": "WITHIN_SIZE_LIMIT",
"detail": {
"heading": {
"transaction_set_header_ST": {
"transaction_set_identifier_code_01": "846",
"transaction_set_control_number_02": 319101
},
"beginning_segment_for_inventory_inquiry_advice_BIA": {
"transaction_set_purpose_code_01": "00",
"report_type_code_02": "DD",
"reference_identification_03": "37",
"date_04": "2022-09-12",
"time_05": "12:30"
},
"name_N1_loop": [
{
"name_N1": {
"entity_identifier_code_01": "ZZ",
"name_02": "WHSE",
"identification_code_qualifier_03": "92",
"identification_code_04": "WHSE"
}
}
]
},
"detail": {
"item_identification_LIN_loop": [],
"x-stedi-fragment-detail": {
"batchSize": 800,
"fragmentCount": 1,
"keyName": "item_identification_LIN_loop"
}
},
"summary": {
"transaction_totals_CTT": {
"number_of_line_items_01": 16,
"hash_total_02": 196
},
"transaction_set_trailer_SE": {
"number_of_included_segments_01": 37,
"transaction_set_control_number_02": 319101
}
}
}
}
}
Retrieve inbound transaction with fragments
Stedi does not store the complete transaction for inbound files with fragments enabled. When you use Stedi’s Get Transaction endpoint to retrieve inbound transactions with fragments, Stedi always returns the fragment wrapper (the transaction minus fragments).
You cannot retrieve the complete transaction with fragments included - you must use the Get Fragment endpoint to retrieve the fragments separately.
Was this page helpful?