[ofbiz-framework] branch trunk updated (51ff39c -> 56f164d)
Locked
 
|
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git. from 51ff39c Documented: migrate help link to asciidoc user manual for SFA (OFBIZ-11577) new 00176a2 Documented: Order migration to asciidoc (OFBIZ-11580) new 56f164d Documented: migrate help link to asciidoc user manual for Order (OFBIZ-11580) The 2 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: .../order/data/{helpdata => }/HELP_ORDERMGR.xml | 5 +- applications/order/data/OrderHelpData.xml | 17 +--- .../order/data/helpdata/HELP_ORDERMGR_Report.xml | 99 ---------------------- .../order/data/helpdata/HELP_ORDERMGR_View.xml | 21 ----- .../src/docs/asciidoc/_include/order_report.adoc | 60 +++++++++++++ .../src/docs/asciidoc/order.adoc} | 29 +++++-- .../order/widget/ordermgr/CommonScreens.xml | 1 + .../order/widget/ordermgr/ReportScreens.xml | 3 +- docs/asciidoc/user-manual.adoc | 2 + 9 files changed, 93 insertions(+), 144 deletions(-) rename applications/order/data/{helpdata => }/HELP_ORDERMGR.xml (81%) delete mode 100644 applications/order/data/helpdata/HELP_ORDERMGR_Report.xml delete mode 100644 applications/order/data/helpdata/HELP_ORDERMGR_View.xml create mode 100644 applications/order/src/docs/asciidoc/_include/order_report.adoc copy applications/{humanres/src/docs/asciidoc/_include/HELP-hr-NewEmployee.adoc => order/src/docs/asciidoc/order.adoc} (66%) |
|
|
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 00176a26c225a7d08f3b6762813a04cfa9931706 Author: holivier <[hidden email]> AuthorDate: Fri Apr 3 14:39:53 2020 +0200 Documented: Order migration to asciidoc (OFBIZ-11580) For all of HELP_Order files content has been directly put in order.adoc except for order_report which has its own file user-manual is updated to include it in. --- .../src/docs/asciidoc/_include/order_report.adoc | 60 ++++++++++++++++++++++ applications/order/src/docs/asciidoc/order.adoc | 44 ++++++++++++++++ docs/asciidoc/user-manual.adoc | 2 + 3 files changed, 106 insertions(+) diff --git a/applications/order/src/docs/asciidoc/_include/order_report.adoc b/applications/order/src/docs/asciidoc/_include/order_report.adoc new file mode 100644 index 0000000..e64859e --- /dev/null +++ b/applications/order/src/docs/asciidoc/_include/order_report.adoc @@ -0,0 +1,60 @@ +//// +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. +//// += Help for Order Reports + +The Order Reports provide general information about orders in the system. + +== Initial steps. +If your reports look empty it may be required to initialize the warehouse entities in the BI component. + +. Go to :https://localhost:8443/bi/control/main[Business Intelligence] +. Click "Quick Init DataWarehouse". System will automatic initial Data in the warehouse for Reports +. Go back to : https://localhost:8443/ordermgr/control/OrderPurchaseReportOptions[Order Reports.] + +== Reports List +=== 1. Sales Order By Referrer Report +There are referrers, link, totals orders, quantity totals and amount totals. +They are grouped by referrer. + +=== 2. Sales Order By Channel Report +There are total Orders, total Items, quantity totals and amount totals. +They are grouped by Sales Channel. + +=== 3. Sale Orders Discount Code Report +There are order, product, promotion and discount. +This report is list of All orders. + +=== 4. Last Three Months Sales Report +There are products, prices, stock, sale out quantity and sale out total amount. +This report is list of all products, it contains the sales and movements in last 3 months. + +=== 5. Coupon Sales Report +This report lists promotions, total orders, percent of total orders, total orders amount, percent of total orders amount and shipping amounts. + +=== 6. Sales Report +This Sales report contains paid and unpaid sales orders. + +=== 7. Net Before Overhead Report +Net Before Overhead Report is the profit calculation of paid-shipped orders and all the occurred fee excluding the overhead cost. +They are grouped by Product Store Id.(Demo data for Net Before Overhead Report have in Product Store Id "B2CStore") + +=== 8. Product Demand Report +Product Demand Report is the report to show us which product sells good and which product doesn't sell good or +not selling at all in one account as well as for all accounts in last 4 weeks. +They are grouped by Product Store Id.(Demo data for Product Demand Report have in Product Store Id "B2CStore") diff --git a/applications/order/src/docs/asciidoc/order.adoc b/applications/order/src/docs/asciidoc/order.adoc new file mode 100644 index 0000000..d6d4428 --- /dev/null +++ b/applications/order/src/docs/asciidoc/order.adoc @@ -0,0 +1,44 @@ +//// +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 Component + +The order manager allows you to enter and maintain orders, quotes, requests and report on them. + +== 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/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index 0c81f3d..99449b5 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -164,3 +164,5 @@ include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[l include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+2] include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+2] + +include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+2] |
|
|
In reply to this post by holivier
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 56f164d3a819e54f0053f957b021ce56dcf141e0 Author: holivier <[hidden email]> AuthorDate: Thu Jul 2 12:06:08 2020 +0200 Documented: migrate help link to asciidoc user manual for Order (OFBIZ-11580) All files have been migrated to asciidoc format and help link now point to the html file generated from the asciidoc files In the global Help Docbook index tree, remove all points about Order and add a short page with a link to the new help Remove docbook help files for Order --- .../order/data/{helpdata => }/HELP_ORDERMGR.xml | 5 +- applications/order/data/OrderHelpData.xml | 17 +--- .../order/data/helpdata/HELP_ORDERMGR_Report.xml | 99 ---------------------- .../order/data/helpdata/HELP_ORDERMGR_View.xml | 21 ----- applications/order/src/docs/asciidoc/order.adoc | 2 +- .../order/widget/ordermgr/CommonScreens.xml | 1 + .../order/widget/ordermgr/ReportScreens.xml | 3 +- 7 files changed, 11 insertions(+), 137 deletions(-) diff --git a/applications/order/data/helpdata/HELP_ORDERMGR.xml b/applications/order/data/HELP_ORDERMGR.xml similarity index 81% rename from applications/order/data/helpdata/HELP_ORDERMGR.xml rename to applications/order/data/HELP_ORDERMGR.xml index 8f21aca..42fe21e 100644 --- a/applications/order/data/helpdata/HELP_ORDERMGR.xml +++ b/applications/order/data/HELP_ORDERMGR.xml @@ -17,8 +17,11 @@ version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" xmlns="http://docbook.org/ns/docbook"> - <title>Order Introduction</title> + <title>Order Help redirection</title> <para> The order manager allows you to enter and maintain orders, quotes, requests and report on them. </para> + <para>Order Help has been migrated to a new system, you can access it by using + <link xl:href="https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_order">OFBiz user documentation site / Order</link> + </para> </section> diff --git a/applications/order/data/OrderHelpData.xml b/applications/order/data/OrderHelpData.xml index 9e44287..9ac802a 100644 --- a/applications/order/data/OrderHelpData.xml +++ b/applications/order/data/OrderHelpData.xml @@ -18,22 +18,11 @@ specific language governing permissions and limitations under the License. --> <entity-engine-xml> - <DataResource dataResourceId="HELP_ORDERMGR" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/order/data/helpdata/HELP_ORDERMGR.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" + <DataResource dataResourceId="HELP_ORDERMGR" localeString="en" dataResourceTypeId="OFBIZ_FILE" + objectInfo="applications/order/data/HELP_ORDERMGR.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Order" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="HELP_ORDERMGR" contentTypeId="DOCUMENT" contentName="Order Manager" templateDataResourceId="HELP_TEMPL" + <Content contentId="HELP_ORDERMGR" contentTypeId="DOCUMENT" contentName="Order Manager" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_ORDERMGR" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_ORDERMGR" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/> - <!-- Order View --> - <DataResource dataResourceId="HELP_ORDERMGR_VIEW" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/order/data/helpdata/HELP_ORDERMGR_View.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Ebay" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="HELP_ORDERMGR_VIEW" contentTypeId="DOCUMENT" contentName="Order View Help" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_ORDERMGR_VIEW" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> - <ContentAssoc contentId="HELP_ORDERMGR" contentIdTo="HELP_ORDERMGR_VIEW" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="ORDERMGR_orderview"/> - - <!-- Reports --> - <DataResource dataResourceId="HELP_ORDERMGR_REPORT" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/order/data/helpdata/HELP_ORDERMGR_Report.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Ebay" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="HELP_ORDERMGR_REPORT" contentTypeId="DOCUMENT" contentName="Order Reports Help" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_ORDERMGR_REPORT" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> - <ContentAssoc contentId="HELP_ORDERMGR" contentIdTo="HELP_ORDERMGR_REPORT" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="ORDERMGR_OrderPurchaseReportOptions"/> </entity-engine-xml> diff --git a/applications/order/data/helpdata/HELP_ORDERMGR_Report.xml b/applications/order/data/helpdata/HELP_ORDERMGR_Report.xml deleted file mode 100644 index 1d6cf20..0000000 --- a/applications/order/data/helpdata/HELP_ORDERMGR_Report.xml +++ /dev/null @@ -1,99 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>Order Reports Help.</title> - <para> - The Order Reports provide general information about orders in the system. - </para> - <section> - <title> - Initial steps. - </title> - <section> - <para> - If your reports look empty it may be required to initialize the warehouse entities in the BI component. - </para> - <orderedlist> - <listitem> - <para>Go to :<link xl:href="https://localhost:8443/bi/control/main">Business Intelligence</link></para> - </listitem> - <listitem> - <para>Click "Quick Init DataWarehouse". System will automatic initial Data in the warehouse for Reports</para> - </listitem> - <listitem> - <para>Go back to : <link xl:href="https://localhost:8443/ordermgr/control/OrderPurchaseReportOptions">Order Reports.</link></para> - </listitem> - </orderedlist> - </section> - </section> - <section> - <title>Reports List</title> - <section> - <title>1. Sales Order By Referrer Report</title> - <para> - There are referrers, link, totals orders, quantity totals and amount totals. They are grouped by referrer. - </para> - </section> - <section> - <title>2. Sales Order By Channel Report</title> - <para> - There are total Orders, total Items, quantity totals and amount totals. They are grouped by Sales Channel. - </para> - </section> - <section> - <title>3. Sale Orders Discount Code Report</title> - <para> - There are order, product, promotion and discount. This report is list of All orders. - </para> - </section> - <section> - <title>4. Last Three Months Sales Report</title> - <para> - There are products, prices, stock, sale out quantity and sale out total amount. - This report is list of all products, it contains the sales and movements in last 3 months. - </para> - </section> - <section> - <title>5. Coupon Sales Report</title> - <para> - This report lists promotions, total orders, percent of total orders, total orders amount, percent of total orders amount and shipping amounts. - </para> - </section> - <section> - <title>6. Sales Report</title> - <para> - This Sales report contains paid and unpaid sales orders. - </para> - </section> - <section> - <title>7. Net Before Overhead Report</title> - <para> - Net Before Overhead Report is the profit calculation of paid-shipped orders and all the occurred fee excluding the overhead cost. - They are grouped by Product Store Id.(Demo data for Net Before Overhead Report have in Product Store Id "B2CStore") - </para> - </section> - <section> - <title>8. Product Demand Report</title> - <para> - Product Demand Report is the report to show us which product sells good and which product doesn’t sell good or not selling at all in one account as well as for all accounts in last 4 weeks. - They are grouped by Product Store Id.(Demo data for Product Demand Report have in Product Store Id "B2CStore") - </para> - </section> - </section> -</section> diff --git a/applications/order/data/helpdata/HELP_ORDERMGR_View.xml b/applications/order/data/helpdata/HELP_ORDERMGR_View.xml deleted file mode 100644 index 1305455..0000000 --- a/applications/order/data/helpdata/HELP_ORDERMGR_View.xml +++ /dev/null @@ -1,21 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>Order View</title> - <para> This screen allow not only to view an order but also to change it (this is a mock to hide a weird bug, please fill in...)</para> -</section> diff --git a/applications/order/src/docs/asciidoc/order.adoc b/applications/order/src/docs/asciidoc/order.adoc index d6d4428..4a2e9c4 100644 --- a/applications/order/src/docs/asciidoc/order.adoc +++ b/applications/order/src/docs/asciidoc/order.adoc @@ -16,7 +16,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. //// -= Order Component += Order The order manager allows you to enter and maintain orders, quotes, requests and report on them. diff --git a/applications/order/widget/ordermgr/CommonScreens.xml b/applications/order/widget/ordermgr/CommonScreens.xml index 6907e90..533909b 100644 --- a/applications/order/widget/ordermgr/CommonScreens.xml +++ b/applications/order/widget/ordermgr/CommonScreens.xml @@ -44,6 +44,7 @@ under the License. <set field="activeApp" value="ordermgr" global="true"/> <set field="applicationMenuName" value="OrderAppBar" global="true"/> <set field="applicationMenuLocation" value="component://order/widget/ordermgr/OrderMenus.xml" global="true"/> + <set field="helpAnchor" from-field="helpAnchor" default-value="_order"/> <set field="applicationTitle" from-field="uiLabelMap.OrderManagerApplication" global="true"/> <!-- globally parameterize the link to a customer's detail information, to help with cases when such details are accessed via external application. --> <set field="customerDetailLink" value="/partymgr/control/viewprofile?partyId=" global="true"/> diff --git a/applications/order/widget/ordermgr/ReportScreens.xml b/applications/order/widget/ordermgr/ReportScreens.xml index 84ba15c..c2470d0 100644 --- a/applications/order/widget/ordermgr/ReportScreens.xml +++ b/applications/order/widget/ordermgr/ReportScreens.xml @@ -26,6 +26,7 @@ under the License. <actions> <set field="titleProperty" value="OrderReports"/> <set field="headerItem" value="reports"/> + <set field="helpAnchor" value="_help_for_order_reports"/> </actions> <widgets> <decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}"> @@ -205,7 +206,7 @@ under the License. <property-map resource="ProductUiLabels" map-name="uiLabelMap" global="true"/> <property-map resource="PartyUiLabels" map-name="uiLabelMap" global="true"/> <property-map resource="CommonUiLabels" map-name="uiLabelMap" global="true"/> - + <entity-condition entity-name="OrderReportSalesGroupByProduct" list="productReportList"> <condition-list combine="and"> <!-- this can use the other view, so long as the filter is by SALES_ORDER and fromPartyId = ProductStore.payToPartyId if provided --> |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |