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 7d1c2c5ed41b8d694d3bc49439e00de2d043fb51
Author: holivier <holiv...@apache.org>
AuthorDate: Tue Feb 25 16:42:20 2020 +0100
Documented: Manufacturing Production Run migration to asciidoc
(OFBIZ-11416)
For most of files content has been directly put in
mfg-production-run.adoc
---
.../_include/HELP-mfg-EditProductionRun.adoc | 63 +++++++++
.../_include/HELP-mfg-EditProductionRun_NL.adoc | 58 ++++++++
.../docs/asciidoc/_include/mfg-production-run.adoc | 106 +++++++++++++++
.../asciidoc/_include/mfg-production-run_NL.adoc | 146 +++++++++++++++++++++
.../src/docs/asciidoc/manufacturing.adoc | 2 +
.../src/docs/asciidoc/manufacturing_NL.adoc | 3 +
6 files changed, 378 insertions(+)
diff --git
a/applications/manufacturing/src/docs/asciidoc/_include/HELP-mfg-EditProductionRun.adoc
b/applications/manufacturing/src/docs/asciidoc/_include/HELP-mfg-EditProductionRun.adoc
new file mode 100644
index 0000000..9c8c656
--- /dev/null
+++
b/applications/manufacturing/src/docs/asciidoc/_include/HELP-mfg-EditProductionRun.adoc
@@ -0,0 +1,63 @@
+////
+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.
+////
+
+= Edit Production Run
+This screen displays the details of a Production Run. +
+Through this screen you can:
+
+* Edit the basic details of the Production Run
+* Create tasks that will be performed as part of the Production Run by
clicking 'Tasks'
+* Add materials that the Production Run will use to make the manufactured
product by clicking 'Materials'
+* Associate equipment that will be used as part of Production by clicking
'Equipment'
+* View any associated (or dependent) Production Runs by clicking 'Assocs'
+* View any associated content by clicking 'Content'
+* View the actual cost of the Production Run by click 'Actual Costs'
+
+== Basic Production Run Details
+This section displays the basic details of the Production Run. +
+This includes information about the Facility where the Production Run will
take place, the quantity of product
+ to be produced and the proposed start and completion date.
+
+The majority of these fields are editable, the exception being the "Calculated
completion date".
+
+This section also allows you to change the Production Run status as follows:
+
+* "Cancel" - To cancel the Production Run.
+* "Quick Close" - To close the Production Run
+* "Quick complete" - To mark the Production Run as 'complete'
+* "Confirm" - To confirm the Production Run
+* "Schedule" -To schedule the Production Run in the calendar
+* "Print" - To create a pdf file of the Production Run
+
+== Order Items
+This section displays an overview of associated order items if the Production
Run will be used to fulfill an order.
+
+== Tasks
+This section displays an overview of associated tasks that will be performed
as part of the Production Run.
+These are also called "Routing Tasks"
+
+== Materials
+This section displays an overview of the required materials that will be used
during the Production Run.
+This information is taken from the Bill of Materials.
+
+== Equipment/Production Run Fixed Assets
+This section displays the required equipment or machinery to be used in the
Production Pun.
+
+== Notes
+This section displays an overview of any associated Production Run notes.
\ No newline at end of file
diff --git
a/applications/manufacturing/src/docs/asciidoc/_include/HELP-mfg-EditProductionRun_NL.adoc
b/applications/manufacturing/src/docs/asciidoc/_include/HELP-mfg-EditProductionRun_NL.adoc
new file mode 100644
index 0000000..128eb00
--- /dev/null
+++
b/applications/manufacturing/src/docs/asciidoc/_include/HELP-mfg-EditProductionRun_NL.adoc
@@ -0,0 +1,58 @@
+////
+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.
+////
+
+= Tonen production run
+Dit scherm toont de productierun. +
+Via dit scherm kun je:
+
+* Basisgegevens van de productierun wijzigen
+* Taken aanmaken - klik op 'Taken'
+* Materialen toevoegen - klik op 'Materialen'
+* Productiemiddelen koppelen - klik op 'Productiemiddelen'
+* De gekoppelde (afhankelijke) productieruns bekijken - klik op 'Associaties'
+* De gekoppelde content document bekijken - klik op 'Content'
+* De werkelijke kosten van de productierun bekijken - klik op 'Kosten'
+
+== Gegevens productierun
+Deze sectie toont de basisgegevens van de productie run. +
+Tevens kun je de basisgegevens bijwerken.
+
+In deze sectie kun je volgende acties uitvoeren:
+
+* Annuleren - om de taak te annuleren
+* Quick close - om de taak af te sluiten
+* Quick complete - 0m de taak als uitgevoerd aan te merken
+* Bevestigen - om de taak te bevestigen
+* Agenderen -om de taak te agenderen in de kalender
+* Afdrukken - om een pdf van de productierun aan te maken
+
+== Orderregels
+Deze sectie toont de gekoppelde orderregels
+
+== Taken
+Deze sectie toont de gekoppelde taken
+
+== Materialen
+Deze sectie toont de benodigde materialen voor de productierun
+
+== Productiemiddelen
+Deze sectie toont de benodigde productiemiddelen voor de productierun
+
+== Notities
+Deze sectie toont de gekoppelde notities inzake de productierun
\ No newline at end of file
diff --git
a/applications/manufacturing/src/docs/asciidoc/_include/mfg-production-run.adoc
b/applications/manufacturing/src/docs/asciidoc/_include/mfg-production-run.adoc
new file mode 100644
index 0000000..2077b5f
--- /dev/null
+++
b/applications/manufacturing/src/docs/asciidoc/_include/mfg-production-run.adoc
@@ -0,0 +1,106 @@
+////
+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.
+////
+= JobShop, or ProductionRun
+Jobshop is the generic term to manage Production Run
+
+The JobShop is used to manage and track all the manufacturing or assembling
work. +
+The work (or job) carried out in the JobShop is called a Production Run.
+
+Production Runs can also be called Work Orders.
+
+Production Runs are the work list of the manufacturing department and include
details of:
+
+* the product to be manufactured
+* the raw materials or sub assemblies to use
+* the steps needed to make the finished product
+
+“Production Runs” are the to do or work lists of the manufacturing department.
+
+Each manufacturing job, batch, or run is done based on a production run.
+
+In OFBiz Jobshop you can
+
+* Create a new ProductionRun
+* Manage ProductionRun
+ ** its tasks
+ ** the materials needed
+ ** fixedAsset need (machine)
+ ** Parties working
+* Associate ProductionRun
+* View cost associated
+* declare all actions done on a ProductionRun
+
+JobShop menu is the default screen for manufacturing.
+
+Productions Runs can be created manually or automatically. +
+To create one manually:
+
+. Click the "Create a Production Run" button
+
+To locate an existing Production Run
+
+. Click "Find"
+. A list of any existing Production Runs will be displayed
+. Click the Production Run Id to view the Production Run details
+
+Production Runs cannot be deleted but they can be cancelled instead.
+
+== ProductionRun management in UI
+=== Find production run
+In this screen you can search for existing production runs.
+You can also create new production runs by clicking 'Create new production run'
+
+=== Create production run
+In this screen you can create a new production run.
+
+. Select the product that needs to be manufactured.
+. Set the quantity to produce and the start date.
+. Subsequently set the warehouse and the routing ID.
+. Give the production run a name and optionally a description.
+. Set the field for 'Create dependent production runs' to yes if you want the
system to automatically create
+ the production runs of sub assemblies or components.
+. Click the button 'Submit' to save the changes.
+
+=== Display production run
+This screen provides the details of the production run. +
+It also provides overviews of related orders, tasks, material, equipment and
notes.
+
+include::HELP-mfg-EditProductionRun.adoc[leveloffset=+2]
+
+=== Display production run tasks
+This screen provides an overview of all routing tasks connected to the
production run. +
+From here you can also add a new or modify an existing routing task to the
production run.
+
+=== Display production run materials
+This screen provides an overview of materials connected to the production run.
+
+From here you can also connect new materials to the production run.
+
+=== Display production run equipment
+This screen provides an overview of the equipment related to the production
run. +
+From here you can also connect new equipment to the production run.
+
+=== Display production run assocs
+This screen provides overviews of mandatory and dependent associated
production runs.
+
+=== Display production run content
+This screen provides an overview of all connected content to the production
run.
+
+=== Display production run costs
+This screen provides overviews of the costs of routing tasks of the production
run and the cost of routings
+ of the production run.
+
diff --git
a/applications/manufacturing/src/docs/asciidoc/_include/mfg-production-run_NL.adoc
b/applications/manufacturing/src/docs/asciidoc/_include/mfg-production-run_NL.adoc
new file mode 100644
index 0000000..9a6a30a
--- /dev/null
+++
b/applications/manufacturing/src/docs/asciidoc/_include/mfg-production-run_NL.adoc
@@ -0,0 +1,146 @@
+////
+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.
+////
+= JobShop, or ProductionRun
+Dit is het startscherm van OFBiz:MFG.
+
+Jobshop is the generic term to manage Production Run
+
+The JobShop is used to manage and track all the manufacturing or assembling
work. +
+The work (or job) carried out in the JobShop is called a Production Run.
+
+Production Runs can also be called Work Orders.
+
+Production Runs are the work list of the manufacturing department and include
details of:
+
+* the product to be manufactured
+* the raw materials or sub assemblies to use
+* the steps needed to make the finished product
+
+“Production Runs” are the to do or work lists of the manufacturing department.
+
+Each manufacturing job, batch, or run is done based on a production run.
+
+In OFBiz Jobshop you can
+
+* Create a new ProductionRun
+* Manage ProductionRun
+ ** its tasks
+ ** the materials needed
+ ** fixedAsset need (machine)
+ ** Parties working
+* Associate ProductionRun
+* View cost associated
+* declare all actions done on a ProductionRun
+
+JobShop menu is the default screen for manufacturing.
+
+Productions Runs can be created manually or automatically. +
+To create one manually:
+
+. Click the "Create a Production Run" button
+
+To locate an existing Production Run
+
+. Click "Find"
+. A list of any existing Production Runs will be displayed
+. Click the Production Run Id to view the Production Run details
+
+Production Runs cannot be deleted but they can be cancelled instead.
+
+== ProductionRun management in UI
+=== Productierun aanmaken en vinden
+Dit scherm biedt de mogelijkheid om productieruns aan te maken en te vinden.
+
+==== Productierun aanmaken
+Klik op de knop 'Productierun aanmaken' om een nieuwe productierun te
genereren.
+
+==== Productierun zoeken en vinden.
+Vul de parameters in en klik op de 'zoek' knop.
+Worden resultaten gevonden, dan worden deze getoond in de sectie onder het
zoek deel.
+
+
+=== Productierun aanmaken
+In dit scherm maak je een nieuwe productierun aan.
+
+Vul de velden in en klik op 'Opslaan'.
+
+. Select the product that needs to be manufactured.
+. Set the quantity to produce and the start date.
+. Subsequently set the warehouse and the routing ID.
+. Give the production run a name and optionally a description.
+. Set the field for 'Create dependent production runs' to yes if you want the
system to automatically create
+ the production runs of sub assemblies or components.
+. Click the button 'Submit' to save the changes.
+
+=== Display production run
+This screen provides the details of the production run. +
+It also provides overviews of related orders, tasks, material, equipment and
notes.
+
+include::HELP-mfg-EditProductionRun_NL.adoc[leveloffset=+2]
+
+=== Aanmaken en tonen taken productierun
+In dit scherm kun je (werkplan) taken koppelen aan de productierun. +
+Het scherm toont tevens de gekoppelde (werkplan) taken.
+
+==== Werkplan taak toevoegen/wijzigen
+In deze sectie selecteer je een beschikbare werkplan taak en vult de gegevens
voor de productierun aan.
+
+==== Overzicht gekoppelde werkplan taken
+Dit overzicht toont de gekoppelde werkplan taken.
+
+
+=== Aanmaken en tonen materialen
+In dit scherm kun je benodigde materialen koppelen aan een productierun. +
+Dit scherm toont tevens de materialen gekoppeld aan de productierun.
+
+==== Materialen toevoegen/wijzigen
+In deze sectie kun je benodigde materialen en/of onderdelen toevoegen aan de
productierun.
+
+==== Overzicht materialen
+Deze sectie toont de benodigde materialen en onderdelen die nodig zijn om het
product in de productierun
+ te fabriceren.
+Tevens kun je in de regel het benodigde hoeveelheid wijzigen.
+
+
+=== Aanmaken en tonen productiemiddelen
+Dit scherm biedt de mogelijk productiemiddelen te koppelen gekoppeld aan de
productierun. +
+Tevens toont het de gekoppelde productiemiddelen.
+
+
+=== Gekoppelde (afhankelijke) productieruns
+Dit scherm toont de verplichte en de afhankelijke productieruns.
+
+==== Verplichte productieruns
+Deze sectie toont een overzicht van de verplichte productieruns.
+
+==== Afhankelijke productieruns
+Deze sectie toont een overzicht van de afhankelijke productieruns.
+
+
+=== Tonen content productierun
+Dit scherm toont de content die gekoppeld is aan productierun.
+
+
+=== Tonen kosten productierun
+Dit scherm toont de kosten van de productierun.
+
+==== Kosten route(s)
+Deze sectie toont de routes en de daarbijhorende kosten.
+
+==== Kosten productierun
+Deze sectie toont kosten van de productierun.
diff --git a/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc
b/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc
index bdae140..de5e051 100644
--- a/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc
+++ b/applications/manufacturing/src/docs/asciidoc/manufacturing.adoc
@@ -27,3 +27,5 @@ Catalog to manage product definition, whatever its stage of
manufacture (raw mat
and Workeffort to manage all means of production.
include::_include/mfg-intro.adoc[leveloffset=+1]
+
+include::_include/mfg-production-run.adoc[leveloffset=+1]
diff --git a/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc
b/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc
index 99667fc..7e54e5b 100644
--- a/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc
+++ b/applications/manufacturing/src/docs/asciidoc/manufacturing_NL.adoc
@@ -27,3 +27,6 @@ Catalog to manage product definition, whatever its stage of
manufacture (raw mat
and Workeffort to manage all means of production.
include::_include/hr-intro.adoc[leveloffset=+1]
+
+include::_include/mfg-production-run_NL.adoc[leveloffset=+1]
+
