Denne installasjonsveilederen kan også lastes ned i PDF format.

1. Introduksjon

For å lage UML-modellene i SOSI-modellregisteret til bruk i SOSI-produktspesifikasjoner, 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 http://sosi.geonorge.no/SVNFAQ. 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.

1.1. Endringslogg

Versjon Dato Oppsummering

2.0

2019.10.30

Veilederen er totalrenovert og utgitt i versjon 2.0.
Innført TortoiseSVN som klient i stedet for CollabNet sin.
Selve veilederen er skrevet i AsciiDoc syntaks, og publisert i HTML5 format og PDF.
Skjermbilder er basert på Enterprise Architect 15.

2. Forutsetninger

For å lage dokumentasjon som beskrevet i dokumentet Veileder i å modellere produktspesifikasjon som utplukk fra SOSI fagområderhttps://kartverket.no/geodataarbeid/Standarder/SOSI/Retningslinjer-og-veiledere-SOSI-produktspesifikasjoner/, 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 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. Nødvendig programvare

  • Enterprise Architect – UML modelleringsverktøy

  • TortoiseSVN – SVN klient

  • 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 http://sparxsystems.eu/ 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 12.1 eller senere versjoner, da modellvalidering ikke vil virke med tidligere versjoner. I denne veilederen benyttes Corporate Edition versjon 13.0. Merk at det kan være stor forskjell i menyoppsettet på EA versjon 13.0 og tidligere versjoner av Enterprise Architect, og at mange av funksjonene det henvises til i dette dokumentet vil finnes under andre menyer for tidligere versjoner.

5.2. TortoiseSVN

TortoiseSVN kan lastes ned fra https://tortoisesvn.net/downloads.html
Last ned siste versjon i 32 eller 64 bits variant (for de aller fleste i dag vil det være 64 bits versjonen du trenger).

DownloadTortoiseSVN
Figure 1. Nedlasting av TortoiseSVN

Kjør installasjonsfilen og klikk deg videre (next) til du kommer til dette vinduet:

TortoiseSVNinstall1
Figure 2. Klikk deg videre i installasjonen

Hvis det er et rødt kryss på "command line client tools" så trykker du på den og velger "Entire feature will be installed on local hard drive".

TortoiseSVNinstall2
Figure 3. Velg at kommandolinjeklienten også skal installeres

Dette gjør at den også installerer kommandolinjeklienten (svn.exe) som du må ha for at EA skal fungere mot SOSI-modellregister.

TortoiseSVNinstall3
Figure 4. Når det ser slik ut kan du klikke deg videre

Fra her klikker du deg videre og fullfører installasjonen.

5.3. SOSI plugin i EA

SOSI plugin i EA lastes ned fra http://kartverket.no/geodataarbeid/standarder/sosi/Programmer-og-verktoy/
Klikk på lenken Last ned SOSI plugin i EA. Etter nedlasting går du til katalogen hvor du har valgt å legge den nedlastede installasjonsfilen, f.eks. C:\Users\<brukernavn>\Downloads.

NB! Det er viktig at Enterprise Architect ikke kjører under installasjonsprosessen. Dobbeltklikk på filen sosi-plugin-2.0.0.28.exe

Første vindu når du installerer SOSI-plugin
Figure 5. Første vindu når du installerer SOSI-plugin

Klikk på Next.

Andre vindu når du installerer SOSI-plugin
Figure 6. Andre vindu når du installerer SOSI-plugin

Klikk på Install.

Tredje og siste vindu når du installerer SOSI-plugin
Figure 7. Tredje og siste vindu når du installerer SOSI-plugin

Når installasjonen er ferdig vil du få opp dette vinduet.

Klikk på Finish.

Dermed er all nødvendig programvare installert.

5.4. ShapeChange

ShapeChange brukes til å generere GML skjemaer fra UML modeller. Last ned og se bruksanvisning på ShapeChange.net

Ta kontakt med Standardiseringssekretariatet hvis du har spørsmål om dette.

5.5. SOSI Model Validation Add-In

Kartverket har utviklet et tillegg til Enterprise Architect som hjelper deg med å sjekke om modellen din er i henhold til krav og anbefalinger i standarden Regler for UML-modellering 5.1.
Klikk på denne lenken for å laste ned SOSI Model Validation fra kartverkets Github konto.

  • Åpne installasjonsfilen og huk av for at du aksepterer vilkårene, klikk deretter på Install

Placeholder
  • Klikk på finish når den er ferdig

Placeholder

