Kartverket. Innhold. Installasjon av nødvendig programvare for arbeid med SOSI-produktspesifikasjoner. Prosedyre

Transkript

1 atens kartverk Sjø Kartverket Prosedyre Versjon: 1.7 Gjelder fra: Utarbeidet av: Kartverket Godkjent av: Sidenr: 1 av 41 St Innhold 1 Introduksjon Forutsetninger Uttrykk og begreper Nødvendig programvare Nedlasting og installasjon av nødvendig programvare Enterprise Architect Collabnet subversion ShapeChange plugin i EA SOSI plugin i EA Sjekke ut en initiell versjon av SOSI-modellregister Lese- og skrivetilgang i SVN Konfigurere en arbeidsmappe ved hjelp av kommandobasert klient Konfigurere Enterprise Architect Lage ny EAP-fil Konfigurere tilgang til SOSI-modellregister Importere XMI-pakker fra SOSI-modellregister Import av SOSI UML-profil Konfigurere ShapeChange plugin Sette opp standard SOSI dokumentasjonsmaler Arbeide mot SVN-repository (for eksempel SOSI-modellregister) Check out Angre check out Legge til en ny pakke Check in... 40

2 Side:2 av 41 Statens

3 Side:3 av 41 Statens 1 Introduksjon For å lage UML-modellene i SOSI-modellregisteret til bruk i SOSIproduktspesifikasjoner, 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 standardsett av programvare. Dette dokumentet er en veileder om hvilken programvare dette standardsettet består av. Dokumentet beskriver også nødvendig konfigurasjon av denne programvaren. Vi har samlet en liste med kjente problemer og løsninger under Hvis du støter på et problem som ikke er omtalt i dette dokumentet så anbefaler vi at du går inn på denne siden og ser om du finner problemet/feilmeldingen omtalt der. 2 Forutsetninger For å lage dokumentasjon som beskrevet i dokumentet Veileder i å modellere produktspesifikasjon som utplukk fra SOSI fagområder på SOSI/, 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. SOSI modelleregister = et (for tiden) SVN-basert register som inneholder alle UML-modeller som inngår i SOSI. Repository = sentralt lagringssted, i denne sammenhengen for datafiler som skal håndteres via SVN.

4 Side:4 av 41 Statens 4 Nødvendig programvare a) Enterprise Architect UML modelleringsverktøy b) Collabnet Subversion SVN klient c) ShapeChange eksportverktøy UML GML for Enterprise Architect d) SOSI plugin UML profil og eksportverktøy UML SOSI for Enterprise Architect 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. Det anbefales å benytte Corporate Edition versjon 10, men også versjon 8 og 9 (Corporate Edition, Professional, Ultimate) har blitt testet og disse versjonene bør 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. 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 Side:5 av 41 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 Side:6 av 41 Statens 5.3 ShapeChange plugin i EA ShapeChange plugin i EA lastes ned fra Klikk på linken Last ned ShapeChange plugin i EA. Etter nedlasting går du til katalogen hvor du har valgt å legge den nedlastede zip-filen, f.eks C:\Users\<brukernavn>\Downloads. Dobbeltklikk på zip-filen. Da vises innholdet i et nytt vindu. NB! Det er viktig at Enterprise Architect er slått av under installasjonsprosessen. Dobbeltklikk på filen Shapechange_setup_2_0.exe.

7 Side:7 av 41 Statens Klikk på Next Installasjonssted er C:\Program Files\Arkitektum AS\ShapeChange. Klikk på Install.

8 Side:8 av 41 Statens Når installasjonen er ferdig vil du få opp dette vinduet. Klikk på Finish.

9 Side:9 av 41 Statens 5.4 SOSI plugin i EA SOSI plugin i EA lastes ned fra Klikk på linken Last ned SOSI plugin i EA. Etter nedlasting går du til katalogen hvor du har valgt å legge den nedlastede zip-filen, f.eks C:\Users\<brukernavn>\Downloads. NB! Det er viktig at Enterprise Architect er slått av under installasjonsprosessen. Dobbeltklikk på filen SOSI_plugin_setup_1_1_5.exe

10 Side:10 av 41 Statens Klikk på Next. Klikk på Install. Når installasjonen er ferdig vil du få opp dette vinduet.

