DocEdit pour Agefodd/Documentation utilisateur

De ATM
Aller à : Navigation, rechercher

Sommaire

Présentation du module

  • Ce module vous permet de personnaliser les documents générés dans Agefodd (convention, programme, etc...). Vous créez vos modèles PDF que vous pouvez ensuite sélectionner lors de la génération de vos documents dans Agefodd. Ce module intègre également les fonctionnalités du module DocEdit pour la personnalisation de vos modèles de factures, propositions, etc...

Informations pratiques

  • Ce module fonctionne à partir de la version 6.0 de Dolibarr
  Si vous installez le module à l'aide de l'outil d'installation automatique de Dolibarr, il faudra renommer le module avec son nom complet : 
  "module_referenceletters-2.0_agefodd.zip" 
  (le module est renommé sur Dolistore suite à une contrainte du nombre limité de caractères)

Configuration du module

  • Pour configurer ce nouveau module, il faut aller dans "Accueil", puis dans le menu de gauche "Configuration" -> "Modules/Applications"; recherchez alors le module "DocEdit - Formation".
DocEdit pour Agefodd - Configuration
  • Cliquez sur l'icône Mcv2.3.png en bout de ligne pour accéder au détail de la configuration.
DocEdit pour Agefodd - Configuration
  • C'est ici que vous aller pouvoir créer votre en-tête et pied de page par défaut.
DocEdit pour Agefodd - Personnalisation entête et pied de page
  • Vous pourrez tout à fait définir des en-têtes et pieds de page différents dans vos modèles, comme vous le verrez par la suite.
  Pour une utilisation optimale du module, il est recommandé d'activer le module éditeur WYSIWYG natif de Dolibarr.
  Pensez également à gérer les droits de vos utilisateurs pour qu'ils aient accès à la consultation/modification/suppression ou l'utilisation des modèles de document.

Menu secondaire

  • Les fonctionnalités du module DocEdit sont accessibles depuis le menu principal de Dolibarr par l'onglet "DocEdit - Formation" :
DocEdit pour Agefodd - Menu principal
  • Le menu principal affiche un tableau de bord de l’utilisation des différents modèles de documents avec :
    • une liste des derniers modèles de documents créés / modifiés
    • une liste des derniers documents courant générés (Hors Agefodd). Vous pouvez remarquer que chaque courrier a sa propre référence.
  • Vous disposez ensuite d'un menu secondaire :
DocEdit pour Agefodd - Menu secondaire
  • Nous allons détailler ici les différentes entrées de ce menu.

Liste des modèles de document

  • En cliquant sur "DocEdit - Formation" on accède au 6 derniers modèles créés, et en cliquant sur "Liste des modèles de document", on accède à l'intégralité des modèles existants.
DocEdit pour Agefodd - Menu secondaire
DocEdit pour Agefodd - Liste des modèles de documents
  • On peut accéder au détail du modèle en cliquant sur son titre ou sur l'icône d'édition en bout de ligne :
DocEdit pour Agefodd - Liste des modèles de documents
  • Les différents onglets permettent d'accéder aux différents éléments de votre modèle pour les visualiser/modifier (corps du document, en-tête, pied de page, image de fond) :
DocEdit pour Agefodd - Liste des modèles de documents
  Le module propose 4 modèles courants (Commande, Contrat, Facture, Proposition), que vous pouvez réutiliser en les clonant. 
  Un modèle "EDITION_PERSO_AGEFODD_EXEMPLE" est disponible pour vous aider dans l'établissement des modèles pour Agefodd.
DocEdit pour Agefodd - Liste des modèles de documents
  • Éditez ce modèle, à l'intérieur vous retrouverez les éléments qui vous servirons pour vos différents modèles de documents de Formation.
DocEdit pour Agefodd - Liste des modèles de documents

Suppression - Désactivation d'un modèle

  • Il est possible de désactiver/activer ou supprimer un modèle : pour cela il faut éditer le modèle, puis cliquer sur le bouton souhaité Désactiver/Activer ou Supprimer. La suppression est bloquante si le modèle à supprimer est utilisé dans Dolibarr. Pour retrouver la liste des utilisations, il faut se rendre dans Liste des documents et supprimer ces courriers. Il sera alors possible de supprimer définitivement le modèle.

Nouveau modèle de document

  • Pour créer un nouveau modèle de document, cliquez sur l'entrée du menu secondaire "Nouveau modèle de document".
DocEdit - Nouveau modèle de document
  Pour rappel, vous disposez dans la liste des modèles de documents, de 4 modèles type (facture, commande, proposition, contrat) que vous pouvez cloner pour vous en inspirer.
  Un modèle récapitulant les variables utiles pour Agefodd est également présent.
  • Vous sélectionnez d'abord le type d'objet dans la liste déroulante (contrat , proposition, feuille d'émargement, programme, chevalet, etc...)
DocEdit pour Agefodd - Nouveau modèle de document
  • Saisissez ensuite le titre du futur document
  • Enfin indiquez si vous souhaitez un format paysage plutôt qu'un format portrait; par défaut, si rien n'est modifié, votre document sera en format portrait.
DocEdit pour Agefodd - Nouveau modèle de document
  • Vous pouvez maintenant cliquer sur le bouton "Créer".
DocEdit pour Agefodd - Nouveau modèle de document
  • 4 onglets sont à votre disposition pour modifier les différents éléments de votre document :
    • le corps du document, onglet "Fiche"
    • en-tête
    • pied de page
    • image de fond (utiliser un format PDF)
  Pour rappel, l'achat du module comprend une heure d'assistance afin de vous aider dans la création / modification de vos documents. 

Création des chapitres

  • Un modèle de document est une succession de « chapitres ». Chaque chapitre pouvant contenir des balises et être complété d'options.
  • Chaque chapitre peut aussi être formaté à votre convenance, en utilisant les fonctionnalités de l'éditeur de texte (Gras, souligné, couleur...).
  • À partir d'un modèle de document, cliquez sur le bouton "Nouveau chapitre" :
DocEdit pour Agefodd - Nouveau chapitre
  • La création d'un nouveau chapitre ouvre une page permettant :
    • de saisir le numéro d'ordre du chapitre dans la future édition
    • d'afficher la liste des tags qui pourront être copiés/collés dans le document avec le "+"
    • d'enregistrer le titre du chapitre
    • de saisir le texte contenu dans le chapitre
    • et de saisir les options.
DocEdit pour Agefodd - Nouveau chapitre

Les Tags et options Les tags (ou balises) présents dans le texte modèle seront remplacés au moment de l'édition du document par les valeurs présentent dans Dolibarr. Par exemple, la balise {mycompany_name} générera la valeur enregistrée dans le champs nom/enseigne/raison sociale/ de votre société/institution dans Dolibarr.

DocEdit pour Agefodd
  • Terminez la création du chapitre en cliquant sur le bouton Créer.
  • Il est toujours possible de modifier ou supprimer le chapitre via les boutons disponibles Mcv2.20.png et Mcv2.21.png.
  • Répétez l'opération de création de chapitre autant de fois que nécessaire pour compléter le modèle de votre document. Plus votre document sera détaillé, plus les modifications et sa personnalisation seront faciles.

Autres options

  • Il est aussi possible , suite à chacun des chapitres, d'insérer des sauts de page qui seront pris en compte lors de l'édition du document.
DocEdit pour Agefodd
  • Les modèles complets peuvent être clonés, c'est-à-dire copiés depuis leur élément d'origine. Le nom du nouveau modèle de document précisera qu'il est issu d'un clonage jusqu'à sa modification.
DocEdit pour Agefodd

Liste des documents

  • En cliquant dans le menu secondaire sur "Liste des documents", vous accédez à la liste des documents utilisés uniquement pour les documents courants Dolibarr, c'est-à-dire hors formation; chaque document généré a sa propre référence. Vous pouvez alors filtrer votre liste par type d'objet ou par société.
DocEdit pour Agefodd - Liste des documents

Génération en masse

  • La génération en masse permet de sélectionner toutes les factures pour lesquelles vous souhaitez générer en un clic les documents correspondants. Il est possible de sélectionner une période à l'aide des filtres.
  • Ceci est disponible uniquement pour les factures.
DocEdit pour Agefodd - Génération en masse

Édition d'un modèle

  • Une fois le modèle terminé, vous pourrez l'éditer depuis la liste des modèles de document en cliquant sur l'un des accès disponibles :
DocEdit pour Agefodd - Liste des modèles de documents

Utilisation des modèles dans Agefodd

  • Nous allons voir ici comment utiliser les modèles prédéfinis pour les générer dans le module de Formation.
  • Rendez-vous sur une session de formation, onglet "Documents liés" :
DocEdit pour Agefodd - Utilisation des modèles pour vos formations
  • Vous êtes sur la liste des documents de formation que vous pouvez générer.
  • À côté des différentes icônes déjà disponibles en standard dans le module, vous observez le symbole "+", comme ci-dessous dans l'exemple :
DocEdit pour Agefodd - Utilisation des modèles pour vos formations
  • Lorsque vous cliquez sur le symbole "+", un champ s'ouvre et vous permet de sélectionner le modèle souhaité :
DocEdit pour Agefodd - Utilisation des modèles pour vos formations
  • Pour les conventions de formation uniquement : une fois que vous avez sélectionné un modèle et si vous souhaitez en changer, vous voyez que le symbole "+" n'apparaît pas; il faut alors éditer le document et sélectionner dans dans la combobox dédiée le modèle voulu. Pour reprendre le modèle standard il suffit de cliquer sur l'icône d'actualisation.
  • Vous pouvez alors visualiser ou télécharger votre document généré avec le modèle sélectionné, à l'aide des icônes habituelles.
  Pour l'instant il n'est pas possible d'utiliser les modèles pour une génération en masse des documents via l'onglet "Documents par participant"

Utilisation des modèles hors Agefodd

  • Il s'agit ici des modèles courants que vous pouvez créer pour les types d'objet suivants :
    • Contrat
    • Tiers
    • Contact
    • Proposition commerciale
    • Facture
    • Commande client
    • Commande fournisseur
    • Demande de prix

Création des documents depuis une fiche

Depuis une fiche en cours

  • Prenons l'exemple d'une fiche proposition, sur l'onglet "Fiche proposition" , on peut sélectionner directement le modèle souhaité dans l'encart "Fichiers joints" :
DocEdit pour Agefodd
  • Cliquer ensuite sur "Générer" pour créer le document correspondant. Si vous cliquez ensuite sur "Envoyer par mail'", ce sera alors le modèle utilisé dans votre envoi de mail.
  • Ce nouveau document est alors accessible dans la liste des documents dans l'onglet "Modèle de document".
DocEdit pour Agefodd

Depuis l'onglet "Modèle de document" de la fiche

  • Il faut se rendre sur l'onglet "Modèle de document" de votre fiche en cours, dans l'exemple suivant nous sommes sur une fiche proposition :
DocEdit pour Agefodd
  • Puis dans le menu déroulant sélectionnez le modèle correspondant, et cliquez sur le bouton "Sélectionner le modèle".
DocEdit pour Agefodd
  • La page d'édition s'affiche.
  • Les chapitres créés dans le modèle ont chacun leur éditeur permettant leur modification pour les adapter au contexte, et la sélection ou non des options prévues avec les cases à cocher :
DocEdit pour Agefodd
  • Une fois votre personnalisation terminée, vous pouvez créer la lettre avec le bouton en bas de page.

Création du PDF

  • Le document créé est accessible depuis la liste des Lettres existantes.
DocEdit pour Agefodd - Création du PDF
  • Il est possible de générer le document en format PDF, les balises sont bien remplacées par leurs valeurs, et le texte modifié lors de la personnalisation a été pris en charge.

FAQ

  • Les modules DocEdit et Sous-total/Sous-total V3/Sous-total Lite sont-ils compatibles ? Oui
  • Si je passe du module "modèle de courrier" à "DocEdit" est-ce que je conserve mes modèles : oui, cependant, avant toute action, nous vous conseillons de bien faire une sauvegarde de vos données.

Historique et mise à jour

  • Dernière mise à jour le 23/07/2018 - version 2.0
  • 30/04/2018 : ajout de nouveaux types d'objet => demande de prix et commande fournisseur
  • Disponible sur Dolistore depuis le 13/02/2018 - version 2.0