.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association
====================
Improved Name Search
====================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:506ec7a25a0bb1d86a79c06d4577aca5a3cda5d81ed921490e95a53a5e49df24
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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/license-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/18.0/base_name_search_improved
: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-18-0/server-tools-18-0-base_name_search_improved
: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=18.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
Extends the name search feature to use additional, more relaxed matching
methods, and to allow searching into configurable additional record
fields.
The name search is the lookup feature to select a related record. For
example, selecting a Customer on a new Sales order.
For example, typing "john brown" doesn't match "John M. Brown". The
relaxed search also looks up for records containing all the words, so
"John M. Brown" would be a match. It also tolerates words in a different
order, so searching for "brown john" also works.
|image0|
Additionally, an Administrator can configure other fields to also lookup
into. For example, Customers could be additionally searched by City or
Phone number.
|image2|
How it works:
Regular name search is performed, and the additional search logic is
only triggered if not enough results are found. This way, no overhead is
added on searches that would normally yield results.
But if not enough results are found, then additional search methods are
tried. The specific methods used are:
- Try regular search on each of the additional fields
- Try ordered word search on each of the search fields
- Try unordered word search on each of the search fields
All results found are presented in that order, hopefully presenting them
in order of relevance.
.. |image0| image:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image0.png
.. |image2| image:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image2.png
**Table of contents**
.. contents::
:local:
Configuration
=============
The fuzzy search is automatically enabled on all Models. Note that this
only affects typing in related fields. The regular ``search()``, used in
the top right search box, is not affected.
Additional search fields can be configured at Settings > Technical >
Database > Models, using the "Name Search Fields" field.
|image1|
.. |image1| image:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png
Usage
=====
Just type into any related field, such as Customer on a Sale Order.
Known issues / Roadmap
======================
- Also use fuzzy search, such as the Levenshtein distance:
https://www.postgresql.org/docs/9.5/static/fuzzystrmatch.html
- The list of additional fields to search could benefit from caching,
for efficiency.
- This feature could also be implemented for regular ``search`` on the
``name`` field.
- While adding m2o or other related field that also have an improved
name search, that improved name search is not used (while if
name_search is customizend on a module and you add a field of that
model on another model it works ok). Esto por ejemplo es en productos
si agregamos campo "categoría pública" y a categoría pública le
ponemos "parent_id". Entonces vamos a ver que si buscamos por una
categoría padre no busca nada, en vez si hacemos esa lógica en
name_search de modulo si funciona
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_name_search_improved%0Aversion:%2018.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
-------
* Daniel Reis
* ADHOC SA
Contributors
------------
- Daniel Reis <https://github.com/dreispt>
- Kitti U. <kittiu@ecosoft.co.th> (migrate to v14)
- Radovan Skolnik <radovan@skolnik.info>
Other credits
-------------
The development of this module has been financially supported by:
- Odoo Community Association
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/server-tools <https://github.com/OCA/server-tools/tree/18.0/base_name_search_improved>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/server-tools",
"name": "odoo-addon-base-name-search-improved",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Daniel Reis, Odoo Community Association (OCA), ADHOC SA",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": ".. image:: https://odoo-community.org/readme-banner-image\n :target: https://odoo-community.org/get-involved?utm_source=readme\n :alt: Odoo Community Association\n\n====================\nImproved Name Search\n====================\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:506ec7a25a0bb1d86a79c06d4577aca5a3cda5d81ed921490e95a53a5e49df24\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github\n :target: https://github.com/OCA/server-tools/tree/18.0/base_name_search_improved\n :alt: OCA/server-tools\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/server-tools-18-0/server-tools-18-0-base_name_search_improved\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=18.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nExtends the name search feature to use additional, more relaxed matching\nmethods, and to allow searching into configurable additional record\nfields.\n\nThe name search is the lookup feature to select a related record. For\nexample, selecting a Customer on a new Sales order.\n\nFor example, typing \"john brown\" doesn't match \"John M. Brown\". The\nrelaxed search also looks up for records containing all the words, so\n\"John M. Brown\" would be a match. It also tolerates words in a different\norder, so searching for \"brown john\" also works.\n\n|image0|\n\nAdditionally, an Administrator can configure other fields to also lookup\ninto. For example, Customers could be additionally searched by City or\nPhone number.\n\n|image2|\n\nHow it works:\n\nRegular name search is performed, and the additional search logic is\nonly triggered if not enough results are found. This way, no overhead is\nadded on searches that would normally yield results.\n\nBut if not enough results are found, then additional search methods are\ntried. The specific methods used are:\n\n- Try regular search on each of the additional fields\n- Try ordered word search on each of the search fields\n- Try unordered word search on each of the search fields\n\nAll results found are presented in that order, hopefully presenting them\nin order of relevance.\n\n.. |image0| image:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image0.png\n.. |image2| image:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image2.png\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nThe fuzzy search is automatically enabled on all Models. Note that this\nonly affects typing in related fields. The regular ``search()``, used in\nthe top right search box, is not affected.\n\nAdditional search fields can be configured at Settings > Technical >\nDatabase > Models, using the \"Name Search Fields\" field.\n\n|image1|\n\n.. |image1| image:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png\n\nUsage\n=====\n\nJust type into any related field, such as Customer on a Sale Order.\n\nKnown issues / Roadmap\n======================\n\n- Also use fuzzy search, such as the Levenshtein distance:\n https://www.postgresql.org/docs/9.5/static/fuzzystrmatch.html\n- The list of additional fields to search could benefit from caching,\n for efficiency.\n- This feature could also be implemented for regular ``search`` on the\n ``name`` field.\n- While adding m2o or other related field that also have an improved\n name search, that improved name search is not used (while if\n name_search is customizend on a module and you add a field of that\n model on another model it works ok). Esto por ejemplo es en productos\n si agregamos campo \"categor\u00eda p\u00fablica\" y a categor\u00eda p\u00fablica le\n ponemos \"parent_id\". Entonces vamos a ver que si buscamos por una\n categor\u00eda padre no busca nada, en vez si hacemos esa l\u00f3gica en\n name_search de modulo si funciona\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_name_search_improved%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Daniel Reis\n* ADHOC SA\n\nContributors\n------------\n\n- Daniel Reis <https://github.com/dreispt>\n- Kitti U. <kittiu@ecosoft.co.th> (migrate to v14)\n- Radovan Skolnik <radovan@skolnik.info>\n\nOther credits\n-------------\n\nThe development of this module has been financially supported by:\n\n- Odoo Community Association\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/18.0/base_name_search_improved>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Friendlier search when typing in relation fields",
"version": "18.0.1.1.0.11",
"project_urls": {
"Homepage": "https://github.com/OCA/server-tools"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7d04b2e473a3d6896acde701fded589a477d8d15834947c5b5ee132210e2c05",
"md5": "92fcf9398b11951494666c3e3ed300f3",
"sha256": "aa741e8e150bd9067720ff0f56922ea9ac2824201ee0569f6d776cc96dc4128c"
},
"downloads": -1,
"filename": "odoo_addon_base_name_search_improved-18.0.1.1.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92fcf9398b11951494666c3e3ed300f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 198733,
"upload_time": "2025-10-10T03:47:47",
"upload_time_iso_8601": "2025-10-10T03:47:47.808063Z",
"url": "https://files.pythonhosted.org/packages/b7/d0/4b2e473a3d6896acde701fded589a477d8d15834947c5b5ee132210e2c05/odoo_addon_base_name_search_improved-18.0.1.1.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-10 03:47:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "server-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "astor",
"specs": []
},
{
"name": "cryptography",
"specs": []
},
{
"name": "dataclasses",
"specs": []
},
{
"name": "odoo_test_helper",
"specs": []
},
{
"name": "odoorpc",
"specs": []
},
{
"name": "openupgradelib",
"specs": []
},
{
"name": "paramiko",
"specs": [
[
"<",
"4.0.0"
]
]
},
{
"name": "pysftp",
"specs": []
},
{
"name": "sentry_sdk",
"specs": [
[
"<=",
"2.22.0"
],
[
">=",
"2.0.0"
]
]
}
],
"lcname": "odoo-addon-base-name-search-improved"
}
JSON
