Skip to content

[IMP] knowledge/properties: update Properties #13973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/applications/essentials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Odoo essentials
essentials/export_import_data
essentials/in_app_purchase
essentials/keyboard_shortcuts
essentials/property_fields
4 changes: 2 additions & 2 deletions content/applications/essentials/html_editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Odoo rich-text editor
=====================

The Odoo rich-text editor allows creating and editing rich-text content in HTML fields, such as the
:guilabel:`Internal Notes` and :guilabel:`Description` fields, as well as in :doc:`Knowledge
articles </applications/productivity/knowledge/articles_editing>` and the :ref:`Studio report
:guilabel:`Internal Notes` and :guilabel:`Description` fields, as well as in the :ref:`Knowledge
articles <knowledge/articles_editing/edit-article>` and the :ref:`Studio report
editor <studio/pdf-reports/report-editor>`, among others. Start typing or use the
:ref:`toolbar <essentials/html_editor/toolbar>` or :ref:`powerbox
<essentials/html_editor/commands>` for formatting and structuring text.
Expand Down
202 changes: 202 additions & 0 deletions content/applications/essentials/property_fields.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
===============
Property fields
===============

Property fields, or properties, enable the customization of a :ref:`form
<studio/views/general/form>` view by adding various :ref:`field types <property_field/add>`. These
fields allow information storage and management by adding values.

.. admonition:: Property vs. regular fields

Properties act as pseudo-fields; they behave like regular fields but are not saved as columns in
the database. They also rely on a defined :ref:`parent record <property-fields/properties-apps>`.

.. example::
Adding a property to a *task* inserts a field in *all tasks* within the *same
project* while other projects' tasks remain unaffected.

.. _property_field/add:

Add property fields
-------------------

To add a first property field to a :ref:`form view <studio/views/general/form>`, click the
:icon:`fa-cog` (:guilabel:`Actions`) icon, then select :icon:`fa-cogs` :guilabel:`Edit Properties`.

In the popover, enter the property's :guilabel:`Label`, choose a :guilabel:`Field Type`, and then
configure the field based on the selected type:

.. list-table::
:header-rows: 1
:widths: 15 30 55

* - Field type
- Use
- Options
* - :ref:`Text <studio/fields/simple-fields-text>`
- Short text on a single line
- Enter a :guilabel:`Default Value` if desired.
* - :guilabel:`Multiline Text`
- Full text on multiple lines
- Enter a :guilabel:`Default Value` if desired.
* - :ref:`HTML <text-editor>`
- HTML field
- Enter a :guilabel:`Default Value` if desired.
* - :ref:`Checkbox <studio/fields/simple-fields-checkbox>`
- Checked or unchecked status
- Choose the :guilabel:`Default State`.
* - :ref:`Integer <studio/fields/simple-fields-integer>`
- Integer numbers (:dfn:`positive, negative, or zero, without a decimal`)
- Enter a :guilabel:`Default Value` if desired.
* - :ref:`Decimal <studio/fields/simple-fields-decimal>`
- Decimal numbers (:dfn:`positive, negative, or zero, with a decimal`)
- Enter a :guilabel:`Default Value` if desired.
* - :ref:`Date <studio/fields/simple-fields-date>`
- Selection of a date on a calendar
- Select a :guilabel:`Default Value` if desired.
* - :ref:`Date & Time <studio/fields/simple-fields-date-time>`
- Selection of a date on a calendar and a time on a clock
- Select a :guilabel:`Default Value` if desired.
* - :ref:`Selection <studio/fields/simple-fields-selection>`
- Selection of a value from a group of predefined values
- Add a selectable option by clicking :icon:`fa-plus` :guilabel:`Add a Value` and entering the
:guilabel:`Option Name`.

If desired, set an option as default by clicking the :icon:`fa-star-o`
(:guilabel:`Select Default`) button.

Reorder the options by dragging and dropping them using the :icon:`oi-draggable`
(:guilabel:`drag handle`) button.

Delete an option by clicking the :icon:`fa-trash-o` (:guilabel:`Remove Property`) button.
* - :ref:`Tags <studio/fields/relational-fields-tags>`
- Selection of multiple values in the form of tags
- Enter a :guilabel:`Tag` name and press `Enter` to save it.

Change a tag's color by clicking it and selecting another one.
* - :ref:`Many2one <studio/fields/relational-fields-many2one>`
- Selection of a single record from another model
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
filter records if needed.

Select a :guilabel:`Default Value` if desired.
* - :ref:`Many2many <studio/fields/relational-fields-many2many>`
- Selection of multiple records from another model
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
filter records if needed.

Select a :guilabel:`Default Value` if desired.
* - :guilabel:`Separator`
- Group several properties under a foldable label
-

Click outside the popover to save the added property.

.. note::
- Select whether to display the property in the Kanban, List, or Calendar views cards for every
field with the :guilabel:`Display in Cards` option.
- To add another property, click :icon:`fa-plus` :guilabel:`Add a Property` at the bottom of the
form while.

.. tip::
To edit an existing property, hover the cursor over the property:

- Click the :icon:`fa-pencil` (:guilabel:`pencil`) button to open a popover and modify the
property. In the popover, click the :icon:`fa-chevron-up` (up) or :icon:`fa-chevron-down`
(down) chevron to move a property upwards or downwards.
- Click :icon:`fa-trash` :guilabel:`Delete`, then :guilabel:`Delete` to delete it. Deleting
a property is permanent.
- Use the :icon:`oi-draggable` (:guilabel:`drag handle`) icon to drag and drop the property to
reorder or regroup.

.. _property-fields/properties-apps:

Properties across apps
----------------------

Property fields can be defined in the :ref:`form view <studio/views/general/form>` of multiple
models. Once set, the property is shared by all records that are linked to the same *parent*.

.. list-table::
:widths: 20 40 40
:header-rows: 1
:stub-columns: 1

* - App
- Model
- Parent
* - :guilabel:`Accounting`
- :ref:`Asset/Revenue Recognition <create-assets-entry>`

:doc:`Loan </applications/finance/accounting/bank/loans>`
- :ref:`Asset model <assets/asset-model>`

:ref:`Journal <cheat_sheet/journals>`
* - :guilabel:`Appraisals`
- :ref:`Employee Appraisal <appraisals/manual>`
- :ref:`Department <employee/create-departments>`
* - :guilabel:`Approvals`
- Approval Request
- Category
* - :guilabel:`CRM`
- :doc:`Lead/Opportunity </applications/sales/crm/acquire_leads/email_manual>`
- :ref:`Sales team <crm/sales-team-dashboard>`
* - :guilabel:`Employees`
- :ref:`Employee <employees/general-info>`
- :ref:`Company <employees/general-info>`
* - :guilabel:`Events`
- :doc:`Event Registration </applications/marketing/events/registration_desk>`
- :ref:`Event <events/new-event>`
* - :guilabel:`Fleet`
- :doc:`Vehicle </applications/hr/fleet/new_vehicle>`
- :ref:`Vehicle model <fleet/add-model>`
* - :guilabel:`Frontdesk`
- :ref:`Frontdesk Visitors <frontdesk/list>`
- :ref:`Station <frontdesk/stations>`
* - :guilabel:`Helpdesk`
- :ref:`Ticket <helpdesk/follow>`
- :ref:`Helpdesk team <helpdesk/create-team>`
* - :guilabel:`Inventory`
- :ref:`Lot/Serial <inventory/product_management/edit-lot>`

:doc:`Transfer
</applications/inventory_and_mrp/inventory/shipping_receiving/picking_methods/wave>`

:ref:`Batch Transfer <inventory/misc/batch_picking>`
- :ref:`Product variant <product-variants/add-product-variants>`

:ref:`Operation type <inventory/product_management/operation-type-setting>`

:ref:`Operation type <inventory/product_management/operation-type-setting>`
* - :guilabel:`Knowledge`
- :ref:`Knowledge Article <knowledge/articles_editing/create-article>`
- :ref:`Parent article <knowledge/articles_editing/create-article>`
* - :guilabel:`Maintenance`
- :ref:`Maintenance Equipment <maintenance/equipment_management/add_new_equipment>`
- :ref:`Equipment category <maintenance/equipment_management/add_new_equipment>`
* - :guilabel:`Meeting Rooms`
- Room
- Office
* - :guilabel:`Planning`
- :ref:`Shift <planning/roles>`
- :ref:`Role <planning/roles>`
* - :guilabel:`Project` / :guilabel:`Field Service`
- :ref:`Task <task_creation/task-configuration>`
- :ref:`Project <project_management/configuration>`
* - :guilabel:`Recruitment`
- :ref:`Applicant <recruitment/quick-add-applicant>`

:ref:`Job Position <recruitment/new_job_position/edit>`

Candidate
- :ref:`Job position <job-position/create-job-position>`

:ref:`Company <companies/manage>`

:ref:`Company <companies/manage>`
* - :guilabel:`Repairs`
- :ref:`Repair order <repairs/repair_orders/repair>`
- :ref:`Company <companies/manage>`
* - :guilabel:`Sales` / etc.
- Product
- Category
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ time of the sale and the amount it is sold for.
To record the sale of an asset, you must first post the related Customer Invoice so you can link
the sale of the asset with it.

.. _assets/asset-model:

Assets Models
=============

Expand Down
2 changes: 2 additions & 0 deletions content/applications/hr/employees/departments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Departments

All employees in the **Employees** app fall under specific departments within a company.

.. _employee/create-departments:

Create new departments
======================

Expand Down
2 changes: 2 additions & 0 deletions content/applications/hr/frontdesk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Configuration
The first item to configure with the **Frontdesk** application is the station, followed by any drink
selections that might optionally be offered.

.. _frontdesk/stations:

Stations
--------

Expand Down
2 changes: 2 additions & 0 deletions content/applications/hr/recruitment/new_job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ View submitted applications by clicking anywhere on a job position card.
.. image:: new_job/jobs.png
:alt: Main dashboard view of Recruitment app showing all job positions.

.. _job-position/create-job-position:

Create a new job position
=========================

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ on a lot number form:
:icon:`fa-cogs` :guilabel:`Add Properties` from the drop-down menu.
#. Click the :icon:`fa-plus` :guilabel:`Add a Property` button, located below the existing fields.

Name and :doc:`configure the new field <../../../../productivity/knowledge/properties>`. Once
Name and :doc:`configure the new field </applications/essentials/property_fields>`. Once
finished, enter the property value in the new field.

.. example::
Expand All @@ -270,7 +270,7 @@ finished, enter the property value in the new field.
:alt: Show the "Add Properties" button on a lot number form.

.. seealso::
:doc:`Configuring custom properties <../../../../productivity/knowledge/properties>`
:doc:`Configuring custom properties </applications/essentials/property_fields>`

.. _inventory/product_management/create-new-lot:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ drop-down menu. Then, select the desired options next to the :guilabel:`Display
Once all desired :guilabel:`Values` have been added, click :guilabel:`Save` to save the new
attribute.

.. _product-variants/add-product-variants:

Add product variants on the product form
========================================

Expand Down
2 changes: 2 additions & 0 deletions content/applications/marketing/events/create_events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Events can be manually created from scratch or built off of pre-made templates.
registration of the event for attendees, the *Sales* app for the purchasing ability of paid tickets,
as well the *CRM* application through customizable lead generation rules.

.. _events/new-event:

New event
=========

Expand Down
Loading