11 Side:11 av 41 Statens Klikk på Finish. Restart Enterprise Architect. Dermed er all nødvendig programvare installert. 6 Sjekke ut en initiell versjon av SOSI-modellregister 6.1 Lese- og skrivetilgang i SVN SOSI-modellregister 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 produktspesifikasjoner i SOSI-modellregisteret må ha skrivetilgang. Ta kontakt med Standardiseringssekretariatet (standardiseringssekretariatet@kartverket.no) 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. Er det første gang at en etat/et institutt bestemmer seg for å lagre egne produktspesifikasjons-uml-modeller i SOSI-modellregisteret, må også Standardiseringssekretariatet kontaktes slik at nødvendige konfigurasjoner på serveren kan foretas.

12 Side:12 av 41 Statens 6.2 Konfigurere en arbeidsmappe ved hjelp av kommandobasert klient Nødvendig forarbeid: 1. Sjekk at ikke mappen C:\SOSI 1 finnes fra før. 2. Hvis mappen C:\SOSI1 finnes fra før slett den. 3. Opprett mappen C:\SOSI1 Da er du klar til å konfigurere arbeidsmappen C:\SOSI1 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:\SOSI1 - den er forbeholdt filer som SVN benytter og dette gjøres alltid automatisk av SVN-klienten. I. Åpne kommandovinduet ved å trykke Windows tasten + R. II. Skriv cmd og trykk Enter eller klikk på OK. Da åpnes et terminalvindu. 1 C:\SOSI er bare et eksempel. Her kan du velge hvilken som helst mappe på den lokale disken din.

13 Side:13 av 41 Statens 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 URL-en ( SOSI ) må skrives med store bokstaver! svn co C:\SOSI1 --username <mitt brukernavn>

14 Side:14 av 41 Statens Erstatt <mitt brukernavn> med brukernavnet som du har fått tildelt. Har du ikke fått eget brukernavn, kan du bruke standardbrukernavn sosi som gir lesetilgang. Trykk så Enter. Så må passordet oppgis. Bruk passordet du fikk tildelt sammen med ditt eget brukernavn eller standardpassordet sosi dersom du valgte standard lesetilgang og brukernavn sosi. Trykk så Enter. Etter utsjekk skal alle filene være lastet ned som en lokal kopi til din lokale arbeidsmappe (C:\SOSI1). IV. Ferdig med den initielle utsjekkingen!

15 Side:15 av 41 Statens 7 Konfigurere Enterprise Architect Å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. Enterprise Architect lagrer prosjekter i en databasefil (EAP-fil). Ved oppkobling mot et svn-repository vil EA automatisk oppdatere xmi-filene i svn-katalogen beskrevet i kapittel 6 og samtidig oppdatere EAP-fila. Standardiseringssekretariatet anbefaler å laste ned EAP-fila fra (øverst på siden). Alternativt kan du importere xmi-filer selv, men dette vil ta noe mer tid. EAP-fila er jevnlig oppdatert og inneholder også noen skript og vår uml-profil. Merk at versjonskontrolloppsett må konfigureres i EA (avsnitt 7.2). Hver konfigurasjon får en ID som lagres som en tagged value i xmi-filene. Siden kataloger for oppkobling til svn vil være avhengig av din lokale katalogstruktur, må konfigurasjonen lagres lokalt i EA hos deg. Du må derfor lese og følge avsnitt 7.1 og 7.2 (om nødvendig med en midlertidig EAP-fil) før du kan laste ned og åpne EAP-fila fra

16 Side:16 av 41 Statens 7.1 Lage ny EAP-fil Lag et nytt prosjekt ved å velge File -> New project fra hovedmenyen på øverste linje. Du får da opp et vindu der du skal angi navn på prosjektet. Prosjektfila bør lagres på en lokal disk. Lagres den på en nettverksdisk, kan det hende at det oppstår feil ved bruk av ShapeChange plugin. Pass på at filtypen er *.eap og klikk deretter på Save.

17 Side:17 av 41 Statens Deretter kommer det opp et popup-vindu hvor du skal klikke på Cancel. Du vil da ha et vindu i EA som ser noe slikt ut:

18 Side:18 av 41 Statens 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. 7.2 Konfigurere tilgang til SOSI-modellregister Etter å ha åpnet prosjektfilen i EA (som du opprettet i starten av dette kapittelet), velg fra hovedmenyen øverst Project -> Version Control -> Version Control Settings. I tilfellet at Version Control ikke vises i hovedmenyen, gå til View-menyen og velg Workspaces and Commands. I Workspaces and Commands-vinduet gå til Commands, velg Complete og kryss av Version Control (se figur nedenfor).

19 Side:19 av 41 Statens I Version Control Settings skriv inn SOSI som Unique ID, huk av Subversion og kontroller at Working Copy Path er C:\SOSI 2. 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. 2 Kan avvike fra standardkonfigurasjonen, men må være identisk med stien som ble valgt under punkt 6.2.

20 Side:20 av 41 Statens Dersom du ofte opplever Time-Out-meldinger ved bruk av SOSImodellregisteret, kan VC Time-Out Value oppjusteres. 7.3 Importere XMI-pakker fra SOSI-modellregister Merk at du kan droppe dette avsnittet hvis du laster ned og åpner EAP-fila på (Men husk å høyreklikke på en av pakkene og velg «Package Control» og «Get All Latest».) Høyreklikk på ønsket mappe i prosjektutforskeren i EA, velg så Package Control og Get Package. Velg nå SOSI under Version Control Configuration, som vist på bildet under.

21 Side:21 av 41 Statens Ved førstegangs import anbefaler vi å velge SOSI Del 1 ( SOSI Generelle Konsepter.xml ), SOSI Del 2 ( SOSI Generell objektkatalog_v4.xml ) og den enkelte pakken fra Del 3 Produktspesifikasjoner som du skal jobbe med. I tilfellet meldingen nedenfor vises, velg No. Etter at du har lagt til SOSI Generelle Konsepter.xml så høyreklikker du igjen på øverste nivå, velger «Package Control» og «Get Package» og legger til «SOSI Generell objektkatalog_v4.xml».

22 Side:22 av 41 Statens Til slutt velger du den aktuelle hovedpakken som starter med «SOSI Del 3\». På bildet under er «Kystverket» valgt som eksempel.

23 Side:23 av 41 Statens Nå bør «Project Browser» i EA se lignendes ut som på bildet under. 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.

24 Side:24 av 41 Statens Nå importeres alle pakkene med filer fra SVN. Dette kan ta minutter når man gjør det for første gang, avhengig av nettforbindelsen og hvor rask datamaskinen er. NB! I stedet for å velge Del 1, Del 2, og en spesifikk pakke fra Del 3, kunne man tidligere velge hele modellregisteret («SOSI Model.xml»). Dette vil i dag føre til problemer med filstørrelser i EAs databaseformat og anbefales ikke. Bruk heller EAP-fila fra Import av SOSI UML-profil 5.0 Dersom du har valgt å laste ned EAP-fil som beskrevet innledningsvis under kapittel 7, kan du se bort fra dette punktet. Du må eventuelt aktivere Resourcesvinduet i EA (View Resources) for å se innhold i profilen. For å sikre bruk av standardiserte modellelementer har Kartverket laget en SOSI UML-profil 5.0. Denne profilen definerer standard stereotyper men lager ingen tagged values da disse skal legges inn med standardskript og eies av klassene. Profilen kan lastes ned fra For å importere profilen aktiver Resources under View som vist i bildet nedenfor.

25 Side:25 av 41 Statens I Resource-vinduet høyreklikker du på UML Profiles og velger Import Profile.

26 Side:26 av 41 Statens I dialogvinduet "Import UML Profile" velger du den nedlastede filen under Filename. Hak av Overwrite Existing Templates og bekreft ved å klikke på Import. 7.5 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. Nedenfor beskrives hvordan dette gjøres. Finne ut om Java 7 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 jre7, åpne den og sjekk at innholdet ser slik ut:

27 Side:27 av 41 Statens Hvis du ikke har katalogen jre7 må du installere Java 7. Gå da til neste kapittel ( Installere java 7 ). Installere Java 7 Gå til og last ned Java 7 32 bits versjonen ved å klikke på Windows Offline 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 jre7 finnes under C:\Program Files (x86)\java som beskrevet i kapittelet over ( Finne ut om Java 7 er installert ). Koble ShapeChange mot Java 7 Marker applikasjonsskjemapakken din som vist under.

28 Side:28 av 41 Statens Applikasjonsskjemapakke som markeres ved å klikke 1 gang på den. Velg deretter Extensions -> ShapeChange -> Transform (i eldre EA-versjoner heter menyvalget Add-ins ) fra hovedmenyen øverst. Da åpner det seg et popup vindu:

29 Side:29 av 41 Statens Klikk på Settings. Et nytt pop-up vindu åpner seg:

30 Side:30 av 41 Statens Her må du skrive/kopiere inn stien til din installerte Java 7 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. 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 å generere 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. En annen feilkilde kan være at prosjektfilen din (*eap-fila) ligger på en nettverksdisk. Flytt den i en mappe på den lokale disken din, åpne den og prøv på nytt å generere GML. 7.6 Sette opp standard SOSI dokumentasjonsmaler I dette kapittelet beskrives nedlasting og konfigurasjon av standard SOSI RTFmal og standard SOSI Word-mal for å lage produktspesifikasjonen i henhold til denne standarden. Nedlasting av SOSI dokumentasjonsmal i EA Gå til Klikk på Last ned SOSI dokumentasjonsmal i EA og velg å lagre filen et egnet sted på lokal maskin (men ikke i mappen C:\SOSI1) NB! Det er viktig at du velger å lagre filen i formatet *.rtf - velg filtype fra listen i lagringsvinduet som vist under.

