...
Nedenstående diagram illustrerer strukturen på en GCTP besked, som bør være indkapsuleret i et <root></root>
element, der evt kan have namespace deklarationer.
Herunder beskrives de enkelte tags
2.1. Gctp
`GCTP GCTP
elementet skal altid findes som den første tag i en besked, dog gerne under et root
element. Herved fortælles det at, der frem til GCTP’ slut tag findes de data der indgår i beskedenAttributter
Table 1. Mulige attributter på et Gctp elementAttribut | Beskrivelse |
---|
v | Skal indeholde versionen af GCTP der anvendes |
env | Kan indeholde en indentifikation af det miljø der kommunikeres med |
Code Block |
---|
|
<Gctp v="1.0">
...
</Gctp> |
...
System
elementet anvendes til at angive oplysninger om hvilket system man agter at køre imod.Attributter
Table 2. Mulige attributter på et System elementAttribut | Beskrivelse |
---|
r | Skal indeholde hvilket system kaldet foretages mod |
...
En CprServiceHeader vil have et underelement i form af en Table
hvor der er angivet hvilke aktion der er muligt at vælge på en hændelse efter denne er initieret.Attributter
Table 3. Mulige attributter på et CprServiceHeader elementAttribut | Beskrivelse |
---|
r | Skal indeholde navnet på hændelsen der kaldes |
mk | Skal indeholde den indberettende myndighedskode |
a | Skal indeholde hvilken aktion der ønskes eller hvilken tilstand servicen er Ii |
u | Hvis denne attribut udfyldes med u="v" angives der at man ønsker at anvende ventesystemet |
st | st="P" angiver primær hændelse. Der anvends anvendes kun primære hændelser i CPR ved GCTP version 2.0 |
ts | Anvendes til at identificere den igangværende session med den pågældende hændelse |
Table 4. Udfaset attributter på et CprServiceHeader elementAttribut | Beskrivelse |
---|
pt | Identificere den primære session en sekundær hændelse indgår i |
pv | Angiver en myndighed som en hændelse er indsendt på vegne af |
...
Table 15. Tilladte værdier for attributter attribut "a" - aktionAktion | Beskrivelse |
---|
I | Initiering af hændelsen |
V | Validering af hændelsen |
G | Gem hændelsen |
F | Fortryd hændelsen |
S | Slet mange registreringer i hændelsen |
1 | Initiering fra Vent |
2 | Gem som kladde |
3 | Gem og send til godkendelse i Vent |
4 | Gem og godkend i Vent |
5 | Aktiver fra Vent |
6 | Slet fra Vent |
7 | Afvis fra Vent |
...
8 | Send til godkendelse uden data |
9 | Godkend uden data |
Table 6. Udfaset værdier for attribut "a" - aktionAktion | Beskrivelse |
---|
U | Gem uden initier |
Code Block |
---|
language | xml |
---|
title | Eksempel på initiering af adoption hændelsen |
---|
|
<CprServiceHeader a="ADOPTI-I" a="I" st="P">
...
</CprServiceHeader> |
...
Field
elementet anvendes til at angive værdier i GCTP beskeden og anvendes både til at angive læsedata og data der skal gemmes i CPR.Attributter
Table 7. Mulige attributter på et Field elementAttribut | Beskrivelse |
---|
r | Skal indeholde navnet på feltet |
v | Værdien af feltet |
a | Egenskaber ved feltet, f.eks. L=Låst, S=Skal |
a1 | Yderligere egenskaber for feltet |
t | En tekst betegnelse af værdien i v attributten |
ts | En forkortet tekst betegnelse af værdien i v attributten |
tm | En mellemlang tekst betegnelse af værdien i v attributten |
tl | En lang tekst betegnelse af værdien i v attributten |
e | En fejlkode der angiver at der er fejl i det pågældende felt |
bv | En boolsk betegnelse (true/false) for værdien i v-attributten |
Code Block |
---|
language | xml |
---|
title | Eksempel på navn angivet i et Field, feltet er låst |
---|
|
<Field r="CNVN_FORNAVN" v="Peter" a="L" /> |
...
Samspillet mellem Table og Row er netop metoden til at kommunikere flere rækker af data imellem server og klient.
Table 8. Mulige attributter på et Row elementAttribut | Beskrivelse |
---|
u | Angiver Usage, hvis denner denne er sat u="M" er der tale om en model række der ikke indeholder data men bare oplysninger om hvilke felter der kan forekomme i hver række på denne tabel |
k | Nøgle for rækken. Denne skal altid være udfyldt, og skal være unik i en Table blok, da det er den måde server og klient er enige om hvilke data der snakkes om |
...
language | xml |
---|
title | Eksempel på model række |
---|
...
Table 9. Tilladte værdier for attribut "u" - usageUsage | Beskrivelse |
---|
M | Beskriver modellen af rækker i en tabel |
B | En logisk separator der kan adskille forskellig data |
REST | Genstart nøgle for søgninger, som indikerer at der er mere data tilgængelig i tabellen |
De nedenstående værdier benyttes ikke længere af systemet, da det selv beslutter betydningen af det indsendte data. Hvis der indsendes nye rækker med data der ikke findes, indsættes der nye data; hvis der rettes i data i en eksisterende række, opdateres der data; og hvis en forespørgsel har fjernet en eksisterende række, slettes data.
Table 10. Udfaset værdier for attribut "u" - usageUsage | Beskrivelse |
---|
C | Indsæt som ny række |
U | Opdater denne række |
D | Slet denne række |
Code Block |
---|
language | xml |
---|
title | Eksempel på model række |
---|
|
<Row u="M">
<Field r="CNVN_FORNAVNE" a="L" />
<Field r="CNVN_STARTMYN" a="S" />
</Row> |
...
Endvidere kan Table indehold informationer om hvor mange rækker der er i alt.
Table 11. Mulige attributter på et Table elementAttribut | Beskrivelse |
---|
r | Skal indeholde tabellens navn |
aia | Antal i alt, anvendes ved søgninger |
min | Det minimale antal rækker tabellen kan skal indeholde |
max | Det maksimale antal rækker tabellen må indeholde |
mr | Max antal rækker der kan indberettes indsendes via tabellen |
Code Block |
---|
language | xml |
---|
title | Eksempel på tabel |
---|
|
<Table r="NavneTab" mr="25">
<Row k="12345625122">
<Field r="CNVN_FORNVN" v="Peter"/>
<Field r="CNVN_EFTERNVN" v="Larsen"/>
</Row>
<Row k="12345625122">
<Field r="CNVN_FORNVN" v="Mette"/>
<Field r="CNVN_EFTERNVN" v="Hansen"/>
</Row>
</Table> |
...
Hvis der er tale om en Gem aktion der er gået godt, indeholder Kvit også en tabel med stamdata om de objekter som persisteringen vedrører.
Table 12. Mulige attributter på et Kvit elementAttribut | Beskrivelse |
---|
rKvitteringstypen. Ok, Afslut, Fejl | Skal angive kvitteringstypen |
v | Indeholder fejlkode såfremt der er tale om en fejlkvittering ellers 0 | ts | Indeholder en fejltekst Skal angive kvitteringskoden |
t | Kan indeholder en tekst såfremt der er tale om en fejlkvittering |
Code Block |
---|
language | xml |
---|
title | Eksempel på fejl kvittering |
---|
|
<Kvit r="Fejl" v="3422" t="Personen findes ikke i CPR" /> |
...
language | xml |
---|
title | Eksempel på OK kvittering efter validering |
---|
...
Table 13. Tilladte værdier for attribut "r" - kvitteringstypeType | Beskrivelse |
---|
System | Systemfejl |
Anmrk | Anmodningen blev behandlet uden fejl men der er en anmærkning |
Afslut | Anmodningen blev behandlet uden fejl og session er afsluttet |
Fejl | Anmodningen fejlede |
Ok | Anmodningen blev behandlet uden fejl og sessionen er stadig aktiv |
returKode | Kvitteringskoden kan have en speciel betydning - ikke blot ok eller en fejl/anmærkning |
Table 14. Udfaset værdier for attribut "r" - kvitteringstypeType | Beskrivelse |
---|
Dump | Gammel systemfejl |
Code Block |
---|
language | xml |
---|
title | Eksempel på fejl kvittering |
---|
|
<Kvit r="Fejl" v="3422" t="Personen findes ikke i CPR" /> |
Code Block |
---|
language | xml |
---|
title | Eksempel på OK kvittering efter validering |
---|
|
<Kvit r="OK" v="0" /> |
Code Block |
---|
language | xml |
---|
title | Eksempel på Afslut kvittering efter data er gemt |
---|
|
<Kvit r="Afslut" v="0">
<Table r="AFSLUT">
<Row k="PNR=1212121212;">
<Field r="PNR" v="1212121212"/>
<Field r="ADRNVN" v="Petersen,Peter"/>
<Field r="FORNVN" v="Peter"/>
<Field r="MELNVN"/>
<Field r="EFTERNVN" v="Petersen"/>
<Field r="STATUS" v="1" t="Bopæl i Danmark"/>
<Field r="REL"/>
</Row>
</Table>
</Kvit> |
...
Output data tjener som stamdata om de objekter servicen omhandler, mens Inputdata tjener som de data der evt. kan indberettes på servicen.
Table 15. Mulige attributter på et CprData elementAttribut | Beskrivelse |
---|
uAngiver | om data i blokken er O(utput) eller I(nput)Skal angive hvilken type data der indgår i blokken. |
Table 16. Tilladte værdier for attribut "u" - data usageData usage | Beskrivelse |
---|
I | Blokken indeholder input data der kan redigeres |
O | Blokken indeholder output data der ikke kan redigeres, og som blot er til visninger |
2.9. Rolle
...
Hvis der er tale om en Output rolle vil der være et eller flere Praes
elementer i blokken. Hvis der er tale om en input Rolle vil der være Table
eller Field
elementer i blokken.
Attribut | Beskrivelse |
---|
r | Skal indeholde navnet på rollen |
...
Sik
elementet anvendes ved logon.
...
Table 17. Mulige attributter på et Rolle elementAttribut | Beskrivelse |
---|
r | Skal indeholde navnet på rollen |
2.10. SikSik
elementet anvendes ved logon.
Table 18. Mulige attributter på et Sik elementAttribut | Beskrivelse |
---|
function | Skal angive den funktion der benyttes |
userid | Skal angive brugernavn |
password | Skal angive password |
newpass1 | Kan indeholde et nyt password |
Table 19. Tilladte værdier for attribut "function" - funktionFunktion | Beskrivelse |
---|
signon | Logon via GCTP |
newpass | Skift password |
Code Block |
---|
language | xml |
---|
title | Eksempel på logon |
---|
|
<Sik function="signon" userid="x3450" password="xxxxxx" /> |
Code Block |
---|
language | xml |
---|
title | Eksempel på logonskifte password |
---|
|
<Sik uifunction="newpass" userid="x3450" pwpassword="xxxxxx" npwnewpass1="xxxxxxyyyyyy" /> |
2.11. Praes
...
Der er en række kendte præsentationer for standard objekter, som altid vil indeholder de samme felter, f.eks. vil STAMPNR altid indeholder felter der præsenterer en person, og STAMMYN vil altid indeholde de samme felter for en præsentation af en myndighed.
Table 20. Mulige attributter på et Praes elementAttribut | Beskrivelse |
---|
r | Skal indeholder navnet på præsentationen |
...
En Log angives med navn i r
attributten.
Table 21. Mulige attributter på et Log elementAttribut | Beskrivelse |
r | Det Skal angive det logiske navn på log blokken |
...
Når en session afsluttes vil der ikke forekomme CprData
elementer.
Table 22. Mulige attributter på et Service elementAttribut | Beskrivelse |
---|
r | Skal indeholde navnet på servicen der anvendes |
...