NB! Avslutt EA før du starter installasjonen.

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 brukernavn og passord 'sosi'.
De som er editor for et fagområde og/eller ønsker å lagre egne UML-modeller for produktspesifikasjoner i SOSI-modellregister må få skrivetilgang.
Ta kontakt med Standardiseringssekretariatet og angi hvilket fagområde du er editor for, eventuelt hvilken produktspesifikasjon du skal jobbe med, så får du tildelt et eget brukernavn og passord.
Er det første gang en etat/organisasjon/institutt bestemmer seg for å lagre egne produktspesifikasjonsmodeller i SOSI-modellregister, må også Standardiseringssekretariatet kontaktes slik at nødvendige konfigurasjoner på serveren kan foretas.

6.2. Sette opp en lokal arbeidsmappe ved hjelp av TortoiseSVN klienten

Denne veilederen tar utgangspunkt i at man lagrer den lokale arbeidsmappen på C:\SOSI, men du kan selvfølgelig velge å lagre den hvor du vil på din harddisk.

  • Sjekk at mappen C:\SOSI ikke finnes fra før

  • Hvis mappen C:\SOSI finnes fra før – slett den, hvis det er en gammel kopi av .xmi filene

  • Opprett mappen C:\SOSI

Nå er du klar til å konfigurere arbeidsmappen C:\SOSI hvor SVN-klienten legger alle nødvendige datafiler som brukes fra Enterprise Architect.
NB! Du må aldri lagre noen andre filer i mappen C:\SOSI - den er forbeholdt filer som SVN benytter.

  • Åpne windows filutforsker, gå til C:\

Placeholder1
  • Høyre klikk på mappen SOSI og klikk på SVN Checkout…​

Placeholder2
Placeholder3
  • Hvis du kun skal ha lesetilgang skriver du inn sosi og feltene for Username: og Password:
    Hvis du har fått et eget brukernavn og passord for skrivetilgang, så skriver du inn i det i stedet
    Klikk deretter på Ok

TortoiseSVN vil nå laste ned en lokal kopi av SOSI-modellregister.

Placeholder4
  • Når den er ferdig med å laste ned innholdet ser vinduet slik ut. Klikk på Ok

Nå er du klar for å sette opp EA.

7. Konfigurere Enterprise Architect

For at EA skal klare å håndtere alle utf-8 tegn skikkelig, deriblant samiske tegn, så er det noen innstillinger som må gjøres.

  • Åpne Enterprise Architect. Gå til Start og Preferences, som vist på bildet under.

Placeholder
  • I vinduet som da kommer opp huker du av på Use JET 4.0 – requires restart, som vist på bildet under.

Placeholder
  • Velg Ok når du får opp et vindu som sier at EA må startes på nytt.

  • Gå deretter på XML Specifications, og skriv inn utf-8 i Code Page feltet, som vist på bildet under.

Placeholder
  • Enterprise Architect er nå satt opp for å håndtere utf-8 tegnsett på en skikkelig måte. Start så EA på nytt for at endringene skal tre i kraft.

Kapitel 7.1 beskriver hvordan man går frem for å bruke en forhåndskonfigurert EAP fil, mens kapitel 7.2 tar for seg hvordan man går frem for å sette opp alt manuelt.

7.1. Bruke forhåndskonfigurert EAP fil i Enterprise Architect

Standardiseringssekretariatet anbefaler å laste ned en forhåndskonfigurert EAP-fil fra http://sosi.geonorge.no/SVNFAQ (øverst på siden). Alternativt kan du bygge opp en .EAP fil selv fra de lokale .xmi filene, men merk at dette vil ta en god del mer tid. EAP-filen er jevnlig oppdatert og inneholder også noen nyttige script, vår uml-profil og dokumentasjonsmal for EA.

Last ned EAP-filen og lagre denne et sted på lokal harddisk.

  • Klikk helt øverst til venstre på EAIcon og velg Open Project…​ som vist under.

Placeholder
  • Du får da opp et nytt vindu hvor du klikker på Local File, som vist på bildet under.

Placeholder
  • I neste vindu navigerer du deg til det stedet du valgte å lagre den forhåndskanfigurerte EAP-filen.
    Marker filen og klikk Open, som vist under.

Placeholder

Hvis versjonskontroll innstillinger ikke er satt opp fra før, typisk hvis dette er første gang du åpner denne EAP filen, vil du få opp et vindu som ser slik ut:

Placeholder
  • Her klikker du på Yes.

Da vil du få opp et vindu som ser slik ut:

Placeholder
  • I den øverste delen for Model Settings, sørg for at den midterste og nederste av de 3 boksene er huket av.

  • Working Copy Path: så klikker du på Select Path… og navigerer deg til mappen hvor de lokale .xmi filene ble lastet ned i punkt [_6_2_sette_opp_en_lokal_arbeidsmappe_ved_hjelp_av_tortoisesvn_klienten]. Velg mappen og klikk OK, som vist under.

Placeholder
  • Så går du til linjen hvor det står Subversion Exe Path: og klikker på Select Path….

