Konfiguracja

Moduł Tormigo Integration podczas generowania dokumentacji wykorzystuje API programu Enterprise Architect. Aby uwzględnić diagramy oraz podlinkowane dokumenty (LinkedDocument) w generowanej dokumentacji należy w konfiguracji Tormigo wskazać katalog z instalację Enterprise Architect. Konfigurację Tormigo można wywołać wybierając z menu głównego Plik | Konfiguracja aplikacji. W oknie konfiguracji Tormigo pole „Katalog instalacji programu Enterprise Architect” powinien wskazywać ścieżkę do miejsca instalacji EA.

Zarządzanie projektami

Tormigo Integration pozwala na zdefiniowanie projektów, do których może być przypisane więcej niż jedno repozytorium. Aby wyświetlić listę projektów należy z menu głównego wybrać Integracja | Lista projektów. Na obrazku poniżej zostało przedstawione przykładowe okno Lista projektów.

Zaznaczenie projektu na liście i wybranie przycisku „Pokaż” spowoduje wyświetlenie okna do obsługi projektu. Pozwala ono na zdefiniowanie parametrów projektu, wygenerowanie dokumentacji oraz skanowanie dokumentacji w poszukiwaniu uwag do projektu.

Aby zdefiniować nowy projekt należy skorzystać z przycisku „Dodaj”, którego kliknięcie spowoduje wyświetlenie okna definiowania projektu. W oknie tym należy ustawić podstawowe parametry projektu takie jak: kod, tytuł, autorzy, firma, słowa kluczowe, kategoria, temat oraz komentarz. Kod projektu musi być unikatowy w ramach aplikacji Tormigo. Parametry te mogą zostać później wykorzystane w szablonie dokumentacji. Poniżej przedstawiony został przykładowy wygląd okna dla konfiguracji projektu.

W prawej części projektu znajduje się panel pozwalający na zdefiniowanie repozytoriów powiązanych z projektem. Przycisk „+” umożliwia dodanie repozytorium, przycisk „…” pozwala na edycję wybranego repozytorium, a przycisk „-” na jego usunięcie. Przyciski ze strzałkami skierowanymi do góry i do dołu pozwalają na przeniesienie zaznaczonego repozytorium odpowiednio na pozycję o jeden wyższą lub niższą na liście.

Aby dodać nowy projekt skorzystaj z przycisku „+”. Poniżej przedstawiono przykładowy wygląd okna dialogowego pozwalającego na wybranie repozytorium.

W polu nazwa sekcji wprowadź nazwę jaką zostanie oznaczony rozdział rozpoczynający generowanie dokumentacji dla tego repozytorium. Następnie z listy rozwijanej należy wybrać zdefiniowane w programie połączenie do repozytorium. Całość operacji należy zatwierdzić przyciskiem „Zapisz”. Jeżeli brak jest zdefiniowanego połączenia do repozytorium możesz użyć przycisku „Nowy” aby zdefiniować nowe połączenie. Jeżeli istnieje potrzeba edycji już zdefiniowanego połączenia wybierz je z listy rozwijanej, a następnie kliknij przycisk „Edytuj”.

Aby dodać nowe połączenie kliknij przycisk „Nowy”. W otwartym oknie zdefiniuj parametry połączenia do repozytorium. Tormigo, aby wyświetlać w dokumentacji diagramy i dokumenty podłączone (LinkedDocument) wymaga podania w konfiguracji połączenia ścieżki do pliku EAP. Jeżeli korzystasz z repozytorium opartego o DBMS masz możliwość stworzenia pliku EAP ze skrótem połączenia do wybranego repozytorium. Aby tego dokonać otwórz projekt w Enterprise Architect, a następnie wybierz z głównego menu: File | Save Project Shortcut. Następnie wprowadź ścieżkę do tego pliku korzystając z zakładki „Skrót do pliku EAP” w oknie konfiguracji połączenia. Zakładka będzie aktywna tylko w przypadku definiowania połączenia do bazy danych innej niż plik EAP. Poniżej zostało przedstawione okno pozwalające zdefiniować parametry do skrótu w pliku EAP.

