X12 Outbound Applications Trade Links (Tag: X12OBAppLink)

Note: If you have used the XML AutoLoad Utility previously, be aware that in this version of the product, a test post office has been introduced to X12 outbound links. The existing post office field, PutMailPO, is now the production post office. If you make no changes to your XML script generation, the post office that you have used previously for X12 Outbound Links will be this production post office. See the fields TestIndicator, ProdIndicator and TestPutPO fields in the tag X12OBAppLink for more information. If you do not want to take advantage of these new test vs. production post offices, set the two post offices to the same value.

Use this tag to add Applications (documents) to a new X12 Outbound Trade Link. To add, change, or delete Applications on an existing Trade Link, see the related tag: X12OBAppLinkAddChangeDelete. One or more Applications per Trade Link are required. At least one record is required per link. The tag and field descriptions are described in the following table:

Field Label FieldName/Tag Req'd Max. Len. Validation Notes
Application Version GS_VersionRelease Yes 12 fk to X12_Version 1
Functional ID GS_FunctionalID Yes 2 fk to X12_FuncID with Version 1
Reset GS Control # Value GSControlNoValue No 10 Only if GS Scheme is "F".
Numeric, positive integer
2
ST Control Scheme STControlNoScheme No 1 U, R, or T 3

Default: R

ST Control Map STControlNoMap No 255 Only if ST Scheme is U  
Put Post Office PutMailPO Yes 3 Put PO 4, 11
Validate By ValidateByInd No 1 F, T, or I 5

Default: I

Acknowledgement Hours ACK_Within No 5 > 0 and < 99999 6

Default: 0

Application Format Leave_Intact No 1 Y=Fully
N=Partial
M=Control
Numbers Only (aka "Mostly")
Default: N
Routing: RouteOnly RouteOnly No 1 Y/N Default: N
GS Time Stamp Option TimeStampOption No 1 0, 1, 2, 3 7
Test Indicator TestIndicator No 1 T=True, F=False
Default: F
4
Production Indicator ProdIndicator No 1 T=True, F=False
Default: F
4
Test PO Nickname TestPutPO Yes if Test Ind. is T 3 Nickname of Valid Put PO 5
AckGetPO   No 3   8
AckProdPutPO   No 3   9
AckTestPutPo   No 3   10

Notes:

  1. Version/Functional ID is verified to be unique within this Application Partner Link.
  2. GS Scheme, specified at the Trading Partner level, must be F (functional group) to specify GS Reset values here.
  3. U=User Defined; R=relative; T=Increment by Transaction. If U then STMap is required.
  4. Must be exactly 3 characters in length and exist as a Put Post Office Nickname.
  5. Valid values, if specified are F=Functional Group, T= Transaction Set, I=interchange. Defaults to I.
  6. Number of hours an acknowledgement is expected.
  7. 0=hhmm, 1=hhmmss, 2=hhmmssd, 3=hhmmssdd. If not specified, the default will be zero (hhmm) if the version is less than 4010, otherwise the default is one (hhmmss)
  8. To automatically create an acknowledgement link, specify the Get Post Office nickname. That nickname will be used to create the acknowledgement. See Automatic creation of X12 acknowledgement trade links.
  9. To automatically create an acknowledgement link, specify at lease one Put post office. You can specify the Production post office nicnname here, and/or use AckTestPutPO. See Automatic creation of X12 acknowledgement trade links.
  10. To automatically create an acknowledgement link, specify at least one Put post office. You can specify the Test Post Office nickname here and/or use AckProdPutPO. See Automatic creation of X12 acknowledgement trade links.
  11. This is the production post office.