diff --git a/content/applications/essentials/property_fields.rst b/content/applications/essentials/property_fields.rst index a90d9072ed..4473b99fcc 100644 --- a/content/applications/essentials/property_fields.rst +++ b/content/applications/essentials/property_fields.rst @@ -8,12 +8,12 @@ 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 `. + 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 `. - .. example:: - Adding a property to a *task* inserts a field in *all tasks* within the *same - project* while other projects' tasks remain unaffected. + .. 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: @@ -27,87 +27,96 @@ In the popover, enter the property's :guilabel:`Label`, choose a :guilabel:`Fiel configure the field based on the selected type: .. list-table:: - :header-rows: 1 - :widths: 15 30 55 - - * - Field type - - Use - - Options - * - :ref:`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 ` - - HTML field - - Enter a :guilabel:`Default Value` if desired. - * - :ref:`Checkbox ` - - Checked or unchecked status - - Choose the :guilabel:`Default State`. - * - :ref:`Integer ` - - Integer numbers (:dfn:`positive, negative, or zero, without a decimal`) - - Enter a :guilabel:`Default Value` if desired. - * - :ref:`Decimal ` - - Decimal numbers (:dfn:`positive, negative, or zero, with a decimal`) - - Enter a :guilabel:`Default Value` if desired. - * - :ref:`Date ` - - Selection of a date on a calendar - - Select a :guilabel:`Default Value` if desired. - * - :ref:`Date & Time ` - - Selection of a date on a calendar and a time on a clock - - Select a :guilabel:`Default Value` if desired. - * - :ref:`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 ` - - 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 ` - - Selection of a single record from another model - - Enter the :guilabel:`Model` name. Configure its :ref:`Domain ` to - filter records if needed. - - Select a :guilabel:`Default Value` if desired. - * - :ref:`Many2many ` - - Selection of multiple records from another model - - Enter the :guilabel:`Model` name. Configure its :ref:`Domain ` 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. + :header-rows: 1 + :widths: 20 30 50 + + * - Field type + - Use + - Options + * - :ref:`Text ` + - Short text on a single line + - Enter a :guilabel:`Default Value` if desired. + * - :ref:`Multiline Text ` + - Full text on multiple lines + - Enter a :guilabel:`Default Value` if desired. + * - :ref:`HTML ` + - HTML field + - Enter a :guilabel:`Default Value` if desired. + * - :ref:`Checkbox ` + - Checked or unchecked status + - Choose the :guilabel:`Default State`. + * - :ref:`Integer ` + - Integer numbers (:dfn:`positive, negative, or zero, without a decimal`) + - Enter a :guilabel:`Default Value` if desired. + * - :ref:`Decimal ` + - Decimal numbers (:dfn:`positive, negative, or zero, with a decimal`) + - Enter a :guilabel:`Default Value` if desired. + * - :ref:`Monetary ` + - Selection of a (cost) currency + - Enter a :guilabel:`Default Value` if desired. + * - :ref:`Date ` + - Selection of a date on a calendar + - Select a :guilabel:`Default Value` if desired. + * - :ref:`Date & Time ` + - Selection of a date on a calendar and a time on a clock + - Select a :guilabel:`Default Value` if desired. + * - :ref:`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 ` + - 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 ` + - Selection of a single record from another model + - Enter the :guilabel:`Model` name. Configure its :ref:`Domain ` to + filter records if needed. + + Select a :guilabel:`Default Value` if desired. + * - :ref:`Many2many ` + - Selection of multiple records from another model + - Enter the :guilabel:`Model` name. Configure its :ref:`Domain ` to + filter records if needed. + + Select a :guilabel:`Default Value` if desired. + * - :guilabel:`Separator` + - Group several properties under a foldable label + - .. 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. + - Enter a :guilabel:`Suffix` to specify the contextual description that is automatically + appended to the displayed value of the field type. For example, to indicate cost per + kilometer, select the :guilabel:`Monetary` field type an name it **Cost**, then enter **per + km** in the :guilabel:`Suffix` field. The property displays the following: **Cost** [added + value] **per km**. + - Enable :guilabel:`Display in Cards` to select whether to display the property in the Kanban, + List, or Calendar views cards for every field. + - Enable :guilabel:`AI` to add :ref:`AI fields ` to the property. + Write a :guilabel:`Prompt` and/or type `/field` to insert dynamic values. - 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: + - 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. + - 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 permanently remove it. + - Use the :icon:`oi-draggable` (:guilabel:`drag handle`) icon to drag and drop the property to + reorder or regroup. + + - Click outside the popover to save the added property. .. _property-fields/properties-apps: @@ -117,93 +126,100 @@ Properties across apps Property fields can be defined in the :ref:`form view ` 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 ` - - :doc:`Loan ` - - :ref:`Asset model ` - - :ref:`Journal ` - * - :guilabel:`Appraisals` - - :ref:`Employee Appraisal ` - - :ref:`Department ` - * - :guilabel:`Approvals` - - Approval Request - - Category - * - :guilabel:`CRM` - - :doc:`Lead/Opportunity ` - - :ref:`Sales team ` - * - :guilabel:`Employees` - - :ref:`Employee ` - - :ref:`Company ` - * - :guilabel:`Events` - - :doc:`Event Registration ` - - :ref:`Event ` - * - :guilabel:`Fleet` - - :doc:`Vehicle ` - - :ref:`Vehicle model ` - * - :guilabel:`Frontdesk` - - :ref:`Frontdesk Visitors ` - - :ref:`Station ` - * - :guilabel:`Helpdesk` - - :ref:`Ticket ` - - :ref:`Helpdesk team ` - * - :guilabel:`Inventory` - - :ref:`Lot/Serial ` - - :doc:`Transfer - ` - - :ref:`Batch Transfer ` - - :ref:`Product variant ` - - :ref:`Operation type ` - - :ref:`Operation type ` - * - :guilabel:`Knowledge` - - :ref:`Knowledge Article ` - - :ref:`Parent article ` - * - :guilabel:`Maintenance` - - :ref:`Maintenance Equipment ` - - :ref:`Equipment category ` - * - :guilabel:`Meeting Rooms` - - Room - - Office - * - :guilabel:`Planning` - - :ref:`Shift ` - - :ref:`Role ` - * - :guilabel:`Project` / :guilabel:`Field Service` - - :ref:`Task ` - - :ref:`Project ` - * - :guilabel:`Recruitment` - - :ref:`Applicant ` - - :ref:`Job Position ` - - Candidate - - :ref:`Job position ` - - :ref:`Company ` - - :ref:`Company ` - * - :guilabel:`Repairs` - - :ref:`Repair order ` - - :ref:`Company ` - * - :guilabel:`Sales` / etc. - - Product - - Category + .. list-table:: + :widths: 20 40 40 + :header-rows: 1 + :stub-columns: 1 + + * - App + - Model + - Parent + * - :guilabel:`Accounting` + - :ref:`Asset/Revenue Recognition ` + + :doc:`Loan ` + - :ref:`Asset model ` + + :ref:`Journal ` + * - :guilabel:`Appraisals` + - :ref:`Employee Appraisal ` + - :ref:`Department ` + * - :guilabel:`Approvals` + - Approval Request + - Category + * - :guilabel:`CRM` + - :doc:`Lead/Opportunity ` + - :ref:`Sales team ` + * - :guilabel:`Employees` + - :ref:`Employee ` + - :ref:`Company ` + * - :guilabel:`Events` + - :doc:`Event Registration ` + - :ref:`Event ` + * - :guilabel:`Fleet` + - :doc:`Vehicle ` + - :ref:`Vehicle model ` + * - :guilabel:`Frontdesk` + - :ref:`Frontdesk Visitors ` + - :ref:`Station ` + * - :guilabel:`Helpdesk` + - :ref:`Ticket ` + - :ref:`Helpdesk team ` + * - :guilabel:`Inventory` + - :ref:`Lot/Serial ` + + :doc:`Transfer + ` + + :ref:`Batch Transfer ` + - :ref:`Product variant ` + + :ref:`Operation type ` + + :ref:`Operation type ` + * - :guilabel:`Knowledge` + - :ref:`Knowledge Article ` + - :ref:`Parent article ` + * - :guilabel:`Maintenance` + - :ref:`Maintenance Equipment ` + - :ref:`Equipment category ` + * - :guilabel:`Meeting Rooms` + - Room + - Office + * - :guilabel:`Payroll` + - :ref:`Employee/Contract ` + + :ref:`Payslip ` + - :ref:`Company ` + + :ref:`Structure ` + * - :guilabel:`Planning` + - :ref:`Shift ` + - :ref:`Role ` + * - :guilabel:`Project` / :guilabel:`Field Service` + - :ref:`Task ` + - :ref:`Project ` + * - :guilabel:`Recruitment` + - :ref:`Applicant ` + + :ref:`Job Position ` + + Candidate + - :ref:`Job position ` + + :ref:`Company ` + + :ref:`Company ` + * - :guilabel:`Repairs` + - :ref:`Repair order ` + - :ref:`Company ` + * - :guilabel:`Sales` / etc. + - Product + - Category .. note:: - The following models do not depend on any *parent* and apply to all records: + The following models do not depend on any *parent* and apply to all records: - - :doc:`Contact Form <../../../applications/essentials/contacts>` in the :guilabel:`Contacts` app - - :ref:`Mailing List Contacts ` in the :guilabel:`Email - Marketing` app + - :doc:`Contact Form <../../../applications/essentials/contacts>` in the :guilabel:`Contacts` app + - :ref:`Mailing List Contacts ` in the :guilabel:`Email + Marketing` app diff --git a/content/applications/productivity/ai/fields.rst b/content/applications/productivity/ai/fields.rst index 107f4e1191..55e9a47f99 100644 --- a/content/applications/productivity/ai/fields.rst +++ b/content/applications/productivity/ai/fields.rst @@ -73,6 +73,8 @@ After the field is added, click the |AI| icon to refresh the field value. .. image:: fields/warning.png :alt: A warning message indicating the AI was unable to complete the request. +.. _ai/add-a-new-field/properties: + Add via edit properties -----------------------