Author: fdesbois Date: 2010-01-06 17:18:15 +0000 (Wed, 06 Jan 2010) New Revision: 170 Added: trunk/src/site/ trunk/src/site/resources/ trunk/src/site/resources/doc/ trunk/src/site/resources/doc/DOC_Contacts_Header.ods trunk/src/site/resources/logo-obsmer.jpg trunk/src/site/resources/logo-wao.png trunk/src/site/rst/ trunk/src/site/rst/business-rules.rst trunk/src/site/rst/import/ trunk/src/site/rst/import/boats.rst trunk/src/site/rst/import/contacts.rst trunk/src/site/rst/import/samplingPlan.rst trunk/src/site/rst/installation.rst trunk/src/site/site.xml trunk/suiviobsmer-business/src/site/ trunk/suiviobsmer-business/src/site/site.xml trunk/suiviobsmer-ui/src/site/ trunk/suiviobsmer-ui/src/site/site.xml Log: Add maven-site Added: trunk/src/site/resources/doc/DOC_Contacts_Header.ods =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/doc/DOC_Contacts_Header.ods ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/logo-obsmer.jpg =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/logo-obsmer.jpg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/resources/logo-wao.png =================================================================== (Binary files differ) Property changes on: trunk/src/site/resources/logo-wao.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/src/site/rst/business-rules.rst =================================================================== --- trunk/src/site/rst/business-rules.rst (rev 0) +++ trunk/src/site/rst/business-rules.rst 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,107 @@ +Documentation des règles métiers de l'application WAO +===================================================== + +Ligne du plan d'échantillonnage (ADMIN) +--------------------------------------- + +Pré-requis : Import des zones de pêche + +- Création : + + * (obligatoire) profession : toujours une nouvelle profession + * (obligatoire) zone de pêche : au moins une zone de pêche doit être ajouté à la ligne + * (obligatoire) programme : déjà existant ou nouveau programme + * (obligatoire) période du programme : modifiable si cela ne pose pas de problème sur des données d'embarquements réels + * données des marées / mois : toujours minimum à 0 + * (obligatoire) code de la ligne : générer automatiquement à partir de la date de début du programme : [year]_[lastNum] + * autres champs non obligatoire + +- Modification (si aucun embarquement réel effectué sur la ligne) : + + * Même contraintes que pour la création sauf code de la ligne déjà existant + * (obligatoire) Commentaire de modification + +- Modification (si des embarquements réels ont été effectuées sur la ligne) : + + * Modification impossible pour les champs : profession, zones de pêche, programme + * (obligatoire) Commentaire de modification + +- Suppression : possible uniquement si aucun embarquement réel n'a été enregistré sur la ligne + +- Unicité : code de la ligne + +Navires (OBSERVER/USER) +----------------------- + +- Filtres : + + * Code de la ligne : uniquement celles liés à la société + +- Informations : + + * Possibilité de lier un navire à une ligne du plan disponible (ouverte) + * Possibilité de rayer une ligne du plan d'un navire si elle a été liée par un ADMIN + * Possibilité de supprimer une liaison avec une ligne du plan, uniquement celles liés par la société + +- Unicité : immatriculation du navire + +Contact (OBSERVER/USER) +----------------------- + +Pré-requis : La création n'est possible que sur un navire elligible lié à une ligne du plan + +Etats des contacts : "Contact pris" (CREATION), "Embarquement prévu", "Embarquement réalisé" (TERMINE), "Refus" (TERMINE), "Refus définitif" (TERMINE), "Non abouti" (TERMINE) + +- Création : + + * possible uniquement depuis la page des navires + * doit être effectué sur une ligne du plan (potentiellement sélectionné depuis le plan d'échantillonnage) + * aucun navire doit avoir de contact en cours pour cette société + * impossible si le programme de la ligne du plan est terminé (date de fin > date du jour) + * état initial : "Contact pris" + * observateur initial : l'utilisateur qui a créé la ligne + +- Modification (changement d'état) : + + * possible uniquement si aucune validation n'a été faites + * "Embarquement prévu" -> aucune contrainte + * "Embarquement réalisé" -> les champs "date de début de la marée", "date de fin de la marée" et "nb observateurs" sont obligatoires + * "Non abouti", "Refus", "Refus définitif" -> champs commentaire obligatoire, le changement d'état efface tous les autres champs + +- Contraintes sur les dates : + + * Date de fin postérieure ou égal à la date de début + * Date de fin antérieure à la date du jour + * Date de début et date de fin incluses dans la période du programme de la ligne du plan lié au contact + +- Validation par la société : + + * Aucune validation faites par le programme (ADMIN) + * Etat terminé ("Non abouti", "Refus", "Refus définitif") + * Etat "Embarquement réalisé" avec "date de saisie dans Allegro" renseignée + +- Validation par le programme : + + * Le contact doit être accepté/validé par la société + +- Suppression : + + * possible uniquement si aucune validation n'a été faites + +- Calcul de la durée des marées réels : + + * Ajout si accepté par la société + * Retrait si invalidé par la société après avoir été accepté + * Retrait si refusé par le programme + * Ajout si invalidé par le programme après avoir été refusé + +- Unicité : code de la ligne + immatriculation du navire + société + date de création (avec temps) + +Administration +-------------- + +- Connexion impossible si inactif +- Aucune création d'utilisateur possible pour une société inactive + + + Added: trunk/src/site/rst/import/boats.rst =================================================================== --- trunk/src/site/rst/import/boats.rst (rev 0) +++ trunk/src/site/rst/import/boats.rst 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,30 @@ +Import des navires +================== + +Cette fonctionnalité est disponible depuis la page des **Navires** en mode administrateur. + +Infos +----- + +- Disponible depuis version 0.0.1-alpha-1 +- Encodage du fichier CSV obligatoire en UTF-8 + +Sélections +---------- + +- Navires actifs (indicateur d'état du numéro = actif) +- Pays d'appartenance du navire = France +- Immatriculation du navire NAVS_COD comprise entre 100000 et 999999 +- Navires présents dans le calendrier d'activité 2008 et dont le port d'exploitation est français + +Champs de la table +------------------ + +- NAVS_COD : Numéro d'immatriculation du navire (identifiant unique) +- CARN_NOM : Nom du navire +- CARN_LONGUEUR_HT : Longueur hors tout du navire (en mètres) +- CARN_ANNEE : Année de construction du navire +- QUARTIER_IMMA : Code lieu d'immatriculation +- PER_COD : Code armateur (identifiant unique) (NA = pas d'armateur) +- PER_NOM : Nom de l'armateur +- PER_PRENOM : Prénom de l'armateur \ No newline at end of file Added: trunk/src/site/rst/import/contacts.rst =================================================================== --- trunk/src/site/rst/import/contacts.rst (rev 0) +++ trunk/src/site/rst/import/contacts.rst 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,68 @@ +Import/Export des Contacts +========================== + +Cette fonctionnalité est disponible depuis la page des **Contacts**. + +Infos +----- + +- Disponible depuis version 0.0.3 +- Encodage du fichier CSV obligatoire en UTF-8 + +Voir `Fichier OpenOffice`_ + +.. _Fichier OpenOffice: ../doc/DOC_Contacts_Header.ods + +Note +---- + +- Création d'une ligne si CONT_CREATION est vide. +- Modification d'une ligne si existante : recherche sur NAVS_COD, PLAN_CODE, CONT_CREATION, SOCIETE_NOM +- Les validations (société ou programme) ne sont pas importés + +Types et formats des cellules +----------------------------- + +- string = chaîne de caractères -> ex : "Une_Chaine345" +- double = nombre réel, formaté en anglais -> ex : 1.2 +- date = date, formaté en jour/mois/année (JJ/MM/AAAA sous Excel) -> ex : 01/12/2010 +- int = nombre entier -> ex : 3 +- boolean = vrai ou faux, se traduit par un 'X' si c'est vrai + +Descriptions des colonnes +------------------------- + +- CONT_CODE (string) : Code pour modification d'un contact existant dans WAO (uniquement récupérable depuis un export) +- CONT_CREATION (date) : Date de création de la ligne (si vide, nouvelle ligne dans WAO) +- OBSERV_ID (string) : Login de l'observateur (obligatoire) +- OBSERV_PRENOM (string) : Prénom de l'observateur +- OBSERV_NOM (string) : Nom de l'observateur +- SOCIETE_NOM (string) : Nom de la société +- PLAN_CODE (string) : Code de la ligne (obligatoire) +- PROGRAMME_CODE (string) : Nom du programme +- PROGRAMME_DEBUT (date) : Date de début du programme +- PROGRAMME_FIN (date) : Date de fin du programme +- PECHE_FACADE (string) : Facade de la zone de pêche +- PECHE_ZONE (string) : Secteur de la zone de pêche +- PECHE_DIVISION (string) : Zones de pêche liés à la ligne, chaque zone est séparé par un " / " -> ex : VIIa / VIIb (obligatoire) +- PECHE_AUTRE (string) : Autres information sur les zones de pêche pour la ligne +- METIER_CODE_DCF5 (string) : Code DCF niveau 5 du métier +- METIER_MAILLAGE (string) : Maillage du métier +- METIER_TAILLE (string) : Taille du métier +- METIER_AUTRE (string) : Autre information du métier +- METIER_LIBELLE (string) : Libellé du métier +- METIER_ESPECES (string) : Espèces liées au métier +- NAVS_COD (int) : Immatriculation du navire (6 chiffres) (obligatoire) +- CARN_NOM (string) : Nom du navire +- QUARTIER_IMMA (string) : Code quartier du navire +- CONT_ETAT (string) : Etat du contact + (valeurs possibles : "Contact pris", "Embarquement prévu", "Embarquement réalisé", "Non abouti", "Refus", "Refus définitif") +- CONT_DEBUT_MAREE (date) : Date de début de la marée +- CONT_FIN_MAREE (date) : Date de fin de la marée +- CONT_NB_OBSERV (int) : Nombre d'observateurs pour l'embarquement +- CONT_MAM_CAPT (boolean) : Capture de mammifères +- CONT_MAM_OBSERV (boolean) : Observation de mammifères +- CONT_COMMENT (string) : Commentaire sur le contact +- CONT_ALLEGRO (date) : Date de saisies dans Allegro +- CONT_SOCIETE_VALID (string) : Validation par la société : 'A' pour Accepter, 'N' pour en attente, 'R' pour Refuser +- CONT_PROGRAM_VALID (string) : Validation par le programme : 'A' pour Accepter, 'N' pour en attente, 'R' pour Refuser Added: trunk/src/site/rst/import/samplingPlan.rst =================================================================== --- trunk/src/site/rst/import/samplingPlan.rst (rev 0) +++ trunk/src/site/rst/import/samplingPlan.rst 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,53 @@ +Documentation Import du plan d'échantillonnage +============================================== + +Cette fonctionnalité est disponible depuis la page du **Plan d'échantillonnage** en mode administrateur. + +Infos +----- + +- Disponible depuis version 0.0.1-alpha-1 +- Encodage du fichier CSV obligatoire en UTF-8 + +Types et formats des cellules +----------------------------- + +- string = chaîne de caractères -> ex : "Une_Chaine345" +- double = nombre réel, formaté en anglais -> ex : 1.2 +- date = date, formaté en mois/année (MM/AAAA sous Excel) -> ex : 12/2010 +- int = nombre entier -> ex : 3 + +Descriptions des colonnes +------------------------- + +- PLAN_CODE (string) : Code de la ligne (unique, obligatoire) +- SOCIETE_NOM (string) : Nom de la société +- PECHE_DIVISION (string) : Zones de pêche liés à la ligne, chaque zone est séparé par un " / " -> ex : VIIa / VIIb (obligatoire) +- PECHE_AUTRE (string) : Autres information sur les zones de pêche pour la ligne +- METIER_CODE_DCF5 (string) : Code DCF niveau 5 du métier (obligatoire) +- METIER_MAILLAGE (string) : Maillage du métier +- METIER_TAILLE (string) : Taille du métier +- METIER_AUTRE (string) : Autre information du métier +- METIER_LIBELLE (string) : Libellé du métier +- METIER_ESPECES (string) : Espèces liées au métier +- PROGRAMME_CODE (string) : Nom du programme (obligatoire) +- PROGRAMME_DEBUT (date) : Date de début du programme (obligatoire) +- PROGRAMME_FIN (date) : Date de fin du programme (obligatoire) +- champs pour les mois formatés comme des dates (MM/AAAA) +- PLAN_DUREE_MOY (double) : Durée moyenne d'une marée (obligatoire) +- PLAN_NB_OBSERV (int) : Nombre d'observateurs (obligatoire) +- PLAN_COMMENT (string) : Commentaire sur la création de la ligne + +Refus +----- + +L'affichage indique le nombre de lignes qui ont été refusés pour les raisons suivantes : + +- (PLAN_CODE) Les lignes avec un code déjà existant dans l'application ne seront ni ajoutées, ni modifiées +- (PECHE_DIVISION) Les lignes sans zone de pêche ne seront pas prises en compte + +Note +---- + +Si il n'y a aucun Code pour la ligne, elle ne sera ni interprété ni refusé. + Added: trunk/src/site/rst/installation.rst =================================================================== --- trunk/src/site/rst/installation.rst (rev 0) +++ trunk/src/site/rst/installation.rst 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,29 @@ +Installation +============ + +Deux possibilités +----------------- + +- Lancement direct du fichier war (utilisation de Java-JRE 1.6) +- Déploiement sur un serveur d'application (comme tomcat) + +Super administrateur par défaut +------------------------------- + +Lors du premier lancement de l'application l'utilisateur admin sera créé avec comme identifiants : + +- login = admin +- password = password + +Note + Il est fortement conseillé de modifier le mot de passe par défaut du super admin ! (dans le profile utilisateur) + +Références +---------- + +- `Tomcat`_ +- WarLauncher de `Nuiton-utils`_ + +.. _Tomcat: http://tomcat.apache.org/ + +.. _Nuiton-utils: http://maven-site.nuiton.org/nuiton-utils/Warlauncher.html \ No newline at end of file Added: trunk/src/site/site.xml =================================================================== --- trunk/src/site/site.xml (rev 0) +++ trunk/src/site/site.xml 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <publishDate format="dd/MM/yyyy"/> + + <bannerLeft> + <src alt="Web Applicatif Obsmer">logo-wao.png</src> + <name>${project.name}</name> + <href>index.html</href> + </bannerLeft> + + <bannerRight> + <src alt="Obsmer">logo-obsmer.jpg</src> + </bannerRight> + + <poweredBy> + <logo href="http://maven.apache.org" name="Maven" img="http://maven-site.nuiton.org/jrst/images/logos/maven-feather.png"/> + <logo href="http://maven-site.nuiton.org/jrst" name="JRst" img="http://maven-site.nuiton.org/jrst/images/jrst-logo.png"/> + <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" img="http://maven-site.nuiton.org/jrst/images/restructuredtext-logo.png"/> + </poweredBy> + + <body> + + <breadcrumbs> + <item name="${project.name}" href="${project.url}" /> + </breadcrumbs> + +<!-- <links> + <item name="Libre-Entreprise" href="http://www.libre-entreprise.org/" /> + <item name="[fr" href="index.html" /> + <item name="en]" href="../en/index.html" /> + </links>--> + + <menu name ="Documentation"> + <item name="Import/Export"> + <item name="Plan d'échantillonnage" href="import/samplingPlan.html"/> + <item name="Navires" href="import/boats.html"/> + <item name="Contacts" href="import/contacts.html"/> + <!--<item name="Calendrier d'activité" href="import/activityCalendar.html"/>--> + </item> + <item name="Règles métier" href="business-rules.html" /> + </menu> + + <menu name ="Mise en place"> + <item name="Téléchargement" href="http://labs.libre-entreprise.org/frs/?group_id=154" /> + <item name="Installation" href="installation.html"/> + <item name="Demo" href="http://demo.codelutin.com/suiviobsmer"/> + <item name="Tracker" href="http://labs.libre-entreprise.org/tracker/?group_id=154"/> + </menu> + + <!--<menu ref="parent"/>--> + <menu ref="modules"/> + <menu ref="reports"/> + + </body> + +</project> + Added: trunk/suiviobsmer-business/src/site/site.xml =================================================================== --- trunk/suiviobsmer-business/src/site/site.xml (rev 0) +++ trunk/suiviobsmer-business/src/site/site.xml 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <publishDate format="dd/MM/yyyy"/> + + <bannerLeft> + <name>${project.name}</name> + <href>index.html</href> + </bannerLeft> + +<!-- <bannerRight> + <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> + <href>http://www.codelutin.com</href> + </bannerRight>--> + + <poweredBy> + <logo href="http://maven.apache.org" name="Maven" img="http://maven-site.nuiton.org/jrst/images/logos/maven-feather.png"/> + <logo href="http://maven-site.nuiton.org/jrst" name="JRst" img="http://maven-site.nuiton.org/jrst/images/jrst-logo.png"/> + <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" img="http://maven-site.nuiton.org/jrst/images/restructuredtext-logo.png"/> + </poweredBy> + + <body> + + <breadcrumbs> + <item name="${project.name}" href="${project.url}" /> + </breadcrumbs> + + <menu ref="parent"/> + <menu ref="reports"/> + + </body> + +</project> + Added: trunk/suiviobsmer-ui/src/site/site.xml =================================================================== --- trunk/suiviobsmer-ui/src/site/site.xml (rev 0) +++ trunk/suiviobsmer-ui/src/site/site.xml 2010-01-06 17:18:15 UTC (rev 170) @@ -0,0 +1,34 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <publishDate format="dd/MM/yyyy"/> + + <bannerLeft> + <name>${project.name}</name> + <href>index.html</href> + </bannerLeft> + +<!-- <bannerRight> + <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> + <href>http://www.codelutin.com</href> + </bannerRight>--> + + <poweredBy> + <logo href="http://maven.apache.org" name="Maven" img="http://maven-site.nuiton.org/jrst/images/logos/maven-feather.png"/> + <logo href="http://maven-site.nuiton.org/jrst" name="JRst" img="http://maven-site.nuiton.org/jrst/images/jrst-logo.png"/> + <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" img="http://maven-site.nuiton.org/jrst/images/restructuredtext-logo.png"/> + </poweredBy> + + <body> + + <breadcrumbs> + <item name="${project.name}" href="${project.url}" /> + </breadcrumbs> + + <menu ref="parent"/> + <menu ref="reports"/> + + </body> + +</project> +