Home Page › Forums › BizTalk 2004 – BizTalk 2010 › Question : Documenting a Design
- This topic has 6 replies, 1 voice, and was last updated 9 years, 10 months ago by
community-content.
-
AuthorPosts
-
-
March 20, 2008 at 4:55 AM #19091
Hi everyone,
I am designing and delivering a BizTalk solution. All is well, however I still do not have a decent way to document the solution that I am producing.
What techniques and tools do you guys use to architect and design a system? I know there is the Visio add in, but this in only for orchestration design, not messaging design.
I was thinking:
1) High level architecture TRYING to use some of the enterprise integration patterns. Even then they don’t map into what I want to do.
2) Break down each provess with activity diagrams or sequence diagrams
What are your thoughts? It would be interesting to hear.
Kind regards
TM
-
March 21, 2008 at 2:55 PM #19101
We usually use visio to document our biztalk solution configuration design, which shows endpoints, send/receive ports, orchestrations, components, etc involved in solution. You can also use “BizTalk Documenter” which is freeware utility that produces documentation (in .chm file) of your biztalk solution after it has been deployed. Hth.
-
March 26, 2008 at 1:26 AM #19117
TM,
I think your initial plan is good. At least it’s what I use. 🙂
So, basically use some of the UML models. Processes usually map nicely into Activity diagrams or Sequence diagrams. Back up at a slightly higher level you’ll probably find a use case (or maybe several) which feed down to an activity. Somewhere activities break down into one or more orchestrations.
To capture a UML diagram I usually use Visio with Pavel Hruby’s excellent stencils. Of course, they don’t understand the semantics, but they are super-friendly to use.
I also usually supplement UML with Gregor Hohpe’s EI patterns. If you find your app/system does *not* fit a pattern, then go back and question your design/architecture. Patterns are *proven* good usage. At the end of your questioning session you may well say “mine is a new pattern” – but do check to make sure.
Personally, I don’t go down to great detail. The documentation is a way of explaining to people, and I expect a developer to take the high-level design as a sketch, not as a strict, to-be-followed-to–the-letter plan.
John D.
-
March 26, 2008 at 4:10 AM #19119
John,
your reply was incredibly helpful! Thank you.
In regards to the EIPs, there seems to be so few real world examples of to use them, im never quite sure if what im doing is correct.
For example I may want to impliment guaranteed delivery between 2 endpoints. However, there is a high level icon and a low level icon. Which do you use and where.
Further, I often find that most things (especially when im dealing with a lot of orchestrations) become Process Managers doing different things. All communicating with the message box through a publish subscribe channel.
It would be very helpful to have some insight into your though process when it comes to using the EIPs. For example, do you think of the problem as a whole? Or document each individual part? etc
Thanks again,
P.s – The UML icons have proved useful! Thank you.
Tarun
-
March 27, 2008 at 2:49 AM #19145
Tarun,
I probably can’t give you much satisfaction, but here’s my current thought. If you are just expecting that the attributes of the channel (for example: reliable) will be taken care of by the infrastructure (for example like we see in WCF) then the attributes are low-level – just decorate the appropriate icon. But if you need to create that as part of your application, then surface it in some diagram. Even in this case though, I think a high-level diagram would be good, supplemented by a second one where you show how the attribute will be implemented.
So, I’d expect to see one diagram showing me there is traffic between two endpoints. With some kind of annotation that it’s reliable.
Then, if you have to describe “how” the reliability will be implemented, I’d expect to see a lower-level diagram. For example, there might be some kind of database message repository.
For the EI patterns, I use them at a high-level. For example, one application I was involved with, took in a request (a document) to generate mail shots (lots of tailored documents) – this was just one diagram, showing a sort of pipeline using several of the EI icons. Anything lower-level I would use UML diagrams.
John D.
-
March 28, 2008 at 6:58 AM #19177
There’s a quite interesting presentation by Gregor Hohpe here, not really answering your question, but in the right area:
http://www.infoq.com/presentations/hohpe-soa-development
John D.
-
April 3, 2008 at 1:26 AM #19241
John,
thanks a lot for the updates and the link. i really apreciate your advice,
kind regards
TM
-
-
-
-
-
AuthorPosts
- The forum ‘BizTalk 2004 – BizTalk 2010’ is closed to new topics and replies.