In the part one we discussed about the basics of EDI message structure and ISA header properties. In part I will detailing about the EDI schema deployment and party creation and configuration.
1- Deploying the EDI Schema
The partner and your organization have decided about which version of EDI message needs to be interchanged. You need to create a schema project using your Visual Studio. You build and deploy this application. Once it is deployed, you can see this under BizTalk Admin à BizTalk Group àApplications àAll Artifacts à Schemas. It is always a best practice to create separate application for common schemas to be used. Though, if you have a small project like the one which we are discussing you can place all the artifacts in the single application.
In order to add the X12 EDI schema, browse to the below location and add the required version of schema. If I need to add schema for EDI 940 of “00502” version, I need to browse to below location.
C:\Program Files\Microsoft BizTalk Server 2006\XSD_Schema\EDI\XSDTemplate\X12\00502
Once the EDI schema is deployed, you need to add and configure the party.
2- Adding and configuring the trading partners
In order to add a party Go to the BizTalk Administrator àBizTalk Group, right click on on Parties and click on Newà Party.
Enter the party name, select the identifier qualifier such as "01" or "02" and enter the value for this identifier.
Note: You need to define one identifier. If you need to define some mutually defined identifier, you need to select the identifier qualifier as “ZZ”. If you wish to define other parameters like, environment [DEV, QA and PROD], you can also do. All these values goes BTS management database which can be used on a later point of time. Please see the BT Management database and explore EDI related and party related tables.
Once the party is added, right click on the party and say “EDI Properties”. This will bring you to the place where you can define the EDI properties, sender and receiver, acknowledgements, setting related to control numbers, EDI reporting, batching, debatching etc. If you are developing EDIFact application then you need to use EDIfact setting and if you are using X12 then you need to use X12 setting. In our case we are using the X12 message so we will be looking into X12 settings.
Party As interchange Sender à X12 Interchange Processing Properties à set the value for ISA 5-6 and ISA 7-8.
If you do not want to allow duplicate control numbers, select the “check for duplicate ISA 13”.
If you do not wish to allow duplicate control number at Group Header level, please select “Check for duplicate GS6”.
Note: This is best practice to check for duplicate control number, this helps you to differentiate the transactions.
After this define values for GS2 [identifier], ST1 [Interchange message i.e. 940] and target namespace.
ACK generation and Validation Settings – This allows you to provide the settings related to Acknowledgement. Please select “Generate 997” and “Do not batch 997”.
Document Validation properties: By default BizTalk EDI does not allow leading or trailing 0’s. If you need to BizTalk EDI to accept that, please select “Allow leading and trailing zeroes and spaces”
Party As Interchange Receiver à X12 Interchange Envelope Generation à ISA Segment definition à set the value for ISA 5-6 and ISA 7-8. This will help the EDI send pipeline to create the ISA header. Also select the ISA12 control version as per your agreed version of EDI.
GS and ST segment definition à You need to set the GS and ST values, mentioning which EDI message your application will be sending.
Note : There are scenarios where you only need to acknowledgement and you see that EDI 997 is not in the list. If you will leave this part with any value then it will not allow you to configure Party as interchange receiver.ST1 field could be set to anything and this value will be overwritten EDI send pipeline with appropriate values.Thus if you only need to send 997 to the trading partner then configure the GS segment for some arbitrary value.
ACK generation and Validation Settings are same as we have done for the “Party As interchange Sender”.
Interchange batch creation settings allows to create the batch for outbound messages.
In the next scetion I will be discussing about application configuration in BizTalk administration and then about the Global EDI settings. Keep watching !!
For Part 3 of this series please follow the below link.