You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ho...@apache.org on 2020/06/20 14:07:44 UTC
[ofbiz-framework] 07/10: Documented: Manufacturing Bill Of Material
migration to asciidoc (OFBIZ-11416)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 47a7b30bacd6a48f611009a15404180a2d532e8d
Author: holivier <ho...@apache.org>
AuthorDate: Wed Feb 26 15:56:12 2020 +0100
Documented: Manufacturing Bill Of Material migration to asciidoc
(OFBIZ-11416)
For all of files, content has been directly put in mfg-bom.adoc
---
.../src/docs/asciidoc/_include/mfg-bom.adoc | 70 ++++++++++++++++++++
.../src/docs/asciidoc/_include/mfg-bom_NL.adoc | 77 ++++++++++++++++++++++
.../src/docs/asciidoc/manufacturing.adoc | 4 +-
.../src/docs/asciidoc/manufacturing_NL.adoc | 4 +-
4 files changed, 153 insertions(+), 2 deletions(-)
diff --git a/applications/manufacturing/src/docs/asciidoc/_include/mfg-bom.adoc b/applications/manufacturing/src/docs/asciidoc/_include/mfg-bom.adoc
new file mode 100644
index 0000000..25e9d32
--- /dev/null
+++ b/applications/manufacturing/src/docs/asciidoc/_include/mfg-bom.adoc
@@ -0,0 +1,70 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Bill Of Material
+The Bill of Materials is the list of raw materials or list of ingredients required to make
+our manufactured product.
+
+When a product is created and it will be manufactured, we need to define the relationship between the product
+ and its raw materials. This is done using the BOM.
+
+For configurable product, or product with feature, it's possible to define some "Manufacturing Rules" to have
+ a BOM which that adjust according to the options / feature chosen.
+
+== Bill Of Material management in UI
+=== Find BOM
+This screen displays an overview of the BoM's available, i.e. a list of product with components.
+
+When one is selected in the list, the detail of its components are shown.
+
+You can also click the button 'Create BOM' to create a new BoM.
+
+=== Add/edit a BoM
+In this screen you can create a new BOM (a Product association) or modify an existing BOM.
+
+Usually BOM is understand as the product and its componants, in this screen there is the component list
+and it's possible to add or edit each of association between the product and one of its component.
+
+=== BOM Simulation
+This screen shows the effects of a simulated BOM.
+
+==== The parameters form
+Select the product of the BOM you want to simulate. +
+Choose the BoM-type and set the quantity to simulate.
+
+Set the simulation type and select the warehouse to get the QoH (Quantity on Hand).
+
+Subsequently click the 'Submit'-button to execute the simulation.
+The output of the simulation is shown below the form.
+
+==== The simulation overview
+The simulation will be executed and an overview will be shown after the button has been pressed.
+
+The first section will show the details of the BOM. +
+The second part will show the required quantities and costs of the components.
+
+
+=== Manufacturing rules
+This screen displays an overview of the manufacturing rules that are applicable to produce a product. +
+A manufacturing rule displays the replacements of a component.
+
+In this screen you can also create new manufacturing rules.
+
+==== Create/Edit new manufacturing rule
+This form enables you to define replacing materials for the BoM components. +
+In the second part of the screen the overview of replacement rules is shown.
\ No newline at end of file
diff --git a/applications/manufacturing/src/docs/asciidoc/_include/mfg-bom_NL.adoc b/applications/manufacturing/src/docs/asciidoc/_include/mfg-bom_NL.adoc
new file mode 100644
index 0000000..d24d731
--- /dev/null
+++ b/applications/manufacturing/src/docs/asciidoc/_include/mfg-bom_NL.adoc
@@ -0,0 +1,77 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Bill Of Material
+The Bill of Materials is the list of raw materials or list of ingredients required to make
+our manufactured product.
+
+When a product is created and it will be manufactured, we need to define the relationship between the product
+ and its raw materials. This is done using the BOM.
+
+ For configurable product, or product with feature, it's possible to define some "Manufacturing Rules" to have
+ a BOM which that adjust according to the options / feature chosen.
+
+== Bill Of Material management in UI
+=== BoM's'
+Dit scherm biedt je de mogelijkheid om nieuwe BoM's aan te maken en om ze te vinden en te bekijken.
+
+Vanaf hier kun je doorklikken naar:
+
+* kalenders
+* kalenderweken
+
+==== Nieuwe BoM aanmaken
+Klik op de knop 'BoM aanmaken' om een nieuwe BoM te definieren.
+
+==== Overzicht Bom's
+Dit overzicht toont de beschikbare BoM's. +
+Klik op de ID van de BoM om die te bekijken.
+
+
+=== BoM toevoegen/aanpassen
+In dit scherm kun je een bestaande BoM aanpassen of een nieuwe definieren.
+
+
+=== BOM Simulation
+Dit scherm toont de effecten van een simulatie van een BoM.
+
+==== Het invulscherm
+Selecteer het product van de te simuleren BOM. +
+Kies vervolgens het BoM-type en zet het aantal
+
+Kies de type simulatie en selecteer het magazijn, om de vooraad van de componenten op te halen
+
+Klik vervolgens op de 'Uitvoeren'-knop om de simulatie uit te voeren.
+De gegevens van de simulatie worden onder het invulformulier getoond.
+
+==== Het simulatie overzicht
+Nadat op de knop is gedrukt wordt het simulatie overzicht getoond.
+
+Het eerste deel toont de BoM. +
+Het tweede deel toont de benodigde hoeveelheden, en de kosten.
+
+
+=== Manufacturing rules
+Dit scherm toont de productie regels die van toepassing zijn op een te produceren product. +
+Een productie regel geeft aan welke componenten vervangen kunnen worden door een ander component.
+
+In dit scherm kun je tevens nieuwe productie regels definieren.
+
+== Nieuwe productie regel definieren
+Dit formulier stelt je in staat vervangende componenten te definieren voor BoM componenten. +
+In het tweede deel van het scherm worden de vervangingsregels getoond.
diff --git a/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc b/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc
index 543b159..a988983 100644
--- a/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc
+++ b/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc
@@ -50,4 +50,6 @@ Click the 'Submit'-button to save the changes.
Subsequently, the screen will be refreshed and the the modified details are shown in the lower part of the screen.
Click the ID of cost calculation to modify it. +
-Click the 'Delete'-button to remove a cost calculation.
\ No newline at end of file
+Click the 'Delete'-button to remove a cost calculation.
+
+include::_include/mfg-bom.adoc[leveloffset=+1]
diff --git a/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc b/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc
index 6a5b4d8..f82a2f6 100644
--- a/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc
+++ b/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc
@@ -47,4 +47,6 @@ Klik vervolgens op 'Opslaan' om de gegevens vast te leggen.
Het scherm wordt ververst en de ingevoerde gegevens worden in het onderste deel getoond
Klik op de ID van de kostencalculatie (in de eerste kolom) om deze te wijzigen. +
-Klik op de knop 'Verwijderen' om een kostencalculatie te verwijderen.
\ No newline at end of file
+Klik op de knop 'Verwijderen' om een kostencalculatie te verwijderen.
+
+include::_include/mfg-bom_NL.adoc[leveloffset=+1]