Wprowadź także ID użytkownika oraz hasło, jeżeli repozytorium wymaga uwierzytelnienia. Parametry te będą przechowywane w konfiguracji Tormigo. Tormigo wszystkie hasła przechowuje w formie zaszyfrowanej.

Poniżej został przedstawiony przykładowy widok okna konfiguracji projektu, zawierający trzy przypisane repozytoria.

Generowanie dokumentacji

Generowanie dokumentacji dla projektu uruchamia się przez kliknięcie przycisku „Generuj dokumentację” w oknie konfiguracji projektu. Kliknięcie tego przycisku spowoduje wyświetlenie okna generatora dokumentacji. Zawartość wygenerowanego dokumentu MS Word będzie różna w zależności od konfiguracji szablonu oraz rodzaju generowanej dokumentacji. Użytkownik ma możliwość określenia jakie typy elementów będą uwzględnione w dokumentacji.

Opis generatora dokumentacji

Okno generatora dokumentacji pozwala na określenie parametrów dokumentacji oraz wygenerowanie dokumentacji zmiany lub dokumentacji dla wybranych pakietów. W przypadku generowania dokumentacji zmiany aplikacja w ramach dokumentacji zamieści:

· wszystkie pakiety, które w nazwie posiadają kod zmiany,

· wszystkie pakiety, które posiadają przypisany element Maintenace Change, który w nazwie posiada kod zmiany,

· wszystkie elementy, które posiadają przypisany element Maintenace Change, który w nazwie posiada kod zmiany,

· wszystkie diagramy, które w polu Notes posiadają kod zmiany.

Kod zmiany możliwy jest do określenia po uruchomieniu generacji dokumentacji. Domyślnie kod zmiany odpowiada kodowi projektu.

W przypadku generowania dokumentacji dla wybranych pakietów, dla każdego repozytorium użytkownik może wybrać pakiety, które zostaną uwzględnione w dokumentacji.

Poniżej został przedstawiony przykładowy widok z generatora dokumentacji.

Okno generatora dokumentacji podzielone jest na zakładki umożliwiające określenie parametrów szablonu dokumentacji, zawartości dokumentacji oraz przycisków służących do generowania dokumentacji.

Zakładka: Właściwości

Zakładka pozwala na określenie szablonu dokumentacji oraz jego podstawowych parametrów.

Pole Plik szablonu – pozwala na określenie ścieżki do pliku z szablonem dokumentacji.

Pole Numer pierwszego rozdziału – pozwala na określenie wartości pierwszego wygenerowanego rozdziału dokumentacji. Ustawienie wartości na 0 powoduję pominięcie nadawania rozdziałom numerów.

Pole Maksymalny numer nagłówka do użycia w nazwie rozdziału – pozwala na określenie najwyższego numeru stylu, który będzie zastosowany w nazwach kolejnych podrozdziałów.

Panel Szablon – pozwala na otworzenie, zapisanie i usunięcie ustawień szablonu dokumentacji.

Zakładka: Style

Zakładka pozwala zdefiniować nazwy stylów w szablonie. Dla języka obsługiwanego przez Tormigo zostaną wygenerowane domyślne nazwy stylów. Przy każdym definiowaniu szablonu, należy sprawdzić czy szablon zawiera tak zdefiniowane nazwy stylów. W procesie generowania dokumentu próba użycia stylu niezdefiniowanego w szablonie przerwie proces generowania dokumentu z odpowiednim komunikatem. Dodatkowo w zakładce możliwe jest zdefiniowanie dwóch parametrów:

· Użyj stylów nagłówka dla nazw elementów – definiuje czy dla nazw elementów mają być stosowane style nagłówka (z zachowaniem hierarchii podrozdziałów). Pozostawienie tego pola pustego spowoduje, że dla nazwy elementu zostanie użyty styl Element.

· Dodawaj numery rysunków – określa czy generator ma numerować diagramy dodawane do dokumentacji.

Zakładka: Typy elementów do uwzględnienia

Zakładka pozwala na zaznaczenie typów elementów, jakie mają zostać uwzględnione w dokumentacji. Aby typ elementu został uwzględniony musi być zaznaczone pole wyboru przy nazwie typu. Przycisk Zaznacz wszystko spowoduje zaznaczenie wszystkich typów elementów, a przycisk Odznacz wszystko – odpowiednio odznaczenie wszystkich typów elementów.

Zakładka: Zawartość

Zakładka pozwala na określenie, które właściwości elementów i pakietów zostaną wyświetlone w dokumentacji. W zakładce znajdują się trzy panele:

· Właściwości elementów – określa, które właściwości elementów zostaną wyświetlone w dokumentacji,

· Właściwości pakietów – określa, które właściwości pakietów zostaną wyświetlone w dokumentacji,

· Opcje – określa jakie elementy powiązane z pakietami i innymi elementami zostaną wyświetlone w dokumentacji.

Plik szablonu

Dokumentacja generowana jest na podstawie pliku szablonu. Plikiem szablonu jest wstępnie sformatowany dokument MS Word. Dokument musi zawierać klauzulę {doc.Content}, która będzie zamieniona przez wygenerowaną treść. W ramach szablonu można skorzystać z pól zawierających następujące właściwości dokumentu: Title, Author, Company, Keywords, Category, Subject, Comments. Podczas generowania dokumentów pola te zostaną uzupełnione wartościami zdefiniowanymi dla projektu. Użyj w programie MS Word opcji Wstawianie | Tekst | Szybkie części | Właściwości dokumentu | Autor, aby wstawić pole z autorami projektu. Poniżej został zamieszczony przykładowy wycinek szablonu.

Generowanie dokumentacji zmiany

Dokumentacja zmiany zawiera:

· wszystkie pakiety, które w nazwie posiadają kod zmiany,

· wszystkie pakiety, które posiadają przypisany element Maintenace Change, który w nazwie posiada kod zmiany,

· wszystkie elementy, które posiadają przypisany element Maintenace Change, który w nazwie posiada kod zmiany,

· wszystkie diagramy, które w polu Notes posiadają kod zmiany.

Do każdego pakietu i elementu spełniającego te kryteria zostaną także dołączone wszystkie zawarte w nim pakiety i elementy, które będą spełniały filtry określone w generatorze szablonu, jak np. elementy Maintenance.

Generator dokumentacji zmiany przeszukuje po kolei repozytoria przypisane do projektu. W pierwszym kroku poszukuje w repozytorium pakietów, które w nazwie posiadają zawarty kod zmiany (kod projektu). Na przykład jeżeli generator (dla kodu zmiany „PR-DK-01”) znajdzie pakiet o nazwie „Opis projektu PR-DK-01” to dołączy go do generowanego dokumentu oraz wszystkie elementy z jego struktury, które zostały zaznaczone w oknie generatora dokumentacji. W kolejnych krokach system wyszuka pakiety, a później elementy modelu, które mają przypisaną zmianę (Maintenace Change) o nazwie zawierającej kod zmiany. Ostanim krokiem generowania dokumentacji zmiany dla danego repozytorium jest wyszukanie wszytskich diagramów, które w polu Notes także zawierają kod zmiany.

Aby przypisać zmianę Maintenace Change w Enterprise Architect zaznacz w drzewie projektu element, do którego zmiana ma być przypisana. Następnie w oknie Maintenance (ALT + 4) wybierz zakładkę Changes i kliknij ikonę New. W formularzu opsiu zmiany w polu Name umieść kod zmiany (projektu). Nazwę zmiany możesz uzupełnić o krótką informację, czego zmiana dotyczy. Uzupełnij pozostałe pola formularza. Po uzupełnieniu kliknij ikonę Save, aby zapisać zmiany. Poniżej został zamieszczony przykładowy formularz opisujący zmianę wymagania.

Rozpoczęcie generowania dokumentacji zmiany wywoływane jest przyciskiem „Generuj dokumentację zmiany” w oknie generatora dokumentacji. Aplikacja wyświetli okno dialogowe z prośbą o wprowadzenie kodu zmiany w projekcie. Domyślną wartością kodu zmiany jest kod projektu.

Po naciśnięciu przycisku OK zostanie uruchomiona operacja generowania dokumentacji. Poniżej został przedstawiony fragment wygenerowanej dokumentacji, zawierający wycinek z dokumentacji:

· pakietu zawierającego w nazwie kod zmiany,

· wymagania do którego została przypisana zmiana Maintenance Change z nazwą zawierającą kod zmiany.

Generowanie dokumentacji wybranych pakietów

Generowanie dokumentacji dla wybranych pakietów odbywa się przez kliknięcie przycisku „Generuj dokumentację pakietów” w oknie generatora dokumentacji. Po uruchomieniu generatora użytkownik ma możliwość wskazania pakietów, które zostaną uwzględnione w dokumentacji.

Zaznaczenie opcji „Wstaw repozytorium jako nową sekcję w dokumencie” spowoduje dodanie oddzielnego podrozdziału dla każdego repozytorium.

Kliknięcie przycisku OK spowoduje rozpoczęcie generowania dokumentacji. W wygenerowanym dokumencie zostaną zawarte wszystkie zaznaczone pakiety wraz z zamieszczonymi w nich elementami i diagramami. Poniżej został zamieszczony wycinek dokumentacji dla wybranych pakietów.

Filmy DEMO

FILM 1

Na filmie zostało przedstawione jak za pomocą Tormigo można zarządzać projektami, na które składają się jeden lub więcej repozytoriów Enterprise Architect. Zobaczysz jak skonfigurować Tormigo aby mógł odczytywać diagramy z repozytorium korzystając z API Enterprise Architect, jak zdefiniować nowy projekt w Tormigo oraz jak powiązać projekt z repozytoriami Enterprise Architecta.

FILM 2

Na filmie zostało przedstawione jak przygotować w MS Word plik szablonu, który będzie można wykorzystać w Tormigo do wygenerowania dokumentacji projektu. Zobaczysz jak szybko i prosto można stworzyć plik szablonu, jakich parametrów możesz w nim użyć, jak skonfigurować szablon z poziomu Tormigo oraz jak zapisać utworzony szablon do późniejszego wykorzystania.

FILM3

Na filmie zostało przedstawione jak wygenerować dokumentację zmiany w projekcie. Zobaczysz w jaki sposób opisywać zmiany w projekcie aby zostały uwzględnione w dokumentacji, jak uruchomić generowanie dokumentacji zmiany oraz przykładową zawartość dokumentu. Dokumentacja generowana jest dla wcześniej zdefiniowanego projektu FILM 1 z wykorzystaniem przygotowanego szablonu FILM 2

FILM4

Na filmie zostało przedstawione jak wygenerować dokumentację dla wybranych pakietów w projekcie. Zobaczysz jak uruchomić generowanie dokumentacji pakietów, jak wybrać pakiety, które mają zostać uwzględnione w dokumencie oraz przykładową zawartość wygenerowanej dokumentacji. Dokumentacja generowana jest dla wcześniej zdefiniowanego projektu FILM3 z wykorzystaniem przygotowanego szablonu FILM2.

We are pleased to inform you that MANEA – a plugin allowing for synchronization of entries from MANTIS Bug Tracker with Enterprise Architect has been updated.
I would like to remind that MANEA is the plugin to MANTIS BUG TRACKER that allows for two-way synchronization of selected entries from the MANTIS BT system with the requirements repository contained in Enterprise Architect.
We are pleased to inform you that currently the plugin is used by dozens of companies around the world.

MANEA in 1.28 version means, above all, the possibility to work with 1.28 version of MANTIS Bug Tracker – current stable version of this tool.
In the new version, we have removed some minor bugs. Moreover, we have simplified the possibility of using the demo version. Now you do not have to register to use demo version of our plugin. All you have to do is to download the demo files and key. Instructions for downloading and activating the demo version may be downloaded from http://manea.modesto.pl/downloads/
On the occasion of the update, you can buy MANEA for 100$ (net) till the end of 2011. Orders for the special price can be placed on the platform http://takeit.modesto.pl/en/manea/207-manea.html

If you define requirements in Enterprise Architect and you like to work under Linux, use Tormigo. Tormigo works under Windows and Linux platforms. Tormigo does not allow for modeling, but you can:

• load requirements directly from OpenOffice
• create the content of new requirement or modify the existing one
• create use cases
• save use cases scenarios
• assign requirements to use cases
• create many advanced reports

