EDI Specification. 997 Functional Acknowledgement. For all Trading Partners. Version: ANSI X /21/2011 V 1.0

Transcription

1 Ascena Retail Technology Services EDI Specification 997 Functional Acknowledgement Version: ANSI X /21/2011 V 1.0 For all Trading Partners

2 Table of Content Introduction: 997 Functional Acknowledgement...3 Envelope Details...4 ISA Interchange Control Header...4 GS Functional Control Header...6 ST Transaction Set Header...8 Acknowledgement Content...9 AK1 Functional Group Response Header...9 AK2 Transaction Set Response Header AK3 Data Segment Note AK4 Data Element Note AK5 Transaction Set Response Trailer AK9 Functional Group Response Trailer Enveloping summary detail SE Transaction Set Trailer GE Functional Group Trailer IEA Interchange Control Trailer Sample of data of 20

3 Introduction: 997 Functional Acknowledgement Functional Group = FA The purpose of this Implementation Guide is to describe the details of Ascena Retail use of the 997 Functional Acknowledgement Transaction Set. This Draft Standard for Trial Use contains the format and establishes the data contents of the Functional Acknowledgment Transaction Set (997) for use within the context of an Electronic Data Interchange (EDI) environment. The transaction set can be used to define the control structures for a set of acknowledgments to indicate the results of the syntactical analysis of the electronically encoded documents. The encoded documents are the transaction sets, which are grouped in functional groups, used in defining transactions for business data interchange. This standard does not cover the semantic meaning of the information encoded in the transaction sets. Heading: Seg ID Name Req. Max.Use Loop Repeat ST Transaction Set Header M 1 AK1 Functional Group Response Header M 1 LOOP ID AK2 AK2 Transaction Set Response Header M 1 LOOP ID AK3 AK3 Data Segment Note O 1 AK4 Data Element Note O 99 AK5 Transaction Set Response Trailer M 1 AK9 Functional Group Response Trailer M 1 SE Transaction Set Trailer M Ascena Retail require acknowledgement at the transaction level with mandatory presence of AK2 and AK5 segments 3 of 20

4 Envelope Details Segment: Level: Loop: Usage: Max use: Purpose: ISA Interchange Control Header N/A Mandatory 1 To start and identify an interchange of zero or more functional groups and interchange-related control segments. Data Element Summary ISA01 I01 Authorization Information Qualifier M ID 2/2 Description: Code identifying the type of information in the Authorization Information Code Name 0 No Authorization Information Present (No Meaningful Information in I02) ISA02 I02 Authorization Information M AN 10/10 Description: Information used for additional identification or authorization of the interchange sender or the data in the Interchange; the type of inform ation is set by the Authoriz at ion Inform atio n Qualifier (I01). Set to 10 empty spaces ISA03 I03 Security Information Qualifier M ID 2/2 Description: Code identifying the type of information in the Security Information Code Name 0 No Security Information Present (No Meaningful Information in I04) ISA04 I04 Security Information M AN 10/10 Description: 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 (Sender) M ID 2/2 Description: Code indicating the system/method of code structure used to designate the sender ID element being qualified ISA06 I06 Interchange Sender ID M AN 15/15 Description: Identification code published by the sender for other parties to use as the Sender ID to route data to them. ISA07 I05 Interchange ID Qualifier (Receiver) M ID 2/2 ISA08 I07 Interchange Receiver ID M AN 15/15 ISA09 I08 Interchange Date (sender) M DT 6/6 Description: Date of the interchange 4 of 20

5 ASCENA EDI 997 Functional Acknowledgement Version /21/ ISA10 I09 Interchange Time (sender) M TM 4/4 Description: Time of the interchange ISA11 I65 Repetition Separator M 1/1 Description: Type is not applicable; the repetition separator is a delimiter and not a data element; this field provides the delimiter used to separate repeated occurrences of a simple data element or a composite data structure; this value must be different than the data element separator, component element separator, and the segment terminator ^ ISA12 I11 Interchange Control Version Number M ID 5/5 Description: Code specifying the version number of the interchange control segments Code Name Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1999 ISA13 I12 Interchange Control Number M N0 9/9 Description: A control number assigned by the interchange sender ISA14 I13 Acknow ledgment Requested M ID 1/1 Description: Code indicating sender's request for an interchange acknow ledgment Code Name 0 No Acknow ledgment Requested ISA15 I14 Usage Indicator M ID 1/1 Description: Code indicating w hether data enclosed by this interchange envelope is test, production or information Code Name P Production Data T Test Data ISA16 I15 Component Element Separator M 1/1 Description: 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 w ithin a composite data structure; this value must be different than the data element separator and the segment terminator > 5 of 20

6 Segment: GS Functional Control Header Level: N/A Loop: Usage: Mandatory Max use: 1 Purpose: To indicat e the beginning of a functional group and to provide control inform ation. Data Element Summary: GS Functional Identifier Code M ID 2/2 Description: Code identifying a group of application related transaction sets Code Name FA Acknow ledgement (997) GS Application Sender's Code M AN 2/15 Description: Code identifying party sending transmission; codes agreed to by trading partners GS Application Receiver's Code M AN 2/15 Description: Code identifying party receiving transmission; codes agreed to by trading partners GS Date M DT 8/8 Description: Date expressed as CCYYMMDD w here CC represents the first tw o digits of the calendar year GS Time M TM 4/8 Description: Time expressed in 24-hour clock time as follow s: HHMM, or HHMMSS, or HHMMSSD, or HHMMSSDD, w here H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD =decimal seconds; decimal seconds are expressed as follow s: D =tenths (0-9) and DD = hundredths (00-99) Ascena Retail Note: The format used is HHMMSSDD GS06 28 Group Control Number M N0 1/9 Description: Assigned number originated and maintained by the sender GS Responsible Agency Code M ID 1/2 Description: Code identifying the issuer of the standard; this code is used in conjunction w ith Data Element 480 Code Name X Accredited Standards Committee X12 6 of 20

7 ASCENA EDI 997 Functional Acknowledgement Version /21/2011 Ref Id Elemen t Name Req Type Min/Max GS Version / Release / Industry Identifier Code M AN 1/12 Description: Code indicating the version, release, subrelease, 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 subrelease, 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 allow ed Code Name Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October of 20

8 Segmen t: ST Transaction Set Header Level: Header Loop: Usage: Mandatory Max use: 1 Purpose: To indicat e the start of a transactio n set and to assign a control number Data Element Summary ST Transaction Set Identifier Code M ID 3/3 Description: Code uniquely identifying a Transaction Set Code Name 850 Purchase Order ST Transaction Set Control Number M AN 4/9 Description: Identifying control number that must be unique w ithin the transaction set functional group assigned by the originator for a transaction set Example: ST*997* of 20

9 Acknowledgement Content Segmen t: AK1 Functional Group Response Header Level: Header Loop: Usage: Mandatory Max use: 1 Purpose: To start acknowledgment of a functional group Syntax 1. AK101 is the functional ID found in the GS segment (GS01) in the functional group being Notes: acknowledged. 2. AK102 is the functional group control number found in the GS segment in the functional group being acknowledged. Data Element Summary AK Functional Identifier Code M ID 2/2 Description: Code identifying a group of applications related transaction sets. Refer to Data Element Dictionary for acceptable code values. AK Group Control Number M N0 1/9 Description: Identifying control number that must be unique w ithin the transaction set functional group assigned by the originator for a transaction set Example: AK1*PO*1234 AK1*SH* of 20

10 Segmen t: AK2 Transaction Set Response Header Level: Detail Loop: AK2 Usage: Mandatory Max use: Purpose: To start acknowledgment of a single transaction set Syntax 1. AK201 is the transaction set ID found in the ST segment (ST01) in the Notes: transaction set being acknowledged. 2. AK202 is the transaction set control number found in the ST segment in the transaction set being acknowledged. Data Element Summary AK Transaction Set Identifier Code M ID 3/3 Description: Code uniquely identifying a Transaction Set Refer to Data Element Dictionary for acceptable code values. AK Transaction Set Control Number M AN 4/9 Description: Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set Example: AK2*850* AK2*856* of 20

11 Segmen t: AK3 Data Segment Note Level: Detail Loop: AK2 Usage: Optional Max use: 1 Purpose: To report errors in a data segment and identify the location of the data segment Data Element Summary AK Segment ID Code M ID 2/3 Description: Code defining the segment ID of the data segment in error (See Appendix A - Number 77) AK Segment Position in Transaction Set M N0 1/6 Description: The numerical count position of this data segment from the start of the transaction set: the transaction set header is count position 1 AK Loop Identifier Code O AN 1/6 Description: The loop ID number given on the transaction set diagram is the value for this data element in segments LS and LE AK Segment Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a segment. Code Description 1 Unrecognized segment ID 2 Unexpected segment 3 Mandatory segment missing 4 Loop occurs over maximum times 5 Segment exceeds maximum use 6 Segment not in defined transaction set 7 Segment not in proper sequence 8 Segment has data element errors Example: AK3*SLN of 20

12 Segment: AK4 Data Element Note Level: Detail Loop: AK2 Usage: Optional Max use: 99 Purpose: To report errors in a data element or composite data structure and identify the location of the data element Semantic 1. In no case shall a value be used for AK404 that would generate a syntax error, Notes: e.g., an invalid character Data Element Summary AK Element Position in Segment M N0 1/2 Description: Code indicating the relative position of a simple data element, or the relative position of a composite data structure combined with the relative position of the component data element within the composite data structure, in error; the count starts with 1 for the simple data element or composite data structure immediately following the segment ID AK Data Element Reference Number O N0 1/4 Description: Reference number used to locate the data element in the Data Element Dictionary AK Data Element Syntax Error Code M ID 1/3 Description: Code indicating the error found after syntax edits of a data element. Code Description 1 Mandatory data element missing 2 Conditional required data element missing. 3 Too many data elements. 4 Data element too short. 5 Data element too long. 6 Invalid character in data element. 7 Invalid code value. AK Copy of Bad Data Element O AN 1/99 Description: This is a copy of the data element in error Example: AK of 20

13 Segmen t: AK5 Transaction Set Response Trailer Level: Detail Loop: AK2 Usage: Mandatory Max use: 1 Purpose: To acknowledge acceptanc e or rejection and report errors in a transaction set Data Element Summary AK Transaction Set Acknow ledgement Code M ID 1/1 Description: Code indicating accept or reject condition based on the syntax editing of the transaction set. Code Description A Accepted E Accepted But Errors Were Noted RRejected AK Transaction Set Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a transaction set. Notes: This data element is repeated in positions AK503, AK504, AK505, and AK506. Code Description 1 Transaction Set Not Supported 2 Transaction Set Trailer Missing 3 Transaction Set Control Number in Header and Trailer Do Not Match 4 Number of Included Segments Does Not Match Actual Count 5 One or More Segments in Error AK Transaction Set Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a transaction set. AK Transaction Set Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a transaction set. AK Transaction Set Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a transaction set. AK Transaction Set Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a transaction set. Example: AK5 A 13 of 20

14 Segment: AK9 Functional Group Response Trailer Level: Loop: Usage: Max use: Purpose: Comments : Trailer Mandatory 1 To acknowledge acceptance or rejection of a functional group and report the number of included transaction sets from the original trailer, the accepted sets, and the received sets in this functional group 1. If AK901 contains the value "A" or "E", then the transmitted functional group is accepted Data Element Summary AK Functional Group Acknow ledgement Code M ID 1/1 Description: Code indicating accept or reject condition based on the syntax editing of the functional group. Code Description A Accepted E PPartially Accepted, At Least One RTransaction Set Was Rejected Accepted But Errors Were Noted AK Number of Transaction Set Included M N0 1/6 Description: Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element AK Number of Received Transaction Sets M N0 1/6 Description: Number of Transaction Sets received AK904 2 Number of Accepted Transaction Sets M N0 1/6 Description: Number of accepted Transaction Sets in a Functional Group AK Functional Group Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of the functional group header and/or trailer. Note: This data element is repeated in positions AK906, AK907, AK908, and AK909. Code Description 1 Functional Group Not Supported 2 Functional Group Version Not Supported 3 Functional Group Trailer Missing 4 Group Control Number in the Functional Group Header and Trailer Do Not Agree 5 Number of Included Transaction Sets Does Not Match Actual Count AK Functional Group Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of the 14 of 20

15 functional group header and/or trailer. 15 of 20

16 ASCENA EDI 997 Functional Acknowledgement Version /21/2011 AK Functional Group Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of the functional group header and/or trailer. AK Functional Group Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of the functional group header and/or trailer. AK Functional Group Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of the functional group header and/or trailer. Example: AK9 A of 20

17 Enveloping summary detail Segment: SE Transaction Set Trailer Level: Trailer Loop: Usage: Mandatory Max use: 1 Purpose: To indicat e the end of the transact ion set and provide the count of the transm itt ed segm ents (includin g the beginning (ST) and ending (SE) segments) Data Element Summary: SE01 96 Number of Included Segments M N0 1/10 Description: Total number of segments included in a transaction set including ST and SE segments SE Transaction Set Control Number M AN 4/9 Description: Identifying control number that must be unique w ithin the transaction set functional group assigned by the originator for a transaction set Example: SE*149* of 20

18 Segment: GE Functional Group Trailer Level: Loop: Usage: Max use: Purpose: Semantics: Header Mandatory 1 To indicate the end of a functional group and to provide control information The data interchange control number GE02 in this trailer must be identical to the same data element in the associated functional group header, GS06 Data Element Summary: GE01 97 Number of Transaction Sets Included M N0 1/6 Description: Total number of transaction sets included in the functional group or interchange (transmission) group terminated by the trailer containing this data element GE02 28 Group Control Number M N0 1/9 Description: Assigned number originated and maintained by the sender Example: GE*1* of 20

19 Segment: IEA Interchange Control Trailer Level: Header Loop: Usage: Mandatory Max use: 1 Purpose: To define the end of an interchange of zero or more functional groups and interchange-related control segments Data Element Summary: IEA01 I16 Number of Included Functional Groups M N0 1/5 Descrip tion : A count of the number of functional groups included in an interchange IEA02 I12 Interchange Control Number M N0 9/9 Description: A control number assigned by the interchange sender Example: IEA*1* of 20

20 Sample of data Sample 1: ST*997*0001 AK1*PO* AK2*850* AK5*A AK9*A*1*1*1 SE*6*0001 Sample 2: ST AK1 SH 14 AK AK5 A AK AK5 A AK AK5 A AK AK5 A AK AK5 A AK AK3 SLN 11 3 AK AK5 R AK AK5 A AK AK5 A AK9 A SE of 20