Charming Technology Services
EDI Specification
997 Functional Acknowledgement Version: ANSI X12 004030 02/21/2011 V 1.0
For all Trading Partners
CSI 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
CSI 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 Charming Shoppes 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
ST AK1
Name
Transaction Set Header Functional Group Response Header
Req.
Max.Use
M M
1 1
M
1
O O M M M
1 99 1 1 1
Loop Repeat
LOOP ID – AK2
999999 AK2
Transaction Set Response Header LOOP ID – AK3
999999 AK3 AK4 AK5 AK9 SE
Data Segment Note Data Element Note Transaction Set Response Trailer Functional Group Response Trailer Transaction Set Trailer
Charming Shoppes require acknowledgement at the transaction level with mandatory presence of AK2 and AK5 segments
______________________________________________________________________________________________________________________
3 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
Envelope Details Segment:
ISA Interchange Control Header
Level: Loop: Usage: Max use:
N/A ___ Mandatory 1
Purpose:
To start and identify an interchange of zero or more functional groups and interchange-related control segments.
Data Element Summary Ref ISA01
Id I01
Element Name Req Type Min/Max Authorization Information Qualifier M ID 2/2 Description: Code identifying the type of information in the Authorization Information Code Name 00 No Authorization Information Present (No Meaningful Information in I02)
Ref ISA02
Id I02
Element Name Req Type Min/Max 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 information is set by the Authorization Information Qualifier (I01). Set to 10 empty spaces
Ref ISA03
Id I03
Element Name Req Type Min/Max Security Information Qualifier M ID 2/2 Description: Code identifying the type of information in the Security Information Code Name 00 No Security Information Present (No Meaningful Information in I04)
Ref ISA04
Id I04
Element Name Req Type Min/Max 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
Ref ISA05
Id I05
Element Name Req Type Min/Max 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
Ref ISA06
Id I06
Element Name Req Type Min/Max 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.
Ref ISA07
Id I05
Element Name Interchange ID Qualifier (Receiver)
Req M
Type ID
Min/Max 2/2
Ref ISA08
Id I07
Element Name Interchange Receiver ID
Req M
Type AN
Min/Max 15/15
Ref ISA09
Id I08
Element Name Interchange Date (sender) Description: Date of the interchange
Req M
Type DT
Min/Max 6/6
______________________________________________________________________________________________________________________
4 of 20
CSI EDI 997 Functional Acknowledgement Version 4030 Req M
02/21/2011
Ref ISA10
Id I09
Element Name Interchange Time (sender) Description: Time of the interchange
Type TM
Min/Max 4/4
Ref ISA11
Id I65
Element Name Req Type Min/Max 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 ‘^’
Ref ISA12
Id I11
Element Name Req Type Min/Max 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 ISA13
Id I12
Element Name Req Type Interchange Control Number M N0 Description: A control number assigned by the interchange sender
Ref ISA14
Id I13
Element Name Req Type Min/Max Acknowledgment Requested M ID 1/1 Description: Code indicating sender's request for an interchange acknowledgment Code Name 0 No Acknowledgment Requested
Ref ISA15
Id I14
Element Name Req Type Min/Max Usage Indicator M ID 1/1 Description: Code indicating whether data enclosed by this interchange envelope is test, production or information Code Name P Production Data T Test Data
Ref ISA16
Id I15
Element Name Req Type Min/Max 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 within a composite data structure; this value must be different than the data element separator and the segment terminator ‘>’
Min/Max 9/9
______________________________________________________________________________________________________________________
5 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
Segment:
GS Functional Control Header
Level: Loop: Usage: Max use: Purpose:
N/A ___ Mandatory 1
02/21/2011
To indicate the beginning of a functional group and to provide control information.
Data Element Summary: Ref GS01
Id 479
Element Name Req Type Min/Max Functional Identifier Code M ID 2/2 Description: Code identifying a group of application related transaction sets Code Name FA Acknowledgement (997)
Ref GS02
Id 142
Element Name Req Type Min/Max Application Sender's Code M AN 2/15 Description: Code identifying party sending transmission; codes agreed to by trading partners
Ref GS03
Id 124
Element Name Req Type Min/Max Application Receiver's Code M AN 2/15 Description: Code identifying party receiving transmission; codes agreed to by trading partners
Ref GS04
Id 373
Element Name Req Type Min/Max Date M DT 8/8 Description: Date expressed as CCYYMMDD where CC represents the first two digits of the calendar year
Ref GS05
Id 337
Element Name Req Type Min/Max Time M TM 4/8 Description: 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)
Charming Shoppes Note: The format used is HHMMSSDD Ref GS06
Id 28
Element Name Req Type Min/Max Group Control Number M N0 1/9 Description: Assigned number originated and maintained by the sender
Ref GS07
Id 455
Element Name Req Type Min/Max Responsible Agency Code M ID 1/2 Description: Code identifying the issuer of the standard; this code is used in conjunction with Data Element 480 Code Name X Accredited Standards Committee X12
______________________________________________________________________________________________________________________
6 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
Ref GS08
Id 480
02/21/2011
Element Name Req Type Min/Max 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 allowed Code Name 004030 Draft Standards Approved for Publication by ASC X12 Procedures Review Board through October 1999
______________________________________________________________________________________________________________________
7 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
Segment:
ST Transaction Set Header
Level: Loop: Usage: Max use: Purpose:
Header ___ Mandatory 1
02/21/2011
To indicate the start of a transaction set and to assign a control number
Data Element Summary Ref ST01
Id 143
Element Name Req Type Transaction Set Identifier Code M ID Description: Code uniquely identifying a Transaction Set Code Name 850 Purchase Order
Min/Max 3/3
Ref ST02
Id 329
Element Name Req Type Min/Max 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: ST*997*0001
______________________________________________________________________________________________________________________
8 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
Acknowledgement Content Segment:
AK1 Functional Group Response Header
Level: Loop: Usage: Max use: Purpose: Syntax Notes:
Header ___ Mandatory 1 To start acknowledgment of a functional group 1. AK101 is the functional ID found in the GS segment (GS01) in the functional group being 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 AK101 479
Element Name Req Type Min/Max 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 AK102 28
Element Name Req Type Min/Max Group Control Number M N0 1/9 Description: Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set
Example: AK1*PO*1234 AK1*SH*9875
______________________________________________________________________________________________________________________
9 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
Segment:
AK2 Transaction Set Response Header
Level: Loop: Usage: Max use: Purpose: Syntax Notes:
Detail AK2 Mandatory 99999 To start acknowledgment of a single transaction set 1. AK201 is the transaction set ID found in the ST segment (ST01) in the 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 AK201 143
Element Name Transaction Set Identifier Code
Req M
Type ID
Min/Max 3/3
Description: Code uniquely identifying a Transaction Set Refer to 004030 Data Element Dictionary for acceptable code values. Ref Id AK202 329
Element Name Transaction Set Control Number
Req M
Type AN
Min/Max 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
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
Segment:
AK3 Data Segment Note
Level: Loop: Usage: Max use: Purpose:
Detail AK2 Optional 1 To report errors in a data segment and identify the location of the data segment
Data Element Summary Ref Id AK301 721
Element Name Segment ID Code
Req M
Type ID
Min/Max 2/3
Description: Code defining the segment ID of the data segment in error (See Appendix A - Number 77) Ref Id AK302 719
Element Name Segment Position in Transaction Set
Req M
Type N0
Min/Max 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 AK303 447
Element Name Loop Identifier Code
Req O
Type AN
Min/Max 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 AK304 720
Element Name Segment Syntax Error Code
Req O
Type ID
Min/Max 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
CSI EDI 997 Functional Acknowledgement Version 4030
Segment:
02/21/2011
AK4 Data Element Note
Level: Loop: Usage: Max use:
Detail AK2 Optional 99 To report errors in a data element or composite data structure and identify the location of Purpose: 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 AK401 722
Element Name Element Position in Segment
Req M
Type N0
Min/Max 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 AK402 725
Element Name Data Element Reference Number
Req O
Type N0
Min/Max 1/4
Description: Reference number used to locate the data element in the Data Element Dictionary Ref Id AK403 723
Element Name Data Element Syntax Error Code
Req M
Type ID
Min/Max 1/3
Description: Code indicating the error found after syntax edits of a data element.
Ref Id AK404 724
Code
Description
1 2 3 4 5 6 7
Mandatory data element missing Conditional required data element missing. Too many data elements. Data element too short. Data element too long. Invalid character in data element. Invalid code value.
Element Name Copy of Bad Data Element
Req O
Type AN
Min/Max 1/99
Description: This is a copy of the data element in error
Example: AK4|6||7
______________________________________________________________________________________________________________________
12 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
Segment:
AK5 Transaction Set Response Trailer
Level: Loop: Usage: Max use: Purpose:
Detail AK2 Mandatory 1 To acknowledge acceptance or rejection and report errors in a transaction set
Data Element Summary Ref Id AK501 717
Element Name Transaction Set Acknowledgement Code
Req M
Type ID
Min/Max 1/1
Description: Code indicating accept or reject condition based on the syntax editing of the transaction set.
Ref Id AK502 718
Code
Description
A E R
Accepted Accepted But Errors Were Noted Rejected
Element Name Transaction Set Syntax Error Code
Req O
Type ID
Min/Max 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 2 3
Transaction Set Not Supported Transaction Set Trailer Missing Transaction Set Control Number in Header and Trailer Do Not Match Number of Included Segments Does Not Match Actual Count One or More Segments in Error
4 5 Ref Id AK503 718
Element Name Transaction Set Syntax Error Code
Req O
Type ID
Min/Max 1/3
Description: Code indicating error found based on the syntax editing of a transaction set. Ref Id AK504 718
Element Name Transaction Set Syntax Error Code
Req O
Type ID
Min/Max 1/3
Description: Code indicating error found based on the syntax editing of a transaction set. Ref Id AK505 718
Element Name Transaction Set Syntax Error Code
Req O
Type ID
Min/Max 1/3
Description: Code indicating error found based on the syntax editing of a transaction set. Ref Id AK506 718
Element Name Transaction Set Syntax Error Code
Req O
Type ID
Min/Max 1/3
Description: Code indicating error found based on the syntax editing of a transaction set.
Example: AK5|A ______________________________________________________________________________________________________________________
13 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
Segment:
AK9 Functional Group Response Trailer
Level: Loop: Usage: Max use: Purpose:
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
Comments:
Data Element Summary Ref Id AK901 715
Element Name Functional Group Acknowledgement Code
Req M
Type ID
Min/Max 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 P Partially Accepted, At Least One R Transaction Set Was Rejected Ref Id AK902 97
Element Name Number of Transaction Set Included
Req M
Type N0
Min/Max 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 AK903 123
Element Name Number of Received Transaction Sets
Req M
Type N0
Min/Max 1/6
Description: Number of Transaction Sets received Ref Id AK904 2
Element Name Number of Accepted Transaction Sets
Req M
Type N0
Min/Max 1/6
Description: Number of accepted Transaction Sets in a Functional Group Ref Id AK905 716
Element Name Functional Group Syntax Error Code
Req O
Type ID
Min/Max 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 1 2 3 4 5 Ref Id AK906 716
Description Functional Group Not Supported Functional Group Version Not Supported Functional Group Trailer Missing Group Control Number in the Functional Group Header and Trailer Do Not Agree Number of Included Transaction Sets Does Not Match Actual Count
Element Name Functional Group Syntax Error Code
Req O
Type ID
Min/Max 1/3
Description: Code indicating error found based on the syntax editing of the
______________________________________________________________________________________________________________________
14 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
functional group header and/or trailer.
______________________________________________________________________________________________________________________
15 of 20
CSI EDI 997 Functional Acknowledgement Version 4030 Ref Id AK907 716
Element Name Functional Group Syntax Error Code
Req O
02/21/2011 Type ID
Min/Max 1/3
Description: Code indicating error found based on the syntax editing of the functional group header and/or trailer. Ref Id AK908 716
Element Name Functional Group Syntax Error Code
Req O
Type ID
Min/Max 1/3
Description: Code indicating error found based on the syntax editing of the functional group header and/or trailer. Ref Id AK909 716
Element Name Functional Group Syntax Error Code
Req O
Type ID
Min/Max 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
CSI EDI 997 Functional Acknowledgement Version 4030
02/21/2011
Enveloping summary detail Segment:
SE Transaction Set Trailer
Level: Loop: Usage: Max use: Purpose:
Trailer ___ Mandatory 1 To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments)
Data Element Summary: Ref SE01
Id 96
Element Name Req Type Min/Max Number of Included Segments M N0 1/10 Description: Total number of segments included in a transaction set including ST and SE segments
Ref SE02
Id 329
Element Name Req Type Min/Max 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: SE*149*000000001
______________________________________________________________________________________________________________________
17 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
Segment:
GE Functional Group Trailer
Level: Loop: Usage: Max use: Purpose:
Header ___ Mandatory 1
Semantics:
02/21/2011
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 GE01
Id 97
Element Name Req Type Min/Max 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 GE02
Id 28
Element Name Req Type Min/Max Group Control Number M N0 1/9 Description: Assigned number originated and maintained by the sender
Example: GE*1*90902339
______________________________________________________________________________________________________________________
18 of 20
CSI EDI 997 Functional Acknowledgement Version 4030
Segment:
IEA Interchange Control Trailer
Level: Loop: Usage: Max use: Purpose:
Header ___ Mandatory 1
02/21/2011
To define the end of an interchange of zero or more functional groups and interchange-related control segments
Data Element Summary: Ref IEA01
Id I16
Element Name Req Type Min/Max Number of Included Functional Groups M N0 1/5 Description: A count of the number of functional groups included in an interchange
Ref IEA02
Id I12
Element Name Req Type Interchange Control Number M N0 Description: A control number assigned by the interchange sender
Min/Max 9/9
Example: IEA*1*060339761
______________________________________________________________________________________________________________________
19 of 20
CSI 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
