Implementation Guidelines for EDI Conventions Transaction set 997 Functional Acknowledgement

Ver. 3060

REQUIREMENTS

======================================================================================= HTNA-EDI (1.0) 1/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997

Introduction This draft standard for trial use contains the format and establishes the data contents of the Acknowledgement transaction set (997) for use within the context of an Electronic Data Interchange (EDI) also know as Electronic Commerce(EC) 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.

======================================================================================= HTNA-EDI (1.0) 2/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997

DEFINITION Abbreviations in the usage column headed “REQ. /ATTRIBUTES. (Requirements/Attributes)” have the following definitions and will appear, as indicated, in all IGEC (Implementation Guidelines for EDI Conventions). The ANSI usage requirements have been provided in the table for reference purposes only.

Condition Designator Segments: M Mandatory. O Optional. Data Elements: C Conditional.

M

Mandatory.

O X

Optional. Relational.

This data segment must be included in the Transaction set. The presence of this data segment is at the option of the sending party.

The data element conditions are of three types: mandatory, optional, and relational, and define the circumstances under which a simple data element, composite data structure or component data element may be required to be present or absent in a particular segment or composite data structure. The element must be used. (Note: If a segment is defined as optional, and if the segment is used, one or more data elements may be listed as mandatory.) The presence of this data element is at the option of the sending party. The presence of this item is related to the presence or absence of other item(s). See Conditional.

Data Element Type The follow types of data elements appear in this guide. Each data element is assigned a minimum and maximum length. The length of the data element value is the number of character positions used except as noted for numeric, and decimal elements. Numeric Decimal Number Identifier String Date Time

Nn (n indicates implied decimal positions) R ID AN (alpha-numeric) DT (YYMMDD) TM (HHMM 24hour clock)

Numeric (Nn) and decimal (R) fields are assumed to be positive unless a leading minus sign indicating a negative value is transmitted. A plus sign is never transmitted. The minus sign (-) and the decimal point are not counted as part of the data element’s length.

HTNA Required Abbreviations in the usage column headed “Usage (HTNA Usage)” have the following definitions and will appear, as indicated, in all IGEC (Implementation Guidelines for EDI Conventions). Must use Used Not used

HTNA require a data segment/element. HTNA require a data segment/element uses at the option. HTNA require a data segment/element des not use.

Required Delimiter Element “*”

Sub Element “:”

Segment Terminator “~”

======================================================================================= HTNA-EDI (1.0) 3/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997

997 SEGMENT USAGE OVERVIEW Functional Group=FA Heading: POS

ID

010 ST 020 AK1 LOOP ID – AK2 030 AK2 LOOP ID – AK2/AK3 040 AK3 050 AK4 060 AK5 070 AK9 080 SE

SEGMENT NAME

REQ

Transaction Set Header Functional Group Response Header

M M

MAX USAGE 1 1

Transaction Set Response Header

O

1

LOOP

USAGE Must use Must use

999999 Must use 999999 Data Segment Note Data Element Note Transaction Set Response Trailer Functional Group Response Trailer Transaction Set Trailer

O O M M M

1 99 1 1 1

Used Used Must use Must use Must use

======================================================================================= HTNA-EDI (1.0) 4/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGMENT:

ST - TRANSACTION SET HEADER

LEVEL/POSITION:

Heading / 010

MAX USAGE/LOOPS:

1 / None

PURPOSE:

To indicate the beginning of a transaction set and to assign a control number

GENERAL INFORMATION:

EXAMPLES:

ELEM ID

ELEM#

The transaction set control number (ST02) in this header must match the transaction set control number (SE02) in the transaction set trailer (SE) segment. ST*997*0080~

ELEMENT NAME

ATTRIBUTES

USAGE

COMMENTS Use “997” for Acknowledgeme nt A unique control number (same as SE02)

ST01

143

Transaction Set ID Code

M ID 03/03

Must use

ST02

329

Transaction Set Control

M AN 04/09

Must use

======================================================================================= HTNA-EDI (1.0) 5/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGMENT:

AK1 – FUNCTIONAL GROUP RESPONSE HEADER

LEVEL/POSITION

Heading / 020

MAX USAGE/LOOPS:

1 / None

PURPOSE:

To indicate the beginning of a acknowledgement of a functional group

GENERAL INFORMATION:

EXAMPLES:

ELEM ID

ELEM#

Provides the identification of the transaction set which the Functional Acknowlegement is responding to. Also contains a unique control number for reference to the particular Funtional Acknowlegement transaction set. AK1*SH*000005353~

ELEMENT NAME

ATTRIBUTES

USAGE

COMMENTS

Must use Must use

** See list below

AK101

479

Functional Identifier Code

M ID 02/02

AK102

28

Group Control Number

M N0 01/09

A unique control number (same as GS06)

Available Codes for AK101: Will Only Send Following Functional ID Codes : “SH” = 856 Ship Notice

======================================================================================= HTNA-EDI (1.0) 6/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGMENT:

AK2 – TRANSACTION SET RESPONSE HEADER

LEVEL/POSITION:

Heading / 030

MAX USAGE/LOOPS:

1 / AK2/999999

PURPOSE:

To indicate the beginning of a acknowledgement of single transaction set

GENERAL INFORMATION:

EXAMPLES:

ELEM ID

ELEM#

Provides identification of the specific transaction set being responded to and echoes the control number of that transaction set. AK2*856*1170001~

ELEMENT NAME

ATTRIBUTES

USAGE

COMMENTS

Must use Must use

** See list below

AK201

143

Transaction Set Identifier Code

M ID 03/03

AK202

329

Transaction Set Control Number

M AN 04/09

A unique control number within the transaction set functional group assigned by sender

Available Codes for AK201: Will Only Send Following Transaction Set ID Code : “856” Ship Notice

======================================================================================= HTNA-EDI (1.0) 7/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGMENT:

AK3 – DATA SEGMENT NOTE

LEVEL/POSITION:

Heading / 040

MAX USAGE/LOOPS:

1 / AK2/AK3/999999

PURPOSE:

To report errors in a data segment and identify the location of the data segment within transaction set

GENERAL INFORMATION:

EXAMPLES:

Provides the location and error code of a data segment in the transaction set being responded to which did not pass syntactical checks during the translation process. AK3*PO4*14**2~ AK3*TD1*8**8~

** This segment is optional.

ELEM ID

ELEM#

ELEMENT NAME

ATTRIBUTES

USAGE

COMMENTS

Must use Must use Used Used

** See list below

AK301

721

Segment ID Code

M ID 02/03

AK302

719

Segment Position in Transaction Set

M N0 01/06

AK303 AK304

447 720

Loop Identifier Code Segment Syntax Error Code

O AN 01/04 O ID 01/03

Available Codes for AK304:

“1” = Unrecognized segment ID “2” = Unexpected segment “3” = Mandatory segment missing “4” = Loop occurs over maximum times “5” = Segment within loop exceeds maximum use “6” = Segment Not in Defined Transaction Set “7” = Segment Not in Proper Sequence “8” = Segment Has Data Element Errors

======================================================================================= HTNA-EDI (1.0) 8/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGEMENT:

AK4 – DATA ELEMENT NOTE

LEVEL/POSITION:

Heading / 050

MAX USAGE/LOOPS:

99 / AK2/AK3

PURPOSE:

To report errors in the data element and to identify the location of the data element

GENERAL INFORMATION:

EXAMPLE:

Provides location and identification of the data element withing the data segment referred to by AK3. AK4*1**2*00001~

** This segment is optional.

ELEM ID

ELEM#

ELEMENT NAME

ATTRIBUTES

USAGE Must use Used

AK401

722

Element Position in Segment

M N0 01/02

AK402

725

Data Element Reference Number

O N0 01/04

AK403

723

Data Element Syntax Error Code

M ID 01/03

AK404

724

Copy of Bad Data Element

O AN 01/99

Available Codes for AK403:

Must use Used

COMMENTS

** See list below

“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 “8” = Invalid date “9” = Invalid time

======================================================================================= HTNA-EDI (1.0) 9/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGMENT:

AK5 – TRANSACTION SET RESPONSE TRAILER

LEVEL/POSITION:

Heading / 060

MAX USAGE/LOOP:

1 / AK2

PURPOSE:

To acknowledge acceptance or rejection and to report errors in a transaction set

GENERAL INFORMATION:

EXAMPLE:

ELEM ID

ELEM#

Provides information that HTNA either accepted or rejected the incoming transaction set. AK5*A~ AK5*E~ AK5*R*5~

(Accepted) (Accepted w/ Error) (Rejected)

ELEMENT NAME

ATTRIBUTES

USAGE

COMMENTS “A” = Accepted “E” = Accepted w/Errors “R” = Rejected ** See list below

AK501

717

Transaction Set Acknowledgment Code

M ID 01/01

Must use

AK502

718

Transaction Set Syntax Error Code

O ID 01/03

Used

AK503

718

Transaction Set Syntax Error Code

O ID 01/03

AK504

718

Transaction Set Syntax Error Code

O ID 01/03

AK505

718

Transaction Set Syntax Error Code

O ID 01/03

AK506

718

Transaction Set Syntax Error Code

O ID 01/03

Not used Not used Not used Not used

Available Codes for AK502:

“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 “6” = Missing or invalid transaction set identifier “7” = Missing or invalid transaction set control number

======================================================================================= HTNA-EDI (1.0) 10/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGMENT:

AK9 – FUNCTIONAL GROUP RESPONSE TRAILER

LEVEL/POSITION:

