Dokumentacja kompilacji źródeł aplikacji 1.0

Transkrypt

1 Projekt dofinansowany ze środków Mechanizmu Finansowego Europejskiego Obszaru Gospodarczego Dokumentacja kompilacji źródeł aplikacji Projekt: Wypracowanie i wdrożenie innowacyjnych metod integracji danych katastralnych, mapy zasadniczej i Bazy Danych Topograficznych oraz modernizacja usług publicznych świadczonych przez służbę geodezyjną i kartograficzną. Opis Dokumentu Stworzony dla: Podstawa prawna: Nazwa skrócona: Samorząd Województwa Mazowieckiego CA/1147/U/2010 DKS, Dokumentacja Kompilacji Źródeł aplikacji, Dokumentacja instalacyjna, RD: 5627 Ostatnia modyfikacja: :27:00 Autorzy: Konsorcjum: Maciej Kanik i Liczba stron: 9 Status dokumentu: Do użytku Zamawiającego

2 Spis treści 1 WSTĘP Cel dokumentu Wykorzystane materiały DOKUMENTACJA KODU ŹRÓDŁOWEGO Zastosowane narzędzia programistyczne i biblioteki Protokoły transmisji danych Formaty plików INSTRUKCJA KOMPILACJI I PRZYGOTOWANIA WERSJI INSTALACYJNEJ SYSTEMU Kompilacja Wygenerowane wersje instalacyjne OGÓLNA STRUKTURA KODU ŹRÓDŁOWEGO Katalog "comarchgis-desktop" Katalog "comarchgis-commons" Katalog "comarchgis-services"... 9 Strona 2 z 9

3 Historia zmian Wersja Data Zmieniający Rozdział Zakres zmian Maciej Kanik Wszystkie Utworzenie i uzupełnienie dokumentu Maciej Kanik, Arkadiusz Zagrodnik Wszystkie Weryfikacja, uzupełnienie instrukcji

4 1 WSTĘP Niniejszy dokument stanowi dokumentację deweloperską opisującą poszczególne kroki budowania wersji instalacyjnej aplikacji powiatowej MazoviaGIS oraz aplikacji MazoviaGIS w wersji dla urzędu wojewódzkiego. 1.1 Cel dokumentu Celem dokumentu jest szczegółowe opisanie kodów źródłowych systemu oraz narzędzi wykorzystywanych do wytworzenia systemu. 1.2 Wykorzystane materiały Treść dokumentu została opracowana na podstawie wytworzonych kodów źródłowych systemu oraz konfiguracji środowiska developerskiego wykorzystywanego w trakcie projektowania i implementacji systemu przez Wykonawcę. Strona 4 z 9

5 2 DOKUMENTACJA KODU ŹRÓDŁOWEGO 2.1 Zastosowane narzędzia programistyczne i biblioteki W trakcie wykorzystania systemu, Wykonawca korzystał z następujących narzędzi deweloperskich Eclipse IDE for Java EE Developers Indigo Packages NetBeans IDE 7.0.1, Wykorzystana do budowania Usług internetowych (Web Service) Java SE Development Kit 6 Update 24 Apache Maven Dodatkowo wykorzystane zostały następujące biblioteki I frameworki: Hibernate Hibernate Spatial Slf4j Protokoły transmisji danych Wykorzystywane są następujące protokoły transmisji danych: HTTP (dostęp do usług), HTTPS (dostęp do usług), JDBC (dostęp do bazy danych). 2.3 Formaty plików.xml konfiguracja wewnętrzna.java kody źródłowe systemu.properties konfiguracja dodatkowa.js kody źródłowe skryptów JavaScript.png,.jpg,.gif zasoby graficzne.sql skrypty bazy danych.pck pakiety bazy danych pozostałe konfiguracja środowiska developerskiego Eclipse Strona 5 z 9