Check out our 30 days free TORMIGO version. Free download.

Since TORMIGO was published as an official Plugin for Enterprise Architect

http://sparxsystems.com.au/products/3rdparty.html#tormigo

each purchase of Tormigo will be awarded with a 12% discount for the purchase of Enterprise Architect.

The promotion will last from April 1^st until April 30^th and it will affect the purchase of new licenses and extension of the existing ones.

Each purchaser of Tormigo will receive a discount code, which can be then used while ordering an Enterprise Architect license.

You can order TORMIGO and Enterprise Architect on: takeit.modesto.pl

Tormigo has been officially registered in the website of Sparx Systems as an Enterprise Architect’s support program.
http://sparxsystems.com.au/products/3rdparty.html#tormigo

Tormigo is the competition for RaQuest in the field of requirement management. Aside from traditional entering of requirements, Tormigo enables recording data directly from MS Word and OpenOffice. In addition, Tormigo operates in Linux environments. What is more, Tormigo allows managing requirements through a system versioning them with each change. The mechanism of attributing requirements to instances of use improves the comfort and effectivenss of work of analysts and designers. Finally, I wish to emphasize that Tormigo is compatible with Enterprise Architect 9.

Tormigo also enables direct introduction of requirements into Enterprise Architect.

When managing requirements, often the problem is the versioning and tracing changes in requirements. This problem is also present in Enterprise Architect. Tormigo – an application I thought up – helps manage this procedure. It not only versioning automatically, but also stores copies of the previous versions. Below, please find a clip presenting this functionality.

If the screen is too small, click your right mouse button on the clip and select Toggle Fullscreen. You may also select the clip-resizing button on the right side in the bottom.

Aside from acquisition of requirements, Tormigo additionally allows efficient mapping of requirements for use cases. The advantage of this application is that it helps automatically make traceabilty between requirements and use cases or another requirement.

Below, please find a clip presenting this functionality.

The most important feature of Tormigo is the possibility of acquiring requirements directly from a text document. Open Office has been chosen as a text document as it opens popular file formats, including doc and docx. In addition, Open Office operates in Linux.

The acquired requirements are entered directly into the Enterprise Architect’s repository.

Only now, on the occasion of Tormigo premiere, we are giving you a discount on the products offered in our store: takeit.modesto.pl

TORMIGO: 20% discount till the end of March 2011

MANEA: 20% discount till the end of March 2011

Software of Sparx Systems Company (Enterprise Architect and other) 8% discount till the end of March 2011

In order to obtain a discount, type:

happytormigo – 20% discount till the end of March 2011 on TOMRIGO and MANEA

ea8 -  8% discount till the end of March 2011

You can use it in the summary tab, when you will ordering product.

Only now, on the occasion of Tormigo premiere, we are giving you a discount on the products offered in our store: takeit.modesto.pl

TORMIGO: 20% discount till the end of March 2011

MANEA: 20% discount till the end of March 2011

Software of Sparx Systems Company (Enterprise Architect and other) 8% discount till the end of March 2011

In order to obtain a discount, type:

happytormigo – 20% discount till the end of March 2011 on TOMRIGO and MANEA

ea8 -  8% discount till the end of March 2011

You can use it in the summary tab, when you will ordering product.

I am pleased to announce that our CASE STUDY concerning our cooperation with PIAP was published on the websites of Sparx Systems community. A link to the Case Study: http://community.sparxsystems.com/casestudies/engineering/architecture-and-interfaces-management-proteus-system-case-study.

Apart from Enterprise Architect, we also used our Tormigo application during the project.

I am pleased to announce that our CASE STUDY concerning our cooperation with PIAP was published on the websites of Sparx Systems community. A link to the Case Study: http://community.sparxsystems.com/casestudies/engineering/architecture-and-interfaces-management-proteus-system-case-study.

Apart from Enterprise Architect, we also used our Tormigo application during the project.

The most important feature of Tormigo is the possibility of acquiring requirements directly from a text document. Open Office has been chosen as a text document as it opens popular file formats, including doc and docx. In addition, Open Office operates in Linux.

The acquired requirements are entered directly into the Enterprise Architect’s repository.