Export a import RTF šablony pro generování dokumentace

Převedení vámi vytvořené šablony RTF reportu z jednoho projektu (EAP soubor) do druhého je poměrně jednoduchý krok, ale je třeba vědět, kam šáhnout.

Export šablony

  1. Možnost uložení šablony na disk mnoho uživatelů Enterprise Architecta hledá v dialogu Generate Documentation (ukážeme si záhy) nebo v editoru šablony. Tam však hledají marně. Je třeba si nalézt dialog Export Reference Data. Ten zobrazíte z menu ProjectModel Import/Export díky položce Export Reference Data… (pozor na to, že v dřívějších verzích EA zmíněnou položku najdete v menu Tools)
  2. V tomto dialogu najděte položku Templates – RTF Document a označte ji.
  3. Stiskněte tlačítko Export.
  4. EA se vás zeptá na soubor, do kterého budou uloženy všechny vaše uživatelské RTF šablony.
  5. Předpokládejme, že se vše povedlo, EA vám to dá na vědomí.
  6. Jestliže nechcete předávat všechny šablony, ale jen některé, pak je třeba vygenerovaný soubor upravit. Jde o XML formát, takže úprava bude jednoduchá: Smažte všechny elementy <DataRow>, které neobsahují potřebné šablony (hledejte dle názvu šablony v atributu value elementu <Column> názvu DocName (příklad: <Column name=“DocName“ value=“My template for Requirements“/>).

Import šablony

Importovat šablonu lze dvěma způsoby:

  1. Importem referenčních dat
    1. V menu ProjectModel Import/Export zvolte položku Import reference data… Zobrazí se dialog podobný tomuto:
    2. Zadejte soubor, který jste získali při exportu.
    3. Po načtení se zobrazí hlavní části ze souboru, označte (v tomto případě jedinou) položku Templates – RTF document.
    4. Stiskněte tlačítko Import.
    5. O úspěšném importu jste informování.
  2. Importem šablony
    1. Z menu ProjectDocumentation vyberte položku Rich Text Format (RTF) Report… (případně stiskněte F8), zobrazí se dialog Generate Documentation.
    2. Přepněte se na záložku Templates
    3. Tam zvolte tlačítko Import From Reference File.
    4. Zobrazí se dialog stejný jako v předchozím postupu, použijte ho tedy.
    5. V seznamu šablon se pak zobrazí všechny nově importované šablony.

Poznámka: Postup a obrázky odpovídají EA verze 9.3.933.

Poznámka ke kompozitním diagramům v EA

Při psaní textu k certifikaci OCUP úrovně Intermediate a dělání příkladů v Enterprise Architectu jsem našel pár nedostatků tohoto nástroje. Pokud budete modelovat kompozitní strukturu v EA, pak narazíte na tyto problémy (platí pro EA verzi 9.2 build 922 a zřejmě i nižší):

  • Pokud má část pouze název, nezapisuje za něj dvojtečku.
  • Neumí zakreslit násobnost části do pravého horního rohu.
  • Neumí zakreslit chovací port (isBehavior = True).
  • Nedobře pracuje s částmi a instancemi.

V daných příkladech jsem si tedy musel pomoci malým „podvodem“.

Test schopnosti UML nástrojů pracovat s XMI

OMG nedávno provedla test vybraných nástrojů, ve kterém se zaměřila na jejich schopnost pracovat se standardizovaným formátem pro výměnu dat mezi modely (XMI). Celkem se provedlo na 16 testových scénářů v aplikacích firem Atego, IBM, NoMagic, Sodius, SOFTEAM a Sparx Systems (poslední jmenovaný dodává mnou používaný Enterprise Architect).

Předseda skupiny, která se formátem pro výměnu dat zabývá, mj. prohlásil: The ability to interchange models offers the potential to significantly improve productivity, quality, and the long term retention of models. Volně přeloženo s přihlédnutím mezi řádky: test dopadl katastrofálně. Výrobci musí vyvinout ještě mnoho úsilí, než dosáhnou uživateli požadovaného výsledku (totiž aby to fungovalo správně).

Ku dobru všech firem je ale nutné přičíst, že na testu spolupracovaly a všechny chyby, které se v průběhu testu našly, byly opraveny. Současně dodávané verze by tedy všemi scénáři nyní prošly bezchybně.

Důležitější je ale zřejmě ohlášení normativního XMI (Canonical XMI). XMI tak, jak je dnes definováno, nabízí poměrně dost volitelných možností, jak např. element či atribut zapsat. Proto vzniklo normativní XMI, které utahuje popuštěnou uzdu volnosti. Teď už jen, aby to všechny významné nástroje začaly plně podporovat.

Odkazy:

Načtení standardu UML 2.4.1 do Enterprise Architecta 9.2

Jak jsem před pár dny slíbil, napsal jsem postup, jak si importovat UML standard 2.4.1 do Enterprise Architecta. Zde překládám všechny jeho kroky.

  1. Je nutné mít Enterprise Architect verze 9.2.
  2. Stáhněte si XMI podobu specifikace, konkrétně tyto soubory:
    1. PrimitiveTypes.xmi
    2. Infrastructure.xmi
    3. Superstructure.xmi
  3. V EA si zvolte balík, do kterého chcete standard importovat.
  4. V kontextovém menu balíku zvolte možnost Import Model from XMI…
  5. Zadejte soubor PrimitiveTypes.xmi (věcí v Options si všímat nemusíte, pokud si s tím chcete pohrát, můžete).
    Dialog Import Package from XMI
  6. Stiskněte tlačítko Import.
  7. Čekejte. Aplikace bude chvíli chroupat, během čehož vytvoří požadované elementy.
  8. Zopakujte kroky 5. až 7. pro soubory Infrastructure.xmi a Superstructure.xmi.
  9. Stiskněte tlačítko Close.

A je hotovo. Ve vybraném balíku máte tři další: PrimitiveTypes, InfrastructureLibrary a UML (což je superstruktura).

Importovaný UML standard

Co importem získáte? Budete mít v modelu všechny třídy včetně vazeb, jejich atributy a metody a umístění v balících. U atributů a metod dostanete krátký popis jejich významu.

Co naopak mít nebudete? Nedostanete hlavně diagramy. Pokud chcete i je, musí bohužel nastoupit ruční práce (ta vaše). Dále nebudete mít základní popis významu tříd, nebudou tam omezení a další.