Mohsin Kalam’s Blog

X12 Party Properties

Goal:

To provide in depth information about the X12 Party properties in PAM used by the EDI run time components to process X12 encoded Interchange.

Overview:

Party properties are divided into a General section used by all EDI components, a contact information tab and a separate EDIFACT and X12 section. The EDIFACT and X12 section is sub divided under Party as Interchange Sender and Party as Interchange Receiver nodes.

Party as Interchange Sender:

The settings from Party as Interchange Sender node are applied during Receive Side processing. This node is subdivided as follows:

X12 Interchange Processing Properties:

These settings are used by BizTalk R2 to process the envelope and transaction sets of X12 encoded interchange received from the party. The following table describes these settings in detail:

X12  Interchange Processing Properties

Field Name

Field Type

Default Value

Purpose

ISA1 Drop down 00 – No Authorization information present Used for authentication**
ISA2 Text field Blank, grayed out, dependent* on ISA1 Used for authentication**
ISA3 Drop down 00 – No Security information present Used for authentication**
ISA4 Text field Blank, grayed out, dependent on ISA3 Used for authentication**
ISA5 Drop down Blank Used for party resolution***
ISA6 Text field Blank Used for party resolution***
ISA7 Drop down <not valued> Used for party resolution***
ISA8 Text field Blank, grayed out, dependent on ISA7 Used for party resolution***
Use ISA11 as Repetition Separator Check box Unchecked If this field is checked, then ISA11 is used as a repetition separator for data fields otherwise it is used as a standard identifier
Check for duplicate ISA13 Check box Checked To check for duplicate interchange received within a period of time based on ISA13. If received while the box is checked, the entire interchange is suspended and stored in wire (EDI) format
Check for duplicate GS6 Check box Unchecked To check for duplicate groups within an interchange based on GS6. If received while the box is checked, all the transaction sets in that group are suspended in XML format
Check for duplicate ST2 Check box Unchecked To check for duplicate transaction sets within a group based on ST2. If received while the box is checked, the offending transaction set is suspended in XML format
Default Target NameSpace Editable Drop down See footnote**** Used during schema discovery
Enable custom transaction sets Grid Blank Used for custom transaction sets*****

 *dependent on means the field can only be edited if the dependent field is checked/active. For example the field “ISA2″ will be grayed out if the field it is dependent on (“ISA1″) is not active

**ISA1, ISA2, ISA3 and ISA4 are used during authentication. If these 4 fields are present in the instance and do not match the fields in PAM, the whole interchange is suspended.

***ISA5, ISA6, ISA7 and ISA8 are used during Party Resolution. It is described in great detail here

****Default is http://schemas.microsoft.com/BizTalk/EDI/X12/2006

*****Users can override the default target namespace with custom namespace for certain Doc types. If GS2 and ST1 in the instance match the fields specified here, the target namespace from this row will be used. Schema discovery is described in great detail here

ACK Generation and Validation Settings:

These settings are used by BizTalk R2 to generate acknowledgments in response to X12 encoded interchange received from a party, validate those interchanges and acknowledgments and to specifying the mode of processing by EDI Receive. The following table describes these settings in detail: 

ACK Generation and Validation Settings

Field Name

Field Type

Default Value

Purpose

Route ACK  on request-response Check box Checked To return the ACK generated by the EDI system on a 2 way request-response receive port
Generate TA1 Check box Unchecked To generate Technical ACK against the incoming document
Do not batch TA1 Check box Unchecked, grayed out, dependent on “Generate TA1″ To include/exclude the Technical ACK in the batching set up for this party
Generate 997 Check box Unchecked To generate Functional ACK against the incoming document
Do not batch 997 Check box Unchecked, grayed out, dependent on “Generate 997″ To include/exclude the Functional ACK in the batching set up for this party
ST2 3 Text fields made up of Prefix + Numeric + Suffix Blank for Prefix and Suffix fields, 1 for numeric* To use this control number for the Functional ACK generated
Generate AK2 loop Check box Unchecked, grayed out, dependent on “Generate 997″ To generate the AK2 loop for accepted transaction sets for Functional ACK. This loop is only generated if there are errors in the transaction sets
EDI Type Check box Checked To perform EDI Validation
Extended Validation Check box Unchecked, dependent on “EDI Type” To perform extended validation
Allow leading and trailing zeroes and spaces Check box Unchecked, dependent on “EDI Type” The EDI validation does not allow leading and trailing spaces and zeroes unless they are required to fulfill minlength requirements for a data type. If this is checked, EDI validation skips this leading and trailing check. This does not include ID data types
Allow trailing separators Check box Unchecked When set to true, trailing delimiters at the segment, field and component level are allowed. If set to false and trailing delimiters encountered in the payload, that document is suspended
Create empty XML tags for trailing separators Check box Unchecked, grayed out, dependent on “Allow trailing separators” To generate empty XML tags for data fields when trailing delimiters encountered
Mask security information Check box Checked When checked, the security information in the context is masked with a special character. These include UNB6.1, UNB6.2 and UNG8 (if present in the instance)
Convert implied decimal format Check box Unchecked To convert X12_Nn data type to decimal in XML format. For example a field with X12_N2 containing the value 1234 will be converted to 12.34 in XML format
Inbound processing mode Drop down Split Interchange as Transaction Sets To specify the mode of interchange processing**

