server-tools/base_sequence_default/README.rst

============================
Default Fields with Sequence
============================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:30552d740f43d32a3643985156656c3d9917f363a22c3e46b3dc906cc2144d00
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
    :target: https://odoo-community.org/page/development-status
    :alt: Alpha
.. |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%2Fserver--tools-lightgray.png?logo=github
    :target: https://github.com/OCA/server-tools/tree/16.0/base_sequence_default
    :alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-tools-16-0/server-tools-16-0-base_sequence_default
    :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/server-tools&target_branch=16.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the use of sequences. It will allow you to use them
in any text field.

If configured correctly, new records will have a default incremental
value in the field of your choice.

.. IMPORTANT::
   This is an alpha version, the data model and design can change at any time without warning.
   Only for development or testing purpose, do not use in production.
   `More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
   :local:

Configuration
=============

To configure this module, you need to:

1. Enable developer mode.

2. Go to the form view of the model to which you want to add the new
   sequential default value.

3. Hover over the field to which you want to add the sequential default
   value. A tooltip with more info will appear.

4. Make sure the tooltip says *Type: char*. Only those fields will work.

5. Take note of the *Object* and *Field*.

6. Go to *Settings > Technical > Sequences & Identifiers > Sequences*.

7. Create one sequence with code named after this pattern:
   ``base_sequence_default.{object}.fields.{field}``. E.g.:
   ``base_sequence_default.res.partner.fields.name`` to add a default
   sequenced name for new partners. Do not use ``{}`` when adding the
   model and field name to the pattern.

   |Setting the sequence code properly|

8. Configure the sequence at will.

   |Configuring a sequence to have date range sub-sequences|

.. |Setting the sequence code properly| image:: https://github.com/OCA/server-tools/assets/147538094/ebf4be69-85d4-4c28-a3ec-bbe930fd53cf
.. |Configuring a sequence to have date range sub-sequences| image:: https://github.com/OCA/server-tools/assets/147538094/e3eb311b-738f-4fce-9af5-a1b592908704

Usage
=====

To use this module, it is necessary to:

1. Follow the configuration instructions.

2. Create a record of the model you configured.

3. Leave empty the fields where you configured a sequence. If they are
   required fields, set value to "-" to trigger the automatic sequence
   on creation.

4. Check that the field defined in the sequence is set to the next value
   in the sequence.

   |The partner reference was auto-incremented as configured|

.. |The partner reference was auto-incremented as configured| image:: https://github.com/OCA/server-tools/assets/147538094/82698762-6ac2-4ac0-89ba-7c9b32ea5909

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20base_sequence_default%0Aversion:%2016.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
-------

* Moduon

Contributors
------------

-  Rafael Blasco (`Moduon <https://www.moduon.team/>`__)
-  Eduardo de Miguel (`Moduon <https://www.moduon.team/>`__)
-  Jairo Llopis (`Moduon <https://www.moduon.team/>`__)

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.

.. |maintainer-Shide| image:: https://github.com/Shide.png?size=40px
    :target: https://github.com/Shide
    :alt: Shide
.. |maintainer-yajo| image:: https://github.com/yajo.png?size=40px
    :target: https://github.com/yajo
    :alt: yajo
.. |maintainer-rafaelbn| image:: https://github.com/rafaelbn.png?size=40px
    :target: https://github.com/rafaelbn
    :alt: rafaelbn

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-Shide| |maintainer-yajo| |maintainer-rafaelbn| 

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/16.0/base_sequence_default>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.