Her skal du navigere deg til installasjonsmappen for SVN klienten som ble installert i punkt [_5_2_tortoisesvn]. Ved standard installasjon så skal denne ligger under C:\Program Files\TortoiseSVN\bin

  • Velg svn.exe og klikk Open, som vist på bildet under.

Placeholder
  • VC Time-Out value: så endrer du fra 30 til 60 sekunder. Dette er for å forhindre tidsavbrudd når man jobber mot modellregisteret.

Nå bør du ha et vindu som ser ut som bildet under.

  • Klikk så på Save.

Placeholder
  • Klikk deretter på Close.

Nå er EA klar til bruk mot SOSI-modellregister.

For å sjekke at det virker som det skal kan du gjerne prøve å oppdatere innholdet fra SOSI-modellregister.

  • Høyre klikke på en pakke i projectbrowser, gå til Package Control og klikk på Get All Latest.

Placeholder
  • Huk av på Import changed files only og trykk deretter OK.

Placeholder

EA vil nå jobbe seg igjennom alle pakker og importere de som er endret siden sist oppdatering av EAP-filen. Dette kan ta litt tid.

7.2. Lage ny EAP-fil

Lag et nytt prosjekt ved å klikke på EAIcon og New project fra hovedmenyen helt øverst til venstre.

Placeholder

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 og tregheter ved bruk. Pass på at filtypen er .eapx og klikk deretter på Save.

Placeholder

Du vil da ha et vindu i EA som ser noe slikt ut:

Placeholder

I venstre side av EA-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 i prosjektutforskeren (der det står Browser) 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 denne veilederen refereres det til prosjektutforskeren slik den er plassert på venstre side som i skjermbildet over.

7.2.1. Konfigurere tilgang til SOSI-modellregister

Etter å ha åpnet prosjektfilen i EA (som du opprettet i starten av dette kapittelet), velg Configure i hovedmenyen øverst. Velg så Project-VC fra Version Control-feltet i båndet under hovedmenyen.

Placeholder

Du får da opp vinduet for versjonskontrollinstillinger.

Placeholder
  • I Version Control Settings skriv inn SOSI i feltet Unique ID og huk av på Subversion.

  • I den øverste delen for Model Settings, sørg for at den midterste og nederste av de 3 boksene er huket av.

  • Working Copy Path: så klikker du på Select Path… og navigerer deg til mappen hvor de lokale .xmi filene ble lastet ned i punkt 6.2. Velg mappen og klikk OK, som vist under.

Placeholder
  • Så går du til linjen hvor det står Subversion Exe Path: og klikker på Select Path….

Her skal du navigere deg til installasjonsmappen for SVN klienten som ble installert i punkt 5.2. Ved standard installasjon så skal denne ligge under C:\Program Files\TortoiseSVN\bin

  • Velg svn.exe og klikk Open, som vist på bildet under.

Placeholder
  • VC Time-Out value: så endrer du fra 30 til 60 sekunder. Dette er for å forhindre tidsavbrudd når man jobber mot modellregisteret.

Nå bør du ha et vindu som ser ut som bildet under.

  • Klikk så på Save.

Placeholder
  • Klikk deretter på Close.

Nå er EA prosjektet klar for å hente innhold fra SOSI-modellregister.

7.2.2. Importere XMI-pakker fra SOSI-modellregister

  • Høyreklikk i prosjektutforskeren, velg så Package Control og Get Package.

Placeholder
  • Velg nå SOSI under Select a Version Control Configuration, som vist på bildet under.

Placeholder

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.

Placeholder
  • 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».

Placeholder
  • Til slutt velger du den aktuelle hovedpakken som starter med SOSI Del 3\
    På bildet under er Bane NOR valgt som eksempel.

Placeholder

Nå bør prosjektutforskeren i EA ligne bildet under.

Placeholder
  • Høyreklikk på en av de importerte pakkene og velg Package Control og Get All Latest.

Placeholder
  • På meldingen som dukker opp lar man valget stå på Import changed files only og klikker på OK.

Placeholder

Nå importeres alle pakkene med filer fra SVN. Dette kan ta 10 – 30 minutter når man gjør det for første gang, avhengig av nettforbindelsen, hvor rask datamaskinen er og hvor mye de forskjellige pakkene inneholder.

NB! Hvis du vil ha hele modellregisteret anbefales det å bruke EAP-filen fra http://sosi.geonorge.no/SVNFAQ

7.2.3. 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.

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 http://kartverket.no/geodataarbeid/standarder/sosi/Programmer-og-verktoy/. For å importere profilen sørg for at «Resources» er aktivert. Vanligvis finnes «Resources»-vinduet som en egen fane i samme felt som «Project Browser» er, men dersom det ikke er der, kan det aktiveres under Configure som vist i bildet nedenfor.

Placeholder
  • I Resource-vinduet høyreklikker du på UML Profiles og velger Import Profile.

