Designdokument och specifikationer

Owned by Helena Ström
Last updated: Sept 08, 2020
1 min read

Kopplat till Integrationskatalogen finns ett ramverk på GU för att dokumentera integrationslösningar. I praktiken innebär detta en uppsättning mallar och mönster i Microsoft Excel och Microsoft Visio, för att dokumentera integrationsarkitektur på ett sätt som inte är direkt knutet till den tekniska implementationen. Med detta menas att designdokumentationen är “teknik-agnostisk” på så sätt att denna design kan implementeras med olika tekniker som .NET (t.ex. BizTalk), Java (t.ex. Apache Camel) eller andra produkter som Boomi etc. GU använder Software AG webMethods.

Med hjälp av detta ramverk dokumenterar vi bland annat alla implementationer på Integrationsplattformen, t.ex. för konsumentadaptrar till olika applikationer. Denna designdokumentation är tillgänglig på Integrationskatalogen under respektive implementation.

Designdokumentationen omfattar bland annat:

  • Övergripande flödesbeskrivning

  • Detaljerad mappningsspecifikation (översättning mellan olika meddelandeformat)

  • Detaljerad specifikation av orkestrering för berikning av meddelanden i flödet

  • Detaljerad specifikation av ingående filter

Kärnan i dokumentationsramverket är symbolspråket Enterprise Integration Patterns (Hohpe-Wolff). Där det är tillämpligt används XPath och UML för t.ex. interaktionsdiagram och flödesdiagram.

Dokumentationsramverket förvaltas av ICC. Se även https://jiragu.atlassian.net/wiki/spaces/ICC/pages/396755147.