[17.0][MIG] crm_phonecall_planner

crm_phonecall_planner/README.rst

@@ -0,0 +1,157 @@
+=================
+Phonecall planner
+=================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:51afc497875e0534eea3d5526ccd3f70a8b975af056fbfaa760705c45711a135
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fcrm-lightgray.png?logo=github
+    :target: https://github.com/OCA/crm/tree/17.0/crm_phonecall_planner
+    :alt: OCA/crm
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/crm-17-0/crm-17-0-crm_phonecall_planner
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/crm&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+Use this module to plan a phone calls schedule for your partners,
+assuming you have specified the ideal time to call them.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+To use this module, you need to specify your partners' preferred phone
+call schedule:
+
+1. Go to any partner's form > *Phone Calls*.
+2. Set the preferred phone calling schedule for the partner.
+3. Repeat above steps for all of your partners.
+
+Usage
+=====
+
+Now, to actually generate the phone call planning:
+
+1. Go to *CRM > Phone Calls > Planner*.
+2. Fill the fields under *Call details*. Those fields will be saved
+   literally in the generated phone calls.
+3. Fill the fields under *Criteria*. Those fields are used to filter the
+   partners and the preexisting calls. The UTM fields will also be saved
+   literally in the generated phone calls.
+4. Fill the fields under *Times*. See note below.
+5. Fill the fields under *Repetition*. See note below.
+6. Press *Generate planning*.
+7. Wait a little bit (this is usually a long process).
+8. You will get to the list of planned phone calls. Start calling!
+
+Note about *Times* section
+--------------------------
+
+The *Start* and *End* times behave in a special way:
+
+- Their *date* part is used to know the start and end dates for the
+  planning.
+- Their *time* part is used to know the time at which we will plan calls
+  *each day under the date range*.
+
+The *Call duration* field indicates the time spacing you want to leave
+between one call and the next one.
+
+So, for instance, if you select start on *2017-09-01 09:00:00*, end on
+*2017-09-03 10:00:00* and duration of *1:00*, it will try to generate
+these phone calls:
+
+- 2017-09-01 09:00:00
+- 2017-09-01 10:00:00
+- 2017-09-02 09:00:00
+- 2017-09-02 10:00:00
+- 2017-09-03 09:00:00
+- 2017-09-03 10:00:00
+
+Note about *Repetition* section
+-------------------------------
+
+If you choose not to repeat calls, the planner will try to schedule one
+single phone call for each **criteria combination** (*Partner + Campaign
++ Source + Medium*) under the specified conditions in the *Times*
+section (see note above).
+
+If you choose instead to repeat calls after some amount of days (*Days
+gap*), the planner will:
+
+1. Try to find a partner that matches the **criteria combination** and
+   has never been called; then schedule a call for him.
+2. If all matching partners have already been called, then search for
+   matching partners that have not been called in the specified *Days
+   gap*; then schedule a call for the one with least total scheduled
+   calls.
+3. If there is still no match, then schedule nothing and continue.
+
+Known issues / Roadmap
+======================
+
+- Incompatible with ``crm_phonecall_summary_predefined`` addon.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/crm/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/crm/issues/new?body=module:%20crm_phonecall_planner%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Tecnativa
+
+Contributors
+------------
+
+- `Tecnativa <https://www.tecnativa.com>`__:
+
+  - Jairo Llopis <jairo.llopis@tecnativa.com>
+  - David Vidal <david.vidal@tecnativa.com>
+  - Alexandre Díaz <alexandre.diaz@tecnativa.com>
+  - Juan Carlos Oñate
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/crm <https://github.com/OCA/crm/tree/17.0/crm_phonecall_planner>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

crm_phonecall_planner/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import wizards

crm_phonecall_planner/__manifest__.py

@@ -0,0 +1,15 @@
+# Copyright 2017 Jairo Llopis <jairo.llopis@tecnativa.com>
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+{
+    "name": "Phonecall planner",
+    "summary": "Schedule phone calls according to some criteria",
+    "version": "17.0.1.0.0",
+    "category": "Customer Relationship Management",
+    "website": "https://github.com/OCA/crm",
+    "author": "Tecnativa, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "application": False,
+    "installable": True,
+    "depends": ["crm_phonecall", "partner_phonecall_schedule"],
+    "data": ["security/ir.model.access.csv", "wizards/crm_phonecall_planner_view.xml"],
+}