Outils pour utilisateurs

Outils du site


fr:manuals:freemedforms:alerts:coding

Les alertes : codage

  • Grâce au XML et à la technologie de script, il est possible de définir de coder des alertes et de les inclure dans vos formulaires ou de les partager avec vos amis.

Code XML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE FreeMedForms>
<Alert>
  <Descr>
    <!--Non translatable values-->
    <uuid>dc8186adfc204b02ab010bb043172c16</uuid>
    <packuid>AlertPack::Vendor::My::PackName</packuid>
    <version/>
    <authors>You &lt;your@mail.com></authors>
    <vendor>Your compagny</vendor>
    <validity>1</validity> <!-- 1 == isValid; 0 == notValid -->
    <fmfv>0.8.0</fmfv>  <!-- FreeMedForms minimal version -->
    <cdate>2012-07-09T09:57:05</cdate>
    <lmdate>2012-07-10T17:11:54</lmdate>
    <icon>identity.png</icon>
    <cryptedPassword>Q09OVFJBUklBTlQ=</cryptedPassword>
    <viewType>nonblocking</viewType>
    <contentType>patientCondition</contentType>
    <prior>high</prior>
    <overrideComment>false</overrideComment>
    <mustBeRead>false</mustBeRead>
    <remindLater>true</remindLater>
    <editable>true</editable>
    <styleSheet>RONFLER YENS RÉSERVÉS POGROMS SOURCIL LIBRAIRIES ENCHANTÉ ÉMINEMMENT RAFFINÉ IMPÉRISSABLE</styleSheet>
    <!--Translatable values-->
    <comment lang="xx">DIMITRI ÉCLUSER CHALEUR DÉROULE SOULEVER ARRIVAGE AU RÉGIME ÉVÊCHÉ BEAUVAU</comment>
    <comment lang="de">GUITARE ASPHALTER</comment>
    <comment lang="en">QUITTÉ CAUSÉ PROCÉDÉ CENTS PANÉGYRIQUE RENTRÉES GRÂCE CHARISME EXPOSITION</comment>
    <comment lang="fr">ABRÉGÉ DÉVERSER DÉTOURNÉS CONFISCATION MINIÈRE</comment>
    <description lang="xx">NOBEL SOUPAPES PREMIER LAISSAIT CHARGÉS</description>
    <description lang="de">SACHEM ÉCHAPPER</description>
    <description lang="en">SUBSISTENT SOUPÇONNEUX BAS JÉRUSALEM ABAISSER MYTHOMANE</description>
    <description lang="fr">ÉTAIENT PAIR LITURGIE ESTIMANT VERRA HERSAGE ROBE LAMELLE OU</description>
    <label lang="xx">AUX CHEZ DÉLÉGUÉ AMORCÉE (item)</label>
    <label lang="de">COUTEAU PICHET ÉTHIQUE VEILLENT</label>
    <label lang="en">PSYCHOLOGIQUES DEMANDES CHÔMEUR EXALTATION PROGRAMMÉ BANG QUERELLES</label>
    <label lang="fr">APPARTENAIENT MOYENNE CONQUÊTE CONVERTIBLES</label>
    <category lang="xx">GAZA COUDE ÉTANCHE LAMBIN</category>
    <category lang="de">QUI SUPPLICATION AMÉLIORATIONS ALLÉGEMENT</category>
    <category lang="en">COLOSSE DÉSOBÉISSANCE VIVES RENTRÉ NÉGLIGEANT SITUATION CONSULTÉS ENTRAÎNEUSE</category>
    <category lang="fr">ACCOMPAGNÉES CONTAGION ÉCOUTES MUSICIENNE ÉGOTISTE BACK SAPIN INTENSIF</category>
  </Descr>
  <Timings>
    <Timing valid="1" end="2012-07-09T22:25:53" id="78" start="2012-07-07T22:25:53"/>
  </Timings>
  <Rels>
    <Rel id="1" to="patient" uid="patient1Uid..." />
    <Rel id="2" to="patient" uid="patient2Uid..." />
    <Rel id="3" to="patient" uid="patient3Uid..." />
    <Rel id="4" to="allUsers"/>
  </Rels>
  <Scripts>
    <Script valid="1" uid="check_item11" type="check" id="56">print("CURRENT ALERT PROPERTY:"+freemedforms.alert.priority());alert.setPriority(0);true;</Script>
  </Scripts>
  <Xtra>
    <xml>PRODIGALITÉ MARÉES ULTIME ACHÈTENT</xml>
  </Xtra>
</Alert>
2014/03/17 12:25

Décryptage du code XML

Bloc de description

  • uuid : identifiant unique. Attention, si vous ne précisez vous devez vous assurer que cette identifiant ne sera jamais partagé avec une autre alerte. Si vous laissez le champs vide, il sera automatiquement calculé.
  • packUid: contient l'identifiant unique du “jeux d'alertes” (peut contenir plus de 255 caractères)
  • version : version de l'alerte. Utile pour tracer les modifications de versions.
  • authors : attention remplacez les '<' par '&lt;'
  • vendor : nom du “fabricant”
  • validity : validité de l'alerte
    • true (sera présentée à l'utilisateur)
    • false (ne sera pas présentée à l'utilisateur)
  • fmfv : FreeMedForms minimal compatible version
    • la valeur doit être au moins égale à 0.8.0
  • cdate : date de création de l'alerte
  • lmdate : date de dernière mise à jour
  • icon : icône à utiliser pour l'alerte (piochée dans le thème de l'application)
  • cryptedPassword : mot de passe (crypté) pour accéder aux données. (non utilisé)
  • viewType : type de présentation: statique ou dynamique
    • nonblocking : alerte non-bloquante
    • blocking : alerte bloquante
  • contentType : type de contenu de l'alerte
    • patientCondition : relative aux pathologies du patient
    • applicationNotification : notification relative à l'application
    • userNotification : notification relative à un ou plusieurs utilisateurs
  • prior : priorité de l'alerte (lire aussi : niveau d'alerte)
    • high : élevée
    • medium : moyenne
    • low : faible
  • overrideComment : outrepasser l'alerte nécessite un commentaire de la part de l'utilisateur
    • false
    • true
  • mustBeRead : pour être validée, outrepasser ou rappelée ultérieurement, cette alerte doit être lue (reste affichée un temps donnée)
    • false
    • true
  • remindLater : défini la possibilité pour une alerte d'être rappelée ultérieurement
    • false
    • true
  • editable : l'alerte est éditable oui/non
    • false
    • true
  • styleSheet : non utilisée

Bloc de relation

  • Les alertes peuvent reliées :
    • à l'utilisateur courant ou un utilisateur particulier
    • au patient courant ou un patient particulier
    • une famille ou un groupe d'utilisateurs
    • une application
    • à une combinaison non limitative de toutes ces possibilités
  • Le bloc est encadré par le tag Rels pour “relations” et chaque relation est défini par le tag Rel.
  • Les attributs du tag Rel sont:
    • id: identifiant dans la base de données (ne pas définir pour un xml entrant)
    • to: défini le type de relations. Les valeurs possibles sont :
      • patient: relation à un patient défini
      • allPatients: relation à tous les patients
      • family: relation à une famille (non supporté)
      • user: un utilisateur défini
      • allUsers: relation à tous les utilisateurs
      • userGroup: relation à un groupe d'utilisateur défini (non supporté)
      • application : relation à une application
    • uid: défini l'identifiant unique à utiliser pour les relations uniques (à un patient, à un utilisateur, à un groupe d'utilisateur, à une application).

Bloc de scripts

  • il est possible de créer des alertes dynamiques grâce à l'utilisation de scripts.
  • Les scripts sont exécutés à des moments précis du traitement des alertes et ont accès aux données du patient courant, des formulaires et de l'utilisateur en cours.
  • Le bloc est encadré par le tag Scripts et chaque script est défini par le tag Script.
  • Les attributs du tag Script sont:
    • id : identifiant dans la base de données (ne pas définir pour un xml entrant)
    • uid : défini le un identifiant unique pour ce script (optionnel)
    • type : type de script cf supra.
    • valid : le script est valide et sera donc exécuté si la valeur est 'true' sinon il ne sera pas exécuté.
  • Plus d'information dans la page de documentation des scripts des alertes
2014/03/17 12:25
fr/manuals/freemedforms/alerts/coding.txt · Dernière modification: 2014/11/20 22:45 (modification externe)