31 Side:31 av 41 Statens Klikk Save. Dermed er malen lagret i korrekt format. Nedlasting av Word-mal I tillegg til RTF-malen som du lastet ned i forrige kapittel, må du også laste ned en Word-mal. Denne inneholder makroer som rydder opp i dokumenter som er generert med RTF-malen. Det er nemlig ikke alt RTF-malen klarer å lage automatisk, men som makroene i Word-malen ordner opp i. Gå til Klikk på Last ned SOSI-dokumentasjon fra RTF til DOC og velg å lagre filen et egnet sted på lokal maskin (men ikke i mappen C:\SOSI1)

32 Side:32 av 41 Statens NB1! I Internett Explorer kan det hende at filens innhold vises i kryptisk format direkte i nettleservinduet istedenfor å lastes ned. Hvis så skjer, høyreklikk på linken og velg Save target as. NB2! Det er viktig at du velger å lagre filen i formatet.dot - velg filtype fra listen i lagringsvinduet som vist under. Klikk Save. Dermed er malen lagret i korrekt format. Hvordan malen skal brukes står i veilederen med tittelen Veileder i å modellere SOSI-produktspesifikasjon som utplukk fra SOSI fagområder som kan lastes ned på SOSI/

33 Side:33 av 41 Statens Konfigurasjon Start 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: Et nytt vindu åpner seg:

34 Side:34 av 41 Statens Velg så fanen Templates og klikk deretter på New.

35 Side:35 av 41 Statens Skriv inn et valgfritt navn på rapportmalen i popup-vinduet som dukker opp. For eksempel SOSI-dokumentasjonsmal : La valget Copy template være satt til None og valget Template Group kan forbli tomt, klikk OK. Et nytt vindu som heter Document Template Editor dukker opp:

36 Side:36 av 41 Statens I Document Template Editor, velg fra hovedmenyen på øverste linje File -> Import. NB! Hvis du ikke har dette menyvalget synlig, kan du høyreklikke i dokumentet for å få samme valgmuligheten. Utforskeren din dukker opp og du navigerer deg frem til den tidligere nedlastede SOSI-malen som heter EA_UML_Prodspek_mal.rtf:

37 Side:37 av 41 Statens Marker filen og klikk Open. Den importerte malen vises da i Document Template Editor :

38 Side:38 av 41 Statens 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). Klikk på Close. Ferdig! SOSI-malen er installert og klar til bruk. NB! Dokumentasjonsmaler i EA er prosjektavhengige. Det betyr man må konfigurere et EA-prosjekt på nytt med de ønskede malene hver gang man begynner å arbeide med en ny eap-fil.

39 Side:39 av 41 Statens 8 Arbeide mot SVN-repository (for eksempel SOSI-modellregister) Du er nå ferdig med all installasjon og konfigurasjon av nødvendig programvare for arbeid med produktspesifikasjoner! 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 Veileder i å modellere produktspesifikasjon som utplukk fra SOSI fagområder på SOSI/ gir en detaljert beskrivelse av denne prosessen relatert til konkrete eksempler. 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 underpakker eller annet, må den ønskede pakken først utsjekkes. Slike operasjoner krever at SVNbrukeren din har rettigheter til dette. Standardbrukeren sosi har ikke endringsrettigheter kun leserettigheter. Se 6.1 for mer informasjon dersom du trenger eget brukernavn med endringsrettigheter. 8.1 Check out Høyreklikk på en av pakkene med nøkkelsymbolet og velg Package Control og Check out. Å sjekke ut en pakke vil si at du kan gjøre endringer i denne. 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:

40 Side:40 av 41 Statens 8.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. 8.3 Legge til en ny pakke Se punkt 5 i dokumentet Veileder i å modellere SOSI-produktspesifikasjon som utplukk fra SOSI fagområder på SOSI/ 8.4 Check in Dersom lokale endringer skal sendes til repository-et, høyreklikk på pakken, velg Package Control og Check In. Når en pakke blir sjekket inn så lagrer man endringer som er utført i SOSI-modellregisteret. 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.

41 Side:41 av 41 Statens Klikk OK. Endringene er dermed sjekket inn i SVN og tilgjengelige for alle andre som jobber mot samme katalog via SVN.