Документация о портовом оркестре Biztalk

Question

У нас есть большая настройка EAI (+ - 70 оркестровок, 200 портов отправки, ...). Почти ни один из оркестров/портов не имеет прямых привязок. Каждый маршрут настраивается с помощью фильтров.

К сожалению, пришло время документировать сценарий интеграции, понятный для тех, кто не является бизнесменом.

Я задавался вопросом, есть ли какие-либо инструменты/word-excel-visio -... шаблоны для документирования такого сценария. Нет необходимости документировать технические данные оркестров/карт/кодов, а также поток сообщений. (rcvport/место (с картами) -> оркестровка (фильтр) -> sendport (ы) (с фильтром, карты)

Thx, Барт

Answer 1

Вы можете использовать Business Process Modeling Notation (BPMN). Я использую его все время для разработки и оркестровки документов.

http://www.bpmn.org/documents.htm Визит

Прокрутка вниз к другим документам. являются трафареты для Visio.

Answer 2

в моей компании мы назн был создан стиль документации для потоков сообщений на основе UML.

Мы представляем приложения BizTalk в качестве компонентов и используем Ports и Interfaces на этих компонентах для представления точек подключения. Затем мы используем соединение Information flow между этими интерфейсами.

Мы используем Enterprise Architect из Sparx Systems для создания этих артефактов и видов. Преимущество этого инструмента заключается в том, что он использует подход на основе репозитория, поэтому все артефакты могут использоваться повторно для нескольких видов.

Недостатком этой оценки является то, что вам необходимо создать все виды самостоятельно. Нет простого способа генерировать эти данные из исходного кода или развернутых приложений BizTalk (которые я знаю), поэтому вам нужно будет вручную создать эту документацию.

Answer 3

Я всегда использовал Visio для рисования собственных диаграмм. По моему мнению, сделав это в течение 10 лет, вы должны быть творческими и не следовать ни одному стандарту. И от одного клиента к другому я не всегда делаю то же самое. Я пытаюсь улучшить, но я не думаю, что есть ответ «один размер подходит всем».

Как и в случае с любым документом, попробуйте сделать что-то очень высокоуровневое. Затем увеличьте масштаб деталей на следующих диаграммах.

Что вообще отсутствует, как описать поток данных в/из порта в порт. Например, что делать, если вы запускаете файл в приемном порту? Я использовал стандартные фигурные диаграммы Visio, например цилиндр для трубопровода, коробку для порта и т. Д. ... затем подключил их к линиям. Если у вас есть только одна карта, вы можете поместить ее на линию. Если у вас их куча, то это сложно представить. Я пытаюсь поместить карту или трубопровод на стрелки.

Обычно я использую Cloud Symbol для отправки данных другим поставщикам или торговым партнерам. Иногда я использую серверные поля Visio, чтобы указать отправку данных на другой сервер внутри нашей компании или даже на FTP-сервер или веб-сервер в другой компании.

Я также показываю, что «MessageBox» имеет порт.Например, Receive Port - это поле, затем строка «MessageBox», затем каждая отправка, на которой есть фильтр, выходит из этого MessageBox. (Я в конечном итоге рисую новый «MessageBox», как правило, для каждого потока, чтобы держать их в отдельности.

Для оркестровок я использовал SnagIt для захвата документа, а затем комментирует титры и стрелки и текст в документе Word после ошибки. (Проблема в том, что у вас широкие или очень сложные оркестровки.)

К сожалению, большинство документов, которые я выполняю, не являются автоматическими и не связаны с кодом или привязками, поэтому он может быстро стать устаревшим. «Никогда не находил« BizTalkDocumenter »таким полезным.

Я иногда использую Таблицы в Word, чтобы показать артефакты разработчика и их взаимосвязь (карты, схемы, конвейеры ...) и включить словесный описатель on/comment для каждого.

Я согласен с HSedidin выше, что BPMN, возможно, стоит попробовать, но даже это, аудитория должна будет учиться.

Существует пакет «Трафарет» для BizTalk, доступный для Vizio здесь: https://gallery.technet.microsoft.com/Collection-of-Visio-2013-0283d5f4, но я должен признать, что я еще не использовал его.