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
The following commit(s) were added to refs/heads/trunk by this push:
new 462b871 Documented: Order online Documentation and help (OFBIZ-12224)
462b871 is described below
commit 462b871f186d0fc9623bc9f059ca5e5ddf1f9907
Author: holivier <[email protected]>
AuthorDate: Thu Apr 15 15:21:52 2021 +0200
Documented: Order online Documentation and help (OFBIZ-12224)
Migration of OFBiz wiki 3.1-3.2-3.3 Order Entry page and Sales Order
Management page
Create Order Diagrams
Order Status Diagrams
Add link from screen to help
---
.../_include/Help-order-bill-settings.adoc | 36 ++++
.../asciidoc/_include/Help-order-check-inits.adoc | 49 ++++++
.../docs/asciidoc/_include/Help-order-confirm.adoc | 34 ++++
.../docs/asciidoc/_include/Help-order-entry.adoc | 56 +++++++
.../_include/Help-order-option-settings.adoc | 45 +++++
.../Help-order-ship-setting.adoc} | 32 +---
.../asciidoc/_include/Help-order-show-cart.adoc | 135 +++++++++++++++
.../docs/asciidoc/_include/Help-order-view.adoc | 186 +++++++++++++++++++++
.../_include/order-create-order-diagrams.adoc | 65 +++++++
.../_include/order-ecommerce-entry-path.adoc | 154 +++++++++++++++++
.../{order.adoc => _include/order-glossary.adoc} | 33 +---
.../asciidoc/_include/order-status-diagrams.adoc | 48 ++++++
.../images/order/create-sales-order_level1.png | Bin 0 -> 16673 bytes
.../images/order/create-sales-order_level2.png | Bin 0 -> 56915 bytes
.../images/order/create-sales-order_level3.png | Bin 0 -> 81329 bytes
applications/order/src/docs/asciidoc/order.adoc | 146 +++++++++++++++-
.../widget/ordermgr/OrderEntryCartScreens.xml | 1 +
.../widget/ordermgr/OrderEntryOrderScreens.xml | 12 +-
.../order/widget/ordermgr/OrderEntryScreens.xml | 2 +
.../order/widget/ordermgr/OrderViewScreens.xml | 4 +
applications/party/src/docs/asciidoc/party.adoc | 13 ++
21 files changed, 993 insertions(+), 58 deletions(-)
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
new file mode 100644
index 0000000..7860417
--- /dev/null
+++
b/applications/order/src/docs/asciidoc/_include/Help-order-bill-settings.adoc
@@ -0,0 +1,36 @@
+////
+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.
+////
+= Order Term
+
+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.
+
+= Payment setting
+
+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.
+
+= Additional Party Entry
+
+There may be reasons for associating another Party or Group with the order.
For example, the person placing the order
+might be an member of an existing customer group, such as a shopping club, or
they might be a purchasing agent for
+a company and need to be identified with that company.
+
+When you select to identify another group or individual for association, a
process will be followed. +
+Select a Party (use the lookup or auto-completion in field) and after the
apply button you have to select which role for this
+party for this order. Only Existing role associated with the party selected
appear.
\ No newline at end of file
diff --git
a/applications/order/src/docs/asciidoc/_include/Help-order-check-inits.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-check-inits.adoc
new file mode 100644
index 0000000..7825b52
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-check-inits.adoc
@@ -0,0 +1,49 @@
+////
+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.
+////
+= Order Entry Init
+
+Order Entry begin with this screen. Using the top portion labeled "Sales
Order" identify the Party placing the order, either
+with their User Login Id (when a ecommerce customer give it to you) or their
Party Id. The lookup can help you to search the
+Id if you have only name, or other details.
+
+* _Sales Order vs. Purchase Order_ +
+ Disregard the Purchase Order section of this screen. That is only used
when you (as a representative of your company) are
+ ordering product or services from another vendor for your company's use.
+* _Product Store_ +
+ It is probable that your CSR (Customer Service Representative) is
processing orders for more than one 'Store' which
+ could be an actual physical presence or a virtual shopping center seen
on-line by the customer. +
+ Confirming the correct Store at this point is critical.
+* _Sales Channel_ +
+ How did this order reach you? Here are some possibilities:
+ .. The customer is standing in front of you at your terminal, probably in
an actual store front -- POS Channel.
+ .. The customer called in the order and you are on the phone with them at
this time -- phone channel.
+ .. You are reading from a fax sheet, an e-mail printout, a letter or order
form -- FAX channel, e-mail channel,
+ or snail mail channel, as appropriate.
+ .. Some other party gathered one or more orders together and has forwarded
a consolidated order to you -- affiliate channel.
+ .. You are not taking the order but it is being processed through the
ecommerce website -- defaults the category
+ to web channel.
+
+= Order Currency, Agreements, and Ship Dates
+
+On a back office perspective, order entry can be use on a B2B context,
+
+* order Name and PO number are customer informations
+* default currency used for this order
+* Catalog and Dates are use as default value on next screen
+* Across the top bar is the link button [Continue] to go to the next step
diff --git
a/applications/order/src/docs/asciidoc/_include/Help-order-confirm.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-confirm.adoc
new file mode 100644
index 0000000..9678ed6
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-confirm.adoc
@@ -0,0 +1,34 @@
+////
+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.
+////
+= Order confirmation
+
+If there are any discrepancies in the order, this the time to fix them. Click
on the appropriate link on Order Confirmation
+Top Bar to be returned to the applicable screen.
+
+When review is finished and everything meets with the customer's approval then
click on [Create Order].
+
+= Order Entry is now completed
+
+Congratulations! You have completed all the aspects of entering an order into
the system. Be sure the customer receives
+the Order Confirmation number. You might wish to mail or fax a copy of this
screen to the customer for their reference.
+
+Work has just begun behind the scenes for processing the order, however.
+
+The next step will be giving Acceptance and/or Approval for the order which
will trigger the processes needed to get
+the product out the door.
\ No newline at end of file
diff --git
a/applications/order/src/docs/asciidoc/_include/Help-order-entry.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-entry.adoc
new file mode 100644
index 0000000..6e15cb2
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-entry.adoc
@@ -0,0 +1,56 @@
+////
+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.
+////
+= Order Entry
+
+In this screen you can create a Sales order on the first part, or a Purchase
Order on the second part.
+
+For Purchase Order entry, all parties with role "SUPPLIER" are listed in the
drop down supplier.
+
+Using the top portion labeled Sales Order, identify the Party placing the
order, either with their User Login Id
+or Party Id. The search tool can be a help. +
+You have several means to reach the PartyID for the person or company which
wishes to place an order.
+
+. Enter the PartyID or LoginID directly if either of those are known. OR
+. Enter the known information, such as name in the search fields; the return
will appear in the table as shown below. OR
+. click on the link to the Popup search tool to the right of the User Login
and Party ID box in the Sales Order section; +
+ and you have a search tool where you can either scroll the listing of known
Parties or enter the information you might
+ have and let the search find the party for you.
+
+If specifics about the order are not known, you might prefer to find it
through the Party.
+In that case, select [Lookup Party]. The Party Manager can link you back to
previous orders. +
+
+Basically, you cannot place an order until the Party is identified.
+There are several ways to establish the Party ID from within the Order Manager.
+Since several of those ways take you back through the Party Manager, it might
be just as easy to begin with the Party Manager.
+
+== Placing a New Order
+Once you click on the [New Order] link, you have begun the order taking
<<Create Order Diagrams,process through the Order Manager>>.
+The internal, 'behind the scenes' processing of the order is very similar to
the Ecommerce order.
+Unlike the Ecommerce ordering process, the customer will not see all of the
screens you have available;
+only the person taking the order can see all the special offers and the
details presented.
+This is why it is important when taking an order over the phone or completing
a transcription from a hard copy or email order,
+that the processor be alert to special offers or to error messages that might
appear.
+
+== Order from eCommerce
+When a customer first enters the Ecommerce website, they are challenged for a
Username and a Password.
+If they are first time visitors, they are provided an opportunity to create an
account.
+If they have visited before, they are asked for their username and password.
+All of their entries are automatically logged into the OFBiz databases for
your review in OFBiz and for their ordering processes.
+They never see any part of OFBiz except the Ecommerce interface which includes
the content posted from OFBiz
+to the Ecommerce portion as called up by their preferences.
diff --git
a/applications/order/src/docs/asciidoc/_include/Help-order-option-settings.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-option-settings.adoc
new file mode 100644
index 0000000..3e66d08
--- /dev/null
+++
b/applications/order/src/docs/asciidoc/_include/Help-order-option-settings.adoc
@@ -0,0 +1,45 @@
+////
+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.
+////
+= Order Option Settings
+
+There are the same options list for each Ship Group, except for internal and
ship Notes
+
+* _Shipping methods_ +
+ Select the radio button for the preferred shipping method. Consider the
customer's desired delivery date, the availability
+ of product, your order processing time, and the transportation time
required before agreeing with the customer to
+ a specific mode of shipping. +
+ Note how the cost of each method is already determined and displayed for
you.
+ Let the customer know the cost involved and obtain his consent to the
cost. +
+ Parameters about shipping cost are associated with Product Store (entered
in first screen).
+* _Single or multiple shipments_ +
+ Sometimes the customer needs to have all parts of the order available at
the same time; they will elect to wait until
+ all of the items are available before shipping. Others want whatever
items are available immediately and prefer not
+ to wait for the rest. Select the radio button to match their preference,
but explain that an additional shipping cost
+ might be incurred.
+* _Special Instructions_ +
+ If you get them, record any special instructions here. These will appear
on the Pick Sheets.
+* _Gift? / Gift Message_ +
+ The Yes radio button selection will direct packers to Gift Wrap if that
was requested in the order.
+ Also, it directs them to attach the Message which follows in the next
section.
+* _Ship Before / After Date_ (optional) +
+ The customer could have any one of many different reasons for wanting the
order to be shipped before or after
+ a specific date. For example, budget that must be spent within a certain
quarter would require the order be
+ fulfilled before the end of the quarter. Similarly, if the item is not
budgeted until next quarter,
+ but they want to receive it early within that quarter, they might specify
the first day of the next business quarter. +
+ Use the popup calendar to identify and insert the date.
diff --git a/applications/order/src/docs/asciidoc/order.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-ship-setting.adoc
similarity index 60%
copy from applications/order/src/docs/asciidoc/order.adoc
copy to
applications/order/src/docs/asciidoc/_include/Help-order-ship-setting.adoc
index 197fba9..ac06a1d 100644
--- a/applications/order/src/docs/asciidoc/order.adoc
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-ship-setting.adoc
@@ -16,31 +16,15 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= Order
+= Set Shipping address and Group
-The order manager allows you to enter and maintain orders, quotes, requests
and report on them.
+On this screen it's possible to choose
-It allow to manage purchase and sales orders from the creation and approval to
the goods packing and shipping.
+* the delivery address and/or create a new one,
+* to create multiple shipping group, and so multiple delivery address or
multiple delivery date
+* the party to shipping to if it's not the same as which one ordered
-== Overview
-TODO
+= Set Item to ShipGroup
-== Orders management
-
-=== Main screen
-To select Sales and/or Purchase orders
-
-=== Order View
-This screen allow not only to view an order but also to change it
-
-include::_include/order_report.adoc[leveloffset=+1]
-
-== Requests
-
-== Quotes
-
-== Returns
-
-== Requirements
-
-== Stats
\ No newline at end of file
+If you have defined multiple ship group, in this screen you can choose for
each item (and each quantity) with which
+group it will be ship
\ No newline at end of file
diff --git
a/applications/order/src/docs/asciidoc/_include/Help-order-show-cart.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-show-cart.adoc
new file mode 100644
index 0000000..6e47bb9
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-show-cart.adoc
@@ -0,0 +1,135 @@
+////
+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.
+////
+= Add Item(s) to cart
+
+Primary order entry screen is complex, and after one item has been entered,
promotional items were added automatically and
+so more information.
+
+* _Order Header Info_
+ Before proceeding with the order entry, confirm that the Party is
correctly identified, and that the Currency is in
+ the correct denomination. +
+ Click on the Party ID number to go to the Party Manager for confirming or
updating information about the Party. +
+ A running total of the current order is displayed for quick reference.
+* _Shortcuts_, +
+ .. _Quotes_ +
+ If the customer refers to a quotation submitted to them from your
company, go here to locate the Quote.
+ .. _Create New Quote From Cart_ +
+ Use the items accumulated in the Shopping Cart and, rather than
fulfilling an order, prepare a Quotation for
+ the customer. This Quote would go into the system established for
Quotes as discussed under the Order Manager.
+ .. _Create a Request for Quote_ +
+ This more formal process provides a vehicle to identify products of
interest to the Customer and assemble
+ a Quotation based upon the Request initiated here. The Request is
initially based upon products identified
+ in the Customers Cart, and is created for this named Customer.
+ To follow through on this, see the Requests tab under the Order Manager.
+ .. _Find Party_ +
+ Takes you to the Party Manager - Find Party screen.
+ .. _Create Customer_ +
+ If this Order is for a new Customer, here is the link to the Party
Manager to establish the information needed
+ in the system.
+ .. _Change Party_ +
+ Cancels the current Sales Order process and takes you to the initial
Order Entry screen where you need
+ to identify the Party.
+ .. _Create New Product_ +
+ If your customer asks for a product which has not yet been established
in the system, and you know you can get it
+ for them, this link allows you to quickly create the product identity
within OFBiz before proceeding with the order.
+ .. _Quick Add_ +
+ Let's say that you are dealing with a customer who knows what he wants
and you do not need many of the features
+ and links given on this particular screen. By choosing [Quick Add] you
are taken to a simplified ordering screen
+ where the order taking can be quickly accomplished. Compare the current
screen with the Quick Add screen to visualize
+ the differences. +
+ The Quick Add screen removes many of the links and features of the full
Order Entry screen, but may easier to use.
+ .. _Shopping List_ +
+ Brings up a table of the Party's existing Lists. It's possible to
[Quick Add All] to brings all of the items on a
+ selected List into this current Order, or Choose single items from a
selected Shopping List ([View List] button)
+* _Choose Catalog_ +
+ Your customer might be ordering from your Spring catalog, your Outdoor
Specials catalog, or whatever Catalog you may
+ have placed into his hands. Establish the Catalog here so that prices
reflect the Catalog he sees.
+ This will also govern what products, special offers, discounts, and other
details of the marketing process are
+ presented in this screen and for the order itself. +
+ Default value is coming from previous screen.
+* _Search Catalog_ +
+ While talking with the customer, this will give you access to the Catalog
to help him locate what he wants.
+* _Browse Categories_ +
+ Here is another way to find products within categories.
+* _Create Sales Order section_ +
+ ** Links to processes +
+ Across the top bar are these link buttons:
+ .. Clear Order which removes all data from the screen except the Party
ID.
+ .. Remove selected, remove all items selected
+ .. Recalculate Order which is selected when a quantity or other
adjustment has been made.
+ .. Finalize Order which should not be selected until all entries have
been made on this page.
+ .. This one takes you to the next step in the order process.
+ .. Finalize Order with default option, less step than previous button
+ .. Quick Finalize Order which consolidates several steps into one
screen for faster completion.
+ ** _ProductId_, +
+ Popup Search tool help you finds products quickly.
+ ** _Quantity_ +
+ How many the customer are wanted
+ ** _Desired delivery date_ (optional) +
+ Note that this does not say Promised delivery dated.
+ If the customer indicates a date when he would like to have the
delivery, this date can serve as a guide to when to
+ process the order in house. It also guides you to recommend the
appropriate shipping method, ensuring compliance
+ with this date but at the lowest cost to the customer. +
+ You can used the popup calendar to find the date. +
+ Use as default desired delivery date for next entry, if checked, will
keep this date for all the items ordered.
+ ** _Ship After Date_ (optional) +
+ This item (and also the shipping group to which it belongs) will not be
pick before this date.
+ ** _Ship Before Date_ (optional) +
+ To have warning if it's not possible to pick or to produce before this
date.
+ ** _Reserve After Date_ (optional) +
+ No stock reservation will be done before this date.
+ ** _Comment_ +
+ Be judicious what you write here: this may appear on paperwork reaching
the customer such as packing slips, invoices,
+ etc.
+ This may be the place for comments such as 'wrap each item separately'
when several units of the same item are being
+ sent in an order to the same address but are intended for different
recipients, for example. +
+ If the comment applies to more than this item in the order, check the
box labeled Use as default comment for next entry
+ ** _Add To Order_ +
+ This button should not be clicked until all details in this section are
confirmed: quantity, product, dates, etc.
+ It updates the totals and enters particulars into the next section.
+* _Add Order Items to Shopping List section_ +
+ ** _Add To Shopping list_ +
+ First select a list from the drop-down box, then click on [Add To
Shopping List].
+ All of the ordered items to that point will be added to the selected
List, in the quantity ordered.
+* _Order Items section_ +
+ All the informations about items in the cart. +
+ In this section it's possible to modify Product description, Quantity,
Price, Date, ..., to validate and save modification
+ click on [Recalculate Order] on the Create Sale Order top bar. +
+ In this section there are all items, including those added by promotions
(the gift !) and if there are some choice, it's
+ the place to give the answers. +
+ Note the informations beside the Inventory buttons :
+ ** ATP : Available To Promise, quantity in the inventory not yet reserved
+ ** QOH : Quantity On Hand, quantity in the inventory
+* _Promotion/ Coupon Codes_ +
+ Enter the code number from other Promotions or Coupons and click on [Add
Code]. Appropriate discounts or promotional
+ consideration will be calculated into the order if the Code is currently
valid.
+* _Special Offers_ +
+ Give some promotion which can be applied if you add some product or
quantity. It's useful when you have the customer
+ on phone, to propose him additional product to access for a specific
promotion. +
+ Click on detail for a promotion to have the detail condition and result.
+* _You might also be interested in_ +
+ Strictly a promotional tool, here is a selection of items which you can
offer to the customer before moving past
+ this screen. Simply enter the quantity and [Add to Cart] when he indicates
acceptance.
+* _Promotion Information_ +
+ In first, this section, all those Promotions which have been applied to
the order are given.
+ Select [Details] to obtain more information. +
+ In second part, the ordered items which made the customer eligible for a
promotion are given. +
+ Every item being shipped as a promotional give away is listed as well.
+
+When all items is entered click on [Finalize Order] to give all other order
conditions.
diff --git a/applications/order/src/docs/asciidoc/_include/Help-order-view.adoc
b/applications/order/src/docs/asciidoc/_include/Help-order-view.adoc
new file mode 100644
index 0000000..207e7a1
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/Help-order-view.adoc
@@ -0,0 +1,186 @@
+////
+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.
+////
+= Order View
+
+This screen allow not only to view an order but also to change it
+
+Note the link to [PDF]. This will create a PDF formatted document which can be
used internally for paper processing the order
+or sent to the customer as an attachment or hard copy to confirm the order.
The customer should be told that the Order Number
+should be referenced in any correspondence regarding the order.
+
+== Order Information Sections
+
+_Status and General Info_ +
+Notice the Status History? This tells you when the order was placed, when it
was approved and, later,
+where it is at in the shipping process.
+
+The section labeled 'Created by' will give you the login ID of the person
taking or making the order.
+This is who you need to talk with if there are any problems in the original
order.
+Remember, it could be your customer service rep or it could be the customer
herself if the order came in through ecommerce.
+
+_Payment Information Section_ +
+This section will reflect the type of payment selected by the customer. If
Debit or Credit Card, the card number last 4 digits
+will show; if EFT (Electronic Funds Transfer - electronic checking
withdrawal), the bank account number will appear.
+
+Shipment of the order against customer payment by check or money order will
appear as shown below.
+It might be your practice to withhold shipment until payment is received.
+When it arrives, pull up the order and click on [Receive Payment].
+
+_Order Items Section_ +
+All the products, whether ordered or being sent as promos, are listed here.
Note the many details shown in this section.
+
+* What do we need to ship?
+* Product Information links +
+ Click on the [Catalog] or the [Ecommerce] link to get detailed information
about the product from either of those sources.
+* Inventory is very important. This shows the Inventory ID for the item and
whether enough inventory exists to fill the order.
+ Here the Inventory number given matches the order quantity, indicating
sufficient inventory to fulfill the order.
+* Status, The first line gives the current status. Beneath that is the history
of status changes.
+* Adjustments, Jurisdictions and rates are given for taxes applied. Amounts of
the adjustment are shown in the column
+ to the right.
+* Beneath Adjustments is the Price Rule applied to determine the effective
price for the item.
+* The Ship Groups listed, If the order was being split between two or more
recipients, each would have its own Ship Group
+ with the quantity going to each one being listed. In this instance, there
is only one destination so there is only
+ one Ship Group.
+* Pricing and adjustments information,
+ To the right in this section is all the financial details on each item. When
taking back a return,
+ be sure that no more is credited to the customer than what the order shows
for a charge.
+
+_Actions Section_ +
+[Quick Ship Entire Order] is a powerful link built on a great many assumptions
that everything needful to complete
+the order is in place, including financial arrangements, inventory, manpower
to fulfill the order, etc.
+This powerful action will by-pass many of the normal processing screens,
accomplishing most steps behind the scenes.
+See the topic <<QuickShip Fulfillment Path>> for more details
+
+
+_Shipment Information Section_ +
+Steps for shipping the order start here.
+
+Remember there are two different uses of the word 'Splitting' and you need to
know which meaning is being used.
+When the phrase 'Splitting Preferences' is used here we mean: Does the
customer want a part of his order to be shipped
+as soon as any portion is available, allowing the delayed balance to follow at
a later date?
+If splitting is not desired, all elements of the order must be gathered
together for a unified shipment.
+
+In this order as shown, if you were to click on the link [Allow Split], you
would reverse the customer's original choice
+to wait for all items in one order. Do NOT select that link unless the
customer has informed you of a change in
+her former preference!
+
+When the next item is considered, 'Ship Group,' we would be looking at a Split
Order with part of it going to one destination
+and the other part to another if there were two Ship Groups indicated.
+As the order in this example shows only one Ship Group, you can know that all
items are destined for the same location.
+
+The *[Pack Shipment For Ship Group]* button Initiates the preparation of
packages for shipping the order under
+the Facility Manager. This is just one of many screens where this step can be
triggered.
+
+There are several approaches to having the products Picked and Packed in the
system.
+One method is to open the Facility Manager, click on the Facilities tab,
select your Facility, then click on the Picking tab. +
+After identifying and submitting orders that need Picking to the floor, you
move over to the Packing tab.
+This one is more individualized; you can see the screen shot below. You must
enter the Order number,
+then enter the Product ID for each item as it is accepted. +
+A much easier method is right there in the Order Manager. Pull up the Order
and look under Shipment Information.
+See the link labeled Pack Shipment For Ship Group [00001]? Click on that and
you will see the second screen below.
+
+The link *[New Shipment for Ship Group {00001}]* will bring up a working
screen in the Facility Manager to allow you
+to begin the Warehouse Path, discussed below.
+
+== QuickShip Fulfillment Path
+QuickShip presumes several things:
+
+1. That inventory is on hand and ready to be shipped or taken from the
premises by the purchaser.
+2. That third parties, such a shipping company, a warehouseman, a picker,
etc., are not needed to fulfill the order.
+3. That the method of payment is acceptable: that the customer has paid or
that credit has been extended for payment
+ to be received later.
+
+Essentially, QuickShip allows OFBiz to bypass all of the procedures for
identifying, picking, packing, billing and
+shipping so that the package is immediately dispatched.
+
+. Click on 'Quick-Ship Entire Order'
+. Confirm Quick-Ship Success
+
+and the screen shows
+
+_Under the ' Order #WS10082 Information' section_
+----
+ Status History Current Status: Completed
+ ________________________________
+ Completed - 2006-02-16 20:18:35.281
+ Approved - 2006-02-16 10:11:26.437
+ Created - 2006-02-16 08:29:56.265
+----
+
+_Under the Payment Information section_
+----
+Invoices # [10060] has been added in a new sub-section.
+Click on the Invoice # to view the invoice in the Accounting Manager.
+----
+
+_Under the Shipment Information section_ +
+Splitting Preference no longer presents an opportunity to change the
preference; chosen method is displayed.
+
+Shipments affords two links:
+
+* #[10050] -> Facility Manager > Shipments tab > View Shipment document 10050.
+* [Packing Slip] generates a PDF document for including with the order as a
Packing Slip.
+
+_[Quick-Refund Entire Order]_ link could be used to immediately reverse a
completed order which had been charged to a
+Credit Card, an Electronics Fund Transfer (EFT), or a Gift Card. Best used
before the items leave the Facility.
+If already shipped, use the [Create Return] link.
+
+_[Create Return]_ brings up a working screen to begin the complex process of
bringing products from the customer back
+into your facility, reversing charges, etc.
+
+_The Quick-Ship Shipment document_ +
+Even though the 'Shipment' did not follow a complete course through the
Facility Manager and elsewhere,
+paperwork is still needed to confirm stock deletions and track where products
have gone.
+
+You can see the highlighted 'Shipments #' link. Click on that number to see
the details as shown immediately below.
+
+_View Shipment Details_ +
+In so much as shipping methods were specified in the ordering process (UPS
Ground), this example is somewhat skewed.
+If you knew the customer was going to retrieve the products personally, you
would so indicate in the original order entry
+process.
+
+You will notice in the document that inventory adjustments and other issues
are all presented.
+You can bore down into any of the highlighted links or select one of the
sub-tabs to bring up further details about
+the order, the products, the customer, etc.
+
+A final link to follow is the 'Generate Shipment Manifest Report' which
produces a PDF form to send with the purchaser
+or to serve as a hard copy for your internal purposes. An example is given
below.
+
+== Warehouse Fulfillment Path
+The Sales Order process is not complete until the Shipment is generated.
+This is begun by clicking on the link [New Shipment for Ship Group #].
+
+The following screen in the Facility Manager is sometimes brought up with the
Order Number and little else completed in it.
+
+When you generate the Shipment by clicking on 'New Shipment For Ship Group
[00001]' link,
+your screen might not appear as completed as shown above. Before you enter
information in the address fields,
+for example, try clicking on the [Submit] or [Update] link at the bottom of
the screen.
+The system usually will retrieve these addresses from the Sales Order and from
the Party Profile to enter the address
+ID numbers as you see here.
+
+The Status ID wil generally be updated as you go through the following steps.
+That Status includes Scheduled, Picked, Packed, etc.
+
+If the Order had a desired delivery date, or if you have a good idea what the
shipping dates could or should be,
+here and now is a good time to complete them. Those dates would be the Ready
date, the Ship date and the Receive date.
+The Latest Cancel Date is the last possible moment the order can be canceled
before it is committed to the shipping company.
+
+Destination Facility would seldom be used for retail customers.
+This would be for wholesale customers or established high-volume Business to
Business clients.
+
diff --git
a/applications/order/src/docs/asciidoc/_include/order-create-order-diagrams.adoc
b/applications/order/src/docs/asciidoc/_include/order-create-order-diagrams.adoc
new file mode 100644
index 0000000..62fbe68
--- /dev/null
+++
b/applications/order/src/docs/asciidoc/_include/order-create-order-diagrams.adoc
@@ -0,0 +1,65 @@
+////
+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.
+////
+= Create Order Diagrams
+CSR creates a sales order for the customer from the backend as per the given
information like personal
+details, contact information, billing and shipping information, and payment
terms and methods.
+A customer can create a sales order from the storefront (ecommerce) as well.
+
+Start process with screen
https://demo-trunk.ofbiz.apache.org/ordermgr/control/orderentry?USERNAME=admin&PASSWORD=ofbiz[Order
+ Entry from Order appl on Apache OFBiz demo site,window=_blank]
+
+== Sales Order from Backend Level 1
+image:order/create-sales-order_level1.png[Level 1]
+// diagram have been created with ofbiz.apache wiki
+//on page
https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+
+. <<Order Entry Init,Product Store and Customer Details>>
+. <<Add Item(s) to cart>>
+. <<Quick Finalize Order,Set Shipping Method and Payment Term>>
+. <<Order confirmation,Create Order>>
+
+== Sales Order from Backend Level 2
+image:order/create-sales-order_level2.png[Level 2]
+// diagram have been created with ofbiz.apache wiki
+//on page
https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+
+. <<Order Entry Init,Product Store and Customer Details>>
+. <<_order_currency_agreements_and_ship_dates,Order Name and other
Information>>
+. <<Add Item(s) to cart>>
+. <<Set Shipping address and Group,Set Shipping Address>>
+. <<Order Option Settings,Select Shipping Method>>
+. <<Order Term,Payment Terms>>
+. <<Additional Party Entry>>
+. <<Order confirmation,Create Order>>
+
+== Sales Order from Backend Level 3
+image:order/create-sales-order_level3.png[Level 3]
+// diagram have been created with ofbiz.apache wiki
+//on page
https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+. <<Order Entry Init,Product Store and Customer Details>>
+. <<_order_currency_agreements_and_ship_dates,Add Additional Information>>
+. <<Add Item(s) to cart>>
+. <<Set Shipping address and Group,Set Shipping Address>>
+. <<Order Option Settings,Select Shipping Method>>
+. <<Order Term,Order Terms>>
+. <<Payment setting,Payment Method>>
+. <<Order confirmation,Create Order>>
diff --git
a/applications/order/src/docs/asciidoc/_include/order-ecommerce-entry-path.adoc
b/applications/order/src/docs/asciidoc/_include/order-ecommerce-entry-path.adoc
new file mode 100644
index 0000000..69f7cb6
--- /dev/null
+++
b/applications/order/src/docs/asciidoc/_include/order-ecommerce-entry-path.adoc
@@ -0,0 +1,154 @@
+////
+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.
+////
+= ECommerce Entry path
+On default main screen
https://demo-trunk.ofbiz.apache.org/ecommerce/control/main[eCommerce appl from
Apache OFBiz demo site]
+there are multiple widgets
+
+* Customer-centered widgets
+ ** _language_, If your site is available in more than one language, this
user-friendly feature should be very much appreciated.
+ ** _Mini-Poll Poll_, you can do surveys with your customers here
+ ** _Did you know?_ Marketing facts, comparisons, plugs, promos, whatever,
can be introduced here in a low-key setting.
+ ** _Browse Forums_, links to forums, boards, or other websites are gathered
here.
+ ** _Special Offers_, discounts and special promotions are presented here to
reward the customer for purchases she has made and
+ to encourage additional purchases. He can click on the link [View All
Promotions] to see even more offers
+ than what are presented here.
+* Ordering Process
+ ** _Choose catalog_, +
+ your customer might be ordering from your Spring catalog, your Outdoor
Specials catalog,
+ or whatever electronic Catalog he may have come across online or through
email. Establish or confirm the Catalog here
+ so that details (including prices!) reflect the Catalog he has seen. +
+ You might need additional login programming to arrive at the correct
catalog if the customer is referred here through
+ internet solicitation and linkage; asking the customer to specify the
catalog he saw in the ad is not always productive.
+ The catalog specified here will govern what products, special offers,
discounts, and other details of the marketing process
+ are presented in this screen and for the order itself. All of your
marketing efforts must be coordinated with
+ the presentation now seen by the customer. Your default catalog needs to
be broad enough to cover all the instances where
+ a customer's choices or the login protocol bring him to the default.
+ ** _Find Product_, +
+ opportunities to select and order product abound on this screen.
+ The customer can follow whichever path attracts his interest or matches
his needs.
+ Those sections of the screen are each discussed below, not necessarily in
order of appearance.
+ *** _Featured Products_, +
+ the center of the screen is a list of all or most of the products
under the heading of
+ Featured Products. These can include a photo, description, price,
promotional information, discounts,
+ links to the catalog page, link from Virtual products to their
variations, place to specify quantity being ordered
+ and the most important link: [Add To Cart]. If more than one page of
products is needed, scrolling links are given. +
+ This section of the page is replaced by other functions when in use,
such as search engines, category lists, etc.
+ The customer can always return to this portion of the screen by
clicking on the Main link on the upper Menu bar.
+ **** _Additional information_ +
+ Clicking on the product name either here or anywhere in the screen
will bring up the product detail screen. +
+ Every product name is hotkey to this information which drops into
the center of the screen. You can establish
+ what information will appear for each of your feature products.
+ *** _Last Products_, +
+ Shows the product which the customer has looked at more closely by
clicking on the product name; cumulative until
+ [Clear] is pressed.
+ *** _Quick Reorder_, +
+ Items from previous orders are listed here with a link to add them to
this order in the same quantity as before.
+ **** _Why offer re-order ?_ +
+ Previously ordered items are displayed here. Studies have indicated
that repeat customers are like gold.
+ By presenting them with reminders of their previous purchases, you
are both flattering them and providing an opportunity
+ for another purchase of the same items. +
+ This section also saves the customer from having to lookup the items
she previously ordered. All are presented here. +
+ Doesn't this make the Shopping List concept unnecessary? Not really,
because the Shopping Lists can carry
+ 'Wish Lists' as well as previously ordered items. Also, Shopping
Lists can be plugged into the order 'en masse'
+ rather than item by item. There could be dozens of different Lists,
each tailor-designed for a specific purpose. +
+ For regular, heavy-hitter customers, you might want to limit the list
of previously-ordered items to only
+ the most recent 10 or so.
+ *** _Browse Categories_, +
+ Categories are collections of related items. If the customer is
looking for Books, for example, this would quickly
+ get him to that portion of the inventory with presentations of Book
titles or sub-catgories from which to choose. +
+ Another way to consider this section: whereas the initial screen
might show all the products (with scrolling),
+ the Category selection will eliminate all products displayed except
those in the Category he has chosen.
+ *** _Search in Category_, +
+ A click on [Advanced Search] to have a dedicated search sub-screen +
+ When the [Search In Category] link is selected, a simple but powerful
search tool opens in the center screen.
+ By making a few choices and entering a keyword or two, the customer
can look for products that exist in the Featured
+ Products category. +
+ After a successful find, the customer is presented with a second
screen, titled productFound.
+ Here she has a couple of choices. If the returns are too extensive,
she could refine the search.
+ If she sees what she wants, a quick click on [Add To Cart] will
select the product in whatever quantity she enters.
+ *** _Last Categories_, +
+ As the Customer browses around the screen, looking into various
products, categories, or other content, this section
+ is constantly updated with links back to previously-viewed screens.
+ Therefore, he will be able to quickly return to something that has
stayed in his memory.
+ *** _Browse Content_, +
+ Brings up a powerful tool for searching Content which could be
documents, case studies, test results, testimonials,
+ additional graphics, specifications, or whatever Content you choose
to have accessible to the customer.
+ *** _Search Catalog_, +
+ Entering a term in the search Catalog field resulted in a Product
Search screen with some results. +
+ Customers will use this to search the catalog by keywords, such as
the name of the product or one of its features.
+ You can help their search by keeping the Thesaurus updated.
+* Walk through an order +
+ Let's assume that our phantom customer, Sherry Shopper, has logged in,
selected the Demo Catalog, and is ready to order.
+ We will now follow her through the ordering process.
+ . From previous orders, a click on the Order History link +
+ Shopper repeats previous Order Items by calling [Order History]. Click on
[view] to select +
+ A complete order detail is shown. +
+ Clearly still within the ecommerce website, here the shopper sees details
of the previous order. She has options to
+ [Add All to Cart], [Add Checked to Cart] or request an auto-ship [Send me
this every month]. +
+ By checking on the item she wants to re-order, then clicking on [Add
Checked to Cart], the item (in the same quantity
+ as before) is added to her shopping cart. The screen will not clear out
the earlier order, however, until she selects
+ another process for finding her items. This gives her time to consider
possibly re-ordering another item from the same list.
+ . with Quick Add screen +
+ Now Sherry can select from the drop-down screen to find a different Quick
Add screen, she can add all of the items
+ on this screen, or she can do what she wants, directly enter quantity for
each she want. +
+ If she elects to click on the link to the Giant Widget, the configuration
screen appear, to be able to choose among the
+ variants. +
+ Sherry has choosen Silver over Black in the 4-Wheel version and can now
click to [Add to Cart]
+ (or to the [Add to Shopping List] link).
+ . Final Choices +
+ For her last two items, Sherry chose a His/Her Gizmo (GZ-9290) from the
list of Quick Reorder items in the left-hand panel.
+ Note how each time an item is selected, the display of that item is
removed from the panel. Finally, on impulse,
+ she added a Round Gizmo from the items listed under 'You might be
interested in these as well:'
+ You can see all these purchases now reflected in the Cart Summary. +
+ Four Items were selected; four other were added by the system at no cost
as promos.
+ . View Cart +
+ When [View Cart] is selected, all details of the order-in-progress are
displayed to the shopper. She can change quantities,
+ remove selected items, or even add more products as desired. +
+ .. First, note how even at this point of viewing the cart, there is an
option to quick add another product!
+ From here, the customer can recalculate her cart or continue shopping
(which returns her to the previous screen),
+ or proceed with Checkout.
+ .. Second, there are various promotional messages around this screen to
encourage further shopping.
+ .. Finally, many primary links are available. Notice that the shopper can
go into her Profile, she can view established
+ Shopping Lists that she might have created before, she can look at her
own Shopping History, etc.
+ . Proceed to Checkout
+ .. Confirm the shipping address, using the radio buttons. If a tax
exemption applies, enter details.
+ .. Shipping address and details, confirm the shipping information, method,
split, gift, and other details.
+ .. Payment particulars, both general methods and those on file for Sherry
are shown. Use links to [Single use Credit Card],
+ [Single use ..], etc.., when the order is being billed to an account
not associated with the customer.
+ .. Review the Order to Checkout, Final Review gives the customer the
opportunity to review and confirm all details about the
+ order.
+ .. Submit the order, when the Submit button was selected, behind the
scenes wheels were placed in motion, and the order is
+ prepared to Accepted or Approved. Note the Order #WS10070 near the
upper LH corner, that is the customer's link to this
+ order as well as your tracking number for processing through the
Picking, Packing and Shipping processes.
+
+_Some comments on the process_ +
+The process is or should be as intuitive as possible so the customer is not
frustrated or confused.
+Note the many links provided for shopping, searching for products, finding
promotions, and so forth.
+You might want to add a link to a Customer Service bot where on-line help
could answer their immediate questions.
+The final screen even shows a large [Continue Shopping] link, but the [logout]
link is rather inconspicuous.
+
+Also not discussed yet are the links to [Requests] and [Quotes]. Mechanisms
are in place to let the customer go from
+the ecommerce screen to check on a Request or to view a Quote using links on
the top menu bar.
+
+_Final discussion of the Ecommerce Path_ +
+What we show here is the generic look and feel of an on-line ordering system.
+The applications are there for you to make this reflect your image while
maintaining the underlying tools.
+You do not need to use all of the marketing or redundant convenience processes
shown, but it is good to practice
+running through this system as a shopper to understand how the customer will
interface with your store.
+Let your customer be treated as you would like to be when you shop online.
diff --git a/applications/order/src/docs/asciidoc/order.adoc
b/applications/order/src/docs/asciidoc/_include/order-glossary.adoc
similarity index 60%
copy from applications/order/src/docs/asciidoc/order.adoc
copy to applications/order/src/docs/asciidoc/_include/order-glossary.adoc
index 197fba9..ae1031c 100644
--- a/applications/order/src/docs/asciidoc/order.adoc
+++ b/applications/order/src/docs/asciidoc/_include/order-glossary.adoc
@@ -16,31 +16,14 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= Order
+[glossary]
+= Order Glossary
-The order manager allows you to enter and maintain orders, quotes, requests
and report on them.
+[comment]
+It's important to sort glossary entries in alphabetic order to avoid
duplication or search failing.
-It allow to manage purchase and sales orders from the creation and approval to
the goods packing and shipping.
+[#CSR]
+CSR::
+Customer Service Representative; A customer service representative (CSR) can
place the order on behalf of a customer
+from the back end
-== Overview
-TODO
-
-== Orders management
-
-=== Main screen
-To select Sales and/or Purchase orders
-
-=== Order View
-This screen allow not only to view an order but also to change it
-
-include::_include/order_report.adoc[leveloffset=+1]
-
-== Requests
-
-== Quotes
-
-== Returns
-
-== Requirements
-
-== Stats
\ No newline at end of file
diff --git
a/applications/order/src/docs/asciidoc/_include/order-status-diagrams.adoc
b/applications/order/src/docs/asciidoc/_include/order-status-diagrams.adoc
new file mode 100644
index 0000000..2fe749c
--- /dev/null
+++ b/applications/order/src/docs/asciidoc/_include/order-status-diagrams.adoc
@@ -0,0 +1,48 @@
+////
+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.
+////
+= Order Status
+
+An Order Status is an easy visual indication to alert business about the
orders requiring actions or not. +
+Order status is indicated on <<Order View>> screen on top of main part and
just below there are history of change.
+
+An Order can have the following status:
+
+* Created
+* Approved
+* Processing
+* Sent
+* Held
+* Rejected
+* Completed
+* Cancelled
+
+Status change on actions on order (ex: payment is received) or on direct
action button on <<Order View>> screen
+on main part in top menu bar.
+
+== Order Status diagram
+image:order/manage-order-status.png[Order Status Change]
+// diagram have been created with ofbiz.apache wiki
+//on page
https://cwiki.apache.org/confluence/display/OFBIZ/Sales+Order+Management+Process+Overview
+
+== Approved Order
+f you have an approval process, you will want to check over the details to
confirm that the shipping information is complete
+and accurate, that the billing details are acceptable and that the requested
shipping dates (if specified) are within
+your company's capabilities.
+
+When all is ok click on the [Approve Order] link in <<Order View>>
diff --git
a/applications/order/src/docs/asciidoc/images/order/create-sales-order_level1.png
b/applications/order/src/docs/asciidoc/images/order/create-sales-order_level1.png
new file mode 100644
index 0000000..c4cc7b7
Binary files /dev/null and
b/applications/order/src/docs/asciidoc/images/order/create-sales-order_level1.png
differ
diff --git
a/applications/order/src/docs/asciidoc/images/order/create-sales-order_level2.png
b/applications/order/src/docs/asciidoc/images/order/create-sales-order_level2.png
new file mode 100644
index 0000000..c14e338
Binary files /dev/null and
b/applications/order/src/docs/asciidoc/images/order/create-sales-order_level2.png
differ
diff --git
a/applications/order/src/docs/asciidoc/images/order/create-sales-order_level3.png
b/applications/order/src/docs/asciidoc/images/order/create-sales-order_level3.png
new file mode 100644
index 0000000..c19ec60
Binary files /dev/null and
b/applications/order/src/docs/asciidoc/images/order/create-sales-order_level3.png
differ
diff --git a/applications/order/src/docs/asciidoc/order.adoc
b/applications/order/src/docs/asciidoc/order.adoc
index 197fba9..a2c133a 100644
--- a/applications/order/src/docs/asciidoc/order.adoc
+++ b/applications/order/src/docs/asciidoc/order.adoc
@@ -23,15 +23,145 @@ The order manager allows you to enter and maintain orders,
quotes, requests and
It allow to manage purchase and sales orders from the creation and approval to
the goods packing and shipping.
== Overview
-TODO
-== Orders management
+A sales order is an agreement between a business association and a customer
concerning the delivery of
+products or provision of services. This process involves order capturing,
order status management,
+payment terms and method setup etc.
-=== Main screen
-To select Sales and/or Purchase orders
+A customer can place an order from the storefront or a customer service
representative (CSR) can place
+the order on behalf of a customer from the back end.
+
+=== Business Purpose
+
+A Sales Order from the customer notifies the business of customer wants. It
tells the business who is
+the customer, what are the products or services ordered, what is the payment
term and method, what are
+the billing and shipping addresses, any special instructions for delivery,
order priority etc.
+
+Sales Order document is created in the system with a unique reference number
that comes in handy for
+better customer service afterward. It enables a business to offer the customer
to have a choice
+to change ordered items. The customer also gets the details of the order which
can be accessed through
+his profile on the storefront (eCommerce front) at any time if registered or
else can use the order
+reference number while contacting the business for reporting any issues.
+
+Order status transitions help business to filter orders based on status
(Created, Approved, Rejected,
+Completed etc.) Current order status tells the state of order in the system at
any given time
+which is used effectively by CSRs while communicating with customers over the
phone.
+
+Order payment terms and method tells the business how the order payment is
going to be processed.
+It helps in timely fulfillment of orders, which is key to success for any
business.
+Same is with billing and shipping information on the order, it tells the
business which address
+to be used for invoicing and which one for shipping. Having an effective order
capturing process helps
+to engage your customers.
+
+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.
+
+include::_include/order-create-order-diagrams.adoc[leveloffset=+2]
+
+include::_include/order-status-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.
+
+=== Orders of the day
+Upon opening the Order Manager, your first screen will be a short sale
"dashboard of the day" with:
+* the new sales orders (enter today)
+* the top 5 of the product sales today
+
+This screen is a portal page, so in some case it's possible to choose which
portlet to put.
+
+On the first part, only order with status and type selected in the <Order
List> screen appears.
+For example, if you work on purchase department, on Order List screen, if you
select purchase type and only
+Approved status, on the main screen you will will see only purchase order
created today and already in approved status.
+
+Even if this screen is useful, it's also a example a developer can personalize
to give orders to follow in your business situation.
+
+=== List Orders
+The focus of this screen is order status +
+retrieve all orders for one type and a selection of status.
+
+It lists all the current orders in need of processing. You should spot the one
prepared above in the list;
+click on the Order Number to proceeed. If too many orders are listed in the
first screen (List Orders),
+unclick the 'Approved' checkbox and click on [Submit].
+If still too many, unclick either the 'Created' or the 'Processing' status
checkbox and try again.
+
+Using the check boxes and the [Submit] link, you will bring up a list of all
orders in any category selected.
+
+Order list give you main information on parties associated to the order and a
link to the order details.
+
+To narrow your search, use the Find Orders tab.
+This brings up a complete search screen which will take any possible
parameters to find the one you want to work with.
+
+=== Find Orders
+This screen brings up a complete search screen which will take any possible
parameters.
+
+Enter information about the order and click on [Find]. +
+Existing Orders are listed and you can complete it or modify it, if that is
what the customer is calling for. +
+Or, reduce the number or Orders presented by entering parameters in the search
screen,
+above (you may need to click [Show Lookup Fields] and trying to find what you
want more specifically.
+
+There is a direct action button on the top left of the list, to directly
change status
+
+* choose the action to be done in the drop-down
+* select one orders or more
+* click on <run action>
+
+In the Order list, there will be a link from that order to the PartyID; +
+click on the ID and you are in the Party Manager > Profile page for the
customer. +
+On the profile page, one of the links there is [New Order] which takes you
back to the initial Order Entry screen, discussed below.
+
+If specifics about the order are not known, you might prefer to find it
through the Party.
+In that case, select [Lookup Party]. The Party Manager can link you back to
previous orders.
+
+include::_include/Help-order-view.adoc[leveloffset=+2]
+
+include::_include/Help-order-entry.adoc[leveloffset=+2]
+
+include::_include/Help-order-check-inits.adoc[leveloffset=+2]
+
+include::_include/Help-order-show-cart.adoc[leveloffset=+2]
+
+=== Quick Finalize Order
+In this screen you have a summary of 3 screens for details look at
+
+* <<Set Shipping address and Group>>
+* <<Order Option Settings>>
+* <<Payment setting>>
+
+include::_include/Help-order-ship-setting.adoc[leveloffset=+2]
+
+include::_include/Help-order-option-settings.adoc[leveloffset=+2]
+
+include::_include/Help-order-bill-settings.adoc[leveloffset=+2]
+
+include::_include/Help-order-confirm.adoc[leveloffset=+2]
+
+== Orders Processes
+
+=== Order Entry
+Order entry can come from 2 path, Order management (back office) and eCommerce.
+
+The company's order entry process is discussed below under the Order Manager
Path.
+You may jump there directly if you wish. Both the ecommerce entry and the
Order Manager entry methods
+are discussed in this section to the point where the order entry is finished
and Order Approval is needed before proceeding.
+It is valuable for you to be familiar with the ecommerce order entry process
so that when a customer writes
+or calls in with a problem from that process you can be understanding and
helpful.
+
+Remember that an order can be canceled anytime up to the final confirmation
point!
+Encourage your staff, especially your customer service people, to walk through
an on-line order.
+They should try to see what happens when clicking on links or following paths
that they wouldn't ordinarily follow,
+just to see what happens! Then, when a customer describes their situation,
+you can relate to what they are seeing on their screen.
+
+==== Order Manager path
+
+Start process with screen
https://demo-trunk.ofbiz.apache.org/ordermgr/control/orderentry[Order Entry
from Order appl on Apache OFBiz demo site]
+and have a look at <<Create Order Diagrams>>
+
+include::_include/order-ecommerce-entry-path.adoc[leveloffset=+3]
-=== Order View
-This screen allow not only to view an order but also to change it
include::_include/order_report.adoc[leveloffset=+1]
@@ -43,4 +173,6 @@ include::_include/order_report.adoc[leveloffset=+1]
== Requirements
-== Stats
\ No newline at end of file
+== Stats
+
+include::_include/order-glossary.adoc[leveloffset=+1]
\ No newline at end of file
diff --git a/applications/order/widget/ordermgr/OrderEntryCartScreens.xml
b/applications/order/widget/ordermgr/OrderEntryCartScreens.xml
index d0ee84e..b80b5d4 100644
--- a/applications/order/widget/ordermgr/OrderEntryCartScreens.xml
+++ b/applications/order/widget/ordermgr/OrderEntryCartScreens.xml
@@ -76,6 +76,7 @@ under the License.
</condition-list>
<order-by field-name="productPromoId"/>
</entity-condition>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_add_items_to_cart"/>
</actions>
<widgets>
<decorator-screen name="CommonOrderEntryDecorator"
location="component://order/widget/ordermgr/OrderEntryCommonScreens.xml">
diff --git a/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml
b/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml
index 3187b2f..a2ed643 100644
--- a/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml
+++ b/applications/order/widget/ordermgr/OrderEntryOrderScreens.xml
@@ -50,6 +50,7 @@ under the License.
<actions>
<set field="headerItem" value="orderentry"/>
<set field="titleProperty" value="PageTitleCheckoutOptions"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_quick_finalize_order"/>
<script
location="component://order/groovyScripts/entry/CheckoutPayment.groovy"/>
<script
location="component://order/groovyScripts/entry/CheckoutOptions.groovy"/>
<script
location="component://order/groovyScripts/entry/StorePaymentOptions.groovy"/>
@@ -91,6 +92,7 @@ under the License.
<set field="stepTitleId"
value="OrderOrderEntryShipToSettings"/>
<set field="stepLabelId" value="FacilityShipping"/>
<script
location="component://order/groovyScripts/entry/ShipSettings.groovy"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_set_shipping_address_and_group"/>
</actions>
<widgets>
<decorator-screen name="CommonOrderCheckoutDecorator">
@@ -137,6 +139,7 @@ under the License.
<set field="stepTitleId" value="SetItemShipGroups"/>
<set field="stepLabelId" value="OrderShipGroups"/>
<script
location="component://order/groovyScripts/entry/SetShoppingCart.groovy"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_set_item_to_shipgroup"/>
</actions>
<widgets>
<decorator-screen name="CommonOrderCheckoutDecorator">
@@ -156,6 +159,7 @@ under the License.
<set field="stepLabelId" value="CommonOptions"/>
<script
location="component://order/groovyScripts/entry/OptionSettings.groovy"/>
<property-to-field resource="order"
property="orderPreference.giftEnable" field="giftEnable" default="Y"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_order_option_settings"/>
</actions>
<widgets>
<decorator-screen name="CommonOrderCheckoutDecorator">
@@ -184,6 +188,7 @@ under the License.
<set field="stepLabelId" value="AccountingPayment"/>
<script
location="component://order/groovyScripts/entry/BillSettings.groovy"/>
<script
location="component://order/groovyScripts/entry/StorePaymentOptions.groovy"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_payment_setting"/>
</actions>
<widgets>
<decorator-screen name="CommonOrderCheckoutDecorator">
@@ -204,7 +209,8 @@ under the License.
<set field="stepLabelId" value="PartyParties"/>
<script
location="component://order/groovyScripts/entry/SetAdditionalParty.groovy"/>
<script
location="component://order/groovyScripts/entry/AdditionalPartyListing.groovy"/>
-
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_additional_party_entry"/>
+
<!-- asmselect parameters, must be prefixed by asm_ for
SetMultipleSelectJs.ftl -->
<!--set field="asm_multipleSelectForm"
value="addAdditionalPartyForm"/>
<set field="asm_multipleSelect" value="additionalRoleTypeId"/>
@@ -212,7 +218,7 @@ under the License.
<set field="asm_asmListItemPercentOfForm" value="95"/>
<set field="asm_sortable" value="false"/>
<property-map resource="OrderUiLabels" map-name="uiLabelMap"
global="true"/>
- <set field="asm_title"
value="${uiLabelMap.OrderPartySelectRoleForParty}"/-->
+ <set field="asm_title"
value="${uiLabelMap.OrderPartySelectRoleForParty}"/-->
</actions>
<widgets>
<decorator-screen name="CommonOrderCheckoutDecorator">
@@ -235,6 +241,7 @@ under the License.
<set field="stepTitleId" value="OrderOrderEntryOrderTerms"/>
<set field="stepLabelId" value="OrderOrderTerms"/>
<script
location="component://order/groovyScripts/entry/OrderTerms.groovy"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_order_term"/>
</actions>
<widgets>
<decorator-screen name="CommonOrderCheckoutDecorator">
@@ -254,6 +261,7 @@ under the License.
<set field="stepLabelId" value="OrderReviewOrder"/>
<property-to-field resource="order"
property="orderPreference.giftEnable" field="giftEnable" default="Y"/>
<script
location="component://order/groovyScripts/entry/CheckoutReview.groovy"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_order_confirmation"/>
</actions>
<widgets>
<decorator-screen name="CommonOrderCheckoutDecorator">
diff --git a/applications/order/widget/ordermgr/OrderEntryScreens.xml
b/applications/order/widget/ordermgr/OrderEntryScreens.xml
index 68353c7..19c45f6 100644
--- a/applications/order/widget/ordermgr/OrderEntryScreens.xml
+++ b/applications/order/widget/ordermgr/OrderEntryScreens.xml
@@ -23,6 +23,7 @@ under the License.
<actions>
<set field="titleProperty" value="PageTitleOrderInits"/>
<set field="headerItem" value="orderentry"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_order_entry"/>
<script
location="component://order/groovyScripts/entry/CheckInits.groovy"/>
</actions>
<widgets>
@@ -39,6 +40,7 @@ under the License.
<actions>
<set field="titleProperty" value="PageTitleOrderAgreements"/>
<set field="headerItem" value="orderentry"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_order_currency_agreements_and_ship_dates"/>
<script
location="component://order/groovyScripts/entry/OrderAgreements.groovy"/>
</actions>
<widgets>
diff --git a/applications/order/widget/ordermgr/OrderViewScreens.xml
b/applications/order/widget/ordermgr/OrderViewScreens.xml
index b1471d3..3c5e2fb 100644
--- a/applications/order/widget/ordermgr/OrderViewScreens.xml
+++ b/applications/order/widget/ordermgr/OrderViewScreens.xml
@@ -40,6 +40,7 @@ under the License.
</condition>
<actions>
<set field="headerItem" value="main"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_orders_of_the_day"/>
</actions>
<widgets>
<decorator-screen name="main-decorator"
location="${parameters.mainDecoratorLocation}">
@@ -55,6 +56,7 @@ under the License.
<actions>
<set field="titleProperty" value="OrderViewOrder"/>
<set field="headerItem" value="findorders"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_order_view"/>
<set field="layoutSettings.javaScripts[]"
value="/ordermgr-js/order.js" global="true"/>
<set field="layoutSettings.javaScripts[]"
value="/ordermgr-js/OrderShippingInfo.js" global="true"/>
<set field="layoutSettings.javaScripts[]"
value="/ordermgr-js/geoAutoCompleter.js" global="true"/>
@@ -205,6 +207,7 @@ under the License.
<actions>
<set field="titleProperty" value="OrderLookupOrder"/>
<set field="headerItem" value="orderlist"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_list_orders"/>
<set field="filterDate" type="Timestamp"
from-field="parameters.filterDate"/>
<script
location="component://order/groovyScripts/order/OrderList.groovy"/>
<script
location="component://order/groovyScripts/order/FilterOrderList.groovy"/>
@@ -249,6 +252,7 @@ under the License.
<actions>
<set field="titleProperty" value="OrderFindOrder"/>
<set field="headerItem" value="findorders"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_find_orders"/>
<script
location="component://order/groovyScripts/order/FindOrders.groovy"/>
<script
location="component://content/groovyScripts/print/FindPrinters.groovy"/>
diff --git a/applications/party/src/docs/asciidoc/party.adoc
b/applications/party/src/docs/asciidoc/party.adoc
index 94f6d65..1a3f8f2 100644
--- a/applications/party/src/docs/asciidoc/party.adoc
+++ b/applications/party/src/docs/asciidoc/party.adoc
@@ -56,6 +56,19 @@ In the "Main Roletype" column the role is listed which is a
child of the "Main r
It is currently set to "Organisation" and "SFA Role". The later to be prepared
to use he party in he SFA component.
See the <<_marketing,marketing application>> for more information
+==== From Party to Order
+This screen can be a starting point for Order management (view existing,
create a new one, ...).
+
+For each Parties listed, there are links to Order management action.
+
+Before taking the order, you might want to update the party's information:
+is the address and phone number current, how will they be paying for the order
(credit card number current?
+EFT information correct?), or perhaps review their ordering history (are there
an excessive number of returns?).
+To look at their file, either click on the [Party ID] or the [Details] link.
+
+If the contact from your customer is specifically about a previous order, you
can click on the [Orders]
+link which will take you to a table of all their previous orders.
+
== Parties Processes
include::_include/party-howto-create-mainCompany.adoc[leveloffset=+2]
