# Date Range

This module lets you define global date ranges that can be used to filter your values in tree views.

It also provides a mixin model for developers that extends the model’s search view so that date ranges can be search as any relational field.

Table of contents

- Installation
- Configuration
- Usage
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

# Installation

The addon use the daterange method from postgres. This method is supported as of postgresql 9.2

# Configuration

For regular usage, see Usage below. This section is to clarify optional functionality to developers.

To configure a model to use the Many2one style search field, make the model inherit from `date.range.search.mixin`:

    class AccountMove(models.Model):
        _name = "account.move"
        _inherit = ["account.move", "date.range.search.mixin"]

This will make a Period field show up in the search view:

By default, the mixin works on the date field. If you want the mixin to work on a field with a different name, you can set a property on your model:

    _date_range_search_field = "invoice_date"

# Usage

To configure this module, you need to:

- Go to Settings > Technical > Date ranges > Date Range Types where you can create types of date ranges.

- Go to Settings > Technical > Date ranges > Date Ranges where you can create date ranges.

  It’s also possible to launch a wizard from the ‘Generate Date Ranges’ menu.

  The wizard is useful to generate recurring periods. Set an end date or enter the number of ranges to create.

- Your date ranges are now available in the search filter for any date or datetime fields

  Date range types are proposed as a filter operator

  Once a type is selected, date ranges of this type are porposed as a filter value

  And the dates specified into the date range are used to filter your result.

- You can configure date range types with default values for the generation wizard on the Generation tab. In the same tab you can also configure date range types for auto-generation. New ranges for types configured for this are generated by a scheduled task that runs daily.

# Bug Tracker

Bugs are tracked on GitHub 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.

Do not contact contributors directly about support or help with technical issues.

# Credits

## Authors

- ACSONE SA/NV

## Contributors

- Laurent Mignon <laurent.mignon@acsone.eu>
- Alexis de Lattre <alexis.delattre@akretion.com>
- Miquel Raïch <miquel.raich@forgeflow.com>
- Andrea Stirpe <a.stirpe@onestein.nl>
- Stefan Rijnhart <stefan@opener.amsterdam>
- David Ramia <<@ramiadavid>>
- Son Ho <sonhd@trobz.com>

## Maintainers

This module is maintained by the OCA.

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.

Current maintainer:

This module is part of the OCA/server-ux project on GitHub.

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