417
edits
Module CapComments: Difference between revisions
CapComments 1.0.28
Eric.seigne (talk | contribs) (capcomments) Tag: 2017 source edit |
Eric.seigne (talk | contribs) (CapComments 1.0.28) |
||
| Line 1: | Line 1: | ||
[[Category: | [[fr:Module_CapComments_FR]] | ||
[[Category:Complementary modules]] | |||
[[Category:CRM]] | [[Category:CRM]] | ||
[[Category:CAP-REL]] | [[Category:CAP-REL]] | ||
{{ | {{TemplateDocDevEn}} | ||
{{ | {{TemplateDocUser}} | ||
= | =Information= | ||
{{TemplateModuleInfo | {{TemplateModuleInfo | ||
|modulename=CapComments | |modulename=CapComments | ||
| Line 13: | Line 14: | ||
|prerequisites= | |prerequisites= | ||
|minversion=18.0.0 | |minversion=18.0.0 | ||
|note= | |note=Threaded comments on Dolibarr cards, with @colleague mentions, scheduled reminders and notifications that follow the rights of each user. | ||
}} | }} | ||
= | =Features= | ||
Discussions about a customer, a proposal or a project get lost in emails and chat tools. CapComments brings them back where the file lives: a '''Comments''' tab on Dolibarr cards, with threads, mentions, reminders and notifications. | |||
==At a glance== | |||
* '''For whom''': any team working together on the same third parties, proposals, orders, projects or tickets. | |||
* '''What the module does''': it adds a comment thread on each supported card, notifies the colleagues mentioned and schedules reminders. | |||
* '''What it does not do''': it sends no email, changes no business document and never shows a comment to someone who may not open the card. | |||
==Feature list== | |||
* '''Comments tab''' on more than twenty kinds of cards: third parties, proposals, orders, invoices, supplier orders and invoices, projects, tasks, tickets, contracts, interventions, products, expense reports, leaves, manufacturing orders and more. | |||
* '''Threads''' with nested replies. | |||
* '''Mentions''' with @login, names suggested while typing; a mention only notifies colleagues who may open the card. | |||
* '''Scheduled reminders''' at a given date, sent by the scheduled job of the module, and personal reminders with @me, @moi or @self. | |||
* '''Notifications''' by a bell in the top bar or by a sticky note, as you prefer. | |||
* '''Private comments''' for internal users only, or '''public''' ones, also shown to the external accounts of the third party. | |||
* '''Lists''' of all comments and of your notifications, filtered by author, third party, message or date. | |||
* '''Widget''' of the connected users on the dashboard. | |||
* '''Demonstration data''' built and removed in one click, on demonstration and development instances. | |||
* '''Nine languages''': French, English, German, Spanish, Italian, Dutch, Polish, Portuguese and Brazilian Portuguese. | |||
==Screenshots== | |||
<gallery widths="300px" heights="200px"> | |||
File:CapComments onglet-commentaires-fiche-tiers.png|The Comments tab on a third party card | |||
File:CapComments fil-discussion-imbrique.png|A thread with nested replies | |||
File:CapComments autocomplete-mentions.png|Colleagues suggested while typing a mention | |||
File:CapComments liste-commentaires.png|The comments list, filtered by third party | |||
File:CapComments liste-notifications.png|The notifications list | |||
File:CapComments page-configuration.png|Module setup page | |||
</gallery> | |||
=Links= | |||
* [https://doc.cap-rel.fr/capcomments/?lang=en Module documentation] | |||
* [https://doc.cap-rel.fr/capcomments/nouveautes-1-0-28 What's new in version 1.0.28] (in French) | |||
* [https://dolinews.com/en/projets/capcomments Get update notifications] | |||
* [https://cap-rel.fr/sav-module-dolibarr/ Support form] | |||
* [https://dolitest.fr/capcomments/ Online demo]: a Dolibarr with threads, mentions and reminders already in place, created for you in less than 20 seconds and removed after the session | |||
=Requirements= | |||
{| class="wikitable" | |||
! Item !! Version or condition | |||
|- | |||
| Dolibarr || 18.0 or later | |||
|- | |||
| PHP || 7.4 or later | |||
|- | |||
| Rights || an administrator account to install, enable and set up the module | |||
|} | |||
The Comments tab shows on the cards of the enabled Dolibarr modules: a missing module simply has no tab. | |||
=Installation= | =Installation= | ||
{{ | {{InstallModuleDoliStoreEn|keyword=capcomments}} | ||
==Upgrade== | |||
# Install the new version through '''Home > Setup > Modules/Applications > Deploy/install external app/module'''. | |||
# Disable then enable the module again: enabling applies the database upgrades and grants the read and write rights to internal users once. | |||
Your comments, notifications and settings are kept. | |||
==Uninstall== | |||
Disable the module from '''Home > Setup > Modules/Applications'''. Comments and notifications stay in the database: enabling the module again later finds them back. | |||
=Setup= | |||
{{ActivationModuleEn}} | |||
The setup is in '''Home > Setup > Modules > CapComments'''. It has the '''Settings''', '''Demonstration data''' and '''About''' tabs. | |||
{| class="wikitable" | |||
! Setting !! Role | |||
|- | |||
| CapComments main menu || shows the menu of the module in the top bar | |||
|- | |||
| Menu in Tools || adds the menu of the module to the Tools menu | |||
|- | |||
| Notification style || bell in the top bar, or sliding sticky note | |||
|} | |||
Scheduled reminders are sent by the '''CapComments''' scheduled job: check that it is enabled in '''Home > Admin tools > Scheduled jobs'''. | |||
==Demonstration data== | |||
The '''Demonstration data''' tab builds, then purges, a full data set: third parties, a proposal, a project, demonstration accounts, threads, mentions and reminders. It only runs on a demonstration or development instance; elsewhere, set the <code>CAPCOMMENTS_ALLOW_DEMO_DATA</code> constant to <code>1</code>, or <code>MAIN_FEATURES_LEVEL</code> to <code>2</code>. Never run it on a production install. | |||
=Permissions= | |||
{| class="wikitable" | |||
! Permission !! What it allows | |||
|- | |||
| Read comments and notifications || see the Comments tab, the comments list and one's notifications | |||
|- | |||
| Write comments || comment, reply and delete one's own comments | |||
|- | |||
| Delete comments written by other users || moderate the comments of a card | |||
|} | |||
The rights of the module add to those of the card: a sales representative limited to their customers only sees the comments of their customers. External accounts only see the public comments of their own third party's cards. | |||
=Usage= | |||
Open a card, click the '''Comments''' tab, write your message and tick '''Private''' if only internal users should read it. Type <code>@</code> to mention a colleague, pick a date to schedule a reminder, and send with the button or with <code>Ctrl+Enter</code>. The '''Reply''' link opens a reply in the thread. | |||
Your notifications show in the top bar; the full list and the list of all comments are in the menu of the module. | |||
Details are in the [https://doc.cap-rel.fr/capcomments/utilisation user guide] (in French). | |||
= | =FAQ= | ||
'''I do not see the Comments tab on a card.'''<br> | |||
Check that you have the right to read comments and that the kind of card is supported. | |||
'''A mentioned colleague got no notification.'''<br> | |||
A mention only notifies people who have the right to read comments and to open the card; a private comment never notifies an external account. | |||
'''A scheduled reminder was not sent.'''<br> | |||
Check that the CapComments scheduled job is enabled. | |||
All questions: [https://doc.cap-rel.fr/capcomments/faq FAQ of the documentation] (in French). | |||
= | =Development= | ||
Developments and improvements can be suggested to the project maintainer by email (see the headers of the source files) or through the [https://cap-rel.fr/sav-module-dolibarr/ support form]. | |||