Skip to content

Commit a890a58

Browse files
committed
[IMP] essentials/properties: update Property fields doc 19
task-5173906 closes #15326 Signed-off-by: Xavier Platteau (xpl) <[email protected]>
1 parent 2e38bc9 commit a890a58

File tree

2 files changed

+184
-167
lines changed

2 files changed

+184
-167
lines changed

content/applications/essentials/property_fields.rst

Lines changed: 182 additions & 167 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ fields allow information storage and management by adding values.
88

99
.. admonition:: Property vs. regular fields
1010

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

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

1818
.. _property_field/add:
1919

@@ -27,87 +27,95 @@ In the popover, enter the property's :guilabel:`Label`, choose a :guilabel:`Fiel
2727
configure the field based on the selected type:
2828

2929
.. list-table::
30-
:header-rows: 1
31-
:widths: 15 30 55
32-
33-
* - Field type
34-
- Use
35-
- Options
36-
* - :ref:`Text <studio/fields/simple-fields-text>`
37-
- Short text on a single line
38-
- Enter a :guilabel:`Default Value` if desired.
39-
* - :guilabel:`Multiline Text`
40-
- Full text on multiple lines
41-
- Enter a :guilabel:`Default Value` if desired.
42-
* - :ref:`HTML <text-editor>`
43-
- HTML field
44-
- Enter a :guilabel:`Default Value` if desired.
45-
* - :ref:`Checkbox <studio/fields/simple-fields-checkbox>`
46-
- Checked or unchecked status
47-
- Choose the :guilabel:`Default State`.
48-
* - :ref:`Integer <studio/fields/simple-fields-integer>`
49-
- Integer numbers (:dfn:`positive, negative, or zero, without a decimal`)
50-
- Enter a :guilabel:`Default Value` if desired.
51-
* - :ref:`Decimal <studio/fields/simple-fields-decimal>`
52-
- Decimal numbers (:dfn:`positive, negative, or zero, with a decimal`)
53-
- Enter a :guilabel:`Default Value` if desired.
54-
* - :ref:`Date <studio/fields/simple-fields-date>`
55-
- Selection of a date on a calendar
56-
- Select a :guilabel:`Default Value` if desired.
57-
* - :ref:`Date & Time <studio/fields/simple-fields-date-time>`
58-
- Selection of a date on a calendar and a time on a clock
59-
- Select a :guilabel:`Default Value` if desired.
60-
* - :ref:`Selection <studio/fields/simple-fields-selection>`
61-
- Selection of a value from a group of predefined values
62-
- Add a selectable option by clicking :icon:`fa-plus` :guilabel:`Add a Value` and entering the
63-
:guilabel:`Option Name`.
64-
65-
If desired, set an option as default by clicking the :icon:`fa-star-o`
66-
(:guilabel:`Select Default`) button.
67-
68-
Reorder the options by dragging and dropping them using the :icon:`oi-draggable`
69-
(:guilabel:`drag handle`) button.
70-
71-
Delete an option by clicking the :icon:`fa-trash-o` (:guilabel:`Remove Property`) button.
72-
* - :ref:`Tags <studio/fields/relational-fields-tags>`
73-
- Selection of multiple values in the form of tags
74-
- Enter a :guilabel:`Tag` name and press `Enter` to save it.
75-
76-
Change a tag's color by clicking it and selecting another one.
77-
* - :ref:`Many2one <studio/fields/relational-fields-many2one>`
78-
- Selection of a single record from another model
79-
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
80-
filter records if needed.
81-
82-
Select a :guilabel:`Default Value` if desired.
83-
* - :ref:`Many2many <studio/fields/relational-fields-many2many>`
84-
- Selection of multiple records from another model
85-
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
86-
filter records if needed.
87-
88-
Select a :guilabel:`Default Value` if desired.
89-
* - :guilabel:`Separator`
90-
- Group several properties under a foldable label
91-
-
92-
93-
Click outside the popover to save the added property.
30+
:header-rows: 1
31+
:widths: 20 30 50
32+
33+
* - Field type
34+
- Use
35+
- Options
36+
* - :ref:`Text <studio/fields/simple-fields-text>`
37+
- Short text on a single line
38+
- Enter a :guilabel:`Default Value` if desired.
39+
* - :ref:`Multiline Text <studio/fields/simple-fields-multiline-text>`
40+
- Full text on multiple lines
41+
- Enter a :guilabel:`Default Value` if desired.
42+
* - :ref:`HTML <studio/fields/simple-fields-html>`
43+
- HTML field
44+
- Enter a :guilabel:`Default Value` if desired.
45+
* - :ref:`Checkbox <studio/fields/simple-fields-checkbox>`
46+
- Checked or unchecked status
47+
- Choose the :guilabel:`Default State`.
48+
* - :ref:`Integer <studio/fields/simple-fields-integer>`
49+
- Integer numbers (:dfn:`positive, negative, or zero, without a decimal`)
50+
- Enter a :guilabel:`Default Value` if desired.
51+
* - :ref:`Decimal <studio/fields/simple-fields-decimal>`
52+
- Decimal numbers (:dfn:`positive, negative, or zero, with a decimal`)
53+
- Enter a :guilabel:`Default Value` if desired.
54+
* - :ref:`Monetary <studio/fields/simple-fields-monetary>`
55+
- Selection of a (cost) currency
56+
- Enter a :guilabel:`Default Value` if desired.
57+
* - :ref:`Date <studio/fields/simple-fields-date>`
58+
- Selection of a date on a calendar
59+
- Select a :guilabel:`Default Value` if desired.
60+
* - :ref:`Date & Time <studio/fields/simple-fields-date-time>`
61+
- Selection of a date on a calendar and a time on a clock
62+
- Select a :guilabel:`Default Value` if desired.
63+
* - :ref:`Selection <studio/fields/simple-fields-selection>`
64+
- Selection of a value from a group of predefined values
65+
- Add a selectable option by clicking :icon:`fa-plus` :guilabel:`Add a Value` and entering the
66+
:guilabel:`Option Name`.
67+
68+
If desired, set an option as default by clicking the :icon:`fa-star-o`
69+
(:guilabel:`Select Default`) button.
70+
71+
Reorder the options by dragging and dropping them using the :icon:`oi-draggable`
72+
(:guilabel:`drag handle`) button.
73+
74+
Delete an option by clicking the :icon:`fa-trash-o` (:guilabel:`Remove Property`) button.
75+
* - :ref:`Tags <studio/fields/relational-fields-tags>`
76+
- Selection of multiple values in the form of tags
77+
- Enter a :guilabel:`Tag` name and press `Enter` to save it.
78+
79+
Change a tag's color by clicking it and selecting another one.
80+
* - :ref:`Many2one <studio/fields/relational-fields-many2one>`
81+
- Selection of a single record from another model
82+
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
83+
filter records if needed.
84+
85+
Select a :guilabel:`Default Value` if desired.
86+
* - :ref:`Many2many <studio/fields/relational-fields-many2many>`
87+
- Selection of multiple records from another model
88+
- Enter the :guilabel:`Model` name. Configure its :ref:`Domain <search/custom-filters>` to
89+
filter records if needed.
90+
91+
Select a :guilabel:`Default Value` if desired.
92+
* - :guilabel:`Separator`
93+
- Group several properties under a foldable label
94+
-
9495

9596
.. note::
96-
- Select whether to display the property in the Kanban, List, or Calendar views cards for every
97-
field with the :guilabel:`Display in Cards` option.
97+
- Enter a :guilabel:`Suffix` to add a contextual description after a field's value. For example,
98+
to indicate the cost per kilometer, use the :guilabel:`Monetary` field and name it **Cost**,
99+
then enter **per km** as the :guilabel:`Suffix` field. The property then displays the
100+
following: **Cost** [added value] **per km**.
101+
- Enable :guilabel:`Display in Cards` to select whether to display the property in the Kanban,
102+
List, or Calendar views' cards for every field.
103+
- Enable :guilabel:`AI` to add :ref:`AI fields <ai/add-a-new-field/properties>` to the property.
104+
Write a :guilabel:`Prompt` and/or type `/field` to insert dynamic values.
98105
- To add another property, click :icon:`fa-plus` :guilabel:`Add a Property` at the bottom of the
99-
form while.
106+
form.
100107

101108
.. tip::
102-
To edit an existing property, hover the cursor over the property:
109+
- To edit an existing property, hover the cursor over the property:
103110

104-
- Click the :icon:`fa-pencil` (:guilabel:`pencil`) button to open a popover and modify the
105-
property. In the popover, click the :icon:`fa-chevron-up` (up) or :icon:`fa-chevron-down`
106-
(down) chevron to move a property upwards or downwards.
107-
- Click :icon:`fa-trash` :guilabel:`Delete`, then :guilabel:`Delete` to delete it. Deleting
108-
a property is permanent.
109-
- Use the :icon:`oi-draggable` (:guilabel:`drag handle`) icon to drag and drop the property to
110-
reorder or regroup.
111+
- Click the :icon:`fa-pencil` (:guilabel:`pencil`) button to open a popover and modify the
112+
property. In the popover, click the :icon:`fa-chevron-up` (up) or :icon:`fa-chevron-down`
113+
(down) chevron to move a property upwards or downwards.
114+
- Click :icon:`fa-trash` :guilabel:`Delete`, then :guilabel:`Delete` to permanently remove it.
115+
- Use the :icon:`oi-draggable` (:guilabel:`drag handle`) icon to drag and drop the property to
116+
reorder or regroup.
117+
118+
- Click outside the popover to save the added property.
111119

