Documentation de port/orchestration de Biztalk

Question

Nous avons une grande configuration EAI biztalk (+ - 70 orchestrations, 200 ports d'envoi, ...). Presque aucun des orchestrations/ports ont des liaisons directes. Chaque itinéraire est configuré à travers des filtres. Malheureusement, il est temps de documenter le scénario d'intégration compréhensible par les techniciens non-biztalk. Je me demandais s'il y avait des outils/modèles word-excel-visio -... pour documenter un tel scénario. Il n'est pas nécessaire de documenter les détails techniques de orchestrain/map/code, juste le flux de messages. (rcvport/emplacement (avec des cartes) -> orchestration (filtre) -> SendPort (s) (avec filtre, cartes)

Thx; Bart

Answer 1

Vous pouvez utiliser Business Process Modeling Notation (BPMN). Je l'utilise tout le temps de concevoir et documenter Orchestrations.

Visitez http://www.bpmn.org/documents.htm

Faites défiler la liste à d'autres documents. le sont pochoirs pour Visio.

Answer 2

Dans mon entreprise, nous Resp ned un style de documentation pour les flux de messages basé sur UML.

Nous représentons les applications BizTalk en tant que composants, et utilisons les Ports et Interfaces pour représenter les points de connexion. Nous utilisons ensuite la connexion Information flow entre ces interfaces.

Nous utilisons Enterprise Architect de Sparx Systems pour créer ces artefacts et ces vues. L'avantage de cet outil est qu'il utilise une approche basée sur le référentiel, de sorte que tous les artefacts peuvent être réutilisés pour plusieurs vues. L'inconvénient de cette approche est que vous devez créer tous les points de vue vous-même. Il n'existe aucun moyen simple de générer ces données à partir du code source ou des applications BizTalk déployées (que je connais), vous devrez donc créer cette documentation manuellement.

Answer 3

J'ai toujours utilisé Visio pour dessiner mes propres diagrammes. À mon avis, après avoir fait cela pendant 10 ans, vous devez être créatif et ne pas suivre un ensemble standard. Et d'un client à l'autre, je ne le fais pas toujours de la même façon. J'essaie de m'améliorer, mais je ne pense pas qu'il existe une solution unique.

Comme pour tout document, d'abord, essayez de faire quelque chose de très haut niveau. Zoomez ensuite sur les détails dans les prochains diagrammes.

Ce qui manque en général, c'est comment décrire le flux de données de/vers un port. Par exemple, que faire si vous débatchez un fichier dans un port de réception? J'ai utilisé des formes d'organigramme standard Visio, par exemple des cylindres pour pipeline, des boîtes pour Port, etc ... puis les ai connectées avec des lignes. Si vous n'avez qu'une seule carte, vous pouvez la mettre en ligne. Si vous en avez plusieurs, alors c'est difficile à représenter. J'essaie de mettre la carte ou le pipeline sur les flèches.

J'utilise généralement le symbole Cloud pour envoyer des données à d'autres fournisseurs ou partenaires commerciaux. Parfois, j'utilise les zones Serveur de Visio pour indiquer l'envoi de données à un autre serveur de notre société ou même à un serveur FTP ou un serveur Web d'une autre société.

Je montre également le "MessageBox" a un port.Par exemple, Receive Port est une case, puis une ligne vers "MessageBox", puis chaque Send qui a un filtre, sort de cette MessageBox. Pour les orchestrations, j'ai utilisé SnagIt pour capturer le doc, puis annoter avec des légendes et des flèches, et du texte dans un document Word. après la photo. (Le problème est si vous avez des orchestrations larges ou très complexes.)

Malheureusement, la plupart des docs que je fais ne sont pas automatisés et ne sont pas connectés au code ou aux bindings, donc ils peuvent rapidement devenir obsolètes. Je n'ai jamais trouvé que "BizTalkDocumenter" soit aussi utile

J'utilise parfois des tableaux dans Word pour montrer les artefacts du développeur et comment ils se rapportent (cartes, schémas, pipelines ...), et comprennent une descripti sur/commentaire pour chacun. Je suis d'accord avec HSedidin ci-dessus que BPMN pourrait être utile d'essayer, mais même cela, le public devrait apprendre.

Il existe un pack "Stencil" pour BizTalk disponible pour Vizio ici: https://gallery.technet.microsoft.com/Collection-of-Visio-2013-0283d5f4, mais je dois admettre que je ne l'ai pas encore utilisé.