Magnus Karge, Knut Sælid

Transkript

1 kartverk Sjø Kartverket Prosedyre Versjon: 0.8 Gjelder fra: Utarbeidet av: Magnus Karge, Knut Sælid Godkjent av: Sidenr: 1 av 31 Statens Innhold 1. Introduksjon Forutsetninger Uttrykk og begreper Nødvendig programvare Nedlasting og installasjon av nødvendig programvare Enterprise Architect Collabnet subversion ShapeChange Sjekke ut en initiell versjon av SOSI objektkatalog fra SVN Lese- og skrivetilgang i SVN Konfigurere en arbeidsmappe Konfigurasjon ved hjelp av kommandobasert klient Konfigurere EnterpriseArchitect Konfigurere SVN-server tilgang Importere SVN-pakker Konfigurere ShapeChange plugin Finne ut om Java 6 er installert Installere Java Koble ShapeChange mot Java Sette opp standard SOSI dokumentasjonsmal Nedlasting Konfigurasjon Arbeide mot SVN repository Check out Angre check out Legge til en ny pakke... 31

2 kartverk Sjø Side:2 av 31 Statens 9.4 Check in... 31

3 kartverk Sjø Side:3 av 31 Statens 1. Introduksjon For å lage UML-modeller til bruk i, må man ha installert en del programvare. I utgangspunktet kan man bruke en rekke forskjellige applikasjoner og programmer til dette formålet, men for at det skal være enklest mulig å samordne opplæring og konfigurasjon, anbefales det å benytte et standard sett av programvare. Dette dokumentet er en veileder om hvilken programvare man bør installere for å kunne arbeide med UML-modeller i. Dokumentet beskriver også nødvendig konfigurasjon av denne programvaren. 2. Forutsetninger Beskrivelsene forutsetter at du benytter norsk versjon av Windows 7 operativsystem, men det vil trolig være nokså likt i andre versjoner av Windows også. Hvis du bruker andre versjoner av programvaren kan du kontakte Norge digitalt for å avtale veiledning. For å lage dokumentasjon som beskrevet i dokumentet Veileder for å lage informasjonsmodellen i en produktspesifikasjon som et utplukk av objekttyper fra fagområdene i SOSI del 2, må norsk versjon av Microsoft Office Word 2007 eller nyere være installert. 3. Uttrykk og begreper EA = Enterprise Architect. Programvare for UML modellering. SVN = Subversion versjonskontrollsystem. Programvare som gjør det mulig å lagre versjoner av datafiler på en sentral server, og samtidig organisere endringer i datafilene uten at det blir konflikt mellom brukere som eventuelt endrer samtidig. Repository = sentralt lagringssted, i denne sammenhengen for datafiler som skal håndteres via SVN. 4. Nødvendig programvare a) Enterprise Architect - UML modelleringsverktøy b) Collabnet Subversion SVN klient c) ShapeChange eksportverktøy UML GML

4 kartverk Sjø Side:4 av 31 Statens 5. Nedlasting og installasjon av nødvendig programvare 5.1 Enterprise Architect Enterprise Architect lastes ned fra Resten av dette dokumentet forutsetter at du installerer Enterprise Architect i henhold til forslagene som foreslås i installasjonsveiledningen som følger med Enterprise Architect før du går videre. Denne leder deg gjennom installasjonen trinn for trinn der du må akseptere lisensbetingelsene, oppgi brukernavn og lignende, angi installasjonssted etc. Det finnes flere versjoner tilgjengelig av EA. Mange benytter versjon 8, men de andre versjonene bør også gå fint å benytte. Det kan dog være noen variasjoner i skjermbilder mellom ulike versjonsnummer. 5.2 Collabnet subversion Collabnet subversion lastes ned fra Last kun ned den kommandolinjebaserte SVN klienten. Du kan velge den helt enkle versjonen på ca 13 MB. OBS! Du må registrere deg på en webside for å laste ned. Websiden for registrering er kresen på innhold i feltene. Pass på at passord inneholder minst 8 tegn og både tall, små bokstaver og store bokstaver. Andre tegn er ikke tillatt. Pass også på at Subversion er valgt som produkt fra nedtrekkslista:

5 kartverk Sjø Side:5 av 31 Statens Etter nedlasting er det bare å installere SVN-klienten som en vanlig Windows installasjon ved å følge installasjonsveiledningen som følger med Collabnet. Resten av dette dokumentet forutsetter at du gjør dette før du går videre.

