I'm learning a little bit more about BizTalk Server (R) 2004 at the moment and something that had me stumped until today was how to get correlation working so I thought I'd blog something on that up here having just managed to get what I wanted working (wasn't hard at all in the end). Correlation is the simple idea of sending a message out to someone and then expecting to receive a response back (more than likely at a later point) and using some common piece of data in the returned message to tie it up (i.e. correlate) with the sending message. Within BizTalk 2004, there's some really powerful functionality built around the Orchestration engine that allows for pretty much automatic correlation. As a very simple example, assume I have a message which looks like; <order> <supplier>SUPP001</supplier> <productCode>PROD001</productCode> </order> and I'm going to send this from my Orchestration schedule to some trading partner who's going to reply with a message something like; <invoice> <supp>SUPP001</supp> <prod>PROD001</prod> </invoice> Clearly, it's contrived and we'd normally correlate on something like a GUID but hopefully it's clear that the invoice message that I'm getting back is meant to relate to the one that I sent out. So, how do we make this work? Well, firstly, we've got to define schemas for these 2 document types and, within those schemas, we need to promote properties (through property schemas) that we're going to use in messaging. So, in our case we need to promote (to promoted properties) the 'supplier', 'productCode', 'supp' and 'prod' fields in our order and invoice schema respectively. Having done that we configure the a port in the orchestration to send the order message out and we configure a port to receive the invoice back (presumably this is just one step in some larger business process). We then need to define a 'Correlation Set' that these 2 ports can share. This is an instance of a 'Correlation Type' which is data that we need to match up between the outgoing document and the incoming document in order to consider that incoming document a 'response' to the outgoing one. In order to make data a part of our 'Correlation Type' we need to make sure the data is available to us as promoted properties so we need to go to our properties ('supplier' and 'productCode' in both the invoice and the order schemas) and make sure they're promoted. Having done that we can then define a 'Correlation Type' which consists of the 'supplier' and 'productCode' promoted properties. We then make a Correlation Set of this type for our Orchestration (by configuring it in the Orchestration View window) and we associate this particular Correlation Set with our ports. For the sending port we configure 'Initialises correlation set' and for the receiving port we configure 'Follows correlation set'. If you're playing with BizTalk 2004 a little you can probably imagine that what might be happening here is that the receiving port is gaining a more granular subscription to the message box. Having done that, we should find that our receiving port within our Orchestration nicely picks up the 'correct' messages that are the responses to the outgoing messages that we sent by only picking up messages that match the data fields that we specified. But...one more thing. In the example I gave, I had fields named 'supplier' and 'productCode' in my order document but fields named 'supp' and 'prod' in my invoice document. If I follow the steps outlined above and try and build an Orchestration like this then my current build of BizTalk 2004 gives me an error saying something like 'metadata property supplier for correlation X does not exist in message Y'. Essentially, it looks like the designer is expecting that if I'm doing correlation then the 'fields' that I'm using in both documents will be named the same way. How to get around this? Well, what I'm doing right now is opening up my invoice.xsd document in a plain XML editor (in VS.NET 2003) and just tweaking the schema annotations that have been added for me to change the names that are being used. So, in the example above VS.NET made a schema annotation like this for me for my invoice schema; <xs:annotation> <xs:appinfo> <b:properties> <b:property name='ns0:Supp' xpath='/*[local-name()='Invoice'and namespace-uri()='http://correlate.Out']/*[local-name()='supp'and namespace-uri()='']' /> <b:property name='ns0:Prod' xpath='/*[local-name()='Invoice'and namespace-uri()='http://correlate.Out']/*[local-name()='prod'and namespace-uri()='']' /> </b:properties> </xs:appinfo> </xs:annotation> and we can see that it's used a name of 'supp' and 'prod' becase that's how my elements were named. However, if I change these names in this annotation to be the same as the ones in the order document, i.e. <xs:annotation> <xs:appinfo> <b:properties> <b:property name='ns0:supplier' xpath='/*[local-name()='Invoice'and namespace-uri()='http://correlate.Out']/*[local-name()='supp'and namespace-uri()='']' /> <b:property name='ns0:productCode' xpath='/*[local-name()='Invoice'and namespace-uri()='http://correlate.Out']/*[local-name()='prod'and namespace-uri()='']' /> </b:properties> </xs:appinfo> </xs:annotation> then my Orchestration compiles up and works just fine (note: only the
name of the property has been changed in the example above - the xpaths are using the original, real names of the elements involved). If your properties are named the same in your outgoing and incoming documents then you should not have to do this but this works for me right now in the scenario where those names don't match so I thought I'd share.
Posted
Sat, Nov 15 2003 12:00 AM
by
mtaulty