Mohsin Kalam’s Blog

EDI Global Properties

Goal:

To provide in depth information about the EDI Global properties used by the EDI run time components.

Overview:

If no parties are configured, or a document does not resolve to a specific party, that document is processed using settings from the Global level. Global settings are referred to the combination of settings available at Global level + the pipeline component properties.

EDI Global Properties:

EDI Global properties are accessed by right clicking on the Parties node under BizTalk Server 2006 Administration Console and selecting “EDI Global Properties“. The following snapshot shows the Global properties view

edi-global-properties.JPG

Global properties are divided into Common properties used by both all EDI components, and a separate X12 and EDIFACT section which are subdivided for Receive and Send Side.

Common Properties: 

Common properties include Activating Status Reporting which is turned off by default. And there is an option of logging the events generated by the BizTalk EDI system to the event log. Common settings are applied for both Receive and Send Side processing.

Receive Side:

For Receive side processing, the settings used come from fields under Interchange Processing Properties for the respective standard. The following table describes the settings in detail:

EDIFACT/X12  Interchange Properties*

Field Name

Field Type

Default Value

Purpose

Check for duplicate {UNB5|ISA13}

Check box

Unchecked

To check for duplicate interchange received within a period of time based on {UNB5|ISA13}. If received while the box is checked, the entire interchange is suspended

Check for duplicate {UNG5|GS6}

Check box

Unchecked

To check for duplicate groups within an interchange based on {UNG5|GS6}. If received while the box is checked, the entire interchange is suspended

Check for duplicate {UNH1|ST2}

Check box

Unchecked

To check for duplicate transaction sets within a group based on {UNH1|ST2}. If received while the box is checked, the entire interchange is suspended

Target NameSpace

Editable Drop down

See Footnote**

Used for schema discovery process

Generate {Technical ACK|TA1}

Check box

Unchecked

To generate Technical ACK against the document received

Generate {Functional ACK|997}

Check box

Unchecked

To generate Functional ACK against the document received

*X12 and EDIFACT pages have similar fields. The way to read this table is as follows: On the EDIFACT page, take the first argument from the curly bracket and for X12, take the second. For example on X12 page, you will read Generate 997

**Default Target NameSpace for EDIFACT is http://schemas.microsoft.com/BizTalk/EDI/EDIFACT/2006.

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

Additionally there are pipeline component properties that are used in conjunction with the Global properties. For Receive side, the following are available:

Receive Side Pipeline Component Properties

Field Name

Field Type

Default Value

Purpose

Allow Trailing Delimiters Drop down False 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
Character Set Text field UTF8 Allowed values are Basic, Extended and UTF8. Used to perform Character Encoding Validation for X12 docs
Convert to Implied Decimal Drop down False 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
Create XML tag for Trailing Separators Drop down False To generate empty XML tags for data fields when trailing delimiters encountered
Detect MID Drop down True To allow processing of multiple interchanges in a single file
EDI Data Validation Drop down True To perform EDI Data Validation
EFACT Delimiters Text field 0×3A, 0×2B, 0×2C, 0×3F, 0×20, 0×27 In case of no UNA present for EDIFACT files, use the separators specified to parse the EDI document
Mask Security Information Drop down True To mask the sensitive fields in the instance when converted to XML
Preserve Interchange Drop down False To allow BIBO mode processing during parsing. In this mode, the whole interchange is preserved as a single doc
Route Ack On 2 way Port Drop down True To return the ACK generated by the EDI system on a 2 way request-response receive port
Use ISA11 as Repetition Separator Drop down False Use the value of ISA11 in the ISA segment as Repetition Separator when set to true. Otherwise use it as a standard identifier
XML Schema Validation Drop down False Allow extended validation by the EDI Engine. This includes XSD data type validation

Send Side: 

For Send side processing, the settings come from fields under {EDIFACT/X12} Interchange Envelope Generation. These fields are used to generate envelopes for outgoing messages. For EDIFACT there are 3 pages that allows the users to specify settings for UNA, UNB and UNB/UNH segments. For X12 there are 2 pages that allow the users to specify settings for ISA and GS/ST segments.