6 kartverk Sjø Side:6 av 31 Statens 5.3 ShapeChange ShapeChange lastes ned fra Klikk på linken Nedlasting av installasjon (versjon 1.0). Etter nedlasting går du til katalogen hvor du har valgt å legge den nedlastede zip-filen, f.eks C:\Users\<brukernavn>\Downloads.

7 kartverk Sjø Side:7 av 31 Statens Dobbeltklikk på zip-filen. Da vises innholdet i et nytt vindu. Dobbeltklikk på filen setup.exe Klikk på Next

8 kartverk Sjø Side:8 av 31 Statens Velg installasjonssted og klikk på Next. Klikk på Next.

9 kartverk Sjø Side:9 av 31 Statens Når installasjonen er ferdig vil du få opp dette vinduet. Klikk på Close. Restart Enterprise Architect. Dermed er all nødvendig programvare installert. 6. Sjekke ut en initiell versjon av SOSI objektkatalog fra SVN 6.1 Lese- og skrivetilgang i SVN SOSI subversion repository-et på SVN-serveren til Kartverket er passordbeskyttet, men alle har lesetilgang via standardbrukernavn og -passord sosi. De som er editor for et fagområde og/eller ønsker å lagre egne UML-modeller for på SVN-serveren må ha skrivetilgang. Ta kontakt med Magnus Karge (magnus.karge@kartverket.no) i SOSI sekretariatet og angi hvilket fagområde du er editor for eller hvilken produktspesifikasjon du vil jobbe med, så får du tildelt eget brukernavn og passord.

10 Side:10 av 31 State Er det første gang at en etat/et institutt bestemmer seg for å lagre egne produktspesifikasjons-umlmodeller på Kartverkets SVN-server, må også SOSI sekretariatet kontaktes slik at nødvendige konfigurasjoner på serveren kan foretas. 7. Konfigurere en arbeidsmappe 7.1 Konfigurasjon ved hjelp av kommandobasert klient Nødvendig forarbeid: 1. Sjekk at ikke mappen C:\SOSI finnes fra før. 2. Hvis mappen C:\SOSI finnes fra før slett den. 3. Opprett mappen C:\SOSI Da er du klar til å konfigurere arbeidsmappen C:\SOSI hvor SVN skal legge alle nødvendige datafiler som du skal bruke fra Enterprise Architect. NB! Du må aldri lagre noen andre filer i mappen C:\SOSI - den er forbeholdt filer som SVN benytter og dette gjøres alltid automatisk avi SVN-klienten. I. Åpne kommandovinduet ved å trykke Windows tasten + R. II. Skriv cmd og trykk Enter eller klikk på OK. Da åpnes et terminalvindu.

11 Side:11 av 31 State III. Sjekk ut SOSI modellen ved å skrive inn følgende kommando i terminalvinduet: NB! URLen er case-sensitiv, store og små bokstaver må angis korrekt. Den siste delen i URLen ( SOSI ) må skrives med store bokstaver! svn co C:\SOSI IV. Nå må brukernavn og passord oppgis. Bruk enten standardbrukernavn og -passord ( sosi ) som gir lesetilgang, eller eget brukernavn og passord som du har fått tildelt fra SOSI sekretariatet. Etter utsjekk skal alle filene være lastet ned som en lokal kopi til din lokale arbeidsmappe (C:\SOSI).

12 Side:12 av 31 State V. Ferdig med den initielle utsjekkingen!

13 Side:13 av 31 State 8. Konfigurere EnterpriseArchitect Åpne Enterprise Architect. Du vil da få opp et vindu som ser noe slikt ut. Dersom du får spørsmål om du vil lage et nytt prosjekt, et nytt view eller noe annet, svar nei og lukk alle pop-up vinduer som måtte komme frem. Lag et nytt prosjekt ved å velge File -> New project fra hovedmenyen på øverste linje.

14 Du får da opp et vindu der du skal angi navn på prosjektet. Pass på at filtypen er.eap og klikk deretter på Save. Side:14 av 31 State Deretter kommer det opp et popup-vindu hvor du skal klikke på Cancel.

15 Side:15 av 31 State Du vil da ha et vindu i EA som ser noe slikt ut: I høyre side av vinduet finner du prosjektutforskeren, på engelsk kalt Project browser. Dette er en arbeidsflate du vil bruke mye i de neste stegene. Det er mulig å flytte prosjektutforskeren rundt i skjermbildet hvis du vil ha den et annet sted. Ved å høyreklikke øverst (på den grå linja) i prosjektutforskeren kan du velge mellom Floating og Docking. Floating lar deg plassere prosjektutforskeren hvor du vil på skjermen, mens Docking låser prosjektutforskeren på angitt sted. Det får være opp til hver enkelt hvor man vil plassere prosjektutforskeren, men i dette dokumentet refereres det til prosjektutforskeren slik den er plassert på høyre side som i skjermbildet over. 8.1 Konfigurere SVN-server tilgang Etter å ha åpnet prosjektfilen i EA (som du opprettet i starten av dette kapittelet), velg fra hovedmenyen øverst Project -> Version Control -> Version Control Settings. Avhengig av hvordan EA har blitt satt opp, kan det hende at noen ikke har opsjonen Version Control. I dette tilfellet kan denne slås på i menyen for Toolbar Options (se bildet nedenfor).