112120
.. _property-fields/properties-apps:
113121

@@ -117,93 +125,100 @@ Properties across apps
117125
Property fields can be defined in the :ref:`form view <studio/views/general/form>` of multiple
118126
models. Once set, the property is shared by all records that are linked to the same *parent*.
119127

120-
.. list-table::
121-
:widths: 20 40 40
122-
:header-rows: 1
123-
:stub-columns: 1
124-
125-
* - App
126-
- Model
127-
- Parent
128-
* - :guilabel:`Accounting`
129-
- :ref:`Asset/Revenue Recognition <create-assets-entry>`
130-
131-
:doc:`Loan </applications/finance/accounting/bank/loans>`
132-
- :ref:`Asset model <assets/asset-model>`
133-
134-
:ref:`Journal <cheat_sheet/journals>`
135-
* - :guilabel:`Appraisals`
136-
- :ref:`Employee Appraisal <appraisals/manual>`
137-
- :ref:`Department <employee/create-departments>`
138-
* - :guilabel:`Approvals`
139-
- Approval Request
140-
- Category
141-
* - :guilabel:`CRM`
142-
- :doc:`Lead/Opportunity </applications/sales/crm/acquire_leads/email_manual>`
143-
- :ref:`Sales team <crm/sales-team-dashboard>`
144-
* - :guilabel:`Employees`
145-
- :ref:`Employee <employees/general-info>`
146-
- :ref:`Company <employees/general-info>`
147-
* - :guilabel:`Events`
148-
- :doc:`Event Registration </applications/marketing/events/registration_desk>`
149-
- :ref:`Event <events/new-event>`
150-
* - :guilabel:`Fleet`
151-
- :doc:`Vehicle </applications/hr/fleet/new_vehicle>`
152-
- :ref:`Vehicle model <fleet/add-model>`
153-
* - :guilabel:`Frontdesk`
154-
- :ref:`Frontdesk Visitors <frontdesk/list>`
155-
- :ref:`Station <frontdesk/stations>`
156-
* - :guilabel:`Helpdesk`
157-
- :ref:`Ticket <helpdesk/follow>`
158-
- :ref:`Helpdesk team <helpdesk/create-team>`
159-
* - :guilabel:`Inventory`
160-
- :ref:`Lot/Serial <inventory/product_management/edit-lot>`
161-
162-
:doc:`Transfer
163-
</applications/inventory_and_mrp/inventory/shipping_receiving/picking_methods/wave>`
164-
165-
:ref:`Batch Transfer <inventory/misc/batch_picking>`
166-
- :ref:`Product variant <product-variants/add-product-variants>`
167-
168-
:ref:`Operation type <inventory/product_management/operation-type-setting>`
169-
170-
:ref:`Operation type <inventory/product_management/operation-type-setting>`
171-
* - :guilabel:`Knowledge`
172-
- :ref:`Knowledge Article <knowledge/articles_editing/create-article>`
173-
- :ref:`Parent article <knowledge/articles_editing/create-article>`
174-
* - :guilabel:`Maintenance`
175-
- :ref:`Maintenance Equipment <maintenance/equipment_management/add_new_equipment>`
176-
- :ref:`Equipment category <maintenance/equipment_management/add_new_equipment>`
177-
* - :guilabel:`Meeting Rooms`
178-
- Room
179-
- Office
180-
* - :guilabel:`Planning`
181-
- :ref:`Shift <planning/roles>`
182-
- :ref:`Role <planning/roles>`
183-
* - :guilabel:`Project` / :guilabel:`Field Service`
184-
- :ref:`Task <task_creation/task-configuration>`
185-
- :ref:`Project <project_management/configuration>`
186-
* - :guilabel:`Recruitment`
187-
- :ref:`Applicant <recruitment/quick-add-applicant>`
188-
189-
:ref:`Job Position <recruitment/new_job_position/edit>`
190-
191-
Candidate
192-
- :ref:`Job position <job-position/create-job-position>`
193-
194-
:ref:`Company <general/companies/company>`
195-
196-
:ref:`Company <general/companies/company>`
197-
* - :guilabel:`Repairs`
198-
- :ref:`Repair order <repairs/repair_orders/repair>`
199-
- :ref:`Company <general/companies/company>`
200-
* - :guilabel:`Sales` / etc.
201-
- Product
202-
- Category
128+
.. list-table::
129+
:widths: 20 40 40
130+
:header-rows: 1
131+
:stub-columns: 1
132+
133+
* - App
134+
- Model
135+
- Parent
136+
* - :guilabel:`Accounting`
137+
- :ref:`Asset/Revenue Recognition <create-assets-entry>`
138+
139+
:doc:`Loan </applications/finance/accounting/bank/loans>`
140+
- :ref:`Asset model <assets/asset-model>`
141+
142+
:ref:`Journal <cheat_sheet/journals>`
143+
* - :guilabel:`Appraisals`
144+
- :ref:`Employee Appraisal <appraisals/manual>`
145+
- :ref:`Department <employee/create-departments>`
146+
* - :guilabel:`Approvals`
147+
- Approval Request
148+
- Category
149+
* - :guilabel:`CRM`
150+
- :doc:`Lead/Opportunity </applications/sales/crm/acquire_leads/email_manual>`
151+
- :ref:`Sales team <crm/sales-team-dashboard>`
152+
* - :guilabel:`Employees`
153+
- :ref:`Employee <employees/general-info>`
154+
- :ref:`Company <employees/general-info>`
155+
* - :guilabel:`Events`
156+
- :doc:`Event Registration </applications/marketing/events/registration_desk>`
157+
- :ref:`Event <events/new-event>`
158+
* - :guilabel:`Fleet`
159+
- :doc:`Vehicle </applications/hr/fleet/new_vehicle>`
160+
- :ref:`Vehicle model <fleet/add-model>`
161+
* - :guilabel:`Frontdesk`
162+
- :ref:`Frontdesk Visitors <frontdesk/list>`
163+
- :ref:`Station <frontdesk/stations>`
164+
* - :guilabel:`Helpdesk`
165+
- :ref:`Ticket <helpdesk/follow>`
166+
- :ref:`Helpdesk team <helpdesk/create-team>`
167+
* - :guilabel:`Inventory`
168+
- :ref:`Lot/Serial <inventory/product_management/edit-lot>`
169+
170+
:doc:`Transfer
171+
</applications/inventory_and_mrp/inventory/shipping_receiving/picking_methods/wave>`
172+
173+
:ref:`Batch Transfer <inventory/misc/batch_picking>`
174+
- :ref:`Product variant <product-variants/add-product-variants>`
175+
176+
:ref:`Operation type <inventory/product_management/operation-type-setting>`
177+
178+
:ref:`Operation type <inventory/product_management/operation-type-setting>`
179+
* - :guilabel:`Knowledge`
180+
- :ref:`Knowledge Article <knowledge/articles_editing/create-article>`
181+
- :ref:`Parent article <knowledge/articles_editing/create-article>`
182+
* - :guilabel:`Maintenance`
183+
- :ref:`Maintenance Equipment <maintenance/equipment_management/add_new_equipment>`
184+
- :ref:`Equipment category <maintenance/equipment_management/add_new_equipment>`
185+
* - :guilabel:`Meeting Rooms`
186+
- Room
187+
- Office
188+
* - :guilabel:`Payroll`
189+
- :ref:`Employee <employees/general-info>`
190+
191+
:ref:`Payslip <payroll/new-payslip>`
192+
- :ref:`Company <employees/general-info>`
193+
194+
:ref:`Structure <payroll/structure-types>`
195+
* - :guilabel:`Planning`
196+
- :ref:`Shift <planning/roles>`
197+
- :ref:`Role <planning/roles>`
198+
* - :guilabel:`Project` / :guilabel:`Field Service`
199+
- :ref:`Task <task_creation/task-configuration>`
200+
- :ref:`Project <project_management/configuration>`
201+
* - :guilabel:`Recruitment`
202+
- :ref:`Applicant <recruitment/quick-add-applicant>`
203+
204+
:ref:`Job Position <recruitment/new_job_position/edit>`
205+
206+
Candidate
207+
- :ref:`Job position <job-position/create-job-position>`
208+
209+
:ref:`Company <general/companies/company>`
210+
211+
:ref:`Company <general/companies/company>`
212+
* - :guilabel:`Repairs`
213+
- :ref:`Repair order <repairs/repair_orders/repair>`
214+
- :ref:`Company <general/companies/company>`
215+
* - :guilabel:`Sales` / etc.
216+
- Product
217+
- Category
203218

204219
.. note::
205-
The following models do not depend on any *parent* and apply to all records:
220+
The following models do not depend on any *parent* and apply to all records:
206221

207-
- :doc:`Contact Form <../../../applications/essentials/contacts>` in the :guilabel:`Contacts` app
208-
- :ref:`Mailing List Contacts <marketing/mailing-list/contacts>` in the :guilabel:`Email
209-
Marketing` app
222+
- :doc:`Contact Form <../../../applications/essentials/contacts>` in the :guilabel:`Contacts` app
223+
- :ref:`Mailing List Contacts <marketing/mailing-list/contacts>` in the :guilabel:`Email
224+
Marketing` app

content/applications/productivity/ai/fields.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ After the field is added, click the |AI| icon to refresh the field value.
7373
.. image:: fields/warning.png
7474
:alt: A warning message indicating the AI was unable to complete the request.
7575

76+
.. _ai/add-a-new-field/properties:
77+
7678
Add via edit properties
7779
-----------------------
7880

0 commit comments

Comments
 (0)