Heading / 070

MAX USAGE/LOOP:

1 / None

PURPOSE:

To acknowledge acceptance or rejection of a functional group and report the number of included transaction sets from the original trailer, accepted sets, and received sets in this functional group

GENERAL INFORMATION:

EXAMPLE:

ELEM ID

ELEM#

Provides information that HTNA either has accepted or rejected the incoming functional group. AK9*A*5*5*5~ AK9*E*1*1*0~ AK9*R*1*1*0~

(Accepted) (Accepted w/ Error) (Rejected)

ELEMENT NAME

ATTRIBUTES

USAGE

COMMENTS “A” = Accepted “E” = Accepted w/Errors “R” = Rejected

AK901

715

Functional Group Acknowledge Code

M ID 01/01

Must use

AK902

97

M N0 01/06

AK903

123

AK904

2

AK905

716

Number of Transaction Sets Included Number of Received Transaction Sets Number of Accepted Transaction Sets Functional Group Syntax Error Code

AK906

716

Functional Group Syntax Error Code

O ID 01/03

AK907

716

Functional Group Syntax Error Code

O ID 01/03

AK908

716

Functional Group Syntax Error Code

O ID 01/03

AK909

716

Functional Group Syntax Error Code

O ID 01/03

Must use Must use Must use Not used Not used Not used Not used Not used

Available Codes for AK502:

M N0 01/06 M N0 01/06 O ID 01/03

“1” = Functional group not supported “2” = Functional group version not supported “3” = Functional group trailer missing “4” = Data interchange control number in the functional group header and trailer do no agree “5” = Number of included transaction sets does not match actual count

======================================================================================= HTNA-EDI (1.0) 11/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997 SEGMENT:

SE - TRANSACTION SET TRAILER

LEVEL/POSITION:

Heading / 080

MAX USAGE/LOOPS:

1 / None

PURPOSE:

To indicate the end of a transaction set and provide the count of the transmitted segments including the SE and ST segments

GENERAL INFORMATION:

EXAMPLE:

ELEM ID

ELEM#

The number of included segments is the total of all segments used in the transaction set including the "ST" and "SE" segments. The transaction set control number (SE02) in the trailer must match the transaction set control number (ST02) in the transaction set header segment (ST). SE*5*0001~

ELEMENT NAME

ATTRIBUTES

USAGE

COMMENTS

Must use Must use

Total number of segments Same as corresponding ST02

SE01

96

Number Of Included Segments

M N0 01/10

SE02

329

Transaction Set Control Number

M AN 04/09

======================================================================================= HTNA-EDI (1.0) 12/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997

Examples of 997 Transaction Set EXAMPLE 1: No Syntax Errors, Functional Group Accepted EDI FORMAT ------------------------------------------------------------ST*997*000000001~

INTERPRETATION ---------------------------------------------------------------------------ANSI Transaction Set 997 Transaction Set Control No. = 000000001

AK1*SH*1017~

Functional Identifier = Ship Notice (SH) Data Interchange Control Number = 1017

AK2*856*123456789~

Transaction Set Identifier Code = Ship Notice (856) Transaction Set Control Number = 123456789

AK5*A~

Transaction Set Accepted

AK9*A*1*1*1~

Functional Group Accepted Transaction Sets Included = 1 Transaction Sets Received = 1 Transaction Sets Accepted = 1

SE*6*000000001~

Total Number of Segments = 6 Transaction Set Control No. = 00000001

======================================================================================= HTNA-EDI (1.0) 13/14 ASC X12 Ver.3060

Hayashi Telempu North America Corp. IMPLEMENTATION GUIDELINES FOR EDI CONVENTIONS Transaction Set 997

EXAMPLE 2: Syntax Errors Detected, Transaction Set Accepted

EDI FORMAT ------------------------------------------------------------ST*997*000000002~

INTERPRETATION ---------------------------------------------------------------------------ANSI Transaction Set 997 Transaction Set Control No. = 000000002

AK1*SH*1020~

Functional Identifier = Ship Notice (SH) Data Interchange Control Number = 1020

AK2*856*987654321~

Transaction Set Identifier Code = Ship Notice (856) Transaction Set Control Number = 987654321

AK3*CLD*20~

Segment ID Code = CLD Segment Segment Position = Twentieth

AK4*01**6*00001~

Element Position = First Element Syntax Error Code = 6 (Invalid character in data element) Copy of Bad Data Element = 00001

AK5*R*5~

Transaction Set Rejected One or more segments are in error

AK9*R*1*1*0~

Functional Group Rejected Transaction Sets Included = 1 Transaction Sets Received = 1 Transaction Sets Accepted = 0

SE*8*000000002~

Total Number of Segments = 8 Transaction Set Control No. = 00000002

======================================================================================= HTNA-EDI (1.0) 14/14 ASC X12 Ver.3060