{"id":1500,"date":"2021-01-12T10:40:00","date_gmt":"2021-01-12T08:40:00","guid":{"rendered":"http:\/\/www.analizatozalezy.pl\/?p=1500"},"modified":"2021-01-12T11:36:47","modified_gmt":"2021-01-12T09:36:47","slug":"fragment-template-dokumentacja-enterprise-architect","status":"publish","type":"post","link":"https:\/\/www.analizatozalezy.pl\/index.php\/2021\/01\/12\/fragment-template-dokumentacja-enterprise-architect\/","title":{"rendered":"Fragment Template – Dokumentacja – Enterprise Architect"},"content":{"rendered":"\n

Cze\u015b\u0107! <\/h2>\n\n\n\n

Stworzenie dokumentacji Word na podstawie repozytorium, czasami wymaga u\u017cycia bardziej zaawansowanych funkcji generowania dokumentacji. Dzisiaj om\u00f3wimy Fragment Template, czyli rozszerzenie funkcji szablon\u00f3w do generowania dokumentacji.<\/p>\n\n\n\n

W tym artykule dowiesz si\u0119:<\/p>\n\n\n\n

  1. Czym jest Fragment Template<\/li>
  2. Jak stosowa\u0107 Fragment Template<\/li>
  3. Jakie mo\u017cliwo\u015bci daje zastosowanie Fragment Template w szablonie<\/li><\/ol>\n\n\n\n

    Je\u017celi nie czyta\u0142e\u015b poprzednich wpis\u00f3w, musisz koniecznie si\u0119 z nimi zapozna\u0107, aby w pe\u0142ni zrozumie\u0107 tre\u015b\u0107 tego artyku\u0142u.
    Poni\u017cej link do wpis\u00f3w.<\/p>\n\n\n\n

    1. Tworzenie szablonu RTF w Enterprise Architect<\/a><\/li>
    2. Generowanie dokumentacji w Enterprise Architect – podstawy<\/a><\/li><\/ol>\n\n\n\n

      Zaawansowany szablon!<\/h2>\n\n\n\n

      Generowanie dokumentacji jest cz\u0119sto ko\u0144cowym krokiem tworzenia modeli w Enterprise Architect. Czasami na podstawie struktury pakiet\u00f3w stworzonego modelu, ci\u0119\u017cko jest wygenerowa\u0107 dokumentacj\u0119, dok\u0142adnie tak\u0105 jak potrzebujemy, poniewa\u017c cz\u0119sto potrzebujemy np. informacji szczeg\u00f3\u0142owych o innych elementach spoza pakietu. W takim wypadku cz\u0119sto zaczynamy stosowa\u0107 nieco bardziej zaawansowane funkcje generatora dokumentacji takie jak filtry, dedykowane zapytania i fragmenty szablonu (Fragment Template ).<\/strong><\/p>\n\n\n\n

      Czym jest Fragment Template?<\/h3>\n\n\n\n

      Wed\u0142ug definicji ze strony Sparx:<\/p>\n\n\n\n


      Fragment Template jest dedykowan\u0105 cz\u0119\u015bci\u0105 raportu i mo\u017ce mie\u0107 odmienne w\u0142asno\u015bci ni\u017c sam szablon (czyli stanowi pod szablon, g\u0142\u00f3wnego szablonu).<\/p>https:\/\/sparxsystems.com\/\u200b<\/strong><\/cite><\/blockquote>\n\n\n\n

      Brzmi troch\u0119 zawile, prawda? Nieco rozwin\u0119 t\u0119 definicj\u0119. Fragment jest cz\u0119\u015bci\u0105 szablonu, pozwalaj\u0105cy na stworzenie pod szablon\u00f3w, kt\u00f3re posiadaj\u0105 oddzieln\u0105 logik\u0119, czyli inne zasady pobierania informacji z repozytorium. Je\u017celi dalej nie jest to dla Ciebie jasne. To poni\u017cej przygotowa\u0142em grafik\u0119, kt\u00f3ra to obrazuje.<\/p>\n\n\n\n

      \"Fragment
      Zobrazowanie poj\u0119cia fragmentu<\/figcaption><\/figure><\/div>\n\n\n\n

      Jakie Fragment Template daje mo\u017cliwo\u015bci?<\/h3>\n\n\n\n

      Fragment template ma du\u017cy wachlarz funkcjonalno\u015bci, kt\u00f3re mo\u017cemy wykorzysta\u0107, do tworzenia dokumentacji. S\u0105 one szersze ni\u017c dla samego szablonu.
      Korzystaj\u0105c z fragment\u00f3w, mo\u017cna zawrze\u0107 w raportach informacje wyodr\u0119bnione za pomoc\u0105 zapyta\u0144 SQL i skrypt\u00f3w. Mo\u017cna tak\u017ce u\u017cy\u0107 Template Selektora, aby wywo\u0142a\u0107 inne fragmenty w zale\u017cno\u015bci od typu elementu, kt\u00f3rego dotyczy raport. Lista funkcji, kt\u00f3re oferuje fragment template jest d\u0142uga. Poni\u017cej lista najwa\u017cniejszych funkcji wyszczeg\u00f3lnionych przez sparx.<\/p>\n\n\n\n

      1. Normal document Template<\/li>
      2. Template Selctor<\/li>
      3. Custom SQL<\/li>
      4. Custom Scripts<\/li>
      5. Document Script<\/li>
      6. Custom XML Script<\/li><\/ol>\n\n\n\n

        Dost\u0119pnych funkcji jest du\u017co. Pytanie, czy wszystkie s\u0105 potrzebne? To zale\u017cy od tego, jak twoje repozytorium jest zbudowane. Je\u017celi struktura repozytorium jest uporz\u0105dkowana, to zapewne nigdy wi\u0119kszo\u015bci z nich nie u\u017cyjesz.<\/p>\n\n\n\n

        Kiedy stosujemy Fragment Template?<\/h3>\n\n\n\n

        Czy zastosowanie Fragment Template jest zawsze niezb\u0119dne? Nie, lecz jest kilka przypadk\u00f3w, kiedy rekomenduje, aby u\u017cy\u0107 tego rozwi\u0105zania, nawet w wypadku prostych szablon\u00f3w. Przy z\u0142o\u017conych szablonach i du\u017cych repozytoriach jest to cz\u0119sto niezb\u0119dne i inaczej nie da si\u0119 osi\u0105gn\u0105\u0107 po\u017c\u0105danego efektu z u\u017cyciem wbudowanego narz\u0119dzia.<\/p>\n\n\n\n

        Niezb\u0119dne jest to w momencie, kiedy tworzymy z\u0142o\u017cone szablony. Przyk\u0142adem mo\u017ce by\u0107 tu szablon przypadk\u00f3w u\u017cycia, gdzie musimy r\u00f3wnie\u017c wy\u015bwietli\u0107 informacj\u0119 o aktorze na podstawie \u0142\u0105cz\u0105cej relacji przypadeku u\u017cycia z aktorem. Nie da si\u0119 tego zrobi\u0107 bezpo\u015brednio w szablonie, poniewa\u017c wy\u015bwietlimy dodatkowo niechciane informacje, jak np. relacje do wymaga\u0144 czy innych przypadk\u00f3w u\u017cycia. Wi\u0119c, w tym przypadku niezb\u0119dne jest u\u017cycie fragmentu i oddzielnej logiki dla filtr\u00f3w.<\/p>\n\n\n\n

        Podstaw\u0105 s\u0105 dla mnie fragmenty, gdy przygotowuje szablony firmowe. Raz dobrze przygotowany zestaw prostych fragment\u00f3w mo\u017ce by\u0107 wielokrotnie wykorzystywany przez r\u00f3\u017cne osoby i dzi\u0119ki temu zachowujemy sp\u00f3jno\u015b\u0107 firmow\u0105 w ramach ca\u0142ej tworzonej dokumentacji.<\/p>\n\n\n\n

        Przydatn\u0105 opcj\u0105 jest skorzystanie z funkcji Template Selector, czyli funkcji, kt\u00f3ra pozwala nam na wywo\u0142ywanie innych fragment\u00f3w wzgl\u0119dem okre\u015blonych element\u00f3w pakietu. U\u017cycie tej funkcji pozwala na automatyzacje procesu tworzenia dokumentacji, oraz ograniczamy liczb\u0119 tworzonych szablon\u00f3w.<\/p>\n\n\n\n

        Praktyczny przyk\u0142ad\u200b<\/h2>\n\n\n\n

        Sporo teorii, ale jak ma si\u0119 ona do praktycznego zastosowania? Zaprezentuj\u0119 to na do\u015b\u0107 prostym zadaniu, wykorzystywanym na wielu szkoleniach. Zadanie to pozwoli prze\u0107wiczy\u0107 osadzanie fragment\u00f3w w szablonach dokumentacji i da Ci szablon przydatny w pracy.<\/p>\n\n\n\n

        Zadanie\u200b<\/h3>\n\n\n\n

        Stw\u00f3rz szablon, kt\u00f3ry pozwoli na wygenerowanie informacji o aktorze powi\u0105zanym przypadkiem u\u017cycia.<\/p>\n\n\n\n

        Rozwi\u0105zanie<\/h3>\n\n\n\n

        Zanim zaczniemy planowa\u0107, sprawd\u017amy jak wygl\u0105da model w repozytorium.<\/p>\n\n\n\n

        \"Fragment
        Widok repozytorium i relacji przypadki u\u017cycia<\/figcaption><\/figure><\/div>\n\n\n\n

        Celem zadania jest wy\u015bwietlenie informacji o aktorach powi\u0105zanych z przypadkiem u\u017cycia. Jak wida\u0107, conamniej jeden z przypadk\u00f3w u\u017cycia posiada relacje do innych element\u00f3w ni\u017c aktorzy. Ten przypadek posiada relacj\u0119, r\u00f3wnie\u017c do wymaga\u0144. Przegl\u0105daj\u0105c, reszt\u0119 repozytorium stwierdzam, \u017ce ta zasada dotyczy wszystkich przypadk\u00f3w.<\/p>\n\n\n\n

        Plan<\/h4>\n\n\n\n

        Na podstawie mojej wiedzy o budowaniu szablon\u00f3w wiem, \u017ce potrzebuj\u0119 1 szablonu i 2 fragment\u00f3w.
        Szablon jest potrzebny, poniewa\u017c musz\u0119 wy\u015bwietli\u0107 pewien zakres danych o przypadku u\u017cycia oraz musz\u0119 mie\u0107 miejsce do osadzenia fragmentu.<\/p>\n\n\n\n

        Fragment nr 1 pozwoli mi na pobranie wszelkich element\u00f3w, b\u0119d\u0105cych w relacji z przypadkiem u\u017cycia.
        We fragmencie nr 2 ustawi\u0119 filtr, aby wy\u015bwietlane by\u0142y tylko i wy\u0142\u0105cznie: elementy o typie actor i osadz\u0119 go we Fragmencie nr 1. Do pracy!<\/p>\n\n\n\n

        Przygotowanie szablonu i fragment\u00f3w<\/h4>\n\n\n\n

        Przygotowa\u0142em nagranie, w kt\u00f3rym przygotowuje i omawiam proces stworzenia szablonu z zadania. Wykonaj zadanie razem z mn\u0105!<\/p>\n\n\n\n

        \n