Upload
trandat
View
219
Download
0
Embed Size (px)
Citation preview
Outbound 824 Application Advice
Page 1 of 21
824 Application Advice
Functional Group ID=AG
Introduction: This standard contains the format and establishes the data contents of the Application Advice Transaction Set (824) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to provide the ability to report the results of an application system's data content edits of transaction sets. The results of editing transaction sets can be reported at the functional group and transaction set level, in either coded or free form format. It is designed to accommodate the business need of reporting the acceptance or rejection related to ocean carrier Shipping Instruction (304), Bill of Lading (310) and Booking Request (300) transaction set.
Heading:
Pos. Seg. Req. Loop Notes and No. ID Name Des. Max.Use Repeat Comments
M ISA Interchange Control Header M 1 M GS Functional Group Header M 1 M 010 ST Transaction Set Header M 1 M 020 BGN Beginning Segment M 1 LOOP ID - N1 >1 030 N1 Name O 1 040 N2 Additional Name Information O 2 Not Supported 050 N3 Address Information O 2 Not Supported 060 N4 Geographic Location O 1 Not Supported 070 REF Reference Identification O 12 080 PER Administrative Communications Contact O 3 Not Supported
Detail:
Pos. No.
Seg. ID
Name
Req. Des.
Max.Use
Loop Repeat
Notes and Comments
LOOP ID - OTI >1 M 010 OTI Original Transaction Identification M 1 n1 020 REF Reference Identification O 12 n2 030 DTM Date/Time Reference O 2 n3 Not Supported 040 PER Administrative Communications Contact O 3 n4 Not Supported 050 AMT Monetary Amount O >1 n5 Not Supported 060 QTY Quantity O >1 n6 Not Supported 065 NM1 Individual or Organizational Name O 9 n7 Not Supported LOOP ID - TED >1 070 TED Technical Error Description O 1 080 NTE Note/Special Instruction O 100 082 RED Related Data O 100 n8 Not Supported LOOP ID - LM >1 Not Supported 085 LM Code Source Information O 1 n9 Not Supported LOOP ID - LQ 100 Not Supported
M 086 LQ Industry Code M 1 Not Supported 087 RED Related Data O 100 n10 Not Supported
M 090 SE Transaction Set Trailer M 1 M GE Functional Group Trailer M 1
Outbound 824 Application Advice
Page 3 of 21
Document History
DATE CHANGES MADE 13/05/2015 Original document.
Outbound 824 Application Advice
Page 4 of 21
Max: 1 Mandatory
Loop: NA Elements: 16
Interchange Control Header
ISA
Purpose: To start and identify an interchange of zero or more functional groups and interchange-related control segments
Element Summary: Ref Id Element Name Req Type Min/Max Usage ISA01 I01 Authorization Information Qualifier
Code to identify the type of information in the Authorization Information
M ID 2/2 EDI Req.
Set to ‘00’ – No Authorization Information Present (No Meaningful Information in I02) ISA02 I02 Authorization Information
Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01) Set to 10 empty spaces
ISA03 I03 Security Information Qualifier Code to identify the type of information in the Security Information
M AN 10/10 EDI Req.
M ID 2/2 EDI Req.
Set to ‘00’ – No Security Information Present (No Meaningful Information in I04) ISA04 I04 Security Information
This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03) Set to 10 empty spaces
ISA05 I05 Interchange ID Qualifier Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified Set to ‘ZZ’ – Mutually Defined
ISA06 I06 Interchange Sender ID Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element
M AN 10/10 EDI Req.
M ID 2/2 EDI Req.
M AN 15/15 EDI Req.
Set to ‘WWALLIANCE’ with 5 empty spaces to fill 15 characters ISA07 I05 Interchange ID Qualifier
Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified Set to ‘ZZ’ – Mutually Defined
ISA08 I07 Interchange Receiver ID Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them
M ID 2/2 EDI Req.
M AN 15/15 EDI Req.
Set to < SCAC Code> with empty spaces to fill 15 characters ISA09 I08 Interchange Date (sender) Date of the interchange
Outbound 824 Application Advice
Page 6 of 21
Ref ISA10
Id I09
Element Name Interchange Time (sender)
Req M
Type TM
Min/Max 4/4
Usage EDI Req.
Time of the interchange ISA11 I10 Interchange Control Standards Identifier Code to
identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer
M ID 1/1 EDI Req.
Set to 'U' – U.S. EDI Community of ASC X12, TDCC and UCS ISA12 I11 Interchange Control Version Number
Code specifying the version number of the interchange control segments
M ID 5/5 EDI Req.
Set to ‘00401’ Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures – Review Board through October 1997
ISA13 I12 Interchange Control Number A control number assigned by the interchange sender
M N0 9/9 EDI Req.
ISA14 I13 Acknowledgment Requested Code sent by the sender to request an interchange acknowledgment (TA1)
M ID 1/1 EDI Req.
Set to ‘0’ – No Acknowledgment Requested
ISA15 I14 Usage Indicator M ID 1/1 EDI Req. Code to indicate whether data enclosed by this interchange envelope is test, production or information
Set to 'T' (test) or ‘P’ (production) – mutually agreed upon per integration status
ISA16 I15 Component Element Separator M AN 1/1 EDI Req. Type is not applicable; the component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator
Sample Segment:
Set to ‘>’
ISA*00* *00* *ZZ*WWALLIANCE *ZZ*RECEIVERID *101119*0916*U*00401*000000001*1*P*>~
Outbound 824 Application Advice
Max: 1 Mandatory
Loop: NA Elements: 8
Functional Group Header
Set to ‘004010’ Draft Standards Approved for Publication by ASC X12 Procedures Review Board – through October 1997 Set to ‘004010’ Draft Standards Approved for Publication by ASC X12 Procedures Review Board – through October 1997
GS
Purpose: To indicate the beginning of a functional group and to provide control information
Element Summary:
Ref GS01
Id 479
Element Name Functional Identifier Code
Req M
Type ID
Min/Max 2/2
Usage EDI Req.
Code identifying a group of application related transaction sets
Set to ‘AG’ – Application Advice GS02 142 Application Sender's Code
Code identifying party sending transmission; codes agreed to by trading partners
M AN 2/15 EDI Req.
Set to ‘WWALLIANCE’ GS03 124 Application Receiver's Code
Code identifying party receiving transmission; codes agreed to by trading partners
M AN 2/15 EDI Req.
Set to <Member's SCAC Code>
GS04 373 Date Date expressed as CCYYMMDD
M DT 8/8 EDI Req.
GS05 337 Time Time expressed in 24-hour clock time as follows: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds; decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00- 99)
M TM 4/8 EDI Req.
GS06 28 Group Control Number Assigned number originated and maintained by the sender
M N0 1/9 EDI Req.
GS07 455 Responsible Agency Code Code identifying the issuer of the standard; this code is used in conjunction with Data Element 480
M ID 1/2 EDI Req.
Set to ‘X’ – Accredited Standards Committee X12
GS08 480 Version / Release / Industry Identifier Code M AN 1/12 EDI Req. Code indicating the version, release, sub release, and industry identifier of the EDI standard being used, including the GS and GE segments; if code in DE455 in GS segment is X, then in DE 480 positions 1-3 are the version number; positions 4-6 are the release and sub release, level of the version; and positions 7-12 are the industry or trade association identifiers (optionally assigned by user); if code in DE455 in GS segment is T, then other formats are allowed
SemanticsNote: 1. GS04 is the group date 2. GS05 is the group time 3. The data interchange control number (GS06) in this header must be identical to the same data element in the
Outbound 824 Application Advice
Page 6 of 21
associated functional group trailer (GE02). Comments: 1. A functional group of related transaction sets, within the scope of X12 standards, consists of a collection of similar
transaction sets enclosed by a functional group header and a functional group trailer. Sample Segment: GS*AG*WWALLIANCE*RECEIVERID*20101119*0916*000000001*X*004010~
Outbound 824 Application Advice
Page 7 of 21
Max: 1 Mandatory
Loop: NA Elements: 2
Transaction Set Header
ST
Purpose: To indicate the start of a transaction set and to assign a control number
Element Summary:
Ref ST01
Id 143
Element Name Transaction Set Identifier Code
Req M
Type ID
Min/Max 3/3
Usage EDI Req.
Code uniquely identifying a Transaction Set Set to ‘824’ – Application Advice
ST02 329 Transaction Set Control Number Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set
M AN 4/9 EDI Req.
Semantics: 1. The transaction set identifier (ST01) used by the translation routines of the interchange partners to select the
appropriate transaction set definition (e.g., 810 selects the Invoice Transaction Set). Sample Segment: ST*824*0001~
Outbound 824 Application Advice
Page 8 of 21
0644
Confirmation Rejection
Max: 1 Mandatory
Loop: NA Elements: 4
Beginning Segment
BGN
Purpose: To indicate the beginning of a transaction set
Element Summary:
Ref BGN01
Id 353
Element Name Transaction Set Purpose Code
Req M
Type ID
Min/Max 2/2
Usage EDI Req.
Code identifying purpose of transaction set
BGN02 127 Reference Identification Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier
M AN 1/30 EDI Req.
See Comments BGN03 373 Date
Date expressed as CCYYMMDD BGN04 337 Time
Time expressed in 24-hour clock time as follows: HHMM
M DT 8/8 EDI Req.
X TM 4/8
Syntax: 1. If BGN05 is present, then BGN04 is required.
Semantics: 1. BGN02 is the transaction set reference number (See Comments). 2. BGN03 is the transaction set date. 3. BGN04 is the transaction set time.
Comments: 1. Set to original message Shipment Identification Number.
Sample Segment: BGN*06*016211*20101119*0916~
Page 9 of 21
Outbound 824 Application Advice
Purpose: To identify a party by type of organization, name and code
Loop Summary:
Id Segment Name Req Max Use Repeat Usage N1 Name O 1 N3 Address Information O 1 Not Supported N4 Geographic Location O 1 Not Supported REF Reference Identification O 12 PER Administrative Communications Contact O 3 Not Supported
Repeat: >1 Optional
Loop: N1 Segments: 5
Loop N1
Outbound 824 Application Advice
Proprietary & Confidential Page 10 of 21 5/26/2015
Max: 1 Optional
Loop: N1 Elements: 2
Name
N1
Purpose: To identify a party by type of organization, name, and code
Element Summary:
Ref N101
Id 98
Element Name Entity Identifier Code
Req M
Type ID
Min/Max 2/3
Usage EDI Req.
Code identifying an organizational entity, a physical location, property or an individual
40 Receiver ID (See Comments #1) N102 93 Name
Free-form name X AN 1/60
N103 66 Identification Code Qualifier Code designating the system/method of code structure used for Identification Code (67)
X ID 1/2
ZZ Mutually Defined (See Comments #2) N104 67 Identification Code X AN 2/80
Set to GT Nexus Party Code or customer defined Division ID for specified party.
Syntax: 1. At least one of N102 or N103 is required.
Comments: 1. By default N102 represents the Interchange Receiver ID (N103 and N104 is not provided).
Sample Segment: N1*40*RECEIVERID~
Outbound 824 Application Advice
Page 11 of 21
Max: 12 Optional
Loop: N1 Elements: 2
Reference Identification
REF
Purpose: To specify identifying information
Element Summary: Ref Id Element Name Req Type Min/Max Usage REF01 128 Reference Identification Qualifier
Code qualifying the Reference Identification ZZ Mutually Defined
REF02 127 Reference Identification Free-form name (See Comments)
M ID 2/3 EDI Req.
X AN 1/30
Syntax: 1. At least one of REF02 or REF03 is required.
Comments: 1. REF02 represents the one of three WWA Acknowledgement definitions: ‘LEVEL 2’, ‘LEVEL 3’ or ‘LEVEL 4’
(‘LEVEL 2’ = WWA transaction processing, ‘LEVEL 3’ = Ocean Carrier received transaction from WWA and ‘LEVEL 4’ = Ocean Carrier BL processed by WWA).
Sample Segment: REF*ZZ*LEVEL 3~
Outbound 824 Application Advice
Page 12 of 21
Purpose: The OTI loop is intended to provide a unique identification of the transaction set that is the subject of this application acknowledgment.
Loop Summary:
Id Segment Name Req Max Use Repeat Usage OTI Original Transaction Identification M 1 REF Reference Identification O 12 DTM Date/Time Reference O 2 Not Supported PER Administrative Communications Contact O 3 Not Supported AMT Monetary Amount O >1 Not Supported QTY Quantity O >1 Not Supported NM1 Individual or Organizational Name O 9 Not Supported
Repeat: >1 Mandatory
Loop: OTI Segments: 7
Loop OTI
Outbound 824 Application Advice
Page 13 of 21
Max: 1 Mandatory
Loop: OTI Elements: 3
Original Transaction Identification
IA TA IR TR
Item Accept Transaction Set Accept Item Reject Transaction Set Reject
OTI
Purpose: To identify the edited transaction set and the level at which the results of the edit are reported, and to indicate the accepted or rejected edit result
Element Summary:
Ref OTI01
Id 110
Element Name Application Acknowledgement Code
Req M
Type ID
Min/Max 1/2
Usage EDI Req.
Code indicating the application system edit results of the business data
OTI02 128 Reference Identification Qualifier
Code qualifying the Reference Identification M ID 2/3 EDI Req.
7U Related Transaction Reference Number OTI03 127 Reference Identification
Reference information as defined for a particular Transaction Set or as specified by the Reference Identification Qualifier
M AN 1/30 EDI Req.
Semantics: 1. OTI03 is the primary reference identification or number used to uniquely identify the original transaction set.
Comments: 1. OTI02 contains the qualifier identifying the business transaction from the original business application, and OTI03 will
contain the original business application identification. 2. The 1st OTI Loop, OTI03 represents the original message Interchange Control Number and the 2nd OTI Loop, OTI03
represents the original message Transaction Set Control Number.
Sample Segment: OTI*IA*7U*000034599~ OTI*TA*7U*93876~
Outbound 824 Application Advice
Page 14 of 21
Max: 12 Optional
Loop: OTI Elements: 2
Reference Identification
ZZ BM SCA BN CR FN CG PO CT RF
Mutually Defined (See Comments #1 and #2) Bill of Lading Number Carrier SCAC Booking Number Division Code Forwarder's/Agent's Reference Number Consignee's Order Number Purchase Order Number Contract Number Export Reference Number
REF
Purpose: To specify identifying information
Element Summary:
REF02 127 Reference Identification Free-form name (See Comments #2 and #3)
REF03 352 Description A free-form description to clarify the related data elements and their content
X AN 1/30
X AN 1/80
Syntax: 1. At least one of REF02 or REF03 is required.
Comments: 1. At a minimum REF01 = ‘ZZ’ will always be provided. 2. When REF01 = ‘ZZ’ REF02 represents one of three GT Nexus processing code definitions: 'SEVERITY 1' = Success,
'SEVERITY 2' = Warning, 'SEVERITY 3' = Error. 3. REF03 description is provided only when REF02 contains ‘SEVERITY 1’ or ‘SEVERITY 2’ (a description for REF02 with ‘SEVERITY
3’ is provided within the TED Loop). 4. When REF02 = ‘SEVERITY 3’ no other REF02 definitions are provided other than ‘ZZ’.
Sample Segment: (“Success” or “Warning”) REF*ZZ*SEVERITY 1*Received BL instruction acknowledgement for WWA reference 10892957~ REF*SCA*ZIMU~ REF*BN*GTN824TEST06~ REF*CR*DIVISIONCODE~ REF*FN*016211~ REF*PO*16789-1~ REF*RF*016211~
(“Error”) REF*ZZ*SEVERITY 3~
Ref REF01
Id 128
Element Name Reference Identification Qualifier
Req M
Type ID
Min/Max 2/3
Usage EDI Req.
Code qualifying the Reference Identification
Outbound 824 Application Advice
Page 15 of 21
Purpose: To identify the error and, if feasible, the erroneous segment, or data element, or both
Loop Summary:
Id Segment Name Req Max Use Repeat Usage TED Technical Error Description O 1 NTE Note/Special Instruction O 100 RED Related Date O 100 Not Supported
Repeat: >1 Optional
Loop: TED Segments: 3
Loop TED
Outbound 824 Application Advice
Page 16 of 21
Max: 1 Optional
Loop: TED Elements: 2
Technical Error Description
TED
Purpose: To identify the error and, if feasible, the erroneous segment, or data element, or both
Element Summary: Ref Id Element Name Req Type Min/Max Usage TED01 647 Application Error Condition Code
Code indicating application error condition ZZZ Mutually Defined
TED02 3 Free Form Message Free-form text (See Comments)
M ID 1/3 EDI Req.
O ID 1/60
Comments: 1. If TED is present TED02 will contain a generic description of the data in error.
Sample Segment: TED*ZZZ*Received rejected BL instruction acknowledgement.~
Page 17 of 21
Outbound 824 Application Advice
NTE Note/Special Instruction Max: 100 Optional
Loop: TED Elements: 2
Purpose: To transmit information in a free-form format, if necessary, for comment or special instruction
Element Summary: Ref Id Element Name Req Type Min/Max Usage NTE01 363 Note Reference Code
Code identifying the functional area or purpose for which the note applies ZZZ Mutually Defined
NTE02 3 Description A free-form description to clarify the related data elements and their content (See Comments)
O ID 3/3
M AN 1/80 EDI Req.
Comments: 1. If NTE is present NTE02 will contain specific information related to the original message Shipment Identification Number,
and instructions regarding resolution steps.
Sample Segment: NTE*ZZZ*Received rejected BL instruction acknowledgement for Customer # 016212. ~ NTE*ZZZ*Please contact carrier to verify the BL instruction: Booking Number, Bill of Lad~ NTE*ZZZ*ing Number and / or other details then correct and resubmit the BL instruction t~ NTE*ZZZ*o WWA.~
Page 18 of 21
Outbound 824 Application Advice
SE Transaction Set Trailer Max: 1 Mandatory
Loop: NA Elements: 2
Purpose: To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)
Element Summary:
Ref SE01
Id 96
Element Name Number of Included Segments
Req M
Type N0
Min/Max 1/10
Usage EDI Req.
Total number of segments included in a transaction set including ST and SE segments (calculated number)
SE02 329 Transaction Set Control Number Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set (generated sequential number)
M AN 4/9 EDI Req.
Comments: 1. SE is the last segment of each transaction set.
Sample Segment: SE*14*0001~
Page 19 of 21
Outbound 824 Application Advice
Max: 1 Mandatory
Loop: NA Elements: 2
Functional Group Trailer
Sets Included on sets included in the hange (transmission) group ontaining this data element
GE
Purpose: To indicate the end of a functional group and to provide control information
Element Summary:
Ref GE01
Id 97
Element Name Number of Transaction
Req M
Type N0
Min/Max 1/6
Usage EDI Req.
Total number of transacti functional group or interc terminated by the trailer c
GE02 28 Group Control Number Assigned number originated and maintained by the sender
M N0 1/9 EDI Req.
Semantics: 1. The data interchange control number (GE02) in this trailer must be identical to the same data element in the
associated functional group header (GS06).
Comments: 1. The use of identical data interchange control numbers in the associated functional group header and trailer is designed to
maximize functional group integrity. The control number is the same as that used in the corresponding header. Sample Segment: GE*1*000000001~
Outbound 824 Application Advice
Page 20 of 21
Max: 1 Mandatory
Loop: NA Elements: 2
Interchange Control Trailer
IEA
Purpose: To define the end of an interchange of zero or more functional groups and interchange-related control segments
Element Summary:
Ref IEA01
Id I16
Element Name Number of Included Functional Groups
Req M
Type N0
Min/Max 1/5
Usage EDI Req.
A count of the number of functional groups included in an interchange
IEA02 I12 Interchange Control Number A control number assigned by the interchange sender
M N0 9/9 EDI Req.
Sample Segment: IEA*1*000000001~
Outbound 824 Application Advice
Page 21 of 21
Sample Outbound 824 Message (Positive): ISA*00* *00* *ZZ*WWALLIANCE
ZZ*SHPT *101119*0916*U*00400*000000001*1*P*>~
*GS*AG*WWALLIANCE*SHPT*20101119*0916*000000001*X*004010~ ST*824*0001~ BGN*06*016211*20101119*0916~ N1*40*SHPT~ REF*ZZ*LEVEL 3~ OTI*IA*7U*000034599~ OTI*TA*7U*93876~ REF*ZZ*SEVERITY 1*Received BL instruction acknowledgement for WWA reference 1234~ REF*SCA*ZIMU~ REF*BN*GTN824TEST06~ REF*CR*DIVISIONCODE~ REF*FN*016211~ REF*PO*16789-1~ REF*RF*016211~ SE*14*0001~ GE*1*000000001~ IEA*1*000000001~
Sample Outbound 824 Message (Negative): ISA*00* *00* *ZZ*WWALLIANCE ZZ**SHPT *101119*0922*U*00400*000000001*1*P*>~ GS*AG*WWALLIANCE*SHPT*20101119*0922*000000001*X*004010~ ST*824*0001~ BGN*44*016212*20101119*0922~ N1*40*SHPT~ REF*ZZ*LEVEL 3~ OTI*IR*7U*000034600~ OTI*TR*7U*93877~ REF*ZZ*SEVERITY 3~ TED*ZZZ*Received rejected BL instruction acknowledgement.~ NTE*ZZZ*Received rejected BL instruction acknowledgement for Customer # 016212. ~ NTE*ZZZ*Please contact carrier to verify the BL instruction: Booking Number, Bill of Lad~ NTE*ZZZ*ing Number and / or other details then correct and resubmit the BL instruction t~ NTE*ZZZ*o WWA.~ SE*13*0001~ GE*1*000000001~ IEA*1*000000001~