16 Side:16 av 31 State I menyen Version Control Settings skriver du inn SOSI som Unique ID og kontrollerer at Working Copy Path er C:\SOSI. Endre til dette om nødvendig. Overta konfigurasjonen fra bildet nedenfor og erstatt Subversion Exe Path med stien til exe-filen til den kommandobaserte SVN-klienten på disken din. Klikk så Save og deretter Close. 8.2 Importere SVN-pakker Høyreklikk på ønsket mappe i prosjektutforskeren i EA velg så Package Control og Get Package. Velg nå SOSI under Version Control Configuration.

17 Side:17 av 31 State Nå kan man velge mellom diverse enkeltpakker (SOSI fagområder), hele SOSI Del 1 ( SOSI Generelle Konsepter.xml ), SOSI Del 2 ( SOSI Generell objektkatalog_v4.xml ), SOSI Del 3 ( SOSI Produktspesifikasjoner.xml ) eller alle SOSI modellene ( SOSI Model.xml ). Ved førstegangs import anbefales det å velge SOSI Model.xml. I tilfellet meldingen nedenfor vises, velg No. Etterpå høyreklikker man på en av de importerte pakkene og velger Package Control og Get All Latest. På meldingen nedenfor gjør man ingen forandringer og klikker på OK. Nå importeres alle pakkene med filer fra SVN, dette kan ta 5 10 minutter når man gjør det for første gang. 8.3 Konfigurere ShapeChange plugin For å få ShapeChange til å fungere i Enterprise Architect (som i øyeblikket kun finnes i 32-bits versjon) må den konfigureres mot en Java 32-bits versjon. I praksis vil dette si Java 6 1. Nedenfor beskrives hvordan dette gjøres. 1 Java 7 finnes også i 32-bits versjon, men det kan være forvirrende å ha 2 ulike Java 7 installasjoner på samme maskin. Dessuten har vi ikke testet Java 7 i 32-bits versjon tilstrekkelig enda

18 Side:18 av 31 State Finne ut om Java 6 er installert Åpne utforskeren og gå til katalogen C:\Program Files (x86)\java og deretter til C:\Program Files\Java. Hvis du i en av disse katalogene har en katalog som heter jre6, åpne den og sjekk at innholdet ser slik ut: Hvis du ikke har katalogen jre6 må du installere Java 6. Gå da til neste kapittel ( Installere java 6 ) Installere Java 6 Gå til og last ned Java 6 32 bits versjonen ved å klikke på Windows Offline (32 bit) linken i listen over ulike versjoner. Når nedlastingen er ferdig starter du installasjonen og følger anvisningene i installasjonsveiledningen som følger med og vises på skjermen underveis. Husk å velge installasjonssted C:\Program Files (x86)\java når du blir spurt om dette. Når installasjonen er ferdig sjekker du at katalogen jre6 finnes under C:\Program Files (x86)\java som beskrevet i kapittelet over ( Finne ut om Java 6 er installert ) Koble ShapeChange mot Java 6 Marker applikasjonsskjemapakken din som vist under.

19 Side:19 av 31 State Applikasjonsskjemapakke som markeres ved å klikke 1 gang på den. Velg deretter Add-Ins -> ShapeChange -> Generer GML (i nyere EA-versjoner heter menyvalget Extensions ) fra hovedmenyen øverst. Da åpner det seg et pop-up vindu:

20 Side:20 av 31 State Klikk på Innstillinger. Et nytt pop-up vindu åpner seg: Her må du skrive/kopiere inn stien til din installerte Java 6 versjon (se skjermbildeeksempelet over for eksempel på en vanlig stiangivelse). Vær oppmerksom på at du må ha med angivelse til filen java.exe i slutten av stien. Velg Lagre. Lukk pop-up vinduet.

