COLD (factures clients) Maarch Professional Services Maarch PS anime le développement d un produit d archivage open source : http://www.maarch.org Guide de visite COLD (factures clients) VERSION DATE ACTEUR A CTION V1.4 Avril 2013 Maarch PS validée
Sommaire 1 INTRODUCTION...4 1.1 PRÉAMBULE... 4 1.2 OBJET DU DOCUMENT... 4 2 GÉNÉRALITÉS...5 2.1 CONNEXION À L'APPLICATION... 5 2.2 SCÉNARIO DE MISE EN ŒUVRE... 5 3 PRE-REQUIS...6 3.1 MAARCH... 6 3.2 AUTOIMPORT... 6 4 AUTOIMPORT...7 4.1 PRÉPARATION... 7 4.2 PARAMÉTRAGE... 7 4.3 EXÉCUTION... 8 5 RECHERCHE / CONSULTATION...9 5.1 FICHE DÉTAILLÉE... 11 5.1.1 Propriétés détaillées... 11 5.1.2 Infos techniques... 11 5.1.3 Historique... 12 5.1.4 Notes... 12 6 ZONES DE STOCKAGE...13 6.1 LIEUX DE STOCKAGE... 14 6.2 TYPES DE ZONE DE STOCKAGE... 14 6.3 ZONES DE STOCKAGE... 14 7 CYCLE DE VIE ET AIP...16 7.1 POLITIQUE D'ARCHIVAGE... 16 7.2 APPLICATION DU CYCLE OAIS_CACHED... 17 7.3 CONSULTATION AIP... 18 7.3.1 Définition AIP... 18 7.4 APPLICATION DU CYCLE OAIS... 19 8 AUTOFOLDERING...20 8.1 CONFIGURATION... 20 8.2 FONCTIONNEMENT... 20 8.3 VISUALISATION DES ARBRES... 20
Illustrations Batch autoimport...8 Écran de connexion...9 Page d'accueil vvictoire...9 Formulaire de recherche facture client...10 Résultat de recherche...10 Propriétés détaillées...11 Infos techniques...11 Historique...12 Notes...12 Note ajoutée...12 Menu vvictoire...13 Administration vvictoire...13 Zones de stockage...13 Lieux de stockage...14 Types de zones de stockage...14 Zones de stockage...15 Zones de stockage...15 Menu vvictoire...16 Administration vvictoire...16 Zones de stockage...16 OAIS cycle de vie...17 Consultation AIP...18 Batch OAIS...19 Classement dynamique fermé...20 Classement dynamique ouvert...21 Arborescence avec document...21
1 INTRODUCTION 1.1 Préambule Maarch est un Système d'archivage Électronique perfectionné auquel des fonctionnalités de Gestion Électronique de Courriers/Documents/Dossiers et Gestion de factures clients (COLD : Computer Output to Laser Disk ) ont été ajoutées. 1.2 Objet du document Ce guide de visite vous présente l application Maarch paramétrée pour une orientation Gestion de factures clients Procédez dans l'ordre de façon à ne pas perdre le guide. Bonne visite!! Page 4 / 21
2 GÉNÉRALITÉS Ce guide d'utilisation est destiné à montrer les possibilités du produit dans un contexte de gestion de factures clients : Auto-Importation en masse de factures clients, La recherche et consultation de facture, le passage du cycle de vie, la consultation des AIP et l'autofoldering (classement dynamique) 2.1 Connexion à l'application Service ACME Prénom Victor Nom VICTOIRE Login vvictoire 2.2 Scénario de mise en œuvre Etape 1 AUTOIMPORT Etape 2 RECHERCHE / CONSULTATION Etape 3 ZONES DE STOCKAGE Etape 4 CYCLE DE VIE ET AIP Etape 5 AUTOFOLDERING Page 5 / 21 Mot de passe maarch
3 PRE-REQUIS Afin de ne pas se perdre dans la pratique du guide, deux pré-requis sont nécessaires 3.1 Maarch Installer 3.2 Autoimport Installer Maarch Autoimport Page 6 / 21
4 AUTOIMPORT 4.1 Préparation Après avoir ''dé-zipper'' et installer Maarch Autoimport : Déplacer les trois cents (300) factures test avec leurs xml associés qui sont dans autoimport / samples / entreprise_cold vers le répertoire autoimport / incoming / entreprise 4.2 Paramétrage Après avoir déplacer les fichiers test on fait le paramétrage suivant : le fichier config_entreprise_cold.xml qui est dans le dossier autoimport / data / conf. La configuration suivante est valable pour windows, si vous êtes sur linux ou suivant le répertoire d'installation de l'autoimport, mettez le(s) chemins adapté(s)! Ci dessous un fichier de config correctement configuré : <ROOT> <CONFIG> <CONFIG_NAME>entreprise</CONFIG_NAME> <MAPPING_FILE>C:\autoimport\data\mapping\mapping_entreprise_cold.xml</MAPPING_FILE> <SCAN_IMPORT_DIRECTORY>C:\autoimport\incoming\entreprise\</SCAN_IMPORT_DIRECTORY> <LOCATION>127.0.0.1</LOCATION> <DATABASE_PORT>5432</DATABASE_PORT> <DATABASE>maarch_entreprise</DATABASE> <DATABASETYPE>POSTGRESQL</DATABASETYPE> <DATABASEWORKSPACE></DATABASEWORKSPACE> <USER_NAME>postgres</USER_NAME> <PASSWORD>maarch</PASSWORD> <TABLE_NAME>res_x</TABLE_NAME> <INSERT_MODE>false</INSERT_MODE> <DOCSERVER_NAME>FASTHD_AI</DOCSERVER_NAME> <DATE_TIME_FORMAT>YYYY-MM-DD</DATE_TIME_FORMAT> <AUTO_IMPORT_DIRECTORY>C:\autoimport\maarch_autoimport\</AUTO_IMPORT_DIRECTORY> <WITHOUT_XML>false</WITHOUT_XML> <BACKUP_BATCH>true</BACKUP_BATCH> <BACKUP_FAILED>true</BACKUP_FAILED> <EXCLUDE_EXISTING_DOCS>false</EXCLUDE_EXISTING_DOCS> <EXCLUDE_EXISTING_DOCS_FOLDER>duplicate</EXCLUDE_EXISTING_DOCS_FOLDER> <CONTROL_COMPLETE_FILES>false</CONTROL_COMPLETE_FILES> <CREATE_FOLDERS>false</CREATE_FOLDERS> <FOLDERS_TABLE_NAME>folders</FOLDERS_TABLE_NAME> <FOLDERS_MAPPING_FILE>C:\autoimport\data\mapping\mapping_folders.xml</FOLDERS_MAPPING_FILE> <APP_NAME>MEP</APP_NAME> <LOG_CONFIG_PATH>C:\xampp\htdocs\maarch_entreprise\apps\maarch_entreprise\xml\log4php.xml</LOG_CONFIG_PATH> <LOGGER>loggerTechnique</LOGGER> <LOG_FORMAT>[%ACCESS_METHOD%][%RESULT%][%CODE_METIER%][%HOW%][%WHAT%][%REMOTE_IP%]</LOG_FORMAT> <!--<PLUGINS> <plugin>pja</plugin> </PLUGINS>--> </CONFIG> </ROOT> Les <TAG> sont assez explicite, bien vérifier les informations de connexion à la base de données et les chemins par rapport à votre répertoire d'installation de l'outil Page 7 / 21
4.3 Exécution Après avoir installé et bien paramétré l'outil AutoImport, nous passons passons l'exécution du batch d'autoimportation des factures clients L'exécution se fait en ligne de commande et peut se faire dans un environnement Windows que Linux Si vous êtes sous linux, le fichier a exécuter est autoimport_entreprise_cold.sh qui se trouve dans le répertoire autoimport / bin / linux Si vous êtes sous windows, le fichier a exécuter est autoimport_entreprise_cold.bat qui se trouve dans le répertoire autoimport / bin / linux Batch autoimport Le script qui s'exécute correctement enregistre les documents dans le docserver et écrit les infos (métadonnées) associées à la base de données Nous allons passer à l'étape suivante c'est à dire faire une recherche / consultation sur les factures autoimportés en masse Page 8 / 21
5 RECHERCHE / CONSULTATION Pour faire la Recherche / Consultation nous allons nous connectez à l'application préalablement installée et surlaquelle on a injecté des factures par AutoImport Figure 2 - Écran de connexion Au démarrage de l'application dans la fenêtre de connexion, connectez-vous avec l'utilisateur Victor VICTOIRE (vvictoire) habilité à faire des recherches de factures clients Utilisateur : vvictoire (Victor VICTOIRE) ACME Mot de passe : maarch Connectez-vous avec ce profil, on tombe sur sa page d'accueil Figure 3 - Page d'accueil vvictoire Page 9 / 21
Cliquer sur le raccourci ''[cold] Rechercher une facture client'' pour aller sur le formulaire de recherche de facture client. Le lien est aussi disponible par survol du menu. Figure 4 - Formulaire de recherche facture client La recherche peut se faire à partir des informations concernant le document : Sur le numéro GED Sur les critères pour affiner la recherche (BDC facture, Date, client facture, contrat facture, date d'enregistrement, Date du document, Montant facture, Pays, Référence, Statut(s)) Les critères peuvent être croisés, associés pour faire la recherche. Les critères sont mémorisés dans la session, on peut tout réinitialiser avec le lien 'Effacer les critères' Si aucun critère n'est défini la recherche se fera sur l'ensemble des factures avec une limite sur les 500 premiers résultats Figure 5 - Résultat de recherche Page 10 / 21
Les factures apparaîssent dans la liste de résultat. Cliquer sur pour afficher la facture. Cliquer sur pour afficher la fiche détaillée de la facture Cliquer sur Cliquer sur pour enregistrer la recherche (permet de ne plus ressaisir les critères) pour exporter le résultat de la recherche 5.1 Fiche détaillée Pour accéder à la fiche détaillée d'un courrier dans la liste de résultat cliquer sur l'icône 5.1.1 Propriétés détaillées La fiche détaillée propose plusieurs onglets permettant d'afficher toutes les informations concernant la facture. Figure 6 - Propriétés détaillées 5.1.2 Infos techniques Cliquer sur l'onglet ''Infos techniques'' pour voir les Propriétés du ficher source, le Cycle de vie et les Zone(s) de stockage Figure 7 - Infos techniques Page 11 / 21
5.1.3 Historique L'onglet ''Historique'' permet de consulter toute l'historique de la facture avec la date, l'utilisateur t l'évènement effectué par l'utilisateur. L'historique peut être filtrer par Utilisateur, action ou période (intervalle de date) Figure 8 - Historique 5.1.4 Notes L'onglet ''Notes'' permet de consulter les notes. Pour ajouter une note à la facture, cliquer sur ''Ajouter un note'' Figure 9 - Notes La note peut être restreinte à une ou plusieurs entités. Seul un utilisateur qui a créé une note peut le modifier/supprimer, les autres ne peuvent que consulter. Figure 10 - Note ajoutée Page 12 / 21
6 ZONES DE STOCKAGE Maarch est un système de référencement et d'indexation de ressources électroniques. Ces ressources sont entreposées dans des zones de stockage gérées par le logiciel au niveau logique et par le matériel au niveau physique. Pour accéder aux zones de stockage, toujours avec l'utilisateur connecté (vvictoire), survoler le menu et cliquer sur ''Administration'' Figure 11 - Menu vvictoire En cliquant sur ''Administration'' on tombe sur la zone d'administration réservée à l'utilisateur Figure 12 - Administration vvictoire En cliquant sur Zones de stockage on accède à la gestion des lieux, types et zones de stockage Figure 13 - Zones de stockage Page 13 / 21
6.1 Lieux de stockage Les lieux de stockage sont des lieux de conservation. Pour voir les lieux de stockage cliquer sur ''Gérer les lieux de stockage de documents'' Figure 14 - Lieux de stockage Le nombre de sites est illimité, on peut a rajouter (avec le lien ''Ajouter un lieu de stockage'') autant qu'on veut. Tout site peut créé peut être Modifié, Suspendu ou Supprimé 6.2 Types de zone de stockage Une partie de la définition de la zone de stockage est intégrée dans son type. Ceci permet d'instancier plusieurs zones de stockage de la même famille. Pour accéder aux types de zone de stockage, à partir de la page d'administration des zones de stockage (cf. figure 13), cliquer sur ''Gérer les types de zones de stockage'' Figure 15 - Types de zones de stockage Avec le lien ''Ajouter un type de zone de stockage'' on peut ajouter un nouveau type de zone de stockage. Tout type de zone créé peut être Modifié, Suspendu ou Supprimé 6.3 Zones de stockage Les zones de stockage sont des instances d'un ou des types de zone. Une zone de stockage contient des informations qui vont permettre à Maarch de placer correctement la ressource électronique à conserver. Page 14 / 21
Les zones sont qualifiées par des types de zone. Le type de zone donne des indications sur la structure de l'archive : empaquetage O/N nombre de documents dans un paquet méthode de compression etc. Pour accéder aux zones de stockage, à partir de la page d'administration des zones de stockage (cf. figure 13), cliquer sur ''Gérer les zones de stockage'' Figure 16 - Zones de stockage Avec le lien ''Ajouter une zone de stockage'' on peut ajouter une nouvelle de zone de stockage. Toute zone de stockage créée peut être Modifiée, Suspendue ou Supprimée Dans le cadre de notre guide sur les factures clients nous sommes intéressés par les zones de stockage liées à la collection res_coll suivants : Figure 17 - Zones de stockage Page 15 / 21
7 CYCLE DE VIE ET AIP Après l'autoimport et la Recherche/Consultation de factures clients, nous allons évaluer le fonctionnement du cycle de vie, en passant les différentes étapes de la politique d'archivage sur les factures injectés. 7.1 Politique d'archivage Pour accéder à la politique de l'archivage, toujours avec l'utilisateur connecté (vvictoire), survoler le menu et cliquer sur ''Administration'' Figure 18 - Menu vvictoire En cliquant sur ''Administration'' on tombe sur la zone d'administration réservée à l'utilisateur Figure 19 - Administration vvictoire En cliquant sur Politique d'archivage on accède à la gestion des politiques d'archivage, cycles de vie et étapes de cycle de vie Figure 20 - Zones de stockage Page 16 / 21
La politique d'archivage reprend le schéma ci-dessous : Figure 21 - OAIS cycle de vie Le schéma (figure 18) comprend en séquence les cycles suivants : Cycle Description INIT Versement initial OAIS_CACHED Copie en différé des documents dans des conteneurs sécurisés sur 2 sites différents, mais les documents restent dans la zone rapide OAIS Au bout de 3 mois, suppression des documents présents dans la zone rapide DISPOSAL Application du sort final : mise sur étagère Avant de continuer, vérifier que physiquement dans votre docserver avec l'autoimport qui s'est bien passé vous avez 300 factures rangées dans la zone de stockage FASTHD_AI : Chemin_du_docserver\ai\. L'espace de stockage utilisé est de 11 Mo. Dans le oint 5 (Recherche / Consultation ) on a vu que les factures importées sont visibles par l'intermédiaire du formulaire "[cold] Rechercher une facture client". Lors de la demande de visualisation d'une facture, Maarch accède à la définition de la zone de stockage pour obtenir la méthode d'extraction du document archivé. 7.2 Application du cycle OAIS_CACHED Le cycle OAIS_CACHED de la politique d'archivage FNTC prévoit le traitement des documents de la collection facture vieux de plus d'une semaine. Le cycle consiste à copier les factures concernées dans des paquets AIP placés dans les zones OAIS_MAIN_1 et OAIS_SAFE_1. Pour simuler le vieillissement, nous allons appliquer une requête SQL directement sur la base de données update res_x set creation_date = creation_date::timestamp - '10 day'::interval where typist = 'AUTOIMPORT'; Page 17 / 21
Toutes les factures sont maintenant considérées comme ayant été versées il y a 10 jours et sont donc candidates au cycle OAIS_CACHED. En ligne de commande, placez-vous sous C:\xampp\htdocs\maarch_entreprise\modules\life_cycle\batch, puis exécutez les scripts batch de transition de cycle : php fill_stack.php -c config/config.xml -coll res_coll -p FNTC -cy OAIS_CACHED php process_stack.php -c config/config.xml -coll res_coll -p FNTC -cy OAIS_CACHED 7.3 Consultation AIP Après exécution des batch ci-dessus, Les AIP ont été créés dans le répertoire de destination OAIS_main et sous un autre format dans la zone secondaire OAIS_safe : Figure 22 - Consultation AIP Les AIP situés dans OAIS_MAIN_1 bénéficient d'une compression intelligente. Le format des PDF a été travaillé pour optimiser cette compression (ratio 1:14). Chaque AIP contient 100 factures. (avec les 3 AIP on retrouve les 300 factures injectés lors de l'autoimport 7.3.1 Définition AIP Un AIP ("Archival Information Package") est un paquet d'archivage autoporté, décrit par la norme ISO 14721, aussi connue sous le nom OAIS. Cette norme établit les principes d'une conservation des ressources électroniques dans un Page 18 / 21
SAE sur le très long terme. En plus d'être référencées dans une base de données, les ressources sont contenues dans des paquets où figurent aussi les métadonnées. 7.4 Application du cycle OAIS Le cycle OAIS est appliqué au bout de trois mois. Il consiste en la suppression des ressources du cache FASTHD_AI. En effet, au bout de trois mois on considère que les demandes de consultation sont plus rares et qu'il est inutile de monopoliser une baie rapide. Pour simuler le vieillissement sur trois mois, nous allons à nouveau appliquer une requête SQL directement sur la base : update res_x set creation_date = creation_date::timestamp - '100 day'::interval where typist = 'AUTOIMPORT'; Toutes les factures sont maintenant considérées comme ayant été versées il y a plus de trois mois et sont donc candidates au cycle OAIS. En ligne de commande, placez-vous sous C:\xampp\htdocs\maarch_entreprise\modules\life_cycle\batch, puis exécutez les scripts batch de transition de cycle : php fill_stack.php -c config/config.xml -coll res_coll -p FNTC -cy OAIS php process_stack.php -c config/config.xml -coll res_coll -p FNTC -cy OAIS Figure 23 - Batch OAIS Les ressources concernées situées dans FASTHD_AI ont été supprimées. Page 19 / 21
8 AUTOFOLDERING Autofoldering (ou classement dynamqiue) est un module de Maarch qui permet de pré-générer des arborescences qui seront chargées au fur et à mesure des clics de l'utilisateur (Ajax), afin d'alléger les requêtes serveurs et le temps de chargement de la page Un "arbre" se présente sous l'aspect d'une arborescence de dossier que l'on déplie au fur et à mesure, un peu à la manière d'un explorateur de fichier. Il permet d'avoir une organisation particulière des métadonnées associées au document. C'est une autre façon de rechercher des documents. Il est possible de faire cohabiter plusieurs arbres différents, par exemple un arbre classé par client et un autre par année. 8.1 Configuration Les 2 fichiers importants pour la configuration sont : modules/autofoldering/xml/config.xml : configuration de la base, des options disponibles modules/autofoldering/xml/autofoldering.xml : fichier de mapping, décrivant les arbres 8.2 Fonctionnement Une fois les arborescences définies en base et dans un fichier xml, l'autofoldering se passe en 2 temps : Chargement en base des arborescences à partir d'un script batch Visualisation des arbres dans l'application (selon des droits spécifiques) Des scripts launch_autofoldering windows (.bat) et linux/unix (.sh) exemples sont disponibles dans le répertoire modules/autofoldering/scripts. Pour les faire fonctionner sous votre système, vous devez adapter les chemins. 8.3 Visualisation des arbres A partir du menu, cliquez sur "Classement dynamique", pour ouvrir la page. Vous choisissez ensuite l'arbre que vous voulez consultez dans la liste déroulante. Une fois l'arbre choisi, le premier niveau de l'arbre s'affiche automatiquement. Figure 24 - Classement dynamique fermé Pour ouvrir un niveau, cliquez sur Page 20 / 21 + et pour fermer un niveau sur -
Figure 25 - Classement dynamique ouvert Enfin pour voir le nombre de documents présents au dernier niveau, cliquez sur le libellé du niveau à ouvrir. Figure 26 - Arborescence avec document A partir de la liste Page 21 / 21 Vous pouvez visualiser un document en cliquant sur Accéder à la page détails d'un document en cliquant sur