This is an automated email from the ASF dual-hosted git repository.
mbrohl 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 3ebb9f6 Documented: All setup help file in docbook format migration to asciidoc format (OFBIZ-11363) 3ebb9f6 is described below commit 3ebb9f6bbc1aaa6b9cd9798ae2bed13f1b5eb926 Author: holivier <[hidden email]> AuthorDate: Fri Feb 21 11:42:01 2020 +0100 Documented: All setup help file in docbook format migration to asciidoc format (OFBIZ-11363) ofbiz-setup.adoc included all setup files and user-documentation.adoc include ofbiz-setup --- .../commonext/data/helpdata/HELP_SETUP.xml | 61 ----------------- .../data/helpdata/HELP_SETUP_editFacility.xml | 70 -------------------- .../data/helpdata/HELP_SETUP_editProductStore.xml | 66 ------------------- .../data/helpdata/HELP_SETUP_editWebSite.xml | 72 -------------------- .../data/helpdata/HELP_SETUP_firstProdCatalog.xml | 67 ------------------- .../helpdata/HELP_SETUP_firstProductCategory.xml | 66 ------------------- .../data/helpdata/HELP_SETUP_firstcustomer.xml | 47 ------------- .../data/helpdata/HELP_SETUP_firstproduct.xml | 76 ---------------------- .../data/helpdata/HELP_SETUP_initialsetup.xml | 45 ------------- .../data/helpdata/HELP_SETUP_profileCompany.xml | 30 --------- .../docs/asciidoc/_include/HELP_initialsetup.adoc | 35 ++++++++++ .../asciidoc/_include/HELP_setup_editFacility.adoc | 39 +++++++++++ .../_include/HELP_setup_editProductStore.adoc | 41 ++++++++++++ .../asciidoc/_include/HELP_setup_editWebSite.adoc | 39 +++++++++++ .../_include/HELP_setup_firstProdCatalog.adoc | 38 +++++++++++ .../_include/HELP_setup_firstProductCategory.adoc | 36 ++++++++++ .../_include/HELP_setup_firstcustomer.adoc | 32 +++++++++ .../asciidoc/_include/HELP_setup_firstproduct.adoc | 39 +++++++++++ .../commonext/src/docs/asciidoc/ofbiz-setup.adoc | 72 ++++++++++++++++++++ docs/asciidoc/user-manual.adoc | 4 +- 20 files changed, 374 insertions(+), 601 deletions(-) diff --git a/applications/commonext/data/helpdata/HELP_SETUP.xml b/applications/commonext/data/helpdata/HELP_SETUP.xml deleted file mode 100644 index 69e1140..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP.xml +++ /dev/null @@ -1,61 +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>The OFBiz Setup application Overview</title> - <para> - The OFBiz Setup application is supporting for immediate setup your organization. For example, Product Store, WebSite , Facility , product catalog, category - , product, and etc. and then be able to create orders from data that is created. - </para> - <section> - <title>Why we have OFBiz Setup Application?</title> - <warning> - <para> - For manual setup instructions, please see the <ulink url="https://cwiki.apache.org/confluence/display/OFBENDUSER/Apache+OFBiz+Business+Setup+Guide">Business Setup Guide</ulink> on the wiki. - </para> - </warning> - <para> - If you are the company and also want to use OFBiz for running your business then you easily be able to setting your information for start running - the system quickly via The OFBiz Setup Application. - </para> - </section> - <section> - <title>How to get started.</title> - <para>1. Open a new terminal.</para> - <para>2. Go to your ofbiz directory.</para> - <para>3. Clean out all built classes with : ./ant clean-all </para> - <para>4. Load the seed data with : ./ant load-extseed </para> - <para>5. Create the admin user with : ./ant create-admin-user-login , then enter a user login id that will be created for you (the initial temporary password is "ofbiz")</para> - <para>6. Start ofbiz with : ./startofbiz.sh </para> - <para>7. Connect to the OFBiz Setup application with your browser at https://localhost:8443/ofbizsetup.</para> - </section> - <xi:include href="HELP_SETUP_initialsetup.xml" /> - <xi:include href="HELP_SETUP_editFacility.xml" /> - <xi:include href="HELP_SETUP_editProductStore.xml" /> - <xi:include href="HELP_SETUP_editWebSite.xml" /> - <xi:include href="HELP_SETUP_firstcustomer.xml"/> - <xi:include href="HELP_SETUP_firstProdCatalog.xml"/> - <xi:include href="HELP_SETUP_firstProductCategory.xml" /> - <xi:include href="HELP_SETUP_firstproduct.xml" /> - <xi:include href="HELP_SETUP_profileCompany.xml" /> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_editFacility.xml b/applications/commonext/data/helpdata/HELP_SETUP_editFacility.xml deleted file mode 100644 index 0e5ac78..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_editFacility.xml +++ /dev/null @@ -1,70 +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>The OFBiz Setup Edit Facility help screen.</title> - <para> The Edit Facility help screen is used to manage a warehouse, a store with related inventory. </para> - <section> - <title>How do I create a facility?</title> - <para> - <orderedlist> - <listitem> - <para>Select the 'Facility' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Enter the 'Facility Id' field (NOTE: If you do not enter the 'Facility Id' field it will be used the default as - 'Organization Party Id')</para> - </listitem> - <listitem> - <para>Enter the 'Name' field </para> - </listitem> - <listitem> - <para>Enter a description describing what the line item is </para> - </listitem> - <listitem> - <para>Enter a number in the 'Default Days To Ship ' field</para> - </listitem> - <listitem> - <para>Press the 'Save' button</para> - </listitem> - </orderedlist> - </para> - </section> - <section> - <title>How do I update a facility?</title> - <para>Not all the fields on the facility can be updated. For example Facility Id cannot be updated. If these fields need to be amended then - the facility will need to be removed and then re-created.</para> - <para> - <orderedlist> - <listitem> - <para>Select the 'Facility' sub menu and the screen will be displayed: Any existing line items will be displayed in the 'Items' - box</para> - </listitem> - <listitem> - <para>Amend the details in the line item that needs to be updated (eg Name, Description, Default Days To Ship)</para> - </listitem> - <listitem> - <para>Press the 'Update' button displayed at the end of the line item that has been updated </para> - </listitem> - </orderedlist> - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_editProductStore.xml b/applications/commonext/data/helpdata/HELP_SETUP_editProductStore.xml deleted file mode 100644 index b12511c..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_editProductStore.xml +++ /dev/null @@ -1,66 +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>The OFBiz Setup Edit Product Store help screen.</title> - <para> The Product Store screen is used to manage a store with has all the information needed to sell products. For example shippings ,a series of - catalogs, which are composed of product categories and products , and also used to configure the payment processing settings , fulfillment, - notification, promotions, payment processing, and tax calculation policies , and etc. </para> - <section> - <title>How do I create a Product Store?</title> - <para> - <orderedlist> - <listitem> - <para>Select the 'Product Store' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Enter the 'Product Store Id' field (NOTE: If you do not enter the 'Product Store Id' field it will be used the default as - 'Organization Party Id')</para> - </listitem> - <listitem> - <para>Enter the 'Store Name' field </para> - </listitem> - <listitem> - <para>Press the 'Update' button</para> - </listitem> - </orderedlist> - </para> - </section> - <section> - <title>How do I update a Product Store?</title> - <para>Not all the fields on the Product Store can be updated. For example Product Store Id cannot be updated. If these fields need to be - amended then the Product Store will need to be removed and then re-created.</para> - <para> - <orderedlist> - <listitem> - <para>Select the 'Product Store' sub menu and the screen will be displayed: Any existing Product Store will be displayed in the - 'Items' box</para> - </listitem> - <listitem> - <para>Amend the details in the line item that needs to be updated (eg Store Name)</para> - </listitem> - <listitem> - <para>Press the 'Update' button displayed at the end of the line item that has been updated </para> - </listitem> - </orderedlist> - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_editWebSite.xml b/applications/commonext/data/helpdata/HELP_SETUP_editWebSite.xml deleted file mode 100644 index 0254959..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_editWebSite.xml +++ /dev/null @@ -1,72 +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>The OFBiz Setup Edit WebSite help screen.</title> - <para> The WebSite screen is used to manage the details of a WebSite. The WebSite record is used to configure which Product Store to use for your - site that references it. </para> - <section> - <title>How do I create a Web Site?</title> - <para> - <orderedlist> - <listitem> - <para>Select the 'Web Site' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Enter the 'Web Site Id' field (NOTE: If you do not enter the 'Web Site Id' field it will be used the default as - 'Organization Party Id')</para> - </listitem> - <listitem> - <para>Enter the 'Site Name' field </para> - </listitem> - <listitem> - <para>Select the 'Visual Theme Set' field</para> - </listitem> - <listitem> - <para>Press the 'Save' button</para> - </listitem> - </orderedlist> - </para> - </section> - <section> - <title>How do I update a Web Site?</title> - <para> - <orderedlist> - <listitem> - <para>Not all the fields on the web site can be updated. For example Web Site Id cannot be updated. If these fields need to be - amended then the web site will need to be removed and then re-created.</para> - </listitem> - <listitem> - <para>Select the 'Web Site' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Any existing line items will be displayed in the 'Items' box</para> - </listitem> - <listitem> - <para>Amend the details in the line item that needs to be updated (eg Site Name, Visual Theme Set)</para> - </listitem> - <listitem> - <para>Press the 'Update' button displayed at the end of the line item that has been updated </para> - </listitem> - </orderedlist> - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_firstProdCatalog.xml b/applications/commonext/data/helpdata/HELP_SETUP_firstProdCatalog.xml deleted file mode 100644 index 22ca3c6..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_firstProdCatalog.xml +++ /dev/null @@ -1,67 +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>The OFBiz Setup Edit First Catalog help screen.</title> - <para> It provides an overview on Catalog, Category, and Product which is the first one of your organization. You will be able to create/edit - Catalog, Category, and Product for your organization and also be able to create order by that product. </para> - <section> - <title>How do I create a Catalog?</title> - <para> - <orderedlist> - <listitem> - <para>Select the 'Product Catalog' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Enter the 'Prod Catalog Id' field (NOTE: If you do not enter the 'Prod Catalog Id' field it will be used the default as - 'Organization Party Id')</para> - </listitem> - <listitem> - <para>Enter the 'Catalog Name' field </para> - </listitem> - <listitem> - <para>Press the 'Update' button</para> - </listitem> - </orderedlist> - </para> - </section> - <section> - <title>How do I update a Catalog?</title> - <para>Not all the fields on the Catalog can be updated. For example Prod Catalog Id cannot be updated. If these fields need to be amended then - the Catalog will need to be removed and then re-created.</para> - <para> - <orderedlist> - <listitem> - <para>Select the 'Product Catalog' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Any existing Catalog will be displayed in the box</para> - </listitem> - <listitem> - <para>Amend the details in the line item that needs to be updated (eg Catalog Name)</para> - </listitem> - <listitem> - <para>Press the 'Update' button displayed at the end of the line item that has been updated </para> - </listitem> - </orderedlist> - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_firstProductCategory.xml b/applications/commonext/data/helpdata/HELP_SETUP_firstProductCategory.xml deleted file mode 100644 index 28a1634..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_firstProductCategory.xml +++ /dev/null @@ -1,66 +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>The OFBiz Setup Edit First Product Category help screen.</title> - <para> The Edit First Product Category screen is used to manage the first category with related the first catalog. </para> - <section> - <title>How do I create a Category?</title> - <para> - <orderedlist> - <listitem> - <para>Select the 'Category' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Enter the 'Product Category Id ' field (NOTE: If you do not enter the 'Product Category Id' field it will be used the - default as 'Organization Party Id')</para> - </listitem> - <listitem> - <para>Enter the 'Category Name' field </para> - </listitem> - <listitem> - <para>Enter a description describing what the category is</para> - </listitem> - <listitem> - <para>Press the 'Update' button</para> - </listitem> - </orderedlist> - </para> - </section> - <section> - <title>How do I update a Category?</title> - <para>Not all the fields on the Category can be updated. For example Prod Catalog Id cannot be updated. If these fields need to be amended - then the Category will need to be removed and then re-created.</para> - <para> - <orderedlist> - <listitem> - <para>Select the 'Category' sub menu and the screen will be displayed: Any existing Category will be displayed in the box</para> - </listitem> - <listitem> - <para>Amend the details in the line item that needs to be updated (eg Category Name, Product Description )</para> - </listitem> - <listitem> - <para>Press the 'Update' button displayed at the end of the line item that has been updated </para> - </listitem> - </orderedlist> - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_firstcustomer.xml b/applications/commonext/data/helpdata/HELP_SETUP_firstcustomer.xml deleted file mode 100644 index 56f43ae..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_firstcustomer.xml +++ /dev/null @@ -1,47 +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>The OFBiz Setup Create First Customer help screen.</title> - <para> The First Customer screen provides create/edit the first customer of your organization and also setup the "Shipping Destination Address" , - "General Correspondence Address", any telephone numbers, and email addresses you want for your first customer. </para> - <section> - <title>How do I update the profile information of the first customer?</title> - <para>After the first customer is created the profile and contact information screen will be displayed</para> - <para> - <orderedlist> - <listitem> - <para>Select the 'Update' button on the top corner of the profile information and the screen will be displayed: Any existing - information will be displayed in the box</para> - </listitem> - <listitem> - <para>Amend the details in the profile information that needs to be updated</para> - </listitem> - <listitem> - <para>Press the 'Save' button</para> - </listitem> - <listitem> - <para>Press the 'Cancel/Done' button for go back to the first customer screen</para> - </listitem> - </orderedlist> - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_firstproduct.xml b/applications/commonext/data/helpdata/HELP_SETUP_firstproduct.xml deleted file mode 100644 index 72a0013..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_firstproduct.xml +++ /dev/null @@ -1,76 +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>The OFBiz Setup Edit First Product help screen.</title> - <para> The Edit First Product screen is used to manage the first product with related the first catalog and the first category. </para> - <section> - <title>How do I create a Product?</title> - <para> - <orderedlist> - <listitem> - <para>Select the 'Product' sub menu and the screen will be displayed</para> - </listitem> - <listitem> - <para>Enter the 'Product Id' field (NOTE: If you do not enter the 'Product Id' field it will be used the default as 'Organization - Party Id')</para> - </listitem> - <listitem> - <para>Enter the 'Internal Name' field </para> - </listitem> - <listitem> - <para>Enter the 'Product Name' field </para> - </listitem> - <listitem> - <para>Enter a description describing what the category is</para> - </listitem> - <listitem> - <para>Enter a number in the 'Default Price' field</para> - </listitem> - <listitem> - <para>Enter a number in the 'Average Cost ' field</para> - </listitem> - <listitem> - <para>Press the 'Update' button</para> - </listitem> - </orderedlist> - </para> - </section> - <section> - <title>How do I update a Product?</title> - <para>Not all the fields on the Product can be updated. For example Product Id cannot be updated. If these fields need to be amended then the - Product will need to be removed and then re-created.</para> - <para> - <orderedlist> - <listitem> - <para>Select the 'Product' sub menu and the screen will be displayed: Any existing Product will be displayed in the box</para> - </listitem> - <listitem> - <para>Amend the details in the line item that needs to be updated (eg Internal Name, Product Name, Short Description, Default - Price, Average Cost)</para> - </listitem> - <listitem> - <para>Press the 'Update' button displayed at the end of the line item that has been updated </para> - </listitem> - </orderedlist> - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_initialsetup.xml b/applications/commonext/data/helpdata/HELP_SETUP_initialsetup.xml deleted file mode 100644 index be04e78..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_initialsetup.xml +++ /dev/null @@ -1,45 +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>The Main OFBiz Setup Overview</title> - <para>The main page on OFBiz Setup application including 2 sections, following this:</para> - <section> - <title>1. Available Internal Organizations Section</title> - <para> - This section shows list of organizations which store in the system. You be able to edit an information of your orgainzation via click setup then it will go to - view profile screen, you will see other tab button including Facility, Product Store, Web Site, First Customer, and First Product where you would like to - edit an information. - </para> - <para> - When you created an information of your orgainzation and also created product. And the last step is click "Set to complete" button. - </para> - </section> - <section> - <title>2. Create New Organization Section</title> - <para> - This section provides a form for create a new an organization(the first step of setup organization) and also setup the "Billing (AP) Address" - , "Payment (AR) Address", "General Correspondence Address", any telephone numbers, and email addresses you want for your Company. - </para> - </section> -</section> diff --git a/applications/commonext/data/helpdata/HELP_SETUP_profileCompany.xml b/applications/commonext/data/helpdata/HELP_SETUP_profileCompany.xml deleted file mode 100644 index 2773500..0000000 --- a/applications/commonext/data/helpdata/HELP_SETUP_profileCompany.xml +++ /dev/null @@ -1,30 +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>The View Organization Profile help screen.</title> - <para> - This screen shows details of an individual profile. It displays specific information regarding the contact and profile information. - The lower part of the screen shows the contact information details indicating the address , telephone number , or email used to communicate with your organization. - </para> -</section> diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_initialsetup.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_initialsetup.adoc new file mode 100644 index 0000000..88bbfaf --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_initialsetup.adoc @@ -0,0 +1,35 @@ +//// +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. +//// + += The Main OFBiz Setup Overview +The main page on OFBiz Setup application including 2 sections, following this: + +== Available Internal Organizations Section +This section shows list of organizations which store in the system. +You be able to edit an information of your orgainzation via click setup then it will go to view profile screen, +you will see other tab button including Facility, Product Store, Web Site, First Customer, and First Product where + you would like to edit an information. + +When you created an information of your orgainzation and also created product. +And the last step is click "Set to complete" button. + +== Create New Organization Section +This section provides a form for create a new an organization(the first step of setup organization) and also setup + the "Billing (AP) Address" , "Payment (AR) Address", "General Correspondence Address", any telephone numbers, + and email addresses you want for your Company. \ No newline at end of file diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editFacility.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editFacility.adoc new file mode 100644 index 0000000..752557a --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editFacility.adoc @@ -0,0 +1,39 @@ +//// +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 Setup Edit Facility +The Edit Facility screen is used to manage a warehouse, a store with related inventory. + +== How do I create a facility? +. Select the 'Facility' sub menu and the screen will be displayed +. Enter the 'Facility Id' field + + (NOTE: If you do not enter the 'Facility Id' field it will be used the default as 'Organization Party Id') +. Enter the 'Name' field +. Enter a description describing what the line item is +. Enter a number in the 'Default Days To Ship ' field +. Press the 'Save' button + +== How do I update a facility? +Not all the fields on the facility can be updated. + +For example Facility Id cannot be updated. +If these fields need to be amended then the facility will need to be removed and then re-created. + +. Select the 'Facility' sub menu and the screen will be displayed: Any existing line items will be displayed in the 'Items' box +. Amend the details in the line item that needs to be updated (eg Name, Description, Default Days To Ship) +. Press the 'Update' button displayed at the end of the line item that has been updated diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editProductStore.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editProductStore.adoc new file mode 100644 index 0000000..8504a0c --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editProductStore.adoc @@ -0,0 +1,41 @@ +//// +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 Setup Edit Product Store +The Product Store screen is used to manage a store with has all the information needed to sell products. + +For example shippings ,a series of catalogs, which are composed of product categories and products, + and also used to configure the payment processing settings , fulfillment, notification, promotions, payment processing, + and tax calculation policies , and etc. + +== How do I create a Product Store? +. Select the 'Product Store' sub menu and the screen will be displayed +. Enter the 'Product Store Id' field + + (NOTE: If you do not enter the 'Product Store Id' field it will be used the default as 'Organization Party Id') +. Enter the 'Store Name' field +. Press the 'Update' button + +== How do I update a Product Store? +Not all the fields on the Product Store can be updated. + +For example Product Store Id cannot be updated. +If these fields need to be amended then the Product Store will need to be removed and then re-created. + +. Select the 'Product Store' sub menu and the screen will be displayed: + Any existing Product Store will be displayed in the 'Items' box +. Amend the details in the line item that needs to be updated (eg Store Name) +. Press the 'Update' button displayed at the end of the line item that has been updated diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editWebSite.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editWebSite.adoc new file mode 100644 index 0000000..88c89b6 --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_editWebSite.adoc @@ -0,0 +1,39 @@ +//// +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 Setup Edit WebSite +The WebSite screen is used to manage the details of a WebSite. + +The WebSite record is used to configure which Product Store to use for your site that references it. + +== How do I create a Web Site? +. Select the 'Web Site' sub menu and the screen will be displayed +. Enter the 'Web Site Id' field + + (NOTE: If you do not enter the 'Web Site Id' field it will be used the default as 'Organization Party Id') +. Enter the 'Site Name' field +. Select the 'Visual Theme Set' field +. Press the 'Save' button + +== How do I update a Web Site? +. Not all the fields on the web site can be updated. + + For example Web Site Id cannot be updated. + + If these fields need to be amended then the web site will need to be removed and then re-created. +. Select the 'Web Site' sub menu and the screen will be displayed +. Any existing line items will be displayed in the 'Items' box +. Amend the details in the line item that needs to be updated (eg Site Name, Visual Theme Set) +. Press the 'Update' button displayed at the end of the line item that has been updated diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstProdCatalog.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstProdCatalog.adoc new file mode 100644 index 0000000..220a820 --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstProdCatalog.adoc @@ -0,0 +1,38 @@ +//// +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 Setup Edit First Catalog +It provides an overview on Catalog, Category, and Product which is the first one of your organization. + +You will be able to create/edit Catalog, Category, and Product for your organization and also be able to create order by that product. + +== How do I create a Catalog? +. Select the 'Product Catalog' sub menu and the screen will be displayed +. Enter the 'Prod Catalog Id' field + + (NOTE: If you do not enter the 'Prod Catalog Id' field it will be used the default as 'Organization Party Id') +. Enter the 'Catalog Name' field +. Press the 'Update' button + +== How do I update a Catalog? +. Not all the fields on the Catalog can be updated. + + For example Prod Catalog Id cannot be updated. + + If these fields need to be amended then the Catalog will need to be removed and then re-created. +. Select the 'Product Catalog' sub menu and the screen will be displayed +. Any existing Catalog will be displayed in the box +. Amend the details in the line item that needs to be updated (eg Catalog Name) +. Press the 'Update' button displayed at the end of the line item that has been updated diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstProductCategory.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstProductCategory.adoc new file mode 100644 index 0000000..5b16e4e --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstProductCategory.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. +//// += Help for Setup Edit First Product Category +The Edit First Product Category screen is used to manage the first category with related the first catalog. + +== How do I create a Category? +. Select the 'Category' sub menu and the screen will be displayed +. Enter the 'Product Category Id ' field + + (NOTE: If you do not enter the 'Product Category Id' field it will be used the default as 'Organization Party Id') +. Enter the 'Category Name' field +. Enter a description describing what the category is +. Press the 'Update' button + +== How do I update a Category? +. Not all the fields on the Category can be updated. + + For example Prod Catalog Id cannot be updated. + + If these fields need to be amended then the Category will need to be removed and then re-created. +. Select the 'Category' sub menu and the screen will be displayed: Any existing Category will be displayed in the box +. Amend the details in the line item that needs to be updated (eg Category Name, Product Description ) +. Press the 'Update' button displayed at the end of the line item that has been updated diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstcustomer.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstcustomer.adoc new file mode 100644 index 0000000..9bc7686 --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstcustomer.adoc @@ -0,0 +1,32 @@ +//// +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 Setup Create First Customer +The First Customer screen provides + + - create/edit the first customer of your organization + + - and also setup the "Shipping Destination Address" , "General Correspondence Address", any telephone numbers, + and email addresses you want for your first customer. + +== How do I update the profile information of the first customer? +After the first customer is created the profile and contact information screen will be displayed + +. Select the 'Update' button on the top corner of the profile information and the screen will be displayed: + Any existing information will be displayed in the box +. Amend the details in the profile information that needs to be updated +. Press the 'Save' button +. Press the 'Cancel/Done' button for go back to the first customer screen diff --git a/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstproduct.adoc b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstproduct.adoc new file mode 100644 index 0000000..cccb529 --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/_include/HELP_setup_firstproduct.adoc @@ -0,0 +1,39 @@ +//// +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 Setup Edit First Product +The Edit First Product screen is used to manage the first product with related the first catalog and the first category. + +== How do I create a Product? +. Select the 'Product' sub menu and the screen will be displayed +. Enter the 'Product Id' field + + (NOTE: If you do not enter the 'Product Id' field it will be used the default as 'Organization Party Id') +. Enter the 'Internal Name' field +. Enter the 'Product Name' field +. Enter a description describing what the category is +. Enter a number in the 'Default Price' field +. Enter a number in the 'Average Cost ' field +. Press the 'Update' button + +== How do I update a Product? +. Not all the fields on the Product can be updated. + + For example Product Id cannot be updated. + + If these fields need to be amended then the Product will need to be removed and then re-created. +. Select the 'Product' sub menu and the screen will be displayed: Any existing Product will be displayed in the box +. Amend the details in the line item that needs to be updated (eg Internal Name, Product Name, Short Description, Default Price, Average Cost) +. Press the 'Update' button displayed at the end of the line item that has been updated diff --git a/applications/commonext/src/docs/asciidoc/ofbiz-setup.adoc b/applications/commonext/src/docs/asciidoc/ofbiz-setup.adoc new file mode 100644 index 0000000..62a99f2 --- /dev/null +++ b/applications/commonext/src/docs/asciidoc/ofbiz-setup.adoc @@ -0,0 +1,72 @@ +//// +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. +//// + += The OFBiz Setup application Overview + +The OFBiz Setup application is supporting for immediate setup your organization. +For example, Product Store, WebSite , Facility , product catalog, category , product, and etc. +and then be able to create orders from data that is created. + +== Why we have OFBiz Setup Application? +IMPORTANT: For manual setup instructions, please see the +https://cwiki.apache.org/confluence/display/OFBENDUSER/Apache+OFBiz+Business+Setup+Guide[Business Setup Guide] on the wiki. + +If you are the company and also want to use OFBiz for running your business then you easily be able to setting your information for start running the system quickly via The OFBiz Setup Application. + +== How to get started. +NOTE: TO CHECK add link to Readme and better information between demo data and seed + +For instructions to run and load data to have OFBiz ready to be used, please read the README documentation. + +For having OFBiz ready to be setup, it's needed to load data from reader seed and seed-initial + +. Open a new terminal. +. Go to your ofbiz directory. +. Clean out all built classes with : ./ant clean-all +. start with a database clean and empty +. Load the seed data with gradlew "ofbiz --load-data readers=seed,seed-initial" +. Create the admin user with login name MyUserName and default password with value "ofbiz": + gradlew loadAdminUserLogin -PuserLoginId=MyUserName +. start ofbiz with : gradlew ofbiz +. Connect to the OFBiz Setup application with your browser at https://localhost:8443/ofbizsetup. +. follow each step of the next chapter "Steps for setup" + +== Steps for setup +include::_include/HELP_initialsetup.adoc[leveloffset=+2] + +include::_include/HELP_setup_editFacility.adoc[leveloffset=+2] + +include::_include/HELP_setup_editProductStore.adoc[leveloffset=+2] + +include::_include/HELP_setup_editWebSite.adoc[leveloffset=+2] + +include::_include/HELP_setup_firstcustomer.adoc[leveloffset=+2] + +include::_include/HELP_setup_firstProdCatalog.adoc[leveloffset=+2] + +include::_include/HELP_setup_firstProductCategory.adoc[leveloffset=+2] + +include::_include/HELP_setup_firstproduct.adoc[leveloffset=+2] + +=== Help for View Organization Profile +This screen shows details of an individual profile. + +It displays specific information regarding the contact and profile information. +The lower part of the screen shows the contact information details indicating the address, telephone number, + or email used to communicate with your organization. diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc index 575fddb..83df2c2 100644 --- a/docs/asciidoc/user-manual.adoc +++ b/docs/asciidoc/user-manual.adoc @@ -137,6 +137,8 @@ first. include::../../README.adoc[tags=quickstart] +include::../../applications/commonext/src/docs/asciidoc/ofbiz-setup.adoc[leveloffset=+1] + == Core Business Applications Most businesses share universal needs. They require accounting functionality, @@ -149,7 +151,7 @@ functionality. This section of the manual will describe each core business application starting with a high level overview of design and purpose down to the details -of how to achieve common tasks. +of how to achieve common tasks. include::../../applications/accounting/src/docs/asciidoc/accounting.adoc[leveloffset=+2] |
Free forum by Nabble | Edit this page |