The UNA segment page lets the users choose the settings for all the separators used in serialization. Since UNA segment is optional, there is a checkbox “Generate UNA segment” checked by default to allow users to generate UNA. If this field is not checked, UNA segment is not created but the delimiters specified are still used during serialization.

The UNB segment page lets the users choose the settings for the UNB envelope. UNB5 (interchange control number) 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 serialization. PAM validation ensures the total length of these fields do not exceed the maximum length allowed by the EDIFACT standards.

The UNG/UNH segment page lets the users choose the settings for the UNG/UNH envelope. Since UNG segment is optional, there is a checkbox “Create UNG segments” unchecked by default. If this field is checked, the UNG segment is generated. UNG5 (group control number) and UNH1 (transaction set control number) follow the same logic as UNB5. The UNH1 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.

The ISA segment page lets the user choose the settings for the ISA envelope. This page also specifies all the delimiters used during serialization. The GS/ST segment page lets the user choose the settings for the GS/ST envelope. The ST2 (transaction set control number) 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.

Additionally, like Receive, there are pipeline component properties that are used in conjunction with the Global properties. For Send side, the following are available:

Send Side Pipeline Component Properties

Field Name

Field Type

Default Value

Purpose

Allow Trailing Delimiters Drop down False When set to true, trailing delimiters at the segment, field and component level are allowed.
Character Set Text field UTF8 Allowed values are Basic, Extended and UTF8. Used to perform Character Encoding Validation for X12 docs
EDI Data Validation Drop down True To perform EDI Data Validation
XML Schema Validation Drop down False Allow extended validation by the EDI Engine. This includes XSD data type validation

End Note:

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

Thanks

Mohsin Kalam

6 Comments »

  1. About the receive side pipeline component properties… are these only set at the pipeline? Or can these (specifically “Allow Trailing Delimiters”) be set globally? A first read of your excellent blog, gave me the impression that I could do this, but looking at the options in BT console, I did not see that this could be done – at least not in the EDI global properties dialog. [Thank you, I do enjoy the time spent reading through your blog about R2 & Edi]

    Comment by John Lingenfelder — December 27, 2007 @ 8:32 pm

  2. What I meant by EDI Global properties was the combination of “EDI Global Properties” (that you can access by right clicking at the party tab) and the “Pipeline Component properties”. If a document does not resolve to a specific party, then the options from both the global and pipeline components are used.

    With that said, the options at the receive side pipeline component properties can only be set at the pipeline through the BT console or the Visual Studio Pipeline configuration screen.

    Thanks
    Mohsin

    Comment by Mohsin Kalam — January 2, 2008 @ 12:42 pm

  3. Hi mohsin,
    You have given excellent information about EDI in R2. But one thing i want to know is that is there any way to disabling global EDI properties. As in my sample application when i am submitting EDI document with Trading partner as receiver with proper party settings. but document is not getting resolved according to the party setting i am unable to figure it out as it is resolving through global party settings.

    Comment by srini — February 28, 2008 @ 9:44 am

  4. Short answer to your question, no there is no way to disable the party resolution reverting to global settings. However if you can paste the envelope information here, I can tell you the party setting to use to resolve that document.

    Hope that helps
    Mohsin

    Comment by Mohsin Kalam — February 28, 2008 @ 12:07 pm

  5. A good and useful blog. Wanted to know whether we can have interchange control number with alphabets prefixed to the number, the field is alpha numeric..

    Comment by Subhra — April 29, 2008 @ 9:26 pm

  6. For X12, ISA13 (which is the interchange control number) is a numeric field so PAM will not allow you to set alphabets prefix. For EDIFACT, UNB5 is alpha numeric and you can have alphabets prefix and suffix.

    Thanks
    Mohsin

    Comment by Mohsin Kalam — April 30, 2008 @ 12:59 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

Create a free website or blog at WordPress.com.

%d bloggers like this: