Maarch Framework 3/Guide de démarrage rapide

De Maarch // Wiki.

Introduction

Maarch Framework s'adresse à un public de professionnels censés maîtriser l'anglais technique, aussi la majeure partie de la documentation technique est en anglais. Nous faisons en sorte que cet état de fait soit temporaire, et que la documentation technique se retrouve aussi très rapidement dans notre belle langue. En attendant, voici un article qui explique comment faire fonctionner rapidement l'application d'exemple de Maarch v3 après l'avoir téléchargée, et qui s'adresse à tout public.

En suivant "à la culotte" ces instructions, et en vous arrangeant pour ne pas faire dans l'original coté serveur (genre la dernière Ubuntu et une base Postgres), vous allez être en mesure de faire tourner cette application en moins de 30 minutes.

Les plus courageux constateront avec plaisir que nous avons fait un gros effort de documentation (en anglais donc...), et devraient pouvoir faire des choses intéressantes avec Maarch v3.

Enfin, sachez que la GED est un domaine complexe avec des problématiques techniques, organisationnelles et juridiques. En mettant Maarch en téléchargement libre, nous permettons aux organisations d'envisager une diffusion élargie de l'information contenue dans les documents, le tout dans un budget sans commune mesure avec les constantes du marché.

Maarch et son réseau de partenaires vivent uniquement des services d'intégration, de formation et de support sur les projets bâtis autour de l'outil. Il n'y a pas de version "professionnelle" : tous les utilisateurs de Maarch sont à la même enseigne et peuvent télécharger le même logiciel. Par contre, l'expertise sur le produit, le paramétrage poussé, les modules répondant à des besoins spécifiques sont uniquement proposés par le réseau de partenaires.

Avant de recourir à une société tierce pour vous aider à installer Maarch au sein de votre organisation, assurez-vous qu'elle fait partie du réseau de distributeurs/intégrateurs que nous animons.

Bonne installation !

Description de l'application d'exemple (le Sample)

Le conteneur de téléchargement contient le Framework v3 ainsi qu'une application de démonstration. Cette application permet de gérer des dossiers de type Crédits Immobiliers, et permet aussi de consulter des factures client. Il y a deux collections documentaires distinctes, avec des écrans de recherche et des fonctionnalités spécifiques.

Dossiers de Crédits Immobiliers

L'entreprise ACME gère des dossiers de crédit immobilier, chaque dossier comprenant des chemises, des sous-chemises, et des documents à l'intérieur des chemises. ACME souhaite numériser ses dossiers avant archivage physique, de telle sorte que l'archivage ne se fasse plus par dossier, mais par boite d'archive.
Dans cet exemple la numérisation prend effet après l'instruction du prêt et décision sur son issue. Le but de l'application est de numériser ces dossiers pour les proposer ensuite en consultation. Le module 'Physical Archive' permet d'ouvrir une boite d'archive, de décrire les documents à l'intérieur du dossier, puis d'imprimer un séparateur code à barre qui sera placé sur chaque type de document.

La liasse est placée dans le chargeur du scanner puis numérisée.

Un module générique d'archivage physique

Grâce à la combinaison des modules Folder et Physical Archive, il est possible de définir entièrement la structure des dossiers, pour un type de dossier particulier. Par exemple, vous pouvez au sein d'une même collection documentaire avoir des dossiers de type "Prêt immo" et "RH". Sur le code à barre sont inscrites les informations permettant de retrouver le dossier, son type, le type de document, et la boite d'archive dans laquelle on remise le dossier après numérisation.

Le pilotage du scanner, la transmission via internet des images, la séparation des documents et la conversion en PDF dépendent du matériel et font appel à des composants non libres, aussi vous ne les trouverez pas dans ce sample.
Sachez cependant que les intégrateurs Maarch livrent ces outils avec les sources, pour un volume de numérisation illimitée.

Un outil d'importation de masse après numérisation

En sortie de numérisation et de notre outil de transfert internet et conversion, on obtient des PDF accompagnés de leurs fichiers d'index. L'index est un descripteur XML contenant des informations de service ainsi que les informations lues sur le code à barres. L'outil Maarch AutoImport en version 3 permet de transférer les images dans Maarch, en utilisant le fichier XML pour le descripteur. L'application d'exemple est fournie avec un jeu d'essai de documents correspondants au dossier de crédit.

