Skip to content

Commit fff1fc9

Browse files
Feliciousbrse-odoo
andcommitted
[ADD] version control doc
Co-authored-by: brse-odoo <brse@odoo.com>
1 parent 5c4d88a commit fff1fc9

File tree

11 files changed

+155
-0
lines changed

11 files changed

+155
-0
lines changed

content/applications/inventory_and_mrp/manufacturing.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ and allow workers to trigger maintenance operations, feedback loops, quality iss
2121

2222
manufacturing/maintenance
2323
manufacturing/management
24+
manufacturing/plm
2425
manufacturing/quality_control
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:nosearch:
2+
3+
============================
4+
Product Lifecycle Management
5+
============================
6+
7+
Odoo Product Lifecycle Management (PLM) offers a systematic approach for testing, collaboration, and
8+
iteration of products across concept development, design, manufacturing, marketing, and post-launch
9+
support stages. With approvals, key stakeholders can review changes before implementation.
10+
11+
.. toctree::
12+
:titlesonly:
13+
14+
plm/version_control
Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
===============
2+
Version control
3+
===============
4+
5+
.. |BOM| replace:: :abbr:`BoM (Bill of Materials)`
6+
.. |BOMs| replace:: :abbr:`BoMs (Bills of Materials)`
7+
.. |ECO| replace:: :abbr:`ECO (Engineering Change Order)`
8+
.. |ECOs| replace:: :abbr:`ECOs (Engineering Change Orders)`
9+
10+
Odoo's Product Lifecycle Management (PLM) app helps to easily manage the revision history of bills
11+
of materials (BoMs). :menuselection:`PLM` can be used to access previous |BOM| versions, assembly
12+
instructions, component details, and past product design files. |BOM| effective dates are recorded
13+
for error tracking, and changes are compartmentalized in an :ref:`engineering change order
14+
<plm/eco>`, which makes merging |ECOs| back to the production |BOM| simple.
15+
16+
Current BoM version
17+
===================
18+
19+
To see the current version of the |BOM| used in production, go to :menuselection:`PLM app --> Master
20+
Data --> Bill of Materials`, and select the desired |BOM| from the list. Then, switch to the
21+
:guilabel:`Miscellaneous` tab, where the currently live :guilabel:`Version` of the |BOM| is
22+
displayed.
23+
24+
.. note::
25+
|BOMs| can also be accessed from :menuselection:`Manufacturing app --> Products --> Bill of
26+
Materials`.
27+
28+
Version history
29+
===============
30+
31+
As long as the *PLM* app is installed, all all |ECOs| linked to a |BOM| can be viewed by clicking
32+
the :guilabel:`ECO` smart button on a |BOM|.
33+
34+
Click the :guilabel:`≣ (four horizontal lines)` icon to switch to list view.
35+
36+
.. image:: version_control/eco-smart-button.png
37+
:align: center
38+
:alt: Show ECO smart button on a BoM.
39+
40+
In the list of |ECOs|, navigate to the search bar and click the :guilabel:`▼ (down arrow)` icon to
41+
access a drop-down menu of :guilabel:`Filters`. Next, filter by :guilabel:`Done` |ECOs| to view the
42+
revision history of the |BOM|, the :guilabel:`Responsible` user who applied the change, and the
43+
:guilabel:`Effective Date` of the |BOM|. Click each |ECO| to view the past components, operations,
44+
and design files associated with the |BOM|.
45+
46+
.. image:: version_control/eco-list.png
47+
:align: center
48+
:alt: Display ECO revision history for a BoM for a product.
49+
50+
.. tip::
51+
If no date is displayed in the :guilabel:`Effective Date` field, this means the
52+
:guilabel:`Effective` date of the |ECO| was set to :guilabel:`As soon as possible`.
53+
Alternatively, check when the |BOM| went live by navigating to the chatter and hovering over the
54+
time the |ECO| was moved to the :ref:`closing stage <plm/eco/stage-config>`.
55+
56+
.. image:: version_control/effective-asap.png
57+
:align: center
58+
:alt: Show *Effective* as soon as possible field.
59+
60+
61+
Design files
62+
============
63+
64+
Attach computer-aided design (CAD) files, PDFs, images, or other design material to the |BOM|
65+
itself. To do so, navigate to :menuselection:`PLM app --> Master Data --> Bill of Materials`, and
66+
select the desired |BOM|. On the |BOM|, navigate to the *chatter* and click the :guilabel:`📎
67+
(paperclip)` icon. The files associated with the |BOM| are displayed in the :guilabel:`Files`
68+
section. To add more design files, select the :guilabel:`Attach files` button.
69+
70+
.. image:: version_control/attach-files.png
71+
:align: center
72+
:alt: Show paperclip icon in the chatter to attach files to a BoM.
73+
74+
Manage design files in an ECO
75+
-----------------------------
76+
77+
After creating a :ref:`new Engineering Change Order <plm/eco/create-eco>` (ECO), all files stored
78+
in the :guilabel:`Files` section of the |BOM| are automatically copied over to the
79+
:guilabel:`Documents` smart button. Click on the button to open the :guilabel:`Attachments` page.
80+
81+
Hover over each attachment to reveal the :guilabel:`︙ (three vertical dots)` icon. From there,
82+
choose whether to :guilabel:`Edit`, :guilabel:`Remove`, or :guilabel:`Download` the file. Any
83+
changes made to these files are contained within the |ECO|, and will only apply to the production
84+
|BOM| once the :ref:`changes are applied <plm/eco/apply-changes>`.
85+
86+
.. example::
87+
Replace the keyboard PDF in an active |ECO| by first selecting the :guilabel:`Documents` smart
88+
button.
89+
90+
.. image:: version_control/documents-smart-button.png
91+
:align: center
92+
:alt: Show *Documents* smart button from an active ECO.
93+
94+
On the :guilabel:`Attachments` page, hover over the design file and click the :guilabel:`︙ (three
95+
vertical dots)` icon, then the :guilabel:`Edit` option. Rename the file something specific to
96+
express why the file is about to be archived in this active |ECO|. In this case, the |BOM| is for
97+
a smaller keyboard, so the manual for a larger keyboard is no longer relevant. Rename `100%
98+
keyboard manual`, and then save and click back to the :guilabel:`Attachments` page using the
99+
breadcrumbs. Click on the :guilabel:`︙ (three vertical dots)` icon again, and then select the
100+
:guilabel:`Remove` option to archive the file.
101+
102+
Next, click the :guilabel:`Upload` button to upload the new design file, named `60% keyboard
103+
manual`.
104+
105+
.. image:: version_control/attachments.png
106+
:align: center
107+
:alt: View of *Attachments* page from the *Documents* smart button. Displays one archived and
108+
one newly added attachment.
109+
110+
.. note::
111+
Archived files are not permanently deleted—they can still be accessed in the previous |ECO| or as
112+
an archived file in the latest ECO where the archival occurred.
113+
114+
Apply rebase
115+
============
116+
117+
Odoo simplifies the process of merging different versions of a |BOM| when multiple |ECOs| are open
118+
for the same product. If the |BOM| used in production is updated while an |ECO| is still open and in
119+
testing, review the differences between the production |BOMs| in the newly appeared
120+
:guilabel:`Previous Eco Bom Changes` tab. Then, click the :guilabel:`Apply Rebase` button to update
121+
the |BOM| and make it cohesive with the production |BOM|.
122+
123+
.. example::
124+
Two |ECOs|, `ECO0011` and `ECO0012`, are created when the current |BOM| version is `5`. In
125+
`ECO0011`, a new component, `Space stabilizer` is added, and the changes are applied. This means
126+
the current |BOM| version has become `6`.
127+
128+
.. image:: version_control/branch-change.png
129+
:align: center
130+
:alt: Apply changes to an ECO to update the production BOM.
131+
132+
This means that `ECO0012`'s |BOM| is missing the `Space stabilizer`, as shown in the
133+
:guilabel:`Previous Eco Bom Changes` tab. To ensure the changes applied by `ECO0011`
134+
are kept when the changes in `ECO0012`, click the :guilabel:`Apply Rebase` button to apply the
135+
previous |ECO| changes without affecting the changes already made to `ECO0012`.
136+
137+
.. image:: version_control/merge-change.png
138+
:align: center
139+
:alt: Click the *Apply Rebase* button to update the BOM to match the production BOM.
140+
7.59 KB
Loading
18.6 KB
Loading
22.9 KB
Loading
15.2 KB
Loading
28.7 KB
Loading
21.2 KB
Loading
11.7 KB
Loading

0 commit comments

Comments
 (0)