path: root/design/xmlformat.tex

\section{XML Formatet}
Al kommunikation mellem serveren og klienten (og vice versa)
foregår ved hjælp af XML.\\
Dokumenterne skal starte med en header som specificerer hvilken
XML verison som benyttes, efterfulgt af rodknuden som skal være af
typen \texttt{pracro}.\\
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
    .
    .
    .
</pracro>
\end{verbatim}
Det er vigtigt at pointere at alt data i xml dokumentet skal være i
UTF-8 formatering.

\subsection{\texttt{pracro} elementet}
Pracro elementet bruges som indpakning til hele dokumentet. Den
identificerer blandt andet dokumentversionen og kan indeholde alle
typer data forbundet med Pracro systemet.\\
Pracro elementet har flg. attributter:
\begin{itemize}
\item \textit{cpr} - CPR nummeret på den patient som dataene i filen
  er knyttet til. Det bruges blandt andet ved genfinding af data og 
  den afsluttende lagring af data.\\
  Dette felt må ikke undlades.
\item \textit{version} - Dette felt fortæller hvilken dokument
  version der er benyttet.\\
  Denne variabel skal matche den version klienten forventer.\\
  Dette felt må ikke udelades.
\end{itemize}

\subsection{Request}
En request sektion sendt til serveren skal bevirke at serveren inlæser og
sender den angivne makro til klienten.\\
Hvis klienten modtager en request sektion skal den blot ignorere den.
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
  <request macro="visus"/>
</pracro>
\end{verbatim}

\subsection{Makro}
En makro definerer en makro som grafisk viser og eller indsamler data.\\
En makro sektion sendt til klienten skal bevirke at den beskrevne
grafisk makro vises på skærmen.\\
Hvis serveren modtager en makro sektion skal den blot ignorere den.
Vi starter med et eksempel:
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
  <macro name="macro" version="1.0">
    <window name="mainwindow"
            caption="This is the mainwindow"
            width="800"
            height="600"
            layout="vbox">
      <include name="patient"/>
      <frame name="data_frame" layout="hbox">
        <label caption="Some field"/>
        <lineedit name="lineedit1" regexp="[0-9]+"/>
      </frame>
      <frame name="bottom_frame" layout="hbox">
        <spacer />
        <button caption="Close window" action="abort"/>
        <button caption="Commit changes" action="commit"/>
      </frame>
    </window>
  </macro>
</pracro>
\end{verbatim}
Eksemplet illustrerer flg. funktionaliteter: Makroen og den
properties, main vinduet, includes, frames, labels, lineedits og
knapper.\\
\\
Includes foregår serverside, dvs. klienten modtager det sammensatte
dokument og vil dermed aldrig se \verb|<include ...>| tagget.\\
\\
Der skelnes mellem input felter og ikke-input felter. Et input felt er
et felt som ved endt indtastning vil bidrage med input til serveren,
f.eks. LineEdit, Combo eller CheckBox. Ikke-input felter er
felter som udelukkende bidrager til layout og brugerens forståelse af
inputfelterne, f.eks. Frame, Image eler Label.

\subsubsection{\texttt{macro} elementet}
Makro elementet bruges som indpakning til hele makroen. Den
identificerer makroen og angiver en række værdier som skal bruges til
opsætning på klienten.\\
Makroen har flg. attributter:
\begin{itemize}
\item \textit{name} - Navnet på makroen. Navnet skal matche det navn
  som klienten har bedt om.\\
  Navnet må udelukkende indeholdene de almindelige bogstaver, samt
  underscore, dvs. \verb|[a-z0-9_]+|, hvis det skrives ud som regulært
  udtryk.\\
  Dette felt må ikke undlades.
\item \textit{version} - Dette felt fortæller hvilken version 
  den konkrete makro har.\\
  Dette felt må ikke udelades.
\end{itemize}

\subsubsection{\texttt{include} elementet}
Include elementet kan kun frekomme serverside, hvor det vil blive
udvidet med den angivne makro.\\
Serveren indsætter alle elementer fra (og ikke med) makroens rodvindue
og indad på det sted hvor include elementet befinder sig.\\
Include har flg. attributter: 
\begin{itemize}
\item \textit{name} - Navnet på den makro som skal inkluderes.
\item \textit{disabled} - Angiver om den indsatte makro skal
  disables. Kan have værdierne ``true'' eller ``false''. Hvis udeladt
  benyttes værdien ``false''.
\end{itemize}

\subsubsection{Generelle GUI attributter}
Alle GUI elementerne i xml dokumentet har flg. attributter:
\begin{itemize}
\item \textit{name} - Navnet på elementet. Bruges ved data
  nedlæsning.\\
  Navnet må udelukkende indeholdene de almindelige bogstaver, samt
  underscore, dvs. \verb|[a-z0-9_]+|, hvis det skrives ud som regulært
  udtryk.\\
  Navnet skal være unikt på det niveau hvor elementet befinder sig.\\
  Navnet må ikke undlades.
\item \textit{width} - Et positivt heltal som sætter bredden af
  elementet. Hvis den er udeladt benyttes elementets default bredde.
\item \textit{height} - Et positivt heltal som sætter højden på
  elementet. Hvis den er udeladt benyttes elementets default højde.
\item \textit{help} - Elementets hjælpetekst. En beskrivende tekst som
  vises på skærmen når elementet er aktivt. Hvis udeladt vises
  ingenting.
\item \textit{disabled} - Denne attribut kan være enten ``true'' eller
  ``false''. Hvis den er ``true'' vil elementet blive tegnet disabled
  samt alle dets children rekursivt. Hvis undladt benyttes værdien ``false''.
\end{itemize}

\subsubsection{\texttt{window} elementet}
Et vindue benyttes som moder element, til at indsætte andre elementer
i. Det vil optræde som et vindue på skærmen med kanter, vinduestitel,
ikon osv.\\
Et vindue har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises i labelen. Hvis
  udeladt vises ingen tekst i elementet.
\item \textit{fixed} - Angiver om vinduet kan skaleres eller om det er
  statisk. Kan have værdierne ``true'' eller ``false''. Hvis udeladt
  vil vinduet kunne skaleres.
\item \textit{layout} - Vinduets layout engine. Kan have værdierne
  ``hbox'' eller ``vbox''. Hvis udeladt benyttes et vbox layout.
\end{itemize}

\subsubsection{\texttt{frame} elementet}
En frame benyttes til at indsætte nestede elementer i makroen, såsom
gruperinger af radio buttons.\\
En frame har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises i framen. Hvis
  udeladt vises framen som en tom ramme.
\item \textit{border} - Elementets kant type. Kan have værdierne
  ``plain'' eller ``raised'' Hvis udeladt benyttes laves ingen kant.
\item \textit{padding} - En integer som er størelsen på paddingen på
  elementet. Hvis udeladt benyttes elementets default padding.
\item \textit{margin} - En integer som er størelsen på elementets
  margin. Hvis udeladt benyttes elementets default margin.
\item \textit{layout} - Framens layout engine. Kan have værdierne
  ``hbox'' eller ``vbox''. Hvis udeladt benyttes et vbox layout.
\end{itemize}

\subsubsection{\texttt{spacer} elementet}
Et spacer element bruges for at pakke andre elementer i et layout.\\
En spacer har ingen attributter.

\subsubsection{\texttt{label} elementet}
En label benyttes til at indsætte beskrivejnde tekst i makroen.\\
En label har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises i labelen. Hvis
  udeladt vises ingen tekst i elementet.
\item \textit{alignment} - Justeringen af teksten. Kan have værdierne
  ``left'', ``right'' eller ``center''. Hvis udeladt benyttes ``left''.
\end{itemize}

\subsubsection{\texttt{lineedit} elementet}
En lineedit benyttes til at læse input fra brugeren i kraft tekst.\\
Lineediten kan have et regulært udtryk tilknyttet, som validerer input
mens der tastes og ændrer feltets baggrundsfarve afhængig af om feltet
indeholder valid data eller ej.\\
Feltet er et et linies felt.\\
En lineedit har flg. attributter:
\begin{itemize}
\item \textit{value} - Den tekst som skal vises i lineediten. Hvis
  udeladt vil lineediten være tom.
\item \textit{regexp} - Et regulært udtryk som benyttes til at
  validere feltet. Hvis udeladt accepterer feltet alle inputs. Læs
  mere om de regulære udtryk her:
  \verb|http://doc.trolltech.com/4.3/qregexp.html#introduction|
\end{itemize}

\subsubsection{\texttt{textedit} elementet}
En textedit benyttes ligesom lineedit til at læse input fra brugeren i
kraft af tekst.\\
Textediten kan have et regulært udtryk tilknyttet, som validerer input
mens der tastes og ændrer feltets baggrundsfarve afhængig af om feltet
indeholder valid data eller ej.\\
Feltet er modsat lineedit et flerliniers felt.\\
En textedit har flg. attributter:
\begin{itemize}
\item \textit{value} - Den tekst som skal vises i textediten. Hvis
  udeladt vil textediten være tom.
\item \textit{regexp} - Et regulært udtryk som benyttes til at
  validere feltet. Hvis udeladt accepterer feltet alle inputs. Læs
  mere om de regulære udtryk her:
  \verb|http://doc.trolltech.com/4.3/qregexp.html#introduction|
\end{itemize}

\subsubsection{\texttt{button} elementet}
En knap kan benyttes til enten at afbryde makroen eller at acceptere
dens indhold og dermed gemme dataene på serveren.\\
En knap har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises i knappen. Hvis
  udeladt vises knappen uden tekst.
\item \textit{action} - Den handling som skal udføres når der trykkes
  på knappen. Kan være ``abort'', ``commit'' eller ``reset'', hvor ``abort''
  afbryder makroen, ``commit'' gemmer makroen i databasen og i
  journalen og ``reset'' fjerner alle indtastede data. Hvis udeladt
  vil en inaktiv knap blive produceret.
\end{itemize}

\subsubsection{\texttt{checkbox} elementet}
En checkbox bruges til at aktivere eller deaktivere en given værdi ved
hjælp af flueben.\\
En checkbox har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises i knappen. Hvis
  udeladt vises checkboxen uden tekst.
\item \textit{value} - Den værdi som checkboxen har intielt. Kan
  ``true'' eller ``false''. Hvis udeladt vil checkboxen få værdien
  ``false''.
\end{itemize}

\subsubsection{\texttt{togglebutton} elementet}
En togglebutton bruges til at aktivere eller deaktivere en given værdi ved
brug af en trykknap.\\
En togglebutton har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises i knappen. Hvis
  udeladt vises knappen uden tekst.
\item \textit{value} - Den værdi som knappen har intielt. Kan
  ``true'' eller ``false''. Hvis udeladt vil den få værdien
  ``false''.
\end{itemize}

\subsubsection{\texttt{radiobuttons} elementet}
En radiobuttons gruppe bruges til at vælge et element ud af en gruppe
via radiobuttons.\\
Radiobuttons gruppen har flg. attributter:
\begin{itemize}
\item \textit{value} - Inidikerer hvilken radiobutton i gruppen som skal være
  valgt initielt. Hvis udeladt eller ikke-matchende vil ingen radiobutton være
  valgt, hvilket vil svare til at et regulært udtryk på et tekstfelt ikke er
  opfyldt.
\end{itemize}
Radiobuttons indeholder \texttt{item} tags som beskriver hvilke valgmuligheder
den givne gruppe har.\\
Et radiobutton item har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises i radiobuttonen. Hvis
  udeladt vises radiobuttonen uden tekst.
\item \textit{value} - Den værdi som radiobuttonen har og som sendes som værdi
  af gruppen hvis denne radiobutton er valgt ved commit.
\end{itemize}
Ved commit returneres radiobutton gruppens navn med den valgte radiobuttons value.

\subsubsection{\texttt{combobox} elementet}
En combobox gruppe bruges til at vælge et element ud af en gruppe.\\
En combobox har flg. attributter:
\begin{itemize}
\item \textit{value} - Inidikerer hvilket element i gruppen som skal være
  valgt initielt. Hvis udeladt eller ikke-matchende vil comboboxen være tom,
  hvilket vil svare til at et regulært udtryk på et tekstfelt ikke er
  opfyldt.
\end{itemize}
Comboboxen indeholder \texttt{item} tags som beskriver hvilke valgmuligheder
den givne gruppe har.\\
Et combobox item har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises for denne valgmulighed. Hvis
  udeladt vises den uden tekst.
\item \textit{value} - Den værdi som valgmuligheden har og som sendes som værdi
  af gruppen hvis den er valgt ved commit.
\end{itemize}
Ved commit returneres comboboxens navn med det valgte items value.

\subsubsection{\texttt{listbox} elementet}
En listbox bruges til at vælge præcis et element ud af en gruppe via en liste.\\
En listbox har flg. attributter:
\begin{itemize}
\item \textit{value} - Inidikerer hvilket element på listen som skal være
  valgt initielt. Hvis udeladt eller ikke-matchende vil ingenting være valgt,
  hvilket vil svare til at et regulært udtryk på et tekstfelt ikke er
  opfyldt.
\end{itemize}
Listboxen indeholder \texttt{item} tags som beskriver hvilke linier der skal
være i listen.\\
Et listbox item har flg. attributter:
\begin{itemize}
\item \textit{caption} - Den tekst som skal vises for denne valgmulighed. Hvis
  udeladt vises den uden tekst.
\item \textit{value} - Den værdi som valgmuligheden har og som sendes som værdi
  af gruppen hvis den er valgt ved commit.
\end{itemize}
Ved commit returneres listboxens navn med det valgte items value.


\subsection{Commit}
En commit sektion sendt til serveren skal  bevirke at serveren lagrer de
sendte data i databasen, samt genererer et resumé som kan blive sendt
tilbage til klienten.\\
Hvis klienten modtager en commit sektion skal den blot ignorere den.
\begin{verbatim}
<?xml version="1.0" encoding="UTF-8"?>
<pracro version="1.0" cpr="1505050505">
  <commit user="johndoe" macro="visus" version="1.0">
    <field name="visus_objektiv" value="42"/>
    <field name="visus_subjektiv" value="42"/>
  </commit>
</pracro>
\end{verbatim}

\subsubsection{\texttt{commit} elementet}
Commit elementet har flg. attributter:
\begin{itemize}
\item \textit{user} - Brugernavnet på den bruger som har udfyldt makroen.
\item \textit{macro} - Navnet på den makro som dataene er indtastet i.
\item \textit{version} - Versionsnummeret på den makro som er blevet udfyldt.
\end{itemize}

\subsubsection{\texttt{field} elementet}
Field elementet har flg. attributter:
\begin{itemize}
\item \textit{name} - Navnet på feltet.
\item \textit{value} - Værdien af feltet.
\end{itemize}

%\subsection{Resumé}
%En resumé sektion sendt til klienten skal bevirke at klienten appender den
%sendte tekst til PC-Praxis journalfilen.\\
%Hvis serveren modtager en resumé sektion skal den blot ignorere den.
%\begin{verbatim}
%<?xml version="1.0" encoding="UTF-8"?>
%<pracro version="1.0" cpr="1505050505">
%  <resume macro="visus" version="1.0">Det objektive synsmål var
%42 dioptri, og det subjektive synsmål var 42 dioptri.</resume>
%</pracro>
%\end{verbatim}