Placeholder
  • I dialogvinduet Import UML Profile velger du den nedlastede filen under Filename. Huk av Overwrite Existing Templates og bekreft ved å klikke på Import

7.2.4. Sette opp standard SOSI dokumentasjonsmaler

I dette kapittelet beskrives nedlasting og konfigurasjon av standard SOSI RTF-mal og standard SOSI Word-mal for å lage produktspesifikasjonen i henhold til denne standarden.

Nedlasting av SOSI dokumentasjonsmal i EA

  • Klikk på Last ned SOSI dokumentasjonsmal i EA og velg å lagre filen et egnet sted på lokal maskin

NB! Det er viktig at du velger å lagre filen i formatet .xml

NB2! I nettlesere kan det hende at filens innhold vises i xml format direkte i nettleservinduet istedenfor å lastes ned. Hvis dette skjer, høyreklikk på linken og velg Save target as…/Lagre filen som….

Konfigurasjon

Start Enterprise Architect hvis den ikke allerede er startet.

Åpne et ønsket prosjekt eller opprett et nytt prosjekt.

Gå til Configure og velg Transfer og Import Reference Data… som vist under:

Klikk på «Select File». Finn og velg filen «SOSI-dokumentasjonsmal_i_EA.xml» som du lasted ned tidligere. Klikk deretter på «Open» som vist under:

Klikk på «RTF Document Templates» slik at den blir markert som vist under:

Klikk så på Import og deretter på OK.

Nå er SOSI-dokumentasjonsmalen installert og klar til bruk.

NB! Dokumentasjonsmaler i EA lagres i prosjektfilen. Det betyr at man må importere malen hver gang man lager en ny eap-fil.

7.3. Nedlasting av Word-mal

I tillegg til dokumentasjonsmalen i EA, må du også laste ned en Word-mal. Denne inneholder en makro som rydder opp i dokumenter som er generert med EA-malen. Det er nemlig ikke alt EA-malen klarer å lage automatisk, men som makroen i Word-malen ordner opp i.

Klikk på Last ned SOSI-dokumentasjon fra RTF til DOCX og velg å lagre filen et egnet sted på lokal maskin

NB! Det er viktig at du velger å lagre filen i formatet .dotm

Hvordan malen skal brukes står i veilederen med tittelen Veileder i å modellere SOSI-produktspesifikasjon som utplukk fra SOSI fagområder som du finner på https://kartverket.no/geodataarbeid/Standarder/SOSI/Retningslinjer-og-veiledere-SOSI-produktspesifikasjoner/

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 produktspesifikasjonsmodeller!

For oversiktens skyld, gis det i dette kapittelet en kort innføring i hvordan du bruker det sentrale lageret for UML-modeller (SOSI-modellresgister). Kapittelet gir en generell beskrivelse av hvordan man sjekker ut og sjekker inn pakker i SOSI-modellregister.

Dokumentet Veileder i å modellere produktspesifikasjon som utplukk fra SOSI fagområderhttp://kartverket.no/geodataarbeid/standarder/sosi/Retningslinjer-og-veiledere-SOSI/ gir en detaljert beskrivelse av denne prosessen relatert til konkrete eksempler.

For å oppdatere innholdet i pakkene i EA-prosjektet, høyreklikk på en vilkårlig pakke i prosjektutforskeren og velg så Package Control og Get All Latest. Nå sjekkes alle pakkene i EAP-filen mot SOSI-modellregister og oppdaterer de som det er gjort endringer på siden sist.

Ønsker du at bare én pakke skal oppdateres så høyreklikker du på ønsket pakke og velger Package Control og Get Latest.

NB! For å endre på innholdet i en pakke, legge til nye underpakker eller annet, må den ønskede pakken sjekkes ut.

Dette krever at du 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. Sjekke ut

Høyreklikk på en av pakkene med nøkkelsymbolet EAVCPackage 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:

EACheckedOutToOther

Symbolet på en pakke som har blitt sjekket ut av deg selv ser slik ut EACheckedOutToSelf

8.2. Angre check out

Dersom lokale endringer ikke skal lastes opp til SOSI-modellregister og en låst pakke skal frigis, høyreklikk på pakken og velg Package Control og Undo Check Out.

Klikk deretter på 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å http://kartverket.no/geodataarbeid/standarder/sosi/Retningslinjer-og-veiledere-SOSI/

8.4. Check in

Dersom lokale endringer skal sendes til SOSI-modellregister, høyreklikk på pakken, velg Package Control og Check In.

Når en pakke blir sjekket inn så lagres endringene som er utført i pakken tilbake til SOSI-modellregisteret.

I kommentarfeltet bør man skrive en kort oppsummering av endringene som ble gjort slik at det er lettere for andre å forstå hva som er gjort når de ser i versjonsloggen.

Klikk OK.