Nærværende dokument indeholder en beskrivelse Gctp service protokollen

General Communication Transfer Protocol (GCTP) er et data transport format til kommunikation af data mellem CPR’s services og en klient hvad enten den er server side eller desktop baseret.

Formålet med dette dokument er at beskrive GCTP formatet på en sådan måde at læseren sættes istand i til at kunne afkode data fra gctp formatet. Det skal endvidere være mulig på baggrund af dette dokument at implementere software der er i stand til at skrive og modtage GCTP

GCTP indgår som en blok i et XML-dokument af XML ver 1.0 http://www.w3.org/TR/REC-xml. (REC-xml).

GCTP er en XML baseret protokol og fungerer ved hjælp af tags og attributter.

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.

Open

Herunder beskrives de enkelte tags

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 beskeden

Table 1. Mulige attributter på et Gctp element

System elementet anvendes til at angive oplysninger om hvilket system man agter at køre imod.

Table 2. Mulige attributter på et System element

CprServiceHeader elementet anvendes til at angive oplysninger om hvilken tilstand man ønsker at anvende når man kalder gctp og hvilken tilstand man er i når man modtager GCTP’en.

Endvidere kan angives om man anvender ventesystemet og servicen er primær (hvilket den altid er).

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.

Table 3. Mulige attributter på et CprServiceHeader element

Table 4. Udfaset attributter på et CprServiceHeader element

Table 5. Tilladte værdier for attribut "a" - aktion

Table 6. Udfaset værdier for attribut "a" - aktion

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.

Table 7. Mulige attributter på et Field element

En Row er beregnet på at kunne indeholde en række af data fra en tabel. Ved hjælp af usage attributten kan det fastsættes, om en række indeholder data eller om der er tale om en modelrække der bare angiver felter der er muligt på en række.

Selve datafelterne findes som Field elementer inde i Row blokken, som ikke kan optræde uden at være indeholdt i en Table blok.

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

Table 9. Tilladte værdier for attribut "u" - usage

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

En Table er beregnet til at kunne indeholde data i tabel format, dvs i rækker og kolonner.

Table elementet anvendes sammen med Row elementet: Table tagget omkranser hele tabellen, mens de enkelte rækker omkranses af Row elementer inde i Table elementet.

Der kan godt forekomme flere Table elementer i en besked og disse skal derfor navngives unikt.

Endvidere kan Table indehold informationer om hvor mange rækker der er i alt.

Table 11. Mulige attributter på et Table element

Kvit elementet indeholder informationer om resultatet af seneste handling i form af enten en OK kvittering eller en fejl kvittering.

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

Table 13. Tilladte værdier for attribut "r" - kvitteringstype

Table 14. Udfaset værdier for attribut "r" - kvitteringstype

CprData elementet angives til angive blokke af data der anvendes i GCTP beskeden. Der skelnes på attributten u som angiver om der er tale om input eller output data.

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

Table 16. Tilladte værdier for attribut "u" - data usage

Rolle elementet anvendes til at angive blokke af data som omhandler et specifikt objekt der indgår i servicen, f.eks. en person. Omhandler en service f.eks. flere personer kan der være flere Roller under CprData elementet.

En rolle angives med navn i r attributten.

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.

Table 17. Mulige attributter på et Rolle element

Sik elementet anvendes ved logon.

Table 18. Mulige attributter på et Sik element

Table 19. Tilladte værdier for attribut "function" - funktion

Praes elementet anvendes til præsentation af objekters data. Blokken indeholder Field elementer.

En Praes angives med navn i r attributten.

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

Log elementet kan anvendes til at samle flere Service elementer under en logisk logning. Dette anvendes kun ved søge-services.

En Log angives med navn i r attributten.

Table 21. Mulige attributter på et Log element

Service elementet anvendes til at identificere den CPR ydelse der skal benyttes.

En Service angives med navn i r attributten.

Elementet indeholder altid en eller flere CprServiceHeader elementer, samt CprData elementer til input og output data, hvis en service session er i gang. Ved svar var serveren vil der også være et Kvit element.

Når en session afsluttes vil der ikke forekomme CprData elementer.

Table 22. Mulige attributter på et Service element