Ascena Retail Technology Services
EDI Specification
997 Functional Acknowledgement
Version: ANSI X12 004030
02/21/2011 V 1.0
For all Trading Partners
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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 ................................................................................. 10 AK3 Data Segment Note ....................................................................................................... 11
AK4 Data Element Note ....................................................................................................... 12 AK5 Transaction Set Response Trailer................................................................................... 13
AK9 Functional Group Response Trailer................................................................................ 14 Enveloping summary detail .................................................................................................... 17
SE Transaction Set Trailer ..................................................................................................... 17
GE Functional Group Trailer ................................................................................................. 18 IEA Interchange Control Trailer ............................................................................................ 19
Sample of data ........................................................................................................................ 20 _____________________________________________________________________________________________________________________
2 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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
999999 AK2 Transaction Set Response Header M 1 LOOP ID – AK3
999999 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 1
Ascena Retail require acknowledgement at the transaction level with mandatory presence of AK2 and AK5 segments
_____________________________________________________________________________________________________________________
3 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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 Ref Id Element Name Req Type Min/M ax
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)
Ref Id Element Name Req Type Min/Max
ISA02 I02 Authorization Information M AN 10/10
Description: Information used for additional identif ication 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 Qualifie r
(I01). Set to 10 empty spaces
Ref Id Element Name Req Type Min/Max
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)
Ref Id Element Name Req Type Min/Max
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 Qualif ier (I03). Set
to 10 empty spaces
Ref Id Element Name Req Type Min/Max
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 qualif ied
Ref Id Element Name Req Type Min/Max
ISA06 I06 Interchange Sender ID M AN 15/15
Description: Identif ication code published by the sender for other parties to use as the Sender ID to
route data to them.
Ref Id Element Name Req Type Min/Max
ISA07 I05 Interchange ID Qualifier (Receiver) M ID 2/2
Ref Id Element Name Req Type Min/Max
ISA08 I07 Interchange Receiver ID M AN 15/15
Ref Id Element Name Req Type Min/Max
ISA09 I08 Interchange Date (sender) M DT 6/6
Description: Date of the interchange
_____________________________________________________________________________________________________________________
4 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Ref Id Element Name Req Type Min/Max
ISA10 I09 Interchange Time (sender) M TM 4/4
Description: Time of the interchange
Ref Id Element Name Req Type Min/Max
ISA11 I65 Repetition Separator M 1/1
Description: Type is not applicable; the repetition separator is a delimiter and not a data element;
this f ield 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 ‘^’
Ref Id Element Name Req Type Min/Max
ISA12 I11 Interchange Control Version Number M ID 5/5
Description: Code specifying the version number of the interchange control segments
Code Name
00403 Draft Standards for Trial Use Approved for Publication by ASC X12 Procedures Review Board through October 1999
Ref Id Element Name Req Type Min/Max
ISA13 I12 Interchange Control Number M N0 9/9
Description: A control number assigned by the interchange sender
Ref Id Element Name Req Type Min/Max
ISA14 I13 Acknowledgment Requested M ID 1/1
Description: Code indicating sender's request for an interchange acknow ledgment
Code Name
0 No Acknow ledgment Requested
Ref Id Element Name Req Type Min/Max
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
Ref Id Element Name Req Type Min/Max
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 f ield 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
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Segment:
GS Functional Control Header
Level: N/A Loop: ___
Usage: Mandatory
Max use: 1
Purpose: To indicat e the beginn ing of a functiona l group and to provide control inform ation.
Data Element Summary: Ref Id Element Name Req Type Min/Max
GS01 479 Functional Identifier Code M ID 2/2
Description: Code identifying a group of application related transaction sets
Code Name
FA Acknow ledgement (997)
Ref Id Element Name Req Type Min/Max
GS02 142 Application Sender's Code M AN 2/15
Description: Code identifying party sending transmission; codes agreed to by trading partners
Ref Id Element Name Req Type Min/Max
GS03 124 Application Receiver's Code M AN 2/15
Description: Code identifying party receiving transmission; codes agreed to by trading partners
Ref Id Element Name Req Type Min/Max
GS04 373 Date M DT 8/8
Description: Date expressed as CCYYMMDD w here CC represents the f irst tw o digits of the
calendar year
Ref Id Element Name Req Type Min/Max
GS05 337 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
Ref Id Element Name Req Type Min/Max
GS06 28 Group Control Number M N0 1/9
Description: Assigned number originated and maintained by the sender
Ref Id Element Name Req Type Min/Max
GS07 455 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
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Ref Id Elemen t Name Req Type Min/Max
GS08 480 Version / Release / Industry Identifier Code M AN 1/12 Description: Code indicating the version, release, subrelease, and industry identif ier 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 identif iers (optionally assigned
by user); if code in DE455 in GS segment is T, then other formats are allow ed Code Name 004030 Draft Standards Approved for Publication by ASC X12 Procedures Review Board through
October 1999
_____________________________________________________________________________________________________________________
7 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Segment: 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 contro l number
Data Element Summary Ref Id Element Name Req Type Min/M ax
ST01 143 Transaction Set Identifier Code M ID 3/3 Description: Code uniquely identifying a Transaction Set
Code Name
850 Purchase Order
Ref Id Element Name Req Type Min/M ax
ST02 329 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*0001
_____________________________________________________________________________________________________________________
8 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Acknowledgement Content
Segment: 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 Ref Id Element Name Req Type Min/Max
AK101 479 Functional Identifier Code M ID 2/2
Description: Code identifying a group of applications related transaction sets. Refer to 004030 Data
Element Dictionary for acceptable code values.
Ref Id Element Name Req Type Min/Max
AK102 28 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*9875
_____________________________________________________________________________________________________________________
9 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Segment: AK2 Transaction Set Response Header Level: Detail
Loop: AK2
Usage: Mandatory
Max use: 99999
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 Ref Id Element Name Req Type Min/M ax
AK201 143 Transaction Set Identif ier Code M ID 3/3 Description: Code uniquely identifying a Transaction Set Refer to 004030 Data Element Dictionary for acceptable code values.
Ref Id Element Name Req Type Min/M ax
AK202 329 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*1234000 AK2*856*0001
_____________________________________________________________________________________________________________________
10 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Segment: 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 Ref Id Element Name Req Type Min/M ax
AK301 721 Segment ID Code M ID 2/3 Description: Code defining the segment ID of the data segment in error (See Appendix A - Number 77)
Ref Id Element Name Req Type Min/Max
AK302 719 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
Ref Id Element Name Req Type Min/Max
AK303 447 Loop Identif ier 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
Ref Id Element Name Req Type Min/Max
AK304 720 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|11113
_____________________________________________________________________________________________________________________
11 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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 Ref Id Element Name Req Type Min/M ax
AK401 722 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
Ref Id Element Name Req Type Min/M ax
AK402 725 Data Element Reference Number O N0 1/4 Description: Reference number used to locate the data element in the Data Element
Dictionary Ref Id Element Name Req Type Min/M ax
AK403 723 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.
Ref Id Element Name Req Type Min/M ax
AK404 724 Copy of Bad Data Element O AN 1/99 Description: This is a copy of the data element in error
Example: AK4|6||7
_____________________________________________________________________________________________________________________
12 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Segment: 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 Ref Id Element Name Req Type Min/M ax
AK501 717 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
Ref Id Element Name Req Type Min/M ax
AK502 718 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 Ref Id Element Name Req Type Min/M ax
AK503 718 Transaction Set Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a transaction set.
Ref Id Element Name Req Type Min/M ax
AK504 718 Transaction Set Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of a transaction set.
Ref Id Element Name Req Type Min/Max
AK505 718 Transaction Set Syntax Error Code O ID 1/3
Description: Code indicating error found based on the syntax editing of a transaction set.
Ref Id Element Name Req Type Min/Max
AK506 718 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
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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 Ref Id Element Name Req Type Min/M ax
AK901 715 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 Accepted But Errors Were Noted PPartially Accepted, At Least One
RTransaction Set Was Rejected
Ref Id Element Name Req Type Min/M ax
AK902 97 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
Ref Id Element Name Req Type Min/Max
AK903 123 Number of Received Transaction Sets M N0 1/6
Description: Number of Transaction Sets received
Ref Id Element Name Req Type Min/Max
AK904 2 Number of Accepted Transaction Sets M N0 1/6
Description: Number of accepted Transaction Sets in a Functional Group
Ref Id Element Name Req Type Min/Max
AK905 716 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
Ref Id Element Name Req Type Min/M ax
AK906 716 Functional Group Syntax Error Code O ID 1/3 Description: Code indicating error found based on the syntax editing of the
_____________________________________________________________________________________________________________________
14 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
functional group header and/or trailer.
_____________________________________________________________________________________________________________________
15 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Ref Id Element Name Req Type Min/Max
AK907 716 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.
Ref Id Element Name Req Type Min/Max
AK908 716 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.
Ref Id Element Name Req Type Min/Max
AK909 716 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|1|1|1
_____________________________________________________________________________________________________________________
16 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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 (includ in g
the beginning (ST) and ending (SE) segments)
Data Element Summary: Ref Id Element Name Req Type Min/Max
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
Ref Id Element Name Req Type Min/Max
SE02 329 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*000000001
_____________________________________________________________________________________________________________________
17 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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: Ref Id Element Name Req Type Min/Max
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
Ref Id Element Name Req Type Min/Max
GE02 28 Group Control Number M N0 1/9 Description: Assigned number originated and maintained by the sender
Example: GE*1*90902339
_____________________________________________________________________________________________________________________
18 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
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: Ref Id Element Name Req Type Min/Max
IEA01 I16 Number of Included Functional Groups M N0 1/5
Descrip t ion : A count of the number of functiona l groups included in an interchange
Ref Id Element Name Req Type Min/Max
IEA02 I12 Interchange Control Number M N0 9/9
Description: A control number assigned by the interchange sender
Example: IEA*1*060339761
_____________________________________________________________________________________________________________________
19 of 20
ASCENA EDI 997 Functional Acknowledgement Version 4030 02/21/2011
Sample of data
Sample 1: ST*997*0001 AK1*PO*201102091 AK2*850*000000001 AK5*A AK9*A*1*1*1
SE*6*0001
Sample 2: ST|997|000011 AK1|SH|14
AK2|856|0144 AK5|A AK2|856|0145 AK5|A
AK2|856|0146 AK5|A AK2|856|0147 AK5|A
AK2|856|0148 AK5|A AK2|856|0149 AK3|SLN|11||3
AK4|00||5 AK5|R AK2|856|0150 AK5|A AK2|856|0151
AK5|A AK9|A|8|8|7 SE|22|000011
_____________________________________________________________________________________________________________________
20 of 20