21 Side:21 av 31 State Da skal ShapeChange være konfigurert til å benytte den Java-versjonen du skrev inn i pop-up vinduet og som skal være en 32-bits versjon. Hvis det oppstår problemer med at ShapeChange ikke klarer å generer GML, må du sjekke at stien til Java er skrevet helt korrekt og peker til mappen der filen java.exe i 32-bits versjon faktisk ligger. For å kontrollere/endre dette, gjentar du trinnene i dette delkapitlet ( Konfigurere ShapeChange plugin. 8.4 Sette opp standard SOSI dokumentasjonsmal I dette kapittelet beskrives nedlasting og konfigurasjon av standard SOSI.rtf-mal for å lage produktspesifikasjonen i henhold til denne standarden Nedlasting Gå til el_2_oktober/ Klikk på SOSI UML-template - linken og velg å lagre filen et egnet sted på lokal maskin (men ikke i mappen C:\SOSI) NB! Det er viktig at du velger å lagre filen i formatet.rtf - velg filtype fra listen i lagringsvinduet som vist under.

22 Side:22 av 31 State Klikk Lagre. Dermed er malen lagret i korrekt format Konfigurasjon Starte Enterprise Architect hvis den ikke allerede er startet. Åpne et ønsket prosjekt eller opprett et nytt prosjekt. Høyreklikk på applikasjonsskjemapakken og velg Documentation -> Rich Text Format (RTF) Report som vist under:

23 Side:23 av 31 State Et nytt vindu åpner seg:

24 Side:24 av 31 State Vel g så fanen Templates og klikk deretter på New. Skriv inn det angitte navnet på rapportmalen i popup-vinduet som dukker opp:

25 Side:25 av 31 State La valget Copy template være satt til None og klikk OK. Et nytt vindu som heter Document Template Editor dukker opp:

26 Side:26 av 31 State I Document Template Editor, velg fra hovedmenyen på øverste linje File -> Import Utforskeren din dukker opp og du navigerer deg frem til den tidligere nedlastede SOSI-malen som heter SOSI_UML_template a.rtf:

27 Side:27 av 31 State Marker filen og klikk Open. Den importerte malen vises da i Document Template Editor :

28 Side:28 av 31 State Lukk Document Template Editor. Det er mulig du får spørsmål om å lagre endringer i malen. Svar da Yes. Lukk også det gjenværende vinduet (vist under).

29 Side:29 av 31 State Klikk på Close. Ferdig! SOSI-malen er installert og klar til bruk. 9. Arbeide mot SVN repository Du er nå ferdig med all installasjon og konfigurasjon av nødvendig programvare for arbeid med! For oversiktens skyld, gis det i dette kapittelet en kort innføring i hvordan du bruker det sentrale lageret for UML-modeller (SVN-repository). Kapittelet gir en generell beskrivelse av hvordan man sjekker ut og sjekker inn pakker og/eller filer i SVN-repository. Dokumentet Løype for utarbeidelse av informasjonsmodellen (UML modellering) på gir en detaljert beskrivelse av denne prosessen relatert til konkrete eksempler.

30 Side:30 av 31 State For å oppdatere pakkene i EA-prosjektet, høyreklikk på en vilkårlig pakke i prosjektutforskeren og velg så Package Control og Get All Latest. Nå lastes alle pakkene fra repository-et som foreligger der i en nyere versjon. Skal bare én pakke oppdateres, høyreklikk på vedkommende pakke og velg Package Control og Get Latest. NB! For å editere en pakke, legge til nye pakker eller annet, må den ønskede pakken først utsjekkes. Slike operasjoner krever at SVN-brukeren din har rettigheter til dette. Standardbrukeren sosi har ikke endringsrettigheter kun leserettigheter. 9.1 Check out Høyreklikk på en av pakkene med nøkkelsymbolet og velg Package Control og Check out. Hvis denne pakken allerede er utsjekket av en annen bruker, vil det ikke være mulig å sjekke den ut. Man vil i så fall få følgende melding: Symbolet på en pakke som har blitt sjekket ut ser slik ut: 9.2 Angre check out Dersom lokale endringer ikke skal lastes opp til repository-et og en låst pakke skal frigis, høyreklikk på pakken og velg Package Control og Undo Check Out. Velg Yes.

31 Side:31 av 31 State 9.3 Legge til en ny pakke Se dokumentet Løype for utarbeidelse av informasjonsmodellen (UML modellering) på Check in Dersom lokale endringer skal sendes til repository-et, høyreklikk på pakken, velg Package Control og Check In. I kommentarfeltet bør man skrive en kort oppsummering av endringene som ble gjort slik at det er lettere å forstå når man ser på versjonsloggen i etterkant. Klikk OK. Endringene er dermed sjekket inn i SVN og tilgjengelige for alle andre som jobber mot samme katalog via SVN.