Recherche de dossiers et consultation des pièces

Grâce au module Folder, vous avez accès à la recherche de dossiers dans l'application, ainsi qu'à la présentation structurée de ce dernier, selon le plan de classement défini pour ce type de dossier. La structure du dossier est affichée de façon dynamique, le contenu du noeud sélectionné s'affichant dans la partie droite de l'écran.

Sécurisation et traçabilité des accès

L'ensemble des pièces constitutives du dossier est sécurisé grâce aux droits d'accès définis pour les groupes. Contrairement à de nombreux logiciels de GED, les règles de sécurités ne sont pas instaurées de façon définitive au versement du document dans l'archive, mais de façon dynamique par attribution de privilèges d'accès aux groupes, en fonction des valeurs d'index du fonds à sécuriser.

Factures client

L'entreprise ACME a de nombreux clients pour lesquels elle emet des factures à partir de son système éditique. Dans le cadre des besoins d'archivage légal, le flux d'impression est doublé pour produire des fichiers PDF destinés à être archivés, chaque fichier étant accompagné un fichier d'index contenant les descripteurs de la facture.

Le fichier de description au format XML contient les méta-données métier par lesquelles le comptable va pouvoir retrouver la facture sur une période allant de 6 à 10 ans selon les pays :

  <?xml version='1.0' encoding='iso-8859-1'?>
  <ROOT>
    <INVOICE_DATE>26/07/07</INVOICE_DATE>
    <INVOICE_NUMBER>F2007-052</INVOICE_NUMBER>
    <PO_NUMBER>PO2007-052</PO_NUMBER>
    <CUSTOMER>FORTIS</CUSTOMER>
    <CONTACT_NAME>John MURPHY</CONTACT_NAME>
    <COUNTRY>Belgium</COUNTRY>
    <AMOUNT>1300</AMOUNT>
  </ROOT>

Maarch AutoImport y ajoute les informations de service pour des besoins de traçabilité.

L'ensemble des informations sont ensuite consultables dans l'écran de recherche dédié à la collection des factures.

Classement dynamique

On trouve dans la GED comme dans la vie deux catégories de personnes :

• Celles qui savent ce qu'elles cherchent ("les factures émises pour le BdC n°2445")
• Celles qui ne savent pas ("la ou les factures pour ce client asiatique de l'année dernière, à moins que ce ne soit de l'année d'avant")

Pour les premières, pas de problème : une requête bien ciblée sur la recherche avancée leur permettra de retrouver facilement leurs factures.
Pour les secondes, Maarch propose un système de classement dynamique permettant de parcourir le contenu de l'archive en mode exploratoire. Il est possible de définir différents chemins pour accéder aux documents, en fonction de leurs descripteurs.

Ce mode d'accès aux documents est très pratique, et permet à des consultants non experts de retrouver des documents sans une grande connaissance des valeurs à rechercher.

La constitution des arbres de parcours peut prendre un certain temps, et pour cette raison ne se produit pas en temps réel mais de préférence en "mode batch". Si l'ajout ou la modification d'index entraine la création d'un nouveau noeud dans un arbre, celui-ci ne sera visible qu'après l'execution du module Maarch Autofoldering.

Corbeilles de traitement

Le Sample intègre un exemple simplifié de ce qu'il est possible de faire avec le module Baskets. Les corbeilles permettent d'obtenir des vues sur le fonds documentaire, et par la suite d'un changement d'index de faire circuler les documents d'une corbeille à l'autre. Dans l'exemple, le responsable de la comptabilité doit systématiquement valider toutes les factures supérieures à 10.000 euros.
Les documents se retrouvent ensuite soit dans la corbeille "rejetées", soit dans la corbeille "validées".

Workflow procédural

Nous avons codé dans le sample un exemple de workflow de validation de facture. Même s'il s'applique plutôt à des factures fournisseur, nous l'avons placé dans la collection des factures client pour la simplicité. Le workflow procédural permet de définir à l'avance un circuit de validation/approbation.

Nous proposons le circuit suivant :

1. Un membre de la comptabilité réceptionne une facture fournisseur puis la verse dans le système de GED
2. Immédiatement après l'enregistrement, la facture est redirigée vers les membres du groupe des gestionnaires de compte, afin de vérifier si la facture correspond bien à la prestation effectuée. Trois cas peuvent alors se présenter :
   • la facture ne correspond pas, elle est rejetée
   • la facture correspond clairement, et elle est validée
   • la facture semble correspondre, mais le gestionnaire souhaite avoir l'aval de son supérieur hiérarchique. Dans ce dernier cas, la facture est alors redirigée vers le manager.
3. Le manager approuve ou rejette la facture

Installation à partir du package de téléchargement

Maarch Sample a été configuré pour favoriser une installation rapide. Il a donc été prévu pour tourner sous XAMPP installé dans le dossier c:\xampp.

Si vous désirez utiliser le Sample sur un serveur linux, suivez ces instructions pour reconfigurer le framework.

Il est bien entendu possible d'utiliser autre chose que XAMPP sous Windows, mais cela demande des connaissances informatiques plus approfondies pour adapter les fichiers de configuration. Dans ce cas, consultez (en) le guide d'installation et de configuration pour la configuration de Maarch Framework.

Respectez bien le chemin d'installation de XAMPP car nous avons tout pré-paramétré pour une installation sous C:\xampp, et vérifiez bien les options du php.ini, ce qui vous évitera bien des problèmes !

Pré-requis

La liste des pré-requis se trouve dans les détails ici.
Cependant, pour intaller très rapidement une version opérationnelle de Maarch v3, nous vous conseillons de :

• Télécharger et installer XAMPP (dans une version inférieure à la 1.7.2) sur une machine XP ou Windows, dans le répertoire C:\xampp.
• Vérifier l'application des paramètres suivants dans le PHP.ini (C:\xampp\php\php.ini)
  • error_reporting = E_ALL & ~E_NOTICE
  • display_errors = on
  • short_open_tag = On
  • magic_quotes_gpc = off

Téléchargement et installation des packages

Récupérez sur Sourceforge ou Adullact les packages suivants :

• Maarch_Framework_3.0
• Maarch_AutoImport_3.0

Dezippez et installez :

• le framework v3 dans C:\xampp\htdocs (ce qui doit vous donner c:\xampp\htdocs\maarch_v3)
• le package d'AutoImport dans C:\autoimport

Le package d'AutoImport contient des documents d'exemple pour les factures et les dossiers de prêt immobilier. Ces document d'exemple vont servir pour parcourir les fonctions du sample.

Création de la base de données et des valeurs par défaut

Sous phpmyadmin (accessible via http://127.0.0.1/phpmyadmin), créez une nouvelle base de données nommée "maarch_v3".

N'oubliez pas de positionner l'interclassement à "utf8_unicode_ci" (le dernier de la liste).

Toujours sous phpmyadmin, allez dans la base maarch_v3 et cliquez sur l'onglet "Importer".

• Importez le fichier C:\xampp\htdocs\maarch_v3\db_structure_v3.sql, ce qui a pour effet de créer toutes les tables Maarch.
• Importez le fichier C:\xampp\htdocs\maarch_v3\db_values_v3.sql pour créer toutes les valeurs par défaut de sample.

Création des Document Servers

Les document servers sont les espaces de stockage pour les ressources qui sont déclarés dans Maarch. Créez les répertoires suivants :

• C:\Maarch\DocServer\res_x\
• C:\Maarch\DocServer\res_x_ai\
• C:\Maarch\DocServer\res_invoices\
• C:\Maarch\DocServer\res_invoices_ai\

Création du répertoire de catalogue pour les index lucène (recherche plein texte)

Il doit y avoir un répertoire d'index par collection Maarch. Créez les répertoires suivants :

• C:\Maarch\indexes\coll_1\
• C:\Maarch\indexes\coll_2\

Chargement des documents d'exemple

A ce stade, vous pouvez d'ores et déjà vous connecter à l'application en tant que super-utilisateur (superadmin/superadmin) ou utilisateur fonctionnel. Pour que ce soit plus parlant, nous avons créé pour vous deux jeux de documents d'exemple (dossiers de crédit et factures client), à charger avec Maarch AutoImport.

Les documents sont dans :

• C:\autoimport\samples\documents (le dossier de crédit)
• C:\autoimport\samples\invoices (les factures client)

Copiez les documents et leur index dans les répertoires d'entrée de l'autoimport :

 copy C:\autoimport\samples\documents\*.* C:\autoimport\incoming\documents
 copy C:\autoimport\samples\invoices\*.* C:\autoimport\incoming\invoices

Modifiez si besoin les fichiers autoimport_documents.bat et autoimport_invoices.bat pour les mettre en conformité avec l'environnement que nous venons de mettre en place (modifiez si nécessaire les chemins vers votre php CLI et vers votre htdocs ou www).

contenu de autoimport_documents.bat:

 "C:\xampp\php\php.exe" C:\autoimport\maarch_autoimport\maarch_auto_import.php 
 C:\autoimport\maarch_autoimport\config_invoices.xml

Exécutez ensuite les fichiers de commandes pour le chargement :

• C:\autoimport\autoimport_documents.bat
• C:\autoimport\autoimport_invoices.bat

Et voilà !. Vous êtes maintenant prêt à utiliser Maarch Framework v3 ! Suivez le guide d'utilisation rapide du chapitre qui suit.

Tour d'horizon rapide

Ce chapitre est destiné à vous montrer rapidement des possibilités du produit, à travers des exemples concrets des données téléchargées.

Les profils utilisateurs déclarés

Travail sur les factures clients

Recherche avancée

• Ouvrez l'application (dans votre navigateur, ouvrez la page http://127.0.0.1/maarch_v3)
• Connectez-vous avec l'utilisatrice ccharles, puis dans le menu sélectionnez "Recherche avancée"
• Vous arrivez directement sur l'écran de recherche des factures car vous n'avez droit qu'à cette collection. Recherchez toutes les factures belges en tapant "Belgium" dans le champ "Pays", puis cliquez sur "Rechercher".
• Vous trouvez 24 factures. Cliquez sur pour voir la fiche descriptive de la facture, et sur pour voir le document lui-même.

Classement dynamique

Vous pouvez aussi parcourir le fonds documentaire des factures par arborescence. Auparavant, vous devez executer au moins une fois le module Maarch AutoFoldering :

 C:\xampp\htdocs\maarch_v3\modules\autofoldering\launch_autofoldering.bat

• Dans le menu Maarch, sélectionnez "Classement dynamique", puis sélectionnez un arbre à parcourir parmi les deux pré-enregistrés.

Charlotte Charles dispose d'un privilège de modification pour la collection des factures. Voyons la réaction du classement dynamique lorsque l'on change le pays de destination :

• Effectuez une recherche avancée sur la facture n° "F2008-152" (champ Référence)
• Allez sur la fiche de description (document #60), cliquez sur
• Dans la zone basse de la fiche, changez la valeur du champ Pays de "Belgium" à "Senegal", puis cliquez sur "Modifier le document".*
• Exécutez une nouvelle fois le module Maarch AutoFoldering :

 C:\xampp\htdocs\maarch_v3\modules\autofoldering\launch_autofoldering.bat

Puis parcourez l'arbre "Vue par pays/année/client" : le Sénégal apparait dans la liste des pays, et vous retrouvez ainsi votre facture.

La relance du module de classement n'est nécessaire que si on ajoute une nouvelle branche. Si l'on crée "à la main" une nouvelle facture du Sénégal, celle-ci apparait automatiquement dans l'arbre.

• Dans le menu Maarch, sélectionnez "Indexation"
• Comme vous incarnez Charlotte, vous ne pouvez créer que des factures. Choisissez un fichier PDF à verser dans l'archive, votre fichier apparait à droite de l'écran.
• Sélectionnez le type de document "Facture - Customer invoice". La liste des champs d'indexation apparait automatiquement pour ce type. Saisissez les valeurs suivantes :
  • Date du document : 01-10-2008
  • Référence : F2008-999
  • N° externe (BDC) : PO2008-999
  • Nom du contact : Julien SOREL
  • Pays : Senegal
  • Montant : 100
  • Client : FORTIS

Validez votre saisie, puis parcourez à nouveau l'arbre "Vue par pays/année/client" : pour le pays Senegal en 2008 et le client FORTIS, Maarch affiche cette fois deux factures.

Indexeur Plein Texte Lucène

full_text est un module de Maarch qui vous permet de faire de l'indexation plein texte avec le moteur de Lucene. Nous employons la version PHP de Lucene intégrée dans le framework ZEND.

Afin de réaliser des recherches plein texte (sur les PDF-TEXT enregistrés dans Maarch) depuis l'interface de recherche avancée, vous devez au préalable lancer le module full_text de Maarch.

 C:\xampp\htdocs\maarch_v3\modules\full_text\scripts\launch_fulltext_documents.bat

 C:\xampp\htdocs\maarch_v3\modules\full_text\scripts\launch_fulltext_invoices.bat

Ces deux scripts doivent être planifiés si vous désirez indexer de façon régulière vos derniers PDF-TEXT enregistrés dans Maarch.

Corbeilles de traitement

Le sample dispose d'un mécanisme de corbeilles simplifiées. Les corbeilles sont accessibles à partir du menu Maarch. Dans l'exemple, elles sont paramétrées pour afficher les factures de plus de 10.000 euros, pour pouvoir les valider ou les rejeter.

• Connectez-vous au préalable avec l'utilisateur ccharles (mot de passe maarch)
• Une fois que vous avez cliqué sur Mes corbeilles dans le menu Maarch, selectionnez la corbeille des factures de plus de 10.000€.
• Choisissez une facture en cochant la boite de gauche, puis rejetez-la (liste déroulante du bas).

La facture apparait maintenant dans la corbeille des documents rejetés.

Workflow procédural : Validation d'une facture fournisseur

Nous allons maintenant simuler un circuit de validation d'une facture fournisseur fraichement arrivée au service comptabilité fournisseur. Pour simplifier le sample, nous utilisons pour cela la collection approchante des factures clients.

1. Assurez vous que vous êtes connecté sous le nom de Charlotte Charles (ccharles/maarch), du service comptabilité, car c'est la seule capable d'enregistrer des factures.
2. Dans le menu, sélectionnez "Indexation", et procédez comme suit (agrandissez l'image pour un exemple de saisie) :

1. 1. Chargez un fichier PDF de préférence, ressemblant à une facture
   2. Sélectionnez le type de pièce Facture. La liste des index pour le type de pièce sélectionné apparait automatiquement.
   3. Renseignez les index correspondant au document. (attention, dans le jeu de test le montant est un entier)
   4. A la fin de la liste, sélectionnez l'option Démarrer le workflow : "Validation facture", puis cliquez sur "Indexer la pièce". La facture est maintenant partie dans les bons de travail à traiter par les gestionnaires de clientèle
2. Déconnectez-vous et reconnectez-vous avec Barbara Saporta (bsaporta/maarch), qui fait partie des gestionnaires. A partir de la page d'accueil, cliquez sur le bouton d'accès rapide (à droite) "Mes bons de travail".
3. Sélectionnez le workflow des factures, puis cliquez sur la facture nouvellement enregistrée. Vous voyez apparaitre une page de traitement offrant l'historique des validations, un module d'annotation, une fonction d'apposition de filigrane, et enfin un choix d'action pour cette facture.
4. Pour faire plaisir au chef, choisissons de demander l'avis du responsable. Déconnectez-vous et reconnectez-vous en tant que chef (yes!) sous l'identité de Peter Parker (pparker/maarch).
5. A partir de la page d'accueil, cliquez sur le bouton d'accès rapide "Mes bons de travail". Selectionnez la facture, et rejetez-la !

Comme les worflows savent gérer des états, ils peuvent interagir avec les corbeilles avancées : la facture apparait dans la corbeille des documents rejetés (accessible uniquement par Charlotte Charles).

Travail sur les dossiers de crédit

Le sample illustre la numérisation et la consultation de dossiers de crédit après leur acceptation par l'organisme. Il faut commencer par imprimer des séparateurs code-barre pour préparer la numérisation du dossier, chaque séparateur représentant un type de document. A cette fin connectez-vous avec l'utilisatrice Barbara (bsaporta/maarch), et dans le menu sélectionnez "Numérisation".
Nous allons dans un premier temps créer une nouvelle boite d'archive dans laquelle viendront se ranger les originaux papier après numérisation.

• Dans le paragraphe "Créer une boite", entrez un titre de boite d'archive et cliquez sur "Créer une boite". Celle-ci apparait dans la liste du bas en tant que nouvelle boite.
• Sélectionnez la boite nouvellement créée en cliquant sur sa ligne. Vous arrivez sur la page listant les lots (dans ce cas équivalents des dossiers) contenus dans la boite d'archive.
• Cliquez sur le bouton "Créer un lot". Dans l'onglet "Dossier", recherchez un n° de dossier dans la base métier, par exemple en tapant "I" dans le champ "Nom de l'adhérent". Un dossier devrait apparaitre par auto-complétion : celui d'Ismael LO.
• Cliquez sur recherche dossier.
• Sélectionnez Ismael LO (n° F_000012). Maarch passe à l'onglet suivant pour la selection du type de document. Les types de documents sont présentés au sein de leur sous-chemise.
• Cochez les types de document présents dans le dossier, validez, puis dans l'onglet suivant confirmez vos actions en cliquant sur "Créer le lot".

Maarch affiche alors autant de séparateurs code barre que de types de documents cochés, et lance automatiquement l'impression. Les séparateurs contiennent les informations saisies: n° de lot, n° de dossier, n° de lot.

Comme indiqué plus haut, le processus de numérisation, séparation des pages et transfert requiert une certaine expertise et ne peut figurer dans le package Open Source car il fait appel à des composants propriétaires pour la reconnaissance des codes barre.

Pour la consultation des dossiers, connectez-vous avec le login pparker et mot de passe maarch. La consultation des dossiers s'effectue via l'item "Recherche dossier" du menu. Les documents que vous avez chargé précédemment concernent le dossier n° F_000001.

• Effectuez une recherche sur ce numéro de dossier F_000001
• Cliquez sur l'icône d'information pour accéder à la fiche du dossier

Vous voyez apparaitre le plan de classement des documents, l'historique de consultation, et les pièces indispensables pour la complétude du dossier.
Les pièces sont aussi accessibles à partir de la recherche avancée.

• Dans le menu, sélectionnez "Recherche avancée". Contrairement à sa collègue Charlotte, Barbara arrive directement sur la collection des prêts immobiliers, à cause du schéma de sécurité.
• Effectuez une recherche sur le lot n° 60. Les documents du dossier d'Eric SPRITZ apparaissent. A partir de la fiche d'un document, il est possible d'aller au dossier afférent.

Et maintenant ?

Tout d'abord, félicitations pour être arrivé jusqu'ici !

Pour connaitre la suite à donner à votre expérience Maarch, il suffit de savoir en combien de temps vous avez installé et testé le produit :

• moins de 30 minutes

Vous êtes un champion du PHP, Mysql, et vous avez de bonnes connaissances techniques. Elève ingénieur en informatique, vous avez survolé le produit dans le cadre d'un stage ou de vos études. Contactez-nous pour un poste ou un stage chez Maarch ! (mailto:info@maarch.org)

• moins de 2 heures

Vous avez pris le temps d'installer Maarch le plus proprement possible. Vous avez passé du temps à jouer avec, lire la documentation des modules, changer deux ou trois petites choses, et vous avez des idées de business plein la tête : vous êtes dans une SSII ou SSLL ! Appelez-nous directement (+33 1 47 24 51 59) pour devenir un "Maarch Solution Advisor" et représenter Maarch dans votre zone géographique. Les gros intégrateurs sont aussi les bienvenus car nous sommes structurés pour de la vente directe et indirecte. Contactez-nous pour un rendez-vous de présentation personnalisée.

• 2 heures et plus

Vous n'êtes pas un expert mais vous vous en êtes tout de même bien sorti ! Vous avez constaté que Maarch répond de façon simple et bon marché aux vrais besoins de GED de production de votre organisation. Vous retrouvez dans cette démonstration les outils permettant de reprendre votre existant papier, de conserver et consulter rapidement vos archives.
Sachez que nous avons déjà réalisé avec ce Framework de nombreux développements organisés en modules, répondant à l'immense majorité des besoins de production. Tout ne peut pas figurer dans un exemple générique comme celui-ci, mais notre catalogue s'enrichit au fil des projets de Maarch et de ses partenaires contributeurs.
Soyez certain que notre GED Open Source offre toutes les garanties de transparence et d'ouverture, synonyme de maitrise de votre système d'information.
Contactez-nous au +33 1 47 24 51 59 ou sur mailto:info@maarch.org pour plus d'information ou un rendez-vous de présentation personnalisée.