Définition du projet

Projet à une page

La structure globale d'un recueil est définie par le code du projet, qui définit les différentes tables et pages du recueil, ainsi que les liens entre celles-ci.

Pour créer à la fois une table et la page correspondante, utilisez la fonction app.form() de la manière suivante :

app.form ( "cle_page", "Titre de la page" )

Cet appel suffit à définir un projet simple avec une page de recueil, et vous pouvez vous contenter de l'exemple suivant si c'est votre cas :

app.form("projet", "Projet de recueil")

Plusieurs pages

Pour définir un projet avec plusieurs pages dans Goupile, il est nécessaire d'imbriquer les pages à l'intérieur d'une catégorie principale :

app.form ( "cle_categorie", "Nom de la catégorie", () => { app.form ( "page1", "Titre de la première page" ) app.form ( "page2", "Titre de la deuxième page" )
// Autres pages... } )

Avec cette structure simple, le recueil sera structuré selon la capture ci-dessous :

Menu hiérarchisé

L'imbrication des pages définit également la hiérachie de menu du projet. C'est ce que montre l'exemple suivant, plus proche d'un projet réel (avec une inclusion et 2 temps de recueil), avec un menu hiérarchique qui sépare bien les temps de recueil :

Le code de projet qui correspond à la structure du formulaire présenté en capture est disponible ci-dessous :

app.form("projet", "Validation d'échelle", () => {
    app.form("inclusion", "Inclusion")

    app.form("bilan", "Bilan initial", () => {
        app.form("atcd", "Antécédents")
        app.form("echelle0", "Échelle initiale")
    })

    app.form("m1", "Suivi M1", () => {
        app.form("suivi1", "Suivi à 1 mois")
        app.form("echelle1", "Échelle intermédiaire")
    })
})

Options de passation

Système d'annotation

Goupile propose un système d'annotations de variables, chaque variable peut être accompagnée d'un statut de remplissage et d'un commentaire libre. Consultez la documentation sur les variable annotées pour en savoir plus.

Cette fonctionnalité n'est pas activée par défaut pour des raisons historiques. Vous devez l'activer avec l'option app.annotate comme ceci :

app.annotate = true

// app.form("projet", "Titre")
// ...

Toutes les variables peuvent être annotées par défaut, mais vous pouvez modifier cette option pour chaque variable en cas de besoin.

Pages conditionnelles

Il est souvent nécessaire d'activer ou de désactiver certaines pages en fonctions de conditions de remplissage.

Un exemple classique est l'utilisation d'une page d'inclusion : la page d'inclusion doit être la seule page disponible jusqu'à ce que les conditions d'inclusion d'un participant soit remplie. Si les conditions ne sont pas remplies, les pages restent désactivées.

Utilisez l'option enabled pour désactiver des pages. Il s'agit d'une option dynamique, c'est à dire qu'elle peut être calculée en fonction des données de l'enregistrement.

app.form("projet", "Validation", {
    app.form("inclusion", "Inclusion du patient")

    // Le bilan ne sera disponible que si la variable "ok" est égale à 1
    app.form("bilan", "Bilan initial", { enabled: thread => thread.data.inclusion.ok == 1 })
})

Voici un exemple plus complet, avec une page d'inclusion et deux pages de suivi, qui ne sont activées qu'après vérification de critères d'inclusion (âge et partage des données) :

// Script de projet

app.form("projet", "Validation", () => {
    app.form("inclusion", "Inclusion du patient")

    app.pushOptions({ enabled: thread => thread.data.inclusion.ok == 1 })

    app.form("bilan", "Bilan initial")
    app.form("suivi1", "Suivi à 1 mois")
})

// Contenu de la page "inclusion"

form.section("Critères d'inclusion", () => {
    form.binary("majeur", "Avez-vous 18 ans ?")
    form.binary("opposition", "Acceptez-vous de participer à cette étude ?")

    values.ok = (values.majeur == 1 && values.opposition == 1) ? 1 : 0
})

Pages successives

Par défaut, chaque page fonctionne de manière indépendante, et doit être ouverte par le menu ou bien depuis la page de statut d'enregistrement. Lorsque l'utilisateur enregistre une page, celle-ci reste ouverte.

Vous pouvez définir une séquence (ou suite) de pages à l'aide de l'option sequence, qui peut être utilisée de trois manières :

• sequence: true : l'enregistrement d'une page ouvre la prochaine page avec une option sequence
• sequence: "prochaine_page" : l'enregistrement d'une page redirige vers la page nommée explicitement
• sequence: ["page1", "page2", "page3"] : l'enregistrement d'une page envoie vers la page suivante du tableau indiqué

Une fois la fin de la séquence atteinte, l'utilisateur est redirigé vers la page de statut.

Séquence simple

L'exemple suivant démontre l'utilisation d'une séquence simple, avec deux pages, à la fin desquelles l'utilisateur est redirigé vers la page de statut.

app.form("projet", "2 pages", {
    app.pushOptions({ sequence: true })

    app.form("page1", "Première page")
    app.form("page2", "Deuxième page")
})

Séquences multiples

L'exemple suivant démontre l'utilisation de deux séquences. Lorsque l'utilisateur ouvre la page "A", il devra remplir les pages "A", "C" et "E" à la suite. Si il ouvre la page "B", il devra remplir les pages "B", "D" et "F" à la suite.

let ace = ['a', 'c', 'e']
let bdf = ['b', 'd', 'f']

app.form("projet", "6 pages", {
    form.text('a', 'A', { sequence: ace }) // Prochaine page: C
    form.text('b', 'B', { sequence: bdf }) // Prochaine page: D

    form.text('c', 'C', { sequence: ace }) // Prochaine page: E
    form.text('d', 'D', { sequence: bdf }) // Prochaine page: F

    form.text('e', 'E', { sequence: ace }) // Retour à la page de statut
    form.text('f', 'F', { sequence: bdf }) // Retour à la page de statut
})

Sauvegarde automatique

Par défaut, les données ne sont enregistrées que lors de la validation par le bouton Enregistrer. L'enregistrement implique un formulaire entièrement valide, pour lequel les oublis et les erreurs sont corrigées ou annotées.

Vous pouvez opter pour un mode de sauvegarde automatique. Dans ce cas, les changements effectués sont enregistrés à intervalle régulier, sans erreur bloquante. Utilisez le paramètre autosave en précisant le délai d'enregistrement en millisecondes.

// Les changements sont enregistrés après 5 secondes d'inactivité (5000 ms)
app.form("auto", "Sauvegarde automatique", { autosave: 5000 })

Les pages enregistrées de manière automatique sont marqués par un statut de brouillon, qui est visible et peut être filtré dans le tableau de suivi. Le bouton d'enregistrement reste disponible même en mode de sauvegarde automatique; il permet de valider les données et de faire disparaitre le statut de brouillon.

Verrouillage et oubli

Par défaut, les enregistrements Goupile sont modifiables à tout moment. Les droits utilisateurs relatifs aux données distinguent la lecture des données, la sauvegarde et la suppression, sans distinction entre la création et la modification d'un enregistrement.

Goupile propose deux fonctionnalités pour empêcher la modification d'un enregistrement existant, qui peuvent être utilisées séparémment ou bien combinées :

• Le verrouillage (option lock) pour que les données soit mises en lecture seule
• L'oubli (option forget) pour les utilisateurs en mode invité (ou pour les utilisateurs avec droit de sauvegarde sans droit de lecture)

Verrouillage

L'option lock permet de verrouiller les données saisies par l'utilisateur, il y a 3 possibilités :

• lock: true : entraine un verrouillage immédiat au moment de la sauvegarde
• lock: delay : entraine un verrouillage différé, après le délai spécifié en millisecondes (par exemple lock: 300 * 1000 pour verrouiller après 300 secondes soit 5 minutes)
• lock: false : verrouillage manuel avec un bouton dédié

Comme les autres options décrites précédemment, cette option peut être différente pour chaque page du projet. Dans un formulaire avec plusieurs pages, vous pouvez définir l'option lock (immédiate ou après délai) sur la dernière page, pour verrouiller l'enregistrement une fois qu'il est rempli entièrement.

app.form("projet", "2 pages", () => {
    app.form("vous", "Informations sur le participant")
    app.form("avis", "Avis sur la journée scientifique", { lock: 300000 })
})

Les utilisateurs avec droit d'audit (DataAudit) peuvent déverrouiller un enregistrement à l'aide du bouton dédié.

Oubli

Cette fonctionnalité concerne deux types d'utilisateurs :

• Les invités (questionnaires accessibles aux invités)
• Les utilisateurs avec droit de sauvegarde (DataSave) sans droit de lecture

Lorsque ces utilisateurs créent un enregistrement dans Goupile, ils obtiennent un droit de lecture et de modification limité aux enregistrements qu'ils ont créé. Dans Goupile, on dit qu'ils ont un claim sur l'enregistrement concerné.

Ce claim peut être supprimé en définissant l'option forget: true dans les options de page. Tout comme pour le verrouillage décrit précédemment, cette option peut être utilisée sur la dernière page d'un enregistrement à plusieurs pages: ainsi, l'utilisateur pourra remplir les différentes pages, jusqu'à finaliser le remplissage sur la dernière page.

app.form("projet", "2 pages", () => {
    app.form("vous", "Informations sur le participant")
    app.form("avis", "Avis sur la journée scientifique", { forget: true })
})