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 2021/05/18 15:15:56 UTC
[ofbiz-framework] 01/03: Documented: Order online Documentation and
help (OFBIZ-12224)
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 e5cab600b20c9e41e5e1354845ca252b61c9463c
Author: holivier <ho...@apache.org>
AuthorDate: Tue May 11 17:44:14 2021 +0200
Documented: Order online Documentation and help (OFBIZ-12224)
In order - order documentation add
* payment term diagram and help about order-bill-setting,
* order update diagrams
most of content and diagram is coming from wiki page
https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview many thanks to Shivangi Tanwar
and some complement from Order Management PDF from David Jones
---
.../src/docs/asciidoc/_include/acc-payments.adoc | 7 +++
.../_include/Help-order-bill-settings.adoc | 27 ++++++++++++
.../asciidoc/_include/order-payment-diagrams.adoc | 47 +++++++++++++++++++++
.../_include/order-update-order-diagrams.adoc | 40 ++++++++++++++++++
.../docs/asciidoc/images/order/billing-account.png | Bin 0 -> 26058 bytes
.../src/docs/asciidoc/images/order/credit-card.png | Bin 0 -> 19337 bytes
.../asciidoc/images/order/payment-terms_level2.png | Bin 0 -> 14841 bytes
.../asciidoc/images/order/update-order_level1.png | Bin 0 -> 17180 bytes
.../asciidoc/images/order/update-order_level3.png | Bin 0 -> 73706 bytes
applications/order/src/docs/asciidoc/order.adoc | 8 ++++
10 files changed, 129 insertions(+)
diff --git a/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc b/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc
index d610575..fc9bfd9 100644
--- a/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc
+++ b/applications/accounting/src/docs/asciidoc/_include/acc-payments.adoc
@@ -24,6 +24,13 @@ They can be incoming or outgoing.
Incoming payments are normally from customers and outgoing ones to suppliers.
+the Payment screen contains a lot of information not normally at your fingertips. The screen for creating a Payment looks very
+similar to the View Payment screen: you have drop-down boxes for Payment Type, Payment Method Type, and Status.
+The other fields are asking for ID numbers which may be more difficult to obtain.
+
+For the above reasons, it is probably quicker and easier to click on the [Receive Payment] link from the View Order screen
+than to try to create a Payment from the Accounting Manager.
+
== Payments management in User Interface
include::HELP_findPayments.adoc[leveloffset=+2]
diff --git a/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc b/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc
index 7860417..a5b9053 100644
--- a/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc
@@ -20,11 +20,38 @@ under the License.
If there are multiple "payment" term, it's the place to enter them. It's optional and you can enter as many as you want.
+Various payment terms in OFBiz are:
+
+* Financial
+* Payment Net Days
+* Late Fee (percent)
+* Penalty for Collection Agency
+* Non-compete etc.
+
= Payment setting
+*Payment method*
How will the customer pay ? Select the radio button to correspond with he payment method preferred by the customer. +
Billing information is to completed when credit card or eft payments are not used.
+Various payment methods in OFBiz are:
+
+* Billing Account
+* Cash
+* Cash on Delivery
+* Certified Check
+* Company Account
+* Company Check
+* Credit Card
+* Electronic Fund Transfer
+* Financial Account
+* Gift Card
+* Gift Certificate
+* Money Order
+* Offline Payment
+* Paypal
+* Personal Check etc.
+
= Additional Party Entry
There may be reasons for associating another Party or Group with the order. For example, the person placing the order
diff --git a/applications/order/src/docs/asciidoc/_include/order-payment-diagrams.adoc b/applications/order/src/docs/asciidoc/_include/order-payment-diagrams.adoc
new file mode 100644
index 0000000..e3d6bfc
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/order-payment-diagrams.adoc
@@ -0,0 +1,47 @@
+////
+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.
+////
+= Payment Terms and Method
+
+Payment Terms are conditions agreed between business and customers for the payment of invoices.
+
+Selecting Payment Terms and Methods are key things in fulfillment of any order process.
+
+
+== Payment process diagram
+image:order/payment-terms_level2.png[Payment Terms and Methods]
+// diagram have been created with ofbiz.apache wiki
+//on page https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+. <<Order Term,Select Payment Term>>
+. <<Payment setting, Select Payment Method>>
+
+== Payment Method diagram
+Depending on payment method process is not exactly the same.
+
+=== Credit Card
+image:order/credit-card.png[Payment Terms and Credit Card]
+// diagram have been created with ofbiz.apache wiki
+//on page https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+=== Billing Account
+image:order/billing-account.png[Payment Terms and Billing Account]
+// diagram have been created with ofbiz.apache wiki
+//on page https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+For information about Billing Account look at <<_billing_accounts, Accounting - Billing Accounts>>
diff --git a/applications/order/src/docs/asciidoc/_include/order-update-order-diagrams.adoc b/applications/order/src/docs/asciidoc/_include/order-update-order-diagrams.adoc
new file mode 100644
index 0000000..e9682e2
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/order-update-order-diagrams.adoc
@@ -0,0 +1,40 @@
+////
+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.
+////
+= Update Order
+
+A <<CSR>> can edit or update in order to make changes in it based on customer requests or can add notes for handling.
+
+
+== Overview update order process diagram
+image:order/update-order_level1.png[Update Order Overview]
+// diagram have been created with ofbiz.apache wiki
+//on page https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+. <<Find Orders>> or <<List Orders>> or <<Orders of the day>>
+. <<Order View>>
+
+== Detail update order process diagram
+All informations on order are modified, but depending on order status or packing / shipping started.
+
+image:order/update-order_level3.png[Update Order Details]
+// diagram have been created with ofbiz.apache wiki
+//on page https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+. <<Find Orders>> or <<List Orders>> or <<Orders of the day>>
+. <<Order View>>
\ No newline at end of file
diff --git a/applications/order/src/docs/asciidoc/images/order/billing-account.png b/applications/order/src/docs/asciidoc/images/order/billing-account.png
new file mode 100644
index 0000000..8a329be
Binary files /dev/null and b/applications/order/src/docs/asciidoc/images/order/billing-account.png differ
diff --git a/applications/order/src/docs/asciidoc/images/order/credit-card.png b/applications/order/src/docs/asciidoc/images/order/credit-card.png
new file mode 100644
index 0000000..609942b
Binary files /dev/null and b/applications/order/src/docs/asciidoc/images/order/credit-card.png differ
diff --git a/applications/order/src/docs/asciidoc/images/order/payment-terms_level2.png b/applications/order/src/docs/asciidoc/images/order/payment-terms_level2.png
new file mode 100644
index 0000000..26571bc
Binary files /dev/null and b/applications/order/src/docs/asciidoc/images/order/payment-terms_level2.png differ
diff --git a/applications/order/src/docs/asciidoc/images/order/update-order_level1.png b/applications/order/src/docs/asciidoc/images/order/update-order_level1.png
new file mode 100644
index 0000000..6784080
Binary files /dev/null and b/applications/order/src/docs/asciidoc/images/order/update-order_level1.png differ
diff --git a/applications/order/src/docs/asciidoc/images/order/update-order_level3.png b/applications/order/src/docs/asciidoc/images/order/update-order_level3.png
new file mode 100644
index 0000000..2861727
Binary files /dev/null and b/applications/order/src/docs/asciidoc/images/order/update-order_level3.png differ
diff --git a/applications/order/src/docs/asciidoc/order.adoc b/applications/order/src/docs/asciidoc/order.adoc
index a2c133a..b0b4050 100644
--- a/applications/order/src/docs/asciidoc/order.adoc
+++ b/applications/order/src/docs/asciidoc/order.adoc
@@ -53,6 +53,9 @@ Same is with billing and shipping information on the order, it tells the busines
to be used for invoicing and which one for shipping. Having an effective order capturing process helps
to engage your customers.
+The Accounting manager keeps track of financial charges, credit card processes, and receipts of payment.
+The link from the Order Manager to the Accounting Manager is the Invoice Number
+
A customer always provide shipping method details to let the business know about his shipping preference
to ship the order and in other ends, CSR always captures shipping method along with special instructions
for delivery.
@@ -61,6 +64,11 @@ include::_include/order-create-order-diagrams.adoc[leveloffset=+2]
include::_include/order-status-diagrams.adoc[leveloffset=+2]
+include::_include/order-update-order-diagrams.adoc[leveloffset=+2]
+
+include::_include/order-payment-diagrams.adoc[leveloffset=+2]
+
+
== Orders management in UI
Sales and Purchase management are done on the same screen, so depending on what you want, don't forget to select
the correct Order Type.