partner-contact/partner_tier_validation/README.rst

109 lines
3.9 KiB
ReStructuredText
Raw Normal View History

2021-03-23 19:13:18 +00:00
=======================
Partner Tier Validation
=======================
2021-04-28 15:43:20 +00:00
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
.. |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%2Fpartner--contact-lightgray.png?logo=github
:target: https://github.com/OCA/partner-contact/tree/14.0/partner_tier_validation
:alt: OCA/partner-contact
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/partner-contact-14-0/partner-contact-14-0-partner_tier_validation
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/134/14.0
:alt: Try me on Runbot
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
|badge1| |badge2| |badge3| |badge4| |badge5|
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
Adds an approval workflow to Partners.
The default rule requires new parent Contacts to be approved
before they can be used.
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
For this, the new Contact record is kept as "Archived" until it is approved.
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
**Table of contents**
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
.. contents::
:local:
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
Installation
============
This module depends on ``base_tier_validation``. You can find it at
`OCA/server-ux <https://github.com/OCA/server-ux>`_
2021-03-23 19:13:18 +00:00
Usage
=====
2021-04-28 15:43:20 +00:00
A regular user creates a new Contact and sends it for approval:
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
#. Create a Contact triggering at least one "Tier Definition".
The Contact will be in Draft state and marked as Archived until approved.
2021-03-23 19:13:18 +00:00
#. Click on *Request Validation* button.
2021-04-28 15:43:20 +00:00
#. In the *Reviews* section, at the bottom of the form, inspect the pending reviews and their status.
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
The approver reviews Contacts to approve:
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
#. Navigate to the Contacts app, and select the filter "Needs my Approval"
#. Open the Contact form to approve. It will display a
"This Records needs to be validated" banner, with "Validate" and "Reject" options.
#. The approver can change the state to "Active".
This will automatically unarchive the record and make it available to be used.
The Approve/Reject actions do not automatically change the State.
This could be a future improvement.
2021-03-23 19:13:18 +00:00
Bug Tracker
===========
2021-04-28 15:43:20 +00:00
Bugs are tracked on `GitHub Issues <https://github.com/OCA/partner-contact/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/partner-contact/issues/new?body=module:%20partner_tier_validation%0Aversion:%2014.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.
2021-03-23 19:13:18 +00:00
Credits
=======
2021-04-28 15:43:20 +00:00
Authors
~~~~~~~
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
* Open Source Integrators
2021-03-23 19:13:18 +00:00
Contributors
2021-04-28 15:43:20 +00:00
~~~~~~~~~~~~
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
* `Open Source Integrators <https://opensourceintegrators.com>`_.
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
* Antonio Yamuta <ayamuta@opensourceintegrators.com>
* Daniel Reis <dreis@opensourceintegrators.com>
2021-03-23 19:13:18 +00:00
2021-04-28 15:43:20 +00:00
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
2021-03-23 19:13:18 +00:00
.. 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.
2021-04-28 15:43:20 +00:00
This module is part of the `OCA/partner-contact <https://github.com/OCA/partner-contact/tree/14.0/partner_tier_validation>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.