Author: bleny Date: 2011-06-17 14:43:04 +0000 (Fri, 17 Jun 2011) New Revision: 1347 Log: documentation drafts ; schemas updated Added: trunk/src/site/resources/export_feuille_de_route_dans_thunderbird.png trunk/src/site/resources/schemas/References.png trunk/src/site/rst/obsDeb/ trunk/src/site/rst/obsDeb/administrateur.rst trunk/src/site/rst/obsDeb/coordinateur.rst trunk/src/site/rst/obsDeb/observateur.rst Modified: trunk/src/site/resources/schemas/Beans.png trunk/src/site/resources/schemas/Contacts.png trunk/src/site/resources/schemas/Entities.png trunk/src/site/resources/schemas/EntitiesActivityCalendar.png trunk/src/site/resources/schemas/IO.png trunk/src/site/resources/schemas/Operationsdetails.png trunk/src/site/resources/schemas/SamplingPlan.png trunk/src/site/resources/schemas/Services.png trunk/src/site/site_fr.xml Added: trunk/src/site/resources/export_feuille_de_route_dans_thunderbird.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/export_feuille_de_route_dans_thunderbird.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/src/site/resources/schemas/Beans.png =================================================================== (Binary files differ) Modified: trunk/src/site/resources/schemas/Contacts.png =================================================================== (Binary files differ) Modified: trunk/src/site/resources/schemas/Entities.png =================================================================== (Binary files differ) Modified: trunk/src/site/resources/schemas/EntitiesActivityCalendar.png =================================================================== (Binary files differ) Modified: trunk/src/site/resources/schemas/IO.png =================================================================== (Binary files differ) Modified: trunk/src/site/resources/schemas/Operationsdetails.png =================================================================== (Binary files differ) Added: trunk/src/site/resources/schemas/References.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/schemas/References.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/src/site/resources/schemas/SamplingPlan.png =================================================================== (Binary files differ) Modified: trunk/src/site/resources/schemas/Services.png =================================================================== (Binary files differ) Added: trunk/src/site/rst/obsDeb/administrateur.rst =================================================================== --- trunk/src/site/rst/obsDeb/administrateur.rst (rev 0) +++ trunk/src/site/rst/obsDeb/administrateur.rst 2011-06-17 14:43:04 UTC (rev 1347) @@ -0,0 +1,136 @@ +############################################################################### +Utiliser Wao en tant qu'administrateur sur ObsDeb +############################################################################### + +=============================================================================== +Initialisation de Wao +=============================================================================== + +Afin de rendre et de maintenir Wao opérationel, l'administrateur a pour rôle +de maintenir les référentiels Wao : + + * Le référentiel des lieux terrestres : il contient les ports mentionnés + dans la stratification spatiale, les quartiers maritimes et les régions + mentionnées dans le plan d'échantillonnage téléphonique + + * Le référentiel de stratification spatiale : il découpe les lieux terrestres + en unités d'observation, ces unités d'observations sont utilisées dans + le plan d'échantillonnage terrain + + * Le référentiel des navires : il contient les informations sur les navires + qui seront enquêtés lors de la réalisation du plan téléphonique ou qui + seront rencontrés lors de l'observation de terrain + + * Le référentiel de stratification des navires : il associe à chaque navire + une strate d'appartenance. Ce référentiel permet, lors de la réalisation + du plan d'échantillonnage téléphonique de déterminer des substituts au + navire enquêté + + * Le référentiel des codes métiers : ces codes sont mentionnés dans les + comptes rendus des observateurs après reconstitution d'une marée + +Tous ces référentiels peuvent être importés dans Wao dans la partie +« Administration » du site. + +Les fichiers doivent contenir les données au format CSV colonne séparées par +le caractère ``;``, encodage de caractères UTF-8. + +Des fichiers d'exemples se trouvent de le répertoire + +TODO + +=============================================================================== +Import du plan d'échantillonnage initial +=============================================================================== + +Le plan d'échantillonnage initial (qu'il s'agisse du terrain ou du +téléphonique) peut être importé depuis la partie « Administration » +ou depuis la partie « Plan d'échantillonnage ». C'est le même +formulaire qui doit être utilisé pour le terrain ou le téléphonique, +Wao détectera le type de plan (en fonction des colonnes présentes dans +le fichier) et agira en conséquence. + +Dans Wao, les lignes du plan d'échantillonnage sont identifiées par un +code unique. Lors de l'import initial, il est très vivement recommandé +de ne pas essayer d'attribuer arbitrairement des valeurs dans la colonne +PLAN_CODE (risque de collision avec les plan des autres actions). En +laissant la colonne vide pour une ligne donnée, Wao déduira qu'il s'agit +d'une nouvelle ligne et y affectera, au moment du chargement, un code unique. +Ainsi, pour l'import initial, il est recommandé de laisser toutes les lignes +avec la colonne PLAN_CODE vide. + +Des fichiers d'exemples du plan d'échantillonnage se trouvent dans le +répertoire + +TODO + +=============================================================================== +Adaptation du plan d'échantillonnage selon les contraintes opérationnelles +=============================================================================== + +À tout moment, il est possible pour les administrateurs et le coordinateur +d'adapter le plan d'échantillonnage selon les contraintes rencontrées +par les observateurs. + +Pour modifier une ligne, il est possible d'accéder au formulaire de +modification d'une ligne via le bouton « calepin » de la colonne « Actions » +du plan d'échantillonnage. + +Pour modifier plusieurs lignes, la méthode la plus efficiente est d'exporter +le plan (après filtrage pour n'avoir que les lignes concernées), de le +modifier via le tableur OpenOffice puis de ré-importer le plan. Toutes les +colonnes sont modifiables, Wao se basera sur le code de la ligne pour +retrouver les lignes qui ont été modifiées et faire les changements en base. + +Toutes les modifications saisies sont historisées (auteur de la modification, +date, résumé des changements). L'historique d'une ligne est accessible via +le bouton « horloge » de la colonne « Actions » du plan d'échantillonnage. + +=============================================================================== +Suivi de la réalisation du plan d'échantillonnage +=============================================================================== + +Au fur et à mesure des observations réalisées, les observateurs vont créer +des contacts. Vous pouvez à tout moment voir les contacts dans la partie +« Contacts » de Wao. + +Le coordinateur a un rôle de médiation entre les observateurs et vous. Il +peut valider les contacts qui ont été saisis par les observateurs. Après cette +première validation, c'est en tant qu'administrateur qui vous pouvez valider +un contact si vous estimer que l'observation réalisée est conforme aux +exigences du programme. Dans le cas contraire, vous pouvez saisir un +commentaire dans le champs « Commentaire programme » du contact afin +d'indiquer au coordinateur ce qui doit être revu et corrigé. + +Dans la partie « Plan d'échantillonnage », vous pouvez voir quelles sont les +lignes réalisées (colonne « Réalisé »), avec précisé entre parenthèses, le +nombre de contacts créés pour cette ligne. Une ligne est considérée comme +réalisée s'il existe au moins un contact associé à cette ligne. + +Pour passer une ligne en réalisé malgré l'absence de contacts (la ligne +n'a pas pu être échantillonnée suite à des circonstances exceptionnelles), +vous pouvez cocher, dans le formulaire de modification d'une ligne, la +case journée blanche. Dans ce cas, on indique que la société, même si elle +n'a pas pu obtenir de données pour le programme d'observation, a respecté +son contrat de prestataire. + +------------------------------------------------------------------------------- +Synthèses +------------------------------------------------------------------------------- + +Pour obtenir une vue d'ensemble des travaux d'observations réalisés pour +le programme, vous pouvez consulter la partie « Synthèse » de Wao. + +Les différentes synthèses permettent de visualiser, au fur et a mesure +de la réalisation du plan : + + * Le nombre de navires distinct observés + + * Le nombre d'observations réalisées selon l'heure d'observations + + * Les états de contacts indiquant, pour chaque état, le nombre de contacts + dans cet état, ainsi que la proportion de contact dans cet état. + +Vous pouvez raffiner les données observées en filtrant selon des critères +portant sur le plan d'échantillonnage ainsi que selon le critère de +validation des contacts (prévisionnel / réalisé). Added: trunk/src/site/rst/obsDeb/coordinateur.rst =================================================================== --- trunk/src/site/rst/obsDeb/coordinateur.rst (rev 0) +++ trunk/src/site/rst/obsDeb/coordinateur.rst 2011-06-17 14:43:04 UTC (rev 1347) @@ -0,0 +1,46 @@ +############################################################################### +Utiliser Wao en tant que coordinateur sur ObsDeb +############################################################################### + +En tant que coordinateur, vous êtes responsable de la relation entre la société +prestataire et l'Ifremer. Vous veillez à la réalisation du plan d'échantillonnage +et effectuez les aménagements nécessaires si un observateurs ne peut effectuer +l'observation (maladie, blocage administratif…) + +En tant que coordinateur, vous disposez des mêmes possibilités qu'en tant +qu'observateur. Vous pouvez donc vous référez à la page dédiée. + +=============================================================================== +Adaptation du plan d'échantillonnage selon les contraintes opérationnelles +=============================================================================== + +À tout moment, il est possible pour les administrateurs et le coordinateur +d'adapter le plan d'échantillonnage selon les contraintes rencontrées +par les observateurs. + +Pour modifier une ligne, il est possible d'accéder au formulaire de +modification d'une ligne via le bouton « calepin » de la colonne « Actions » +du plan d'échantillonnage. + +Pour modifier plusieurs lignes, la méthode la plus efficiente est d'exporter +le plan (après filtrage pour n'avoir que les lignes concernées), de le +modifier via le tableur OpenOffice puis de ré-importer le plan. Toutes les +colonnes sont modifiables, Wao se basera sur le code de la ligne pour +retrouver les lignes qui ont été modifiées et faire les changements en base. + +Toutes les modifications saisies sont historisées (auteur de la modification, +date, résumé des changements). L'historique d'une ligne est accessible via +le bouton « horloge » de la colonne « Actions » du plan d'échantillonnage. + + +=============================================================================== +Valider les données créées par les observateurs pour le programme +=============================================================================== + +En tant que coordinateur, vous devez valider les contacts créés par les +observateurs de votre société avant présentation auprès du programme. + +Pour cela vous devez régulièrement vous rendre dans la partie « Contacts », +retrouver les contacts non-encore validés validés par la société (ils sont +marqués par un point d'interrogation dans la colonne « Validation Société ») + Added: trunk/src/site/rst/obsDeb/observateur.rst =================================================================== --- trunk/src/site/rst/obsDeb/observateur.rst (rev 0) +++ trunk/src/site/rst/obsDeb/observateur.rst 2011-06-17 14:43:04 UTC (rev 1347) @@ -0,0 +1,151 @@ +############################################################################### +Utiliser Wao en tant qu'observateur sur ObsDeb +############################################################################### + + +En tant qu'observateur, votre rôle est de suivre le plan d'échantillonnage qui +définit le prévisionnel des observations à effectuer. + +Wao vous permet : + + * De savoir ce qu'il vous reste à faire (le prévisionnel des jours à venirs) + + * D'obtenir des informations nécessaire à l'observation (annuaire des navires) + + * De rapporter les observations que vous avez faites via la création de + contacts. + + +=============================================================================== +Avant l'observation : le prévisionnel +=============================================================================== + +Une fois connecté en tant qu'observateur, vous pouvez via la page « Plan +d'échantillonnage » accéder au prévisionnel. En tant qu'observateur, les lignes +listées sont celles qui vont concernent, c'est à dire les lignes pour lesquelles +vous avez été déterminé comme faisant parti des observateurs. + +Les lignes sont triées par ordre chronologique, vous avez donc devant vous, dès +l'ouverture de la page, votre agenda pour les mois à venir. + +L'interface vous permet de permuter l'affichage entre le plan d'échantillonnage +téléphonique et le plan d'échantillonnage de terrain. + +Le plan d'échantillonnage de terrain vous indique le jour d'observation ainsi +que l'unité d'observation dans laquelle vous devez vous rendre pour mener +les observations et tenter d'enquêter les pêcheurs. + +Le plan téléphonique vous donne le navire à joindre, ainsi que la semaine durant +laquelle il faut le joindre pour mener l'enquête et tenter de reconstituer les +dernières Wao. En plus de ce navire, Wao vous propose également des substituts : +ce sont les navires à joindre en cas d'impossibilité ou de refus lors de +l'enquête du navire donné dans le prévisionnel. + +------------------------------------------------------------------------------- +Synchoniser mon agenda OBM, Thunderbird… avec Wao +------------------------------------------------------------------------------- + +En ce qui concerne l'observation de terrain, Wao propose la possibilité de +récupérer l'agenda automatiquement dans votre logiciel d'agenda (type OBM, +Mozilla Lightning / Sunbird). Ainsi, les observations planifiées dans Wao +apparaitront parmi vos autres rendez-vous. + +Pour procéder, vous devez, dans la page plan d'échantillonnage cliquer sur le +lien « Export iCal ». Deux possibilités s'offrent à vous : + + * Télécharger le fichier, ce fichier contient les observations du mois à venir. + Vous pouvez ensuite importer le fichier dans votre agenda et faire ainsi tous + les mois. + + * Deuxième solution, plus pratique : ne pas télécharger le fichier et + copier-collez l'adresse. Fournissez cette adresse à votre agenda en lui + demandant de se synchroniser régulièrement avec Wao. Ainsi, votre agenda + sera systématiquement à jour, même si le coordinateur fait des changements + dans le prévisionnel. + +L'adresse à fournir à l'agenda est de la forme : + +:: + + http://www.ifremer.fr/wao/roadmap/AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE + +Attention, cette adresse Web permet de récupérer des informations sur Wao sans +vous authentifier. Elle doit donc rester confidentielle. + +=============================================================================== +Après l'observation : créer un contact +=============================================================================== + +Lorsque vous voulez rapporter une observation dans Wao, votre objectif et de +créer un contact. Pour ce faire, la procédure est toujours la même : + + 1. Sélectionner dans le plan d'échantillonnage, la ligne échantillonnée + + #. Sélectionner le navire qui a été échantillonné dans la page navire + + #. Créer le contact depuis la page navire. + +Cette création en trois étape a plusieurs déclinaisons, voyons le processus en +détail : + + 1. Dans le plan d'échantillonnage, retrouver la ligne à échantillonner + + #. Dans la colonne action, cliquer sur le bonton « Navires » qui a la forme + d'un bateau bleu + + * Astuce : dans le plan d'échantillonnage téléphonique, vous pouvez + directement cliquer sur le nom du navire ou du subtitut pour provoquer + le même effet. Simplement, les filtres de la page navire seront + initialisés pour que le navire que vous avez cliqué soit ouvert. + + * Attention : les substituts sont triés en fonction de leur proximité + avec le navire initial. Aussi, si vous avez recours à des substituts, + essayez toujours de joindre le premier (de gauche à droite), puis le + second, etc... jusqu'au succès. + + #. Vous arrivez alors dans la page « Navires » : un message indique que vous + êtes en « mode de sélection d'un navire pour la ligne XXXX ». Le filtre + a été initialisé avec le champ ligne avec pour valeur la ligne que vous + avez choisie. Une liste restreinte des navires s'affiche alors : + + * Si vous êtes dans le cadre de l'observation de terrain, les navires qui + apparaissent dans la liste sont ceux qui ont un port d'attache qui se + trouve dans l'unité d'observation définie dans le prévisionnel. Vous + êtes donc susceptible d'avoir rencontré un de ces navires. + + * Si vous êtes dans le cadre de l'enquête téléphonique, les navires qui + apparaissent dans la liste sont le navire prévu dans la prévisionnel + ainsi que ses différents substituts (c'est à dire, tous les navires + qui appartient à la même strate que la navire initial). + + #. Trouvez dans la liste le navire sur lequel vous avez pu obtenir des + informations. Au besoin, manipulez les filtres pour étendre la liste + des navires si celui que vous cherchez ne s'y trouve pas déjà. + + #. Une fois le navire trouvé, vous pouvez cliquer sur son nom pour obtenir + des informations complémentaires + + * Notamment, vous y trouverez les coordonnées téléphonique nécessaire + pour joindre l'armateur dans le cadre de l'enquête téléphonique + + * Astuce : Dans la cadre de l'enquête téléphonique, vous pouvez cliquer + sur le nom de l'armateur pour obtenir la liste des autres navires armés. + Cela peut vous être utile si vous arrivez à obtenir d'autres informations + sur d'autres navires au gré de l'enquête téléphonique + + #. Une fois que vous êtes assuré qu'il s'agit du bon navire, vous pouvez + lancer la création du contact en cliquant sur l'envelopper qui apparaît + juste à côté du nom de chaque navire dans la liste des navires. + + #. Wao ajoute le contact et effectue des recherches en base pour essayer + de pré-remplir le maximum d'informations selon les données du plan + d'échantillonnage et selon les contacts que vous avez précédemment saisi. + + #. Lorsque Wao a terminé, vous êtes automatiquement redirigé vers la page + « Contacts », ou vous voyez apparaître, en première position et sur fond + jaune, le contact que vous venez de créer. + + #. Cliquez sur l'icône « calepin » dans la colonne « Actions » de ce nouveau + contact et remplissez le contre-rendu d'observation. + + Modified: trunk/src/site/site_fr.xml =================================================================== --- trunk/src/site/site_fr.xml 2011-06-16 16:11:08 UTC (rev 1346) +++ trunk/src/site/site_fr.xml 2011-06-17 14:43:04 UTC (rev 1347) @@ -53,7 +53,7 @@ <item name="en]" href="../en/index.html" /> </links>--> - <menu name ="Documentation"> + <menu name ="ObsMer et ObsDeb"> <item name="Administrateur" href="admin/firstlaunch.html"> <item name="Premier lancement" href="admin/firstlaunch.html"/> @@ -118,7 +118,13 @@ </item> </menu> - <menu name ="Projet"> + <menu name="ObsDeb"> + <item name="Administrateur" href="obsDeb/administrateur.html" /> + <item name="Coordinateur" href="obsDeb/coordinateur.html" /> + <item name="Observateur" href="obsDeb/observateur.html" /> + </menu> + + <menu name="Projet"> <item name="Historique des versions" href="release-note.html" /> <item name="Téléchargement" href="http://labs.libre-entreprise.org/frs/?group_id=154" />