Forord. Versioner. Version Date Description /05/2012 Initial version

Transkript

1 APOS2 DWH Services

2 Forord Dette dokument er en del af APOS version 2 manualerne. APOS version 2 (APOS2 herefter) er et organisation, klassifikation og personale system baseret på Sag & Dokument standarderne. Dokument oversigt: APOS2 Bulk data import / export APOS2 Security APOS2 Installation, Operation and Monitoring APOS2 Service Catalogue APOS2 Data Models APOS2 Administration Guide Alle dokumenterne kan findes på: Dette dokument beskriver DWH Services tilgængelige i APOS2. Versioner Version Date Description /05/2012 Initial version 2

3 Indhold 1 Generelt om DWH services Komponent opdelingen Kald af service metoder og respons URL opbygning Relationer og Egenskaber OrganisationEnhed OrganisationFunktion Appendiks Oversigt over Organisation Organisation OrganisationEnhed OrganisationFunktion Lokation Bruger ItSystem Interessefaellesskab Oversigt over Klassifikation Klassifikation Facet Klasse Oversigt over Part Person GeografiskAdresse KlassifikationKontaktkanal

4 1 Generelt om DWH services Komponent opdelingen Services er opdelt i komponenterne Organisation, Part og Klassifikation. Services på entiteter er således opdelt i den respektive komponenter de tilhører. Eks. OrganisationEnhedServiceDwhOIO er tilgængelig i Organisation komponenten, mens PersonServiceDwhOIO er tilgængelig i Part komponenten. 1.1 Kald af service metoder og respons Alle metoder kaldes med GET. Response er OIO XML og dermed valdieret med de offentlige XSD er. Der er én parameter på alle services, der hedder filter, som angiver hvilken relation eller egenskaber der returneres for alle entiteter som servicen returnerer. Alle muligheder er udpenslet i afsnittet Relationer og Egenskaber. Data der returneres er kun på den valide tidakse. Registreringstid antages til at være nu URL opbygning Service komponenterne er opdelt i 3, vist herunder, se tabel 1, for en forklaring af tokens i URL. Organisation komponent Part komponent Klassifiaktion komponent token <server> :<port> -<miljø> beskrivelse DNS navnet på serveren angives hvis den ikke kører på port 80, typisk vil den være på port 8080, som er standard for Tomcat angives hvis det ikke er produktions serveren, alternativt -test el. -trial Tabel 1: URL tokens Eksempel på URL til servicen OrganisationEnhedServiceDwhOIO på en test server 4

5 5

6 2 Relationer og Egenskaber 2.1 OrganisationEnhed For denne entitet returneres selve enhedens data og relationer. OrganisationEnhed Egenskaber navn, brugervendtnoegle OrganisationEnhed Tilhoerer enhedens organisation tilhør OrganisationEnhed Overordnet uuid på overordnet enhed, dvs. enhedens placering OrganisationEnhed Gyldighed AKTIV / INAKTIV med periode angivelse OrganisationEnhed Enhedstype uuid på klasse til angivelse af enhedstype OrganisationEnhed Lokationer uuid er på tilknyttede lokationer Tabel 2: OrganisationEnhed filter muligheder 2.2 OrganisationFunktion Lederfunktioner, engagementer og arbejdsopgave funktioner er indeholdt i denne entitet. OrganisationFunktion Egenskaber navn, brugervendtnoegle OrganisationFunktion Gyldighed AKTIV / INAKTIV perioder OrganisationFunktion TilknyttedeEnheder angiver hvilke enheder en funktion er tilknyttet OrganisationFunktion TilknyttedePersoner angiver hvilke personer en funktion er tilknyttet. For et engagement vil der f.eks. kun være tilknyttet én person OrganisationFunktion Organisatoriskfunktionstype klasse uuid på funktionen type, kan f.eks. anvendes til at opdele i lederfunktion eller engagement OrganisationFunktion Opgaver klasse uuidér på opgaver. For et engagement vil stillingsbetegnelsen være indeholdt her. OrganisationFunktion Adresser reference til funktionens adresser, det kan f.eks være KontaktKanaler. Tabel 3: OrganisationFunktion filter muligheder 6

7 Lokation Egenskaber indholder bl.a. lokationsnavn Lokation Gyldighed AKTIV / INAKTIV perioder Lokation ArbejderHer angiver personer der er placeret på lokationen Lokation Adresser indeholder referencer til både GeografiskAdresse og KlassifikationKontaktKanaler Tabel 4: Lokation filter muligheder Person Egenskaber navn Tabel 5: Person filter muligheder Klasse Egenskaber titel Klasse Facet angiver hvilken facette klassen tilhører Klasse Publiceret angiver om klssen må anvendes Tabel 6: Klasse filter muligheder Facet Egenskaber brugervendtnoegle Facet FacetTilhoer angiver hvilken klassifikation facetten tilhører Tabel 7: Facet filter muligheder KlassifikationKontaktkanal Egenskaber navn, brugervendtnoegle Tabel 8: KlassifikationKontaktkanal filter muligheder Klassifikation Egenskaber navn, brugervendtnoegle Tabel 9: Klassifikation filter muligheder 7

8 3 Appendiks Her følger en komplet oversigt over de data warehouse services og hvilke filterværdier de reagere på. Filterværdierne kan kombineres vha. komma. 3.1 Oversigt over Organisation Organisation OrganisationEnhed OrganisationFunktion

9 Lokation Bruger ItSystem Interessefaellesskab

10 3.2 Oversigt over Klassifikation Klassifikation Facet Klasse Oversigt over Part Person GeografiskAdresse

11 3.3.3 KlassifikationKontaktkanal