Dolibarr ERP CRM Wiki

Changes

Module KMGArchiGED EN (view source)

Revision as of 08:58, 17 January 2023

209 bytes removed ,  2 years ago
m
no edit summary
Line 1: Line 1:  +
<!-- BEGIN origin interlang links -->
 +
<!-- You can edit this section but do NOT remove these comments
 +
    Links below will be automatically replicated on translated pages by PolyglotBot -->
 +
[[fr:Module_KMGArchiGED_FR]]
 +
<!-- END interlang links -->
 +
 
[[Category:Complementary_modules]]
 
[[Category:Complementary_modules]]
 
[[Category:Documents]]
 
[[Category:Documents]]
   −
== Informations ==
+
==Informations==
−
version 1.41 - 01/09/2018
+
version 3.2 - 15/04/2022
 
{{TemplateModuleInfo
 
{{TemplateModuleInfo
 
|modulename=Module KMGArchiGED
 
|modulename=Module KMGArchiGED
−
|currentVersion=1.41
+
|currentVersion=1.53
 
|editor=Kevin GUERRIER
 
|editor=Kevin GUERRIER
−
|webbuy=[http://www.dolistore.com/lang-fr/search.php?search_query=kmg Dolistore]
+
|webbuy=[https://www.dolistore.com/fr/modules/1398-KMGArchiGED.html Dolistore]
 
|status=stable
 
|status=stable
 
|minversion=5.0.4
 
|minversion=5.0.4
 
|maxversion=
 
|maxversion=
−
|note=In Progress - Access to French version : [https://drive.google.com/open?id=1X0w8VmFKhxQR5mNCt8EW8H66INFeLk-Q Documentation FR]
+
|note=In Progress - Screenshots not yet translated : [https://drive.google.com/open?id=1sybiYckVQyIR8gz5A4CyvrU0PyjVVvlH Documentation EN]
 
}}
 
}}
   −
== Preamble ==
+
==Preamble==
−
The KMGArchiGED module has been developed to allow the management of incoming documents within a structure, their reception from a scanning device managing the sending via FTP, their transmission by email, their link with native elements of Dolibarr, as well as than their archiving.
+
The KMGArchiGED module has been developed to allow the management of incoming documents within a structure, their reception from a scanning device managing the sending by FTP, their transmission by email, their link with native elements of Dolibarr, as well as than their archiving.
    
The use case at the origin of the module is the following :  
 
The use case at the origin of the module is the following :  
−
* The mails are received by the secretariat which has a network scanner on which shortcuts have been configured :
  −
** Suppliers Invoices
  −
** Bank Documents
  −
** Social Document
  −
** Dues and taxes
  −
** Others mails
     −
* Depending on the documents, the person sends the items to the correct bib, checks that the document has been correctly transmitted from the module, and then stores the paper documents.
+
*The mails are received by the secretariat which has a network scanner on which shortcuts have been configured :
−
* Processing can be done directly by staff members within different departments directly from the module.
+
**Suppliers Invoices
 +
**Bank Documents
 +
**Social Document
 +
**Dues and taxes
 +
**Others mails
 +
 
 +
*Depending on the documents, the person sends the items to the correct bib, checks that the document has been correctly transmitted from the module, and then stores the paper documents.
 +
*Processing can be done directly by staff members within different departments directly from the module.
 +
 
 
For example :
 
For example :
−
* Supplier invoices can be entered from the preview and the document can be directly linked to ;
  −
* Social documents or tax correspondence can be sent by e-mail to the accountant for further information ;
  −
* Customer payment notices can be used to enter payments with correct lettering and the document can be linked to the third party to maintain traceability ;
  −
* Statements of account can be attached to the corresponding bank account ;
  −
* The worksheets, followed by interventions, activity reports, ... can be attached to the projects and tasks concerned ;
  −
* ...
     −
== Installation ==
+
*Supplier invoices can be entered from the preview and the document can be directly linked to ;
 +
*Social documents or tax correspondence can be sent by e-mail to the accountant for further information ;
 +
*Customer payment notices can be used to enter payments with correct lettering and the document can be linked to the third party to maintain traceability ;
 +
*Statements of account can be attached to the corresponding bank account ;
 +
*The worksheets, followed by interventions, activity reports, ... can be attached to the projects and tasks concerned ;
 +
*...
 +
 
 +
NEW IN VERSION 3.2
 +
 
 +
<nowiki>-----</nowiki>
 +
 
 +
Compatibility for Dolibarr 14 & 15.
 +
 
 +
Adding Link to VAT payment, contact and supplier proposal
 +
 
 +
 
 +
NEW IN VERSION 3.0
 +
 
 +
<nowiki>-----</nowiki>
 +
 
 +
Compatibility for Dolibarr 13.
 +
 
 +
 
 +
NEW IN VERSION 2.0
 +
 
 +
<nowiki>-----</nowiki>
 +
 
 +
It is also possible to define a virtual banner for each user as well as for each group.
 +
 
 +
A tab dedicated to these settings is available from the user card> "KMGArchiGED configuration"
 +
 
 +
<nowiki>-----</nowiki>
 +
 
 +
==Installation==
 
The installation archive contains a kmgarchiged folder containing all the files required for the proper functioning of the module. In order to be activated in the modules configuration interface, the kmgarchiged folder must be copied to either the htdocs directory or the htdocs/custom directory.
 
The installation archive contains a kmgarchiged folder containing all the files required for the proper functioning of the module. In order to be activated in the modules configuration interface, the kmgarchiged folder must be copied to either the htdocs directory or the htdocs/custom directory.
    
<div style="text-align:center;">
 
<div style="text-align:center;">
 
Note that the use of the htdocs/custom directory requires that the parameters<br />
 
Note that the use of the htdocs/custom directory requires that the parameters<br />
−
<source lang="ini">$dolibarr_main_url_root_alt</source><br />
+
<syntaxHighlight lang="ini">$dolibarr_main_url_root_alt</syntaxHighlight><br />
 
and<br />
 
and<br />
−
<source lang="ini">$dolibarr_main_document_root_alt</source><br />
+
<syntaxHighlight lang="ini">$dolibarr_main_document_root_alt</syntaxHighlight><br />
 
has been correctly defined.
 
has been correctly defined.
 
</div>
 
</div>
Line 50: Line 85:       −
== Configuration ==
+
==Configuration==
−
Une fois le module installé, l’accès à la configuration se fait par l’icône .
+
Once the module is installed, access to the configuration is done by the icon ending line.
−
=== Section Types d'événement ===
+
 
−
Le module KMGArchiGED génère automatiquement des événements dans l’agenda lors du traitement d’un document par un utilisateur. Il est possible de créer des codes d’événement spécifiques pour la suppression, la liaison, la notification d’un document depuis le module, ou encore pour la réception d’un document dans le module. Si ces types d'événements ne sont pas présents dans votre instance de Dolibarr, il est possible de le créer en utilisant le bouton “Ajouter”. A défaut, le type d’événement AC_OTH_AUTO, qui définit les “Évènements insérés automatiquement” sera utilisé.
+
===Event Types Section===
 +
The KMGArchiGED module automatically generates events in the calendar when a user processes a document. It is possible to create specific event codes for deleting, linking, notifying a document from the module, or for receiving a document in the module. If these types of events are not present in your instance of Dolibarr, it is possible to create it by using the "Add" button. Otherwise, the event type AC_OTH_AUTO, which defines the "Events inserted automatically" will be used.
   −
=== Section Email ===
+
===Email section===
−
Si l’envoi par mail est correctement configuré sur votre instance Dolibarr, il est possible de transmettre un document présent dans une bannette par mail. Les informations pré-remplies sont personnalisables dans cette section. Dans tous les cas, l’utilisateur peut modifier les éléments avant chaque envoi.  
+
If the sending by email is correctly configured on your Dolibarr instance, it is possible to transmit a document present in a banner by email. Pre-filled information is customizable in this section. In any case, the user can modify the elements before each sending.  
   −
=== Section Outils ===
+
===Tools section===
−
Le module KMGArchiGED utilise des fonctions externes au moteur de Dolibarr et nécessite donc l’utilisation d’outils externes.
+
The KMGArchiGED module uses functions external to the Dolibarr engine and therefore requires the use of external tools.
−
A ce jour, il n’y a que la commande convert qui est utilisée, notamment afin de générer les images d’aperçu d’un document. Cette commande est présente sur la majorité des hébergements. Si vous rencontrez un problème d’affichage de l’aperçu d’un document lors de la consultation d’une bannette, merci de vérifier que la commande convert est bien trouvée par le module dans cette section.
+
To date, only the convert command is used, in particular to generate the preview images of a document. This order is present on most of the accommodations. If you encounter a problem viewing a preview of a document when viewing a mail bin, please check that the convert command is found by the module in this section.
   −
Si cette commande n’est pas trouvée, il est nécessaire de l’installer (ou de l’activer) sur votre serveur. Si, malgré cela, le problème persiste, merci de contacter notre support.  
+
If this command is not found, it is necessary to install (or activate) it on your server. If, despite this, the problem persists, please contact our support.  
   −
=== Section Liens pour envoi direct par FTP ===
+
===Links section for direct sending by FTP===
−
Cette section détaille les chemins relatifs aux différentes bannettes disponibles, informations nécessaires à la configuration de périphériques réseau pour la transmission de documents via FTP (voir ci-dessous : Fonctionnalités > Transmission d’un document via FTP). Ils doivent bien sûr être adaptés selon votre configuration.
+
This section details the paths to the available bins, information needed to configure network devices for FTP document transmission (see below: Features > Transmitting a document by FTP). They must of course be adapted according to your configuration.
   −
== Fonctionnalités ==
+
==Features==
−
=== Accès aux bannettes virtuelles ===
+
===Access to virtual bins===
−
Les documents peuvent être transmis dans une “bannette virtuelle”. L’accès à chacune de ces bannette est subordonné à des permissions des modules Dolibarr. Par défaut, les bannettes suivantes sont disponibles :
+
The documents can be transmitted in a "virtual banner". Access to each of these bins is subordinated to Dolibarr module permissions. By default, the following bins are available :
    
{| class="wikitable centre" style="width:100%;"
 
{| class="wikitable centre" style="width:100%;"
−
|+ Tableau
+
|+Tableau
 
|-
 
|-
−
! scope=col | Bannette virtuelle
+
! scope="col" |Virtual bins
−
! scope=col | Module
+
! scope="col" |Module
−
! scope=col | Permission
+
! scope="col" |Permission
 
|-
 
|-
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Factures Fournisseurs
+
Suppliers Invoices
 
| style="width:34%;" |
 
| style="width:34%;" |
−
Fournisseurs
+
Suppliers
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Consulter les factures fournisseur
+
Read supplier invoices
 
|-
 
|-
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Documents Sociaux
+
Social Documents
−
| style="width:34%;" rowspan="2" |
+
| rowspan="2" style="width:34%;" |
−
Dépenses spéciales
+
Special expenses
−
| style="width:33%;" rowspan="2" |
+
| rowspan="2" style="width:33%;" |
−
Lire les charges fiscales ou sociales et paiement de TVA
+
Read social or fiscal taxes and vat
 
|-
 
|-
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Impôts et taxes
+
Dues and taxes
 
|-
 
|-
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Documents Bancaires
+
Bank documents
 
| style="width:34%;" |
 
| style="width:34%;" |
−
Banques et caisses
+
Banks and cash
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Consulter les comptes financiers
+
Read financial accounts
 
|-
 
|-
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Autres
+
Others
 
| style="width:34%;" |
 
| style="width:34%;" |
 
KMGArchiGED
 
KMGArchiGED
 
| style="width:33%;" |
 
| style="width:33%;" |
−
Utiliser Kmgarchiged
+
Use KMGArchiged
 
|}
 
|}
   −
A noter que le rôle administrateur permet l’accès à l’ensemble des bannettes virtuelles.
+
NEW IN VERSION 2.0
 +
 
 +
<nowiki>-----</nowiki>
 +
 
 +
It is also possible to define a virtual banner for each user as well as for each group.
 +
 
 +
A tab dedicated to these settings is available from the user card> "KMGArchiGED configuration"
 +
 
 +
<nowiki>-----</nowiki>
 +
 
 +
Note that the administrator role allows access to all virtual bins.
 +
 
 +
If you think of other bins or if your operation requires the use of specific bins, do not hesitate to contact us.
   −
Si vous pensez à d’autres bannettes ou si votre fonctionnement nécessite l’utilisation de bannettes spécifiques, n’hésitez pas à nous contacter.
+
===Transmission of a document by FTP===
 +
This feature requires the document directory and its contents to be accessible by FTP. This feature is available for the majority of hosting. The login information (access address, user and password) will be required to configure the scanning device (Copier, MFP, Network Scanner, ...).
 +
It is possible to set shortcuts for a virtual banner by adapting the path.  
   −
=== Transmission d’un document via FTP ===
+
The following is an example configuration for a direct shortcut to "Supplier Invoices".
−
Cette fonctionnalité nécessite que le répertoire document ainsi que son contenu soient accessibles via FTP. Cette fonctionnalité est accessible pour la majorité des hébergements. Les informations de connexion (adresse d’accès, utilisateur et mot de passe) seront nécessaires pour configurer le périphérique de numérisation (Copieur, Imprimante multifonctions, Scanner réseau, …).
  −
Il est possible de paramétrer des raccourcis pour une bannette virtuelle en adaptant le chemin d’accès.  
     −
Vous trouverez ci-après un exemple de configuration pour un raccourci direct vers les “Factures fournisseurs”.
+
'' FTP connection information ''
   −
'' Informations concernant la connexion FTP ''
+
*FTP server address : ftp.my-server.net
−
* Adresse du serveur FTP : ftp.mon-serveur.net
+
*Username : myUser
−
* Nom d’utilisateur : monUser
+
*Password : myPass
−
* Mot de passe : monPass
+
*FTP root : In the folder containing htdocs directories and Dolibarr documents
−
* Racine FTP : Dans le dossier contenant les répertoires htdocs et documents de Dolibarr
        −
'' Configuration du raccourci (issu d’un Xerox WorkCentre 6515DN MFP) ''
+
'' Shortcut Configuration (from a Xerox WorkCentre 6515DN MFP) ''
−
* Nom d'hôte :  ftp.mon-serveur.net
  −
* Chemin du document : /documents/kmgarchiged/SupplierInvoices
  −
* Nom de connexion : monUser
  −
* Mot de passe : monPass
  −
* Confirmer le mot de passe : monPass
     −
Comme vu précédemment, les informations relatives aux différentes bannettes disponibles sont précisées dans la page de configuration du module. Ils doivent bien sûr être adaptés selon votre configuration.
+
*Hostname :  ftp.my-server.net
 +
*Document path : /documents/kmgarchiged/SupplierInvoices
 +
*Login name : myUser
 +
*Password : myPass
 +
*Confirm password : myPass
   −
Le module KMGArchiGED est prévu pour fonctionner avec les fichiers au format PDF. La plein compatibilité du module avec l’utilisation d’autres formats n’est pas garantie. Si vous souhaitez prendre en charge des types de fichiers particuliers, n’hésitez pas à nous contacter.
+
As seen previously, the information relating to the different available bins is specified in the configuration page of the module. They must of course be adapted according to your configuration.
   −
=== Transmission d’un document via upload direct ===
+
The KMGArchiGED module is intended to work with PDF files. The full compatibility of the module with the use of other formats is not guaranteed. If you want to support particular types of files, do not hesitate to contact us.
−
L’interface principale du module liste les bannettes disponibles pour l’utilisateur en fonction de ces droits. Pour chacune de ces bannettes, la liste des documents présents est affichée, et sous cette liste, une section permet à l’utilisateur d’ajouter un nouveau document.
     −
== Consultation et gestion des documents d’une bannette ==
+
===Transmission of a document by direct upload===
−
Un document présent dans une bannette est affiché de la manière suivante :
+
The main interface of the module lists the bins available to the user according to these rights. For each of these bins, the list of present documents is displayed, and under this list, a section allows the user to add a new document.
   −
* Le lien de prévisualisation du document complet (icone fichier avec loupe) ainsi que la date à laquelle le document à été vu pour la première fois par le module sont affichés en entête. Une image représentant le premier tiers de la première page du document est affichée en dessous, suivie de la liste des événements déjà réalisés pour ce document.
+
==Consultation and document management of a virtual bin==
−
* La partie droite permet :  
+
A document in a bin is displayed as follows :  
−
** de transmettre par email le document à un tiers, à un contact, à un utilisateur, ou directement à une adresse mail. Le sujet et le corps du mail sont pré-remplis et peuvent être ajustés par l’utilisateur avant envoi. Dans le cas où le document est transmis à un utilisateur ayant accès au module KMGArchiGED, un lien direct permettant d’accéder au document et au module est ajouté dans le corps du mail ;
  −
** de lier le document à un élément natif de Dolibarr (parmis Tiers, Banque, Propale Client, Commande Client, Facture Client, Commande Fournisseur, Facture Fournisseur, Projet, Tâche, Charge Sociale), avec la possibilité de le renommer au passage (l’extension ne doit pas être précisée dans le nouveau nom. Elle est reprise automatiquement) ;
  −
** d’archiver un document pour lequel plus aucune action n’est requise ;
     −
Si vous souhaitez lier un document à d’autres types d’éléments (natifs ou issus d’un module externe) ou si vous souhaitez une autre fonctionnalité, n’hésitez pas à nous contacter.
+
*The preview link of the complete document (file icon with magnifying glass) as well as the date on which the document was seen for the first time by the module are displayed in the header. An image representing the first third of the first page of the document is displayed below, followed by the list of events already performed for this document.
 +
*The right part allows :
 +
**to send by email the document to a third party, to a contact, to a user, or directly to an email address. The subject and the body of the mail are pre-filled and can be adjusted by the user before sending. In the case where the document is transmitted to a user having access to the KMGArchiGED module, a direct link allowing access to the document and the module is added in the body of the mail ;
 +
**to link the document to a native element of Dolibarr (among Third Parties, Bank, Propale Customer, Sales Order, Customer Invoice, Supplier Order, Supplier Invoice, Project, Task, Social Charge), with the possibility to rename it in the process (the extension must not be specified in the new name and is automatically repeated) ;
 +
**to archive a document for which no further action is required ;
   −
== Consultation des documents archivés ==
+
If you want to link a document to other types of elements (native or from an external module) or if you want another feature, do not hesitate to contact us.
−
Une fois archivé, les documents sont accessibles depuis le menu KMGArchiGED > Archives. Cette interface liste les documents en fonction de la période à laquelle ils ont été reçus dans le module (filtre au trimestre, scindé par semaine et par bannette).
     −
Les documents sont listés les uns en dessous des autre, et sont précédés d’un lien de prévisualisation du document complet (icone fichier avec loupe). Le nom du document est cliquable afin de télécharger directement le fichier.
+
==Viewing archived documents==
−
A noter que les bannettes disponibles dépendent également des permissions accordées à l’utilisateur.
+
Once archived, the documents are accessible from the KMGArchiGED> Archives menu. This interface lists the documents according to the period in which they were received in the module (filter in the quarter, split by week and by bin).
   −
Si vous souhaitez réaliser des actions complémentaires au sein de ces archives ou si vous souhaitez une autre fonctionnalité, n’hésitez pas à nous contacter.
+
The documents are listed below each other, and are preceded by a preview link of the complete document (file icon with magnifying glass). The document name is clickable to download the file directly.
 +
Note that the available bins also depend on the permissions granted to the user.
 +
Since version 1.51, it is possible to delete an archived document. This feature needs a specific permission and must be enabled for the user.
    +
If you wish to carry out additional actions within these archives or if you wish another functionality, do not hesitate to contact us.
   −
== Développement & Support ==
+
==Development & Support==
−
Ce module est développé et maintenu par Kevin GUERRIER. Toute demande de renseignement, question technique, proposition d’amélioration, remontée d’anomalie, … doit être transmise par mail à l’adresse support[at]kmg-process.com.
+
This module is developed and maintained by Kevin GUERRIER. Any request for information, technical question, proposal for improvement, feedback anomaly, ... must be sent by email to the address support[at]kmg-process.com.
Retrieved from "https://wiki.dolibarr.org/index.php?title=Special:MobileDiff/39602...55659"