*ST2 is divided into three parts: Prefix, Number and Suffix. The control number is generated by concatenating these three fields. The prefix and suffix are constant and the numeric part is incremented on every successive Functional ACK generated. PAM validation ensures the total length of these fields do not exceed the maximum length allowed by the X12 standards

**Explained in great detail under Engine Receive post

Party as Interchange Receiver:

The settings from Party as Interchange Receiver node are applied during Send Side processing. This node is subdivided as follows:

X12 Interchange Envelope Generation:

These fields are used by BizTalk R2 to generate envelopes for an outgoing X12 encoded interchange. For X12 there are 2 pages that allows the users to specify settings for ISA, GS and ST segments.

The ISA segment page lets the user choose the settings for the ISA envelope. This page also specifies all the delimiters used during serialization. ISA13 (interchange control number) is incremented after every successive serialization

The GS/ST segment page lets the user choose the settings for the GS/ST envelope. R2 allows users to specify different GS headers for different Doc Types according to the following process

  • If the ST1, Version/Release and the TargetNameSpace specified in PAM match the values in the instance, the GS segment is constructed from that row
    • ST1, Version/Release and the TargetNameSpace are present in the first line of XML file
  • If no match happens, the default row is selected.
  • If the default row is not specified by the user, the message is suspended and an appropriate error logged to the event viewer

GS6 (group control number) and ST2 (transaction set control number) are incremented after every successive serialization. The ST2 field has a checkbox “Apply new ID” that is checked by default. If this is checked, the transaction set control number is updated in the instance otherwise it remains as is. 

ACK Processing and Validation Settings:

These fields are used by BizTalk R2 to process acknowledgments received from a party in response to X12 encoded interchange and to validate those interchanges and acknowledgments. The following table describes these settings in detail:

ACK Processing and Validation Settings

Field Name

Field Type

Default Value

Purpose

Functional ACK Check box Unchecked Used by status reporting
EDI Type Check box Checked To perform EDI Validation
Extended Validation Check box Unchecked, dependent on “EDI Type” To perform extended validation
Allow leading and trailing zeroes and spaces Check box Unchecked, dependent on “EDI Type” The EDI validation does not allow leading and trailing spaces and zeroes unless they are required to fulfill minlength requirements for a data type. If this is checked, EDI validation skips this leading and trailing check. This does not include ID data types
Generate trailing separators Check box Unchecked To generate trailing separators at the segment, field and component level if empty XML tags are encountered

Interchange Batch Creation Settings:

These fields are used by BizTalk R2 to generate and send X12 encoded batch. This will be explained in a separate post in detail.

End Note:

I hope this post has been useful in understanding the X12 Party Properties. Your comments/questions are always welcome.

Thanks

Mohsin Kalam

2 Comments »

  1. very interesting, but I don’t agree with you
    Idetrorce

    Comment by Idetrorce — December 15, 2007 @ 3:23 pm

  2. In previous versions of HIPAA accelerator, we have file mask of # to generate an unique number in edi output file. This property is set in the when configuring the HIPAA EDI Transport.

    BizTalk R2 is there any similar feature where we can append to unique id in file name.

    Thank you.
    -ERS

    Comment by ERS — August 6, 2008 @ 11:57 pm


RSS feed for comments on this post. TrackBack URI

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

The Rubric Theme Blog at WordPress.com.

Follow

Get every new post delivered to your Inbox.

%d bloggers like this: