Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version 1.0.5

...

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.

GCTP Struktur

Herunder beskrives de enkelte tags

Anchor
_gctp
_gctp
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 element
AttributBeskrivelse
vSkal indeholde versionen af GCTP der anvendes
envKan indeholde en indentifikation af det miljø der kommunikeres med
Code Block
languagexml
titleEksempel
<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 element
AttributBeskrivelse
rSkal 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 element
AttributBeskrivelse
rSkal indeholde navnet på hændelsen der kaldes
mkSkal indeholde den indberettende myndighedskode
aSkal indeholde hvilken aktion der ønskes eller hvilken tilstand servicen er Ii
uHvis denne attribut udfyldes med u="v" angives der at man ønsker at anvende ventesystemet
stst="P" angiver primær hændelse. Der anvends anvendes kun primære hændelser i CPR ved GCTP version 2.0
tsAnvendes til at identificere den igangværende session med den pågældende hændelse
Table 4. Udfaset attributter på et CprServiceHeader element
AttributBeskrivelse
ptIdentificere den primære session en sekundær hændelse indgår i
pvAngiver en myndighed som en hændelse er indsendt på vegne af

...

Table 15. Tilladte værdier for attributter attribut "a" - aktion
AktionBeskrivelse
IInitiering af hændelsen
VValidering af hændelsen
GGem hændelsen
FFortryd hændelsen
SSlet mange registreringer i hændelsen
1Initiering fra Vent
2Gem som kladde
3Gem og send til godkendelse i Vent
4Gem og godkend i Vent
5Aktiver fra Vent
6Slet fra Vent
7Afvis fra Vent

...

8Send til godkendelse uden data
9Godkend uden data
Table 6. Udfaset værdier for attribut "a" - aktion
AktionBeskrivelse
UGem uden initier
Code Block
languagexml
titleEksempel 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 element
AttributBeskrivelse
rSkal indeholde navnet på feltet
vVærdien af feltet
aEgenskaber ved feltet, f.eks. L=Låst, S=Skal
a1Yderligere egenskaber for feltet
tEn tekst betegnelse af værdien i v attributten
tsEn forkortet tekst betegnelse af værdien i v attributten
tmEn mellemlang tekst betegnelse af værdien i v attributten
tlEn lang tekst betegnelse af værdien i v attributten
eEn fejlkode der angiver at der er fejl i det pågældende felt
bvEn boolsk betegnelse (true/false) for værdien i v-attributten
Code Block
languagexml
titleEksempel 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 element
AttributBeskrivelse
uAngiver 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
kNø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

...

languagexml
titleEksempel på model række

...

Table 9. Tilladte værdier for attribut "u" - usage
UsageBeskrivelse
MBeskriver modellen af rækker i en tabel
BEn logisk separator der kan adskille forskellig data
RESTGenstart 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" - usage
UsageBeskrivelse
CIndsæt som ny række
UOpdater denne række
DSlet denne række
Code Block
languagexml
titleEksempel 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 element
AttributBeskrivelse
rSkal indeholde tabellens navn
aiaAntal i alt, anvendes ved søgninger
minDet minimale antal rækker tabellen kan skal indeholde
maxDet maksimale antal rækker tabellen må indeholde
mrMax antal rækker der kan indberettes indsendes via tabellen
Code Block
languagexml
titleEksempel 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 element
AttributBeskrivelse
rKvitteringstypen. Ok, Afslut, FejlSkal angive kvitteringstypen
vIndeholder fejlkode såfremt der er tale om en fejlkvittering ellers 0tsIndeholder en fejltekst Skal angive kvitteringskoden
tKan indeholder en tekst såfremt der er tale om en fejlkvittering
Code Block
languagexml
titleEksempel på fejl kvittering
<Kvit r="Fejl" v="3422" t="Personen findes ikke i CPR" />

...

languagexml
titleEksempel på OK kvittering efter validering

...

fejl eller anmærkning
Table 13. Tilladte værdier for attribut "r" - kvitteringstype
TypeBeskrivelse
SystemSystemfejl
AnmrkAnmodningen blev behandlet uden fejl men der er en anmærkning
AfslutAnmodningen blev behandlet uden fejl og session er afsluttet
FejlAnmodningen fejlede
OkAnmodningen blev behandlet uden fejl og sessionen er stadig aktiv
returKodeKvitteringskoden kan have en speciel betydning - ikke blot ok eller en fejl/anmærkning
Table 14. Udfaset værdier for attribut "r" - kvitteringstype
TypeBeskrivelse
DumpGammel systemfejl
Code Block
languagexml
titleEksempel på fejl kvittering
<Kvit r="Fejl" v="3422" t="Personen findes ikke i CPR" />
Code Block
languagexml
titleEksempel på OK kvittering efter validering
<Kvit r="OK" v="0" />
Code Block
languagexml
titleEksempel 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 element
AttributBeskrivelse
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 usage
Data usageBeskrivelse
IBlokken indeholder input data der kan redigeres
OBlokken indeholder output data der ikke kan redigeres, og som blot er til visninger

Anchor
_rolle
_rolle
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.

AttributBeskrivelse
rSkal indeholde navnet på rollen

...

Sik elementet anvendes ved logon.

...

Table 17. Mulige attributter på et Rolle element
AttributBeskrivelse
rSkal indeholde navnet på rollen

Anchor
_sik
_sik
2.10. Sik

Sik elementet anvendes ved logon.

Table 18. Mulige attributter på et Sik element
AttributBeskrivelse
functionSkal angive den funktion der benyttes
useridSkal angive brugernavn
passwordSkal angive password
newpass1Kan indeholde et nyt password
Table 19. Tilladte værdier for attribut "function" - funktion
FunktionBeskrivelse
signonLogon via GCTP
newpassSkift password
Code Block
languagexml
titleEksempel på logon
<Sik function="signon" userid="x3450" password="xxxxxx" />
Code Block
languagexml
titleEksempel på logonskifte password
<Sik uifunction="newpass" userid="x3450" pwpassword="xxxxxx" npwnewpass1="xxxxxxyyyyyy" />

Anchor
_praes
_praes
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 element
AttributBeskrivelse
rSkal indeholder navnet på præsentationen

...

En Log angives med navn i r attributten.

Table 21. Mulige attributter på et Log element
AttributBeskrivelse
rDet 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 element
AttributBeskrivelse
rSkal indeholde navnet på servicen der anvendes

...