6 3 INSTRUKCJA KOMPILACJI I PRZYGOTOWANIA WERSJI INSTALACYJNEJ SYSTEMU Do skompilowania systemu wykorzystywane jest narzędzie Apache Maven 3 (Dostępną pod adresem Kompilacja Aby skompilować całość systemu należy: 1. Dodać do zmiennych środowiskowych PATH lokalizację do MAVEN np. (ścieżka\maven\bin\) 2. Utworzyć w katalogu użytkownika folder.m2 (Windows 7 np. <driver>\users\<użytkownik>\.m2 ) oraz dodać do tego folderu plik settings.xml, który powinien posiadać następujący wpis: <?xml version="" encoding="utf-8"?> <settings xmlns=" </settings> xmlns:xsi=" xsi:schemalocation=" <servers> <server> </servers> </server> <id>remote.comarchgis.co383</id> <username>ro</username> <password>readonly12#$</password> 3. Następnie przejść do katalogu głównego projektu i wykonać następujące polecenia: a. Wyczyszczenie wygenerowanych jar: mvn -P bgwm,build clean b. Budowanie wersji instalacyjnej: mvn -P bgwm,build - DSVN_REVISION=13596 install (DSVN_REVISION oznacza numer wersji źródeł przekazanych przez firmę Comarch. Wersja będzie aktualizowana w ramach przekazywania kolejnych źródeł.) Budowanie powinno zakończyć się informacją [INFO] BUILD SUCCESS Strona 6 z 9

7 UWAGI PRZY PIERWSZYM BUDOWANIU: 1. Może wystąpić sytuacja uniemożliwiająca pobrania źródeł z repozytorium, które może zakończyć się błędem. W tym celu wymagane jest ponowne wywołanie budowania jak w dziale 3 Punkt 3.1 Podpunkt 3.b. 2. Na środowisku, na którym aplikacja nie była jeszcze budowana proces pobierania i budowania może trwać dłuższy czas. Jest to uzależnione od prędkości połączenia sieciowego. 3.2 Wygenerowane wersje instalacyjne Po poprawnym zbudowaniu projektu możemy rozpocząć instalację systemu dostępną w lokalizacji: Dla części powiatowej : scieżka\comarchgis\comarchgis-build\comarchgis-buildpow\installer\target\mazoviagis-pow _setup.exe Dla części Wojewódzkiej: scieżka\comarchgis\comarchgis-build\comarchgis-buildwoj\installer\target\mazoviagis-woj _setup.exe Strona 7 z 9

8 4 OGÓLNA STRUKTURA KODU ŹRÓDŁOWEGO Ogólna struktura kodów źródłowych składa się z następujących elementów: comarchgis-desktop (główny moduł aplikacji), comarchgis-commons (elementy wspólne), comarchgis-services (usługi web service). 4.1 Katalog "comarchgis-desktop" Część desktopowa aplikacji. Znajdują się tutaj elementy aplikacji bazowej oraz rozszerzenia dedykowane: Wspólne: o comarchgis-core-cms\ o comarchgis-core-deegree\ o comarchgis-core-icons\ o comarchgis-core-jaxe\ o comarchgis-core-model\ o comarchgis-core-saig\ o comarchgis-ext-administration\ o comarchgis-ext-authentication\ o comarchgis-ext-bgwm\ o comarchgis-ext-impexp\ o comarchgis-ext-kontrole\ o comarchgis-ext-konwerter\ o comarchgis-ext-mapowanie\ o comarchgis-ext-swde\ o comarchgis-lib-bgwm-gml\ o comarchgis-lib-core-crs\ o comarchgis-lib-core-dxf\ o comarchgis-lib-core-lang\ o comarchgis-lib-core-shp\ o comarchgis-lib-core-tiff\ o comarchgis-model-bgwm\ Dla części powiatowej: o comarchgis-ext-egib\ Strona 8 z 9

9 o comarchgis-ext-gesut\ o comarchgis-ext-mz\ o comarchgis-ext-podgik\ o comarchgis-ext-rciwn\ o comarchgis-ext-sog\ Dla części wojewódzkiej: o comarchgis-ext-bdot\ 4.2 Katalog "comarchgis-commons" Moduły wspólne dla części desktopowej i usług sieciowych. Znajdują się tu projekty: comarchgis-security\ comarchgis-version\ 4.3 Katalog "comarchgis-services" Usługi sieciowe (web serwisy): Wspólne: o comarchgis-ws-buffer\ o comarchgis-ws-cmc\ o comarchgis-ws-docs\ o comarchgis-ws-ldap\ o comarchgis-ws-reportsmanager\ o comarchgis-ws-sts\ o comarchgis-ws-interoperacyjnosc\ o comarchgis-ws-zbdbdot\ Dla części powiatowej: o comarchgis-ws-egb\ o comarchgis-ws-podgik\ o comarchgis-ws-rass\ o comarchgis-ws-sog\ Strona 9 z 9