You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ho...@apache.org on 2020/07/14 19:23:07 UTC
[ofbiz-framework] branch trunk updated (33ca531 -> 9ec3d9c)
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 33ca531 Improved: correct formatting of LoginServices
new 1c09166 Documented: Product (catalog) migration to asciidoc (OFBIZ-11587)
new 63daf25 Documented: migrate help link to asciidoc user manual for Product (OFBIZ-11587)
new f4d01e8 Documented: Workeffort migration to asciidoc (OFBIZ-11587)
new 28e82c2 Documented: Workeffort migration to asciidoc (OFBIZ-11587)
new 2c700e8 Documented: Framework/base migration to asciidoc (OFBIZ-11587)
new 5f56177 Documented: Framework/base migration to asciidoc (OFBIZ-11587)
new e5d49b2 Documented: Check all docbook file in each applications-component documents directory (OFBIZ-11587)
new b36943d Documented: Check all docbook file in each applications-component documents directory (OFBIZ-11587)
new b0f445b Documented: Framework, migration all docbook files to asciidoc (OFBIZ-11587)
new 91fe7bf Documented: Framework, delete all docbook files related to migration to asciidoc (OFBIZ-11587)
new 9ec3d9c Documented: Framework, delete all docbook files related to migration to asciidoc (OFBIZ-11587)
The 11 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:
README.adoc | 2 +
applications/accounting/documents/Accounting.xml | 39 ---
applications/commonext/documents/Setup.xml | 27 --
applications/content/data/WebtoolsHelpData.xml | 11 +-
applications/content/documents/Content.xml | 30 ---
applications/humanres/documents/Humanres.xml | 51 ----
.../manufacturing/documents/manufacturing.xml | 64 -----
applications/marketing/documents/Marketing.xml | 47 ----
.../marketing/src/docs/asciidoc/marketing.adoc | 3 +
applications/marketing/src/docs/asciidoc/sfa.adoc | 5 +
applications/order/documents/Order.xml | 29 ---
applications/party/documents/Party.xml | 32 ---
.../data/HELP_PRODUCT.xml} | 18 +-
applications/product/data/ProductHelpData.xml | 24 --
.../product/data/helpdata/HELP_IMAGEMANAGEMENT.xml | 211 ---------------
.../data/helpdata/HELP_PRODCATALOG_main.xml | 66 -----
.../product/data/helpdata/HELP_PRODUCT.xml | 39 ---
.../data/helpdata/HELP_PRODUCT_Catalog_Promos.xml | 64 -----
.../data/helpdata/HELP_PRODUCT_Features.xml | 93 -------
.../data/helpdata/HELP_PRODUCT_Product_Stores.xml | 129 ----------
.../helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml | 111 --------
applications/product/documents/Product.xml | 33 ---
.../docs/asciidoc/_include/product-catalogs.adoc | 107 ++++++++
.../docs/asciidoc/_include/product-features.adoc | 108 ++++++++
.../_include/product-image-management.adoc | 149 +++++++++++
.../src/docs/asciidoc/_include/product-promos.adoc | 60 +++++
.../src/docs/asciidoc/_include/product-stores.adoc | 135 ++++++++++
.../product/src/docs/asciidoc/product.adoc | 89 +++++++
.../product/widget/catalog/CommonScreens.xml | 11 +-
.../docs/asciidoc/_include/portlet-calendar.adoc | 6 +-
docs/asciidoc/developer-manual.adoc | 23 +-
docs/asciidoc/user-manual.adoc | 2 +
framework/base/documents/FrameworkBase.xml | 32 ---
framework/base/documents/ReceivingEmail.xml | 46 ----
.../docs/asciidoc/_include/email-receiving.adoc | 39 +++
.../src/docs/asciidoc/_include/email-sending.adoc | 15 +-
.../base/src/docs/asciidoc/email.adoc | 9 +-
framework/common/documents/FrameworkCommon.xml | 30 ---
framework/common/documents/SendingEmail.xml | 45 ----
.../datafile/src/docs/asciidoc/datafiles.adoc | 111 ++++++++
framework/documents/DataFiles.xml | 239 -----------------
framework/documents/Framework.xml | 28 --
framework/documents/SingleSignOn.xml | 282 ---------------------
framework/documents/UnitTest.xml | 228 -----------------
framework/entity/documents/EntityEngine.xml | 48 ----
.../entity/src/docs/asciidoc/entity-engine.adoc | 12 +-
framework/minilang/documents/MiniLang.xml | 28 --
.../docs/asciidoc/minilang-to-groovy-manual.adoc | 9 +-
framework/service/documents/ServiceEngine.xml | 28 --
.../testtools/src/docs/asciidoc/SingleSignOn.adoc | 159 ++++++++++++
.../testtools/src/docs/asciidoc/unit-tests.adoc | 155 +++++++++++
.../webtools/data/{helpdata => }/HELP_WEBTOOLS.xml | 6 +-
.../webtools/data/helpdata/HELP_WEBTOOLS_main.xml | 48 ----
framework/webtools/documents/Webtools.xml | 30 ---
.../src/docs/asciidoc/_include/webtools-main.adoc | 38 +++
55 files changed, 1235 insertions(+), 2248 deletions(-)
delete mode 100644 applications/accounting/documents/Accounting.xml
delete mode 100644 applications/commonext/documents/Setup.xml
delete mode 100644 applications/content/documents/Content.xml
delete mode 100644 applications/humanres/documents/Humanres.xml
delete mode 100644 applications/manufacturing/documents/manufacturing.xml
delete mode 100644 applications/marketing/documents/Marketing.xml
delete mode 100644 applications/order/documents/Order.xml
delete mode 100644 applications/party/documents/Party.xml
rename applications/{workeffort/data/helpdata/HELP_PORTLET_CALENDAR.xml => product/data/HELP_PRODUCT.xml} (74%)
delete mode 100644 applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml
delete mode 100644 applications/product/data/helpdata/HELP_PRODCATALOG_main.xml
delete mode 100644 applications/product/data/helpdata/HELP_PRODUCT.xml
delete mode 100644 applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
delete mode 100644 applications/product/data/helpdata/HELP_PRODUCT_Features.xml
delete mode 100644 applications/product/data/helpdata/HELP_PRODUCT_Product_Stores.xml
delete mode 100644 applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
delete mode 100644 applications/product/documents/Product.xml
create mode 100644 applications/product/src/docs/asciidoc/_include/product-catalogs.adoc
create mode 100644 applications/product/src/docs/asciidoc/_include/product-features.adoc
create mode 100644 applications/product/src/docs/asciidoc/_include/product-image-management.adoc
create mode 100644 applications/product/src/docs/asciidoc/_include/product-promos.adoc
create mode 100644 applications/product/src/docs/asciidoc/_include/product-stores.adoc
create mode 100644 applications/product/src/docs/asciidoc/product.adoc
copy CONTRIBUTING.adoc => applications/workeffort/src/docs/asciidoc/_include/portlet-calendar.adoc (83%)
delete mode 100644 framework/base/documents/FrameworkBase.xml
delete mode 100644 framework/base/documents/ReceivingEmail.xml
create mode 100644 framework/base/src/docs/asciidoc/_include/email-receiving.adoc
copy applications/accounting/src/docs/asciidoc/_include/HELP_EditTaxAuthorityPartyInfo.adoc => framework/base/src/docs/asciidoc/_include/email-sending.adoc (61%)
copy CONTRIBUTING.adoc => framework/base/src/docs/asciidoc/email.adoc (83%)
delete mode 100644 framework/common/documents/FrameworkCommon.xml
delete mode 100644 framework/common/documents/SendingEmail.xml
create mode 100644 framework/datafile/src/docs/asciidoc/datafiles.adoc
delete mode 100644 framework/documents/DataFiles.xml
delete mode 100644 framework/documents/Framework.xml
delete mode 100644 framework/documents/SingleSignOn.xml
delete mode 100644 framework/documents/UnitTest.xml
delete mode 100644 framework/entity/documents/EntityEngine.xml
copy applications/accounting/src/docs/asciidoc/_include/HELP_ViewGatewayResponse.adoc => framework/entity/src/docs/asciidoc/entity-engine.adoc (65%)
delete mode 100644 framework/minilang/documents/MiniLang.xml
rename framework/minilang/{ => src}/docs/asciidoc/minilang-to-groovy-manual.adoc (98%)
delete mode 100644 framework/service/documents/ServiceEngine.xml
create mode 100644 framework/testtools/src/docs/asciidoc/SingleSignOn.adoc
create mode 100644 framework/testtools/src/docs/asciidoc/unit-tests.adoc
rename framework/webtools/data/{helpdata => }/HELP_WEBTOOLS.xml (76%)
delete mode 100644 framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml
delete mode 100644 framework/webtools/documents/Webtools.xml
create mode 100644 framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc
[ofbiz-framework] 01/11: Documented: Product (catalog) migration to
asciidoc (OFBIZ-11587)
Posted by ho...@apache.org.
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 1c0916694839577c9fbf2781ecbd461173404570
Author: holivier <ho...@apache.org>
AuthorDate: Tue Apr 7 14:21:58 2020 +0200
Documented: Product (catalog) migration to asciidoc
(OFBIZ-11587)
product.adoc included (by include:: ) the other files by sub-component
user-manual is updated to include it in.
---
.../docs/asciidoc/_include/product-catalogs.adoc | 107 +++++++++++++++
.../docs/asciidoc/_include/product-features.adoc | 108 +++++++++++++++
.../_include/product-image-management.adoc | 149 +++++++++++++++++++++
.../src/docs/asciidoc/_include/product-promos.adoc | 60 +++++++++
.../src/docs/asciidoc/_include/product-stores.adoc | 135 +++++++++++++++++++
.../product/src/docs/asciidoc/product.adoc | 89 ++++++++++++
docs/asciidoc/user-manual.adoc | 2 +
7 files changed, 650 insertions(+)
diff --git a/applications/product/src/docs/asciidoc/_include/product-catalogs.adoc b/applications/product/src/docs/asciidoc/_include/product-catalogs.adoc
new file mode 100644
index 0000000..39bc6be
--- /dev/null
+++ b/applications/product/src/docs/asciidoc/_include/product-catalogs.adoc
@@ -0,0 +1,107 @@
+////
+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.
+////
+= Catalogs
+
+== Catalogs overview
+A product catalog is used to group many product categories together and forms an intermediate step in the organization between
+products, categories, and stores.
+
+The product catalog can be used to define a common look and feel for all categories in this catalog and specify
+the way different categories will behave.
+
+For example, it is very useful for stores which sell products from different manufacturer or completely different product types
+ that require differing presentations to the customer.
+
+=== Sequence from a Store to the Products
+Although the process sequence through the tabs discussed below does not correspond with the tab layout within the Catalog Manager,
+the progression of the steps is intentional.
+
+. Promotions and Price Rules cannot exist without Products.
+. Products are usually so numerous that you wish to divide them into Categories and distinguish them by their Features.
+. Categories are then the major sections of your Catalogs.
+. And Catalogs must be associated with their related Stores.
+. Therefore, when setting up your business, you need to start with the Store.
+
+All of these details are handled within the Catalog Manager.
+
+== Working with Catalogs
+To follow this topic, click on the 'Catalog Detail List' in the left-hand panel under the 'Browse Catalogs' section. +
+Then click on any catalog in the table of current catalogs presented in the main screen.
+
+You will see the top-level editing screen for that catalog. +
+Along the top of the working screen are four sub-tabs: Catalog, Stores, Parties and Catalogs. +
+Each of those are discussed as a topic below.
+
+
+=== Catalog tab
+The main Catalog tab for a product catalog is mostly for establishing the look and feel.
+
+Each catalog can have its own style sheet (CSS), its own logo, and its own content repository (the content path prefix)
+and templates prefix (where its freemarker templates are located).
+
+=== The Stores tab
+The 'Stores' tab shows a list of Stores that this Catalog is currently featured in.
+
+[NOTE]
+Stores and Catalogs do not have a one-to-one relationship: the same Store can feature multiple Catalogs,
+and the same Catalog could be featured in many Stores.
+
+=== The Parties tab
+Here you identify which Party is responsible for or assigned to work with the specific Catalog selected.
+
+The Party's Role is assigned or identified and, if appropriate, a start and/or finish date for the assignment can be specified.
+
+=== Categories tab
+The 'categories' tab shows the different product categories and their roles for this catalog.
+Specifically:
+
+* Each catalog can (should) have a 'Browse Root' category, which is used as the root category for navigation. +
+ For example, the navigation menu would start at this category and show its child categories.
+* Each catalog can also have a 'Promotions' category, which is shown first to the customer when he signs in to the site.
+* There is also a 'Default Search' category. +
+ Products in this category are used for search results first.
+* 'Quick add' categories are used to specify categories where products can be added in bulk to the cart from the same screen.
+
+== Browse Categories links
+In the left-hand panel is a section labeled 'Browse Categories.' You can click on one of the -indented- categories
+to begin editing it directly, or click on the [Choose Top Category] link to view a list of links to all Parent categories.
+
+== Catalog Administration Main Page
+The catalog administration main page has several small menus for finding catalogs, categories, or products.
+
+The first three menus allow you to edit catalogs, categories, or products by their respective IDs, or create new catalogs,
+categories, or products. +
+The last one allows you to look for a product using an ID other than its product ID, such as upc or isbn number (see below.) +
+Under these menus are two more links.
+
+* Auto create keywords
+* Fast load catalog into cache.
+
+=== Auto create keywords
+Auto create keywords will create keywords for all of the products identified with the current Catalog. +
+The keywords are based on product descriptions and are used for searching for products.
+
+=== Fast load catalog
+Fast load catalog into cache will load all products and product categories into the cache; this is good for improved
+ application performance.
+
+[NOTE]
+only basic product and category information from the first Product and Category tabs is loaded,
+so additional information such as content, associations, and pricing will still have to be retrieved from the database
+and cached later by the applications.
diff --git a/applications/product/src/docs/asciidoc/_include/product-features.adoc b/applications/product/src/docs/asciidoc/_include/product-features.adoc
new file mode 100644
index 0000000..04114f3
--- /dev/null
+++ b/applications/product/src/docs/asciidoc/_include/product-features.adoc
@@ -0,0 +1,108 @@
+////
+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.
+////
+= Product Features
+To Sell and to Differentiate Products, Features are characteristics used to sell and to differentiate products.
+
+The Apache OFBiz catalog manager allows you to define any feature set you wish for your products. +
+Typical features include size and color.
+
+In Apache OFBiz, features are associated, or applied, to products as Standard Features, Selectable Features,
+or Distinguishing Features.
+
+== Standard features
+Standard features are features which are associated with every instance of a product.
+
+An example might be the brand name of a product -- all instances of the product share the same brand name.
+
+== Selectable features
+Selectable features are features which the customer selects one from many available choices.
+
+For example, a shirt may be available in White, Blue, Green, Yellow, Pink. +
+These colors would be selectable features of the variant product shirt, and the customer would be prompted to choose a color.
+
+Each color, though, would be a standard feature of the physical product. +
+Thus, White would be a selectable feature of the virtual product 'shirt' but a standard feature of 'white shirt.'
+
+== Distinguishing features
+Distinguishing features are features which distinguish one product from another and are used to show the customer
+which item she chose.
+
+== Working with Product Features
+* Click on Features tab.
+* Defaults to Product Features
+
+== Create and Maintain Product Features
+These screens are for creating and maintaining product features, which are features or characteristics that are available
+for products.
+
+Here you will define what features can be available for products. +
+Later, when working with the products, you will have a chance to define what features a particular product may have.
+
+== Feature Categories and Feature Groups
+Notice the sub-tabs for Feature Categories and Feature Groups.
+
+These are both used to help you organize your product features.
+
+Each feature can only belong to one category but as many groups as you need.
+
+For example, you can have :
+
+* a colors category that has colors White, Blue, Grey, Green, Yellow, Pink, Red, and Orange
+* and a sizes category that has sizes XXS, XS, S, M, L, XL, XXL.
+
+Then, you can have :
+
+* one group for shirts that would have colors White, Blue, Grey and sizes S, M, L, XL, XXL,
+* and another group for dresses that have colors Yellow, Pink, Red, Orange and sizes XXS, XS, S, M, and L.
+
+== Add Features to a Category
+Once you have created a feature category, you can click on it to add features to it.
+
+There is a link [Create new feature] which takes you to a screen to create a new product feature. +
+Below this link is a list of product features already in this category.
+
+Important fields for product features are listed below.
+
+== Feature Categories
+Click on [Feature Categories] (this is the default screen when you clicked on 'Features' above),
+and you will see a menu for editing a particular feature, if you remember its feature ID. +
+(If not, you can edit it from the feature categories below.) Next, you will see a list of feature categories and
+their parent categories.
+
+The categories' ID codes are highlighted, and you can click on one to go to the feature category.
+
+At the very bottom is a menu for creating a new feature category. +
+Here, you would enter the new feature category's name and specify a parent category for it (if it has one.)
+The category ID is automatically created for you.
+
+== Working with Feature Groups
+Click on [Feature Groups] and you will see a screen showing a list of available feature groups,
+and an option to create a new feature group at the bottom.
+
+Click on the ID of the feature group, and you will be taken to a screen which shows all the features in this group
+(if there are any) and a menu to add more features to this group.
+
+Like feature categories, the IDs of feature groups are automatically created.
+
+== Implement Feature-based Product Search
+You can associate feature categories or feature groups to a Product Category. +
+Buy doing this will provide web store customer feature based product search ability.
+
+If customers choose to search within a given category and that category has features associated with it
+then they will be displayed as selectable filtering options (based on the associated product features) on the search form.
diff --git a/applications/product/src/docs/asciidoc/_include/product-image-management.adoc b/applications/product/src/docs/asciidoc/_include/product-image-management.adoc
new file mode 100644
index 0000000..1237198
--- /dev/null
+++ b/applications/product/src/docs/asciidoc/_include/product-image-management.adoc
@@ -0,0 +1,149 @@
+////
+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.
+////
+= Image Management
+The Image Management module manages many kind of image what user want. +
+There are various functions including 'Gallery', 'Upload', 'Approved', 'Manage' etc.
+
+Go to Catalog Component > tab Image Management.
+
+
+== How To Add Security Group For Image Management User
+There are three security groups related in the Image Management including 'IMAGEADMIN', 'IMAGEAPPROVE' and ' IMAGEUPLOAD'.
+
+=== Howto add a security group
+. Go to 'Party' component.
+. Search 'UserLogin' or 'Party Id'.
+. Click 'UserLogin' or 'Party Id'.
+. At 'User Name(s)', click 'Security Groups' button.
+. At 'Add UserLogin go to Security Group',
+ * select group 'IMAGEADMIN Image Management Admin' for use all operations in the Image Management.
+ * select 'IMAGEUPLOAD Image Management Upload': To add party's permission for uploading,
+ * select 'IMAGEAPPROVE Image Management Approve': To add party's permission for approving.
+
+=== Howto Add Role For Approve Image To Party Id
+Click partyId into party's screen already present. +
+Select the submenu 'Role(s)' to add the role to party
+
+There is Add To Role screenlet, select role 'Image Approver'(on the combobox role type Id) then click 'add' button.
+
+== Gallery
+Gallery shows all images which have approved.
+
+[NOTE]
+Everybody can access Gallery function.
+
+. Click 'Gallery' button, then choose a 'Product Id' by type or click a find icon.
+. Click 'Submit' button, then you will see all images which have approved.
+. You can click 'Share' button that generates any codes to share your images to any people.
+
+== Upload
+In this function, you can upload image files into system. +
+You can upload many image files up to 10 files.
+
+[NOTE]
+You must have Image Management Upload permission for access Upload function.
+
+. Go to 'Upload' section, Enter 'Product Id' by type or click a find icon.
+. Optional, you can specify the size of images.
+. Then click 'Browse' button to choose image file(s).
+. Click 'Upload' button.
+
+== Recently Approved
+In this function, you can see the images which have been approved for 14 days recently.
+
+[NOTE]
+You must have Image Management Admin permission for access this function.
+
+. Click 'Recently Approved' Button, then you will see the lists of recently approved product which are separated by date.
+. Click on product id to see its images with details.
+
+== Approve
+In this function, you can set the status of each image including 'Approve', 'Pending' and 'Rejected'.
+
+[NOTE]
+You must have Image Management Admin permission for access this function.
+
+. Click 'Approve' Button, then specify the status of each image.
+. Choose 'Approve' status for approve image.
+. Choose 'Reject' status for reject image..
+. Choose 'Pending' status for pending image..
+. Click 'Submit' button.
+
+The images will be approved if all image administrators approved them. +
+But if only one person rejects an image then that image will be rejected.
+
+== Rejected
+The Rejected function shows the images which have rejected.
+
+[NOTE]
+You must have Image Management Admin permission for access this function.
+
+. Click 'Rejected' button, then you specify the reason of rejection each image.
+. Then click 'Submit' button.
+
+== Manage
+You can edit image such as add frame, crop image etc. +
+You can also add caption, sort order, enable image and choose thumbnail in this function.
+
+[NOTE]
+You must have Image Management Admin permission for access this function.
+
+. Click 'Manage' Button, then you can choose action including 'Frame', 'Crop' and 'Rotate' (see below for more details).
+. Enter your image caption.
+. Sort order of image by enter order number.
+. Enable image by tick enable checkbox.
+. Select image thumbnail of product.
+. Click 'Submit' button.
+
+=== Frame
+In Frame function, you can merge your image with the frame image (transparent image file e.g.
+PNG type) together.
+
+The frame image should be larger than selected image.
+
+. Choose 'Frame' then choose the image you want to merge frame.
+. Select the frame image by browsing transparent image file, such as PNG type.
+. Click 'Upload' button to upload the frame image.
+. Enter width and height of image.
+. Optional, you click 'Preview' to see example image.
+. Click 'Create' button.
+
+=== Crop
+You can crop any images in this function.
+
+. Choose 'Crop' then choose your image.
+. Move your cursor on the image, then drag your mouse to crop image.
+. You can see the preview image in the right hand side.
+. Finally, you click 'Crop' button.
+
+=== Rotate
+You can rotate images in this function.
+
+. Choose 'Rotate' then click clockwise or counterclockwise button for ratating image.
+. 'Submit' button
+
+== Replace
+In this function, you can replace the selected image with other image.
+
+The image which you want to replace must be approved first.
+
+. Click 'Replace' button, Enter 'Product Id' by type or click a find icon.
+. Then choose the image which you want to replace.
+. Choose the other image to replace with the selected image.
+. Click 'Submit' button.
diff --git a/applications/product/src/docs/asciidoc/_include/product-promos.adoc b/applications/product/src/docs/asciidoc/_include/product-promos.adoc
new file mode 100644
index 0000000..669c96a
--- /dev/null
+++ b/applications/product/src/docs/asciidoc/_include/product-promos.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.
+////
+= Promotions
+
+== Similar to Price Rules
+Promotions are similar to Price Rules (see Price Rules, below) but are used to record special promotional offers which
+apply to the entire order, rather than prices for a particular product.
+
+For example, the promotional manager can be used to set up rules to give customers a percentage discount if they purchase
+a minimum quantity, or to create a coupon code.
+
+[NOTE]
+Promotions are tied to specific stores, whereas price rules are applicable to all products +
+(although you can specify the website, product catalog, or category for which a price rule is applicable).
+
+== Opening Screen
+The opening screen lists all promotions which are currently available and a link for creating additional promotions; +
+click on one to go to a promotion.
+
+You will also see a series of four tabs: [Promo], [Rules], [Stores] and [Codes].
+
+== Promo tab
+At the top is general information about this promotion.
+
+Each promotion has an ID, a name and a longer descriptive text, which are shown to customers.
+
+If no text is entered, Apache OFBiz will automatically generate text for you.
+
+== Rules tab
+Rules for promotions are used to determine what actions should be taken in the promotion.
+
+Each promotion can have multiple rules, and each rule can have multiple conditions and actions.
+
+If a promotion had multiple rules, they would all be checked in sequence, and the rules whose conditions were true
+will be activated.
+This is especially helpful for complicated promotions that have multiple offers.
+
+== Stores tab
+The stores tab shows a list of product stores in which this promotion is active.
+
+You can add additional stores here or delete them.
+
+== Codes tab
+The codes tab is used to associate codes for a promotion, similar to coupon codes.
\ No newline at end of file
diff --git a/applications/product/src/docs/asciidoc/_include/product-stores.adoc b/applications/product/src/docs/asciidoc/_include/product-stores.adoc
new file mode 100644
index 0000000..723fe41
--- /dev/null
+++ b/applications/product/src/docs/asciidoc/_include/product-stores.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.
+////
+= Product Stores
+A product store has all the information needed to sell products.
+
+It is composed of a series of catalogs, which are composed of product categories and products.
+
+Each store can have its own shipping, fulfillment, notification, promotions, payment processing, and tax calculation policies.
+
+A product store can point to several different websites, allowing the same products to be sold on multiple hosted sites or domains. +
+Alternatively, multiple stores, each with their own website, can be set up to allow different pricing and fulfillment procedures
+for, say, different countries or different market segments (wholesale versus retail.)
+
+== Main Store screen
+. Go to Catalog Manager
+. Go to Catalog Manager - Stores tab +
+ Stores tab (with a store selected) brings up
+ * Roles,
+ * Promos,
+ * Catalogs,
+ * Web Sites,
+ * Sales Tax,
+ * Shipping,
+ * Payments,
+ * Emails,
+ * Surveys,
+ * and Override tabs to perform a host of other store-related functions.
+. Select existing store
+. If none, Create New Product Store
+. Complete fields
+. Click on Update
+
+
+== Why use stores?
+The 'Stores' tab in the catalog manager as used to define all the properties of a working store,
+is a group of products sold together under the same policies.
+
+Stores greatly improve the flexibility of Apache OFBiz applications.
+
+It is possible for a company to set up multiple stores, each with its warehouses, fulfillment policies, currencies, languages,
+promotions, and look-and-feel.
+
+These stores can be web-based b2b or consumer ecommerce stores or for internal order entry.
+
+They could even be in different countries with different shipping and taxation rules.
+
+== Working with Product Stores
+When you click on 'Stores,' you will see a list of product stores that have been defined. +
+Click on one and you will see several tabs for administering different aspects of that store.
+Some of those aspects are discussed below.
+
+=== Product Store
+This very complete screen provides entry for all of the myriad choices available which define the store and establish parameters.
+
+=== Roles
+Defines parties with specific roles for this store.
+
+For an employee to be able to take orders using the internal order manager application,
+he must be defined as a 'Sales Representative' here.
+
+Restrictions are enforced through the Party Manager - SecurityGroupsList which grants rights according to party roles.
+
+=== Promos
+Shows a list of active promotions for this store.
+
+=== Catalogs
+Catalogs which are available for the current store and the sequence in which they are to be shown to the user in a navigation menu.
+
+=== Web Sites
+Websites which are related to this store. +
+This is directly used to link a store to a web application.
+
+Each web application has a configuration file called web.xml, and it is defined to reference a particular web site. +
+The web site in turn is defined to relate to a product store.
+
+Thus, by setting a store on a web site, it becomes 'live' on that web application.
+
+[NOTE]
+It is possible for a web application to have more than one store associated with it,
+ as long as the application knows how to use the correct one.
+
+=== Shipping
+This page shows the shipping options available to store customers. +
+A list of shipping options and their pricing is shown.
+
+Click on View for a shipping option shows all the settings for this shipping option. +
+At this point, this tab can only view shipping options available and can not be used to define them.
+
+=== Payments
+his is used to set up payment processing for the store.
+
+The payment processing interfaces are defined as Apache OFBiz services.
+
+Each payment method will have a series of service types available to it, such as for authorizing, capturing, and refunding payment.
+
+This page links the payment types and the services together by their purpose. +
+Thus, one service would be used for credit card authorizations, another for credit card capture, and so forth
+
+=== Emails
+This defines emails which the store would send to customers.
+
+The actual email services are either mounted in the controller, such as the order confirmation email, or from scheduled services,
+such as back order notifications.
+
+This page defines where the template for the email is located on the file system, the addresses and subject of each email,
+and a content type (which can be left blank).
+
+=== Surveys
+This page is for adding surveys to the store. +
+Surveys can be associated with certain events or with products and categories.
+
+=== Override
+Allows certain keywords to be ascendant at this store for a particular time period.
+
+=== Segments
+Identifies the Sales or Market Segments targeted for this Store.
+
+The actual assignment is made under the Marketing tab > Segment sub-tab. +
+Here under the Product Store you will see a summary table of those assignments along with links to make any additions or changes.
diff --git a/applications/product/src/docs/asciidoc/product.adoc b/applications/product/src/docs/asciidoc/product.adoc
new file mode 100644
index 0000000..3828ca5
--- /dev/null
+++ b/applications/product/src/docs/asciidoc/product.adoc
@@ -0,0 +1,89 @@
+////
+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.
+////
+= Catalog
+
+The Catalog Manager creates or provides access to a variety of information.
+Whether Products, Catalogs, or Categories, this screen offers search tools and links to get you to the type of information
+you need or are working with quickly and accurately.
+
+The Catalog Manager application is used to manage the products, all what is purchase, sale, build, used, ... by the company.
+A product can be physical or digital.
+
+With catalog application, you can manage all data associated with Product : category, catalog, price, id, ....
+
+== Overview
+TODO
+
+=== Help for Catalog Main screen
+Down the left hand column are 4 sections:
+
+1. Search Products,
+2. Browse Catalogs,
+3. Browse Categories,
+4. Product Categories.
+
+[TIP]
+You can click on the colored '_' to close a section; +
+later, click on the colored '[]' to reopen the section.
+
+
+Each of those sections are discussed below before we begin to explore the Catalog Administration Main Page.
+
+Navigation Panel The Left-hand Navigation Panel is visible even when working under the other tabs. +
+The content displayed will vary according to what choices you have made.
+
+This document is arranged to walk you through the Navigation Panel search tools (Search Products, Browse Catalogs,
+Browse Categories, and Category Products) and links first.
+
+As you come to the desired Edit or Creation window, jump in this document to the associated 'Edit' discussion.
+
+Some symbols used as shortcuts Brackets [] Application links as found on the screens are represented in this document
+with brackets around them like [this]. When you see a bracketed item, you can know we are referring to a link or
+key or 'button' which will initiate the indicated action.
+
+Greater than symbols >> The single (>) or double (>>) greater than symbols can be read as 'takes you to' or 'leads to'
+or 'results in.' These are sometimes used in this document to indicate that from this screen, if you click on the
+[Bracketed Link], you will be taken to Next Process.
+
+Within the pop-up calendars, however, the (>>) jumps you ahead one year and the (<<) jumps you back a year.
+
+An asterisk * marks those items which must be completed on a screen before the desired action can occur.
+
+
+
+== Products
+
+
+include::_include/product-catalogs.adoc[leveloffset=+1]
+
+== Categories
+
+include::_include/product-features.adoc[leveloffset=+1]
+
+include::_include/product-promos.adoc[leveloffset=+1]
+
+== Price Rules
+
+include::_include/product-stores.adoc[leveloffset=+1]
+
+== Configurations
+
+include::_include/product-image-management.adoc[leveloffset=+1]
+
+== Miscellaneous
diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc
index 48386c5..273ce2c 100644
--- a/docs/asciidoc/user-manual.adoc
+++ b/docs/asciidoc/user-manual.adoc
@@ -168,3 +168,5 @@ include::../../applications/marketing/src/docs/asciidoc/sfa.adoc[leveloffset=+2]
include::../../applications/order/src/docs/asciidoc/order.adoc[leveloffset=+2]
include::../../applications/party/src/docs/asciidoc/party.adoc[leveloffset=+2]
+
+include::../../applications/product/src/docs/asciidoc/product.adoc[leveloffset=+2]
[ofbiz-framework] 03/11: Documented: Workeffort migration to
asciidoc (OFBIZ-11587)
Posted by ho...@apache.org.
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 f4d01e8610b97e8b905e937a90b98e55f0e97460
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 10 12:41:46 2020 +0200
Documented: Workeffort migration to asciidoc
(OFBIZ-11587)
only one file about portlet-calendar, currently not include in a
document
---
.../docs/asciidoc/_include/portlet-calendar.adoc | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/applications/workeffort/src/docs/asciidoc/_include/portlet-calendar.adoc b/applications/workeffort/src/docs/asciidoc/_include/portlet-calendar.adoc
new file mode 100644
index 0000000..663101a
--- /dev/null
+++ b/applications/workeffort/src/docs/asciidoc/_include/portlet-calendar.adoc
@@ -0,0 +1,22 @@
+////
+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 Calendar Portlet
+
+It provides an overview on a dayly/weekly/or month period.
+You will see the particular view with the ability to add an event.
\ No newline at end of file
[ofbiz-framework] 02/11: Documented: migrate help link to asciidoc
user manual for Product (OFBIZ-11587)
Posted by ho...@apache.org.
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 63daf2511270037b269bccb3dd0c567861e69afb
Author: holivier <ho...@apache.org>
AuthorDate: Tue Jul 14 16:19:48 2020 +0200
Documented: migrate help link to asciidoc user manual for Product
(OFBIZ-11587)
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
Product & Facility and add a short page with a link to the new help
Remove docbook help files for Product & Facility
---
.../product/data/{helpdata => }/HELP_PRODUCT.xml | 23 +--
applications/product/data/ProductHelpData.xml | 24 ---
.../product/data/helpdata/HELP_IMAGEMANAGEMENT.xml | 211 ---------------------
.../data/helpdata/HELP_PRODCATALOG_main.xml | 66 -------
.../data/helpdata/HELP_PRODUCT_Catalog_Promos.xml | 64 -------
.../data/helpdata/HELP_PRODUCT_Features.xml | 93 ---------
.../data/helpdata/HELP_PRODUCT_Product_Stores.xml | 129 -------------
.../helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml | 111 -----------
.../product/widget/catalog/CommonScreens.xml | 11 +-
9 files changed, 14 insertions(+), 718 deletions(-)
diff --git a/applications/product/data/helpdata/HELP_PRODUCT.xml b/applications/product/data/HELP_PRODUCT.xml
similarity index 66%
rename from applications/product/data/helpdata/HELP_PRODUCT.xml
rename to applications/product/data/HELP_PRODUCT.xml
index 53effb7..f4d59c5 100644
--- a/applications/product/data/helpdata/HELP_PRODUCT.xml
+++ b/applications/product/data/HELP_PRODUCT.xml
@@ -7,9 +7,9 @@
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
@@ -17,23 +17,14 @@
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"
+<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 Catalog overview screen help screen</title>
- <para>Introduction</para>
- <section>
- <title>subsection heading</title>
- <para>Subsection content</para>
- </section>
- <section>
- <title>Subsection 2 title</title>
- <para>
- The Main catalog help screen. For more information please
- see the <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Home">OFBiz documentation site</link> for more info.
+ <title>The Catalog help redirection</title>
+ <para>Catalog 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#_catalog">OFBiz user documentation site / Catalog</link>
</para>
- </section>
</section>
diff --git a/applications/product/data/ProductHelpData.xml b/applications/product/data/ProductHelpData.xml
index 720ec45..ccc43e1 100644
--- a/applications/product/data/ProductHelpData.xml
+++ b/applications/product/data/ProductHelpData.xml
@@ -22,28 +22,4 @@ under the License.
<Content contentId="HELP_PRODUCT" contentTypeId="DOCUMENT" localeString="en" contentName="Catalog Manager" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_PRODUCT" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
<ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_PRODUCT" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="020"/>
- <DataResource dataResourceId="PRODCATALOG_main" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/product/data/helpdata/HELP_PRODCATALOG_main.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Accounting Help" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="PRODCATALOG_main" contentTypeId="DOCUMENT" contentName="Main Catalog Help" templateDataResourceId="HELP_TEMPL" dataResourceId="PRODCATALOG_main" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="HELP_PRODUCT" contentIdTo="PRODCATALOG_main" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="CATALOG_main"/>
-
- <!-- Image Management -->
- <DataResource dataResourceId="IMAGEMANAGEMENT_MAIN" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Image Management" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="IMAGEMANAGEMENT_MAIN" contentTypeId="DOCUMENT" contentName="Image Management" templateDataResourceId="HELP_TEMPL" dataResourceId="IMAGEMANAGEMENT_MAIN" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="PRODCATALOG_main" contentIdTo="IMAGEMANAGEMENT_MAIN" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="01" mapKey="CATALOG_Imagemanagement"/>
-
- <!-- Facility help pages -->
- <DataResource dataResourceId="HELP_FACILITY" localeString="en" dataResourceTypeId="OFBIZ_FILE"
- objectInfo="applications/product/data/helpdata/HELP_FACILITY.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
- dataResourceName="Help system Facility" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="HELP_FACILITY" contentTypeId="DOCUMENT" contentName="Facility" templateDataResourceId="HELP_TEMPL"
- dataResourceId="HELP_FACILITY" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_FACILITY" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/>
-
- <DataResource dataResourceId="HELP_FACILITY_TRK" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/product/data/helpdata/HELP_FACILITY_Tracking.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Help system Facility Tracking" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="HELP_FACILITY_TRK" contentTypeId="DOCUMENT" localeString="en" contentName="Facility Tracking" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_FACILITY_TRK" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="HELP_FACILITY" contentIdTo="HELP_FACILITY_TRK" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="FACILITY_Tracking"/>
-
- <DataResource dataResourceId="HELP_FACILITY_PICK" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/product/data/helpdata/HELP_FACILITY_PicklistManage.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Help system Facility PicklistManage" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="HELP_FACILITY_PICK" contentTypeId="DOCUMENT" localeString="en" contentName="Facility PicklistManage" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_FACILITY_PICK" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="HELP_FACILITY" contentIdTo="HELP_FACILITY_PICK" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="FACILITY_PicklistManage"/>
</entity-engine-xml>
diff --git a/applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml b/applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml
deleted file mode 100644
index 21197c6..0000000
--- a/applications/product/data/helpdata/HELP_IMAGEMANAGEMENT.xml
+++ /dev/null
@@ -1,211 +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>Image Management Help.</title>
- <para>The Image Management module manages many kind of image what user want. There are various functions including 'Gallery', 'Upload', 'Approved', 'Manage' etc.</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Go to Catalog Component.</para>
- <para>Go to Image Management.</para>
- </listitem>
- </orderedlist>
- </para>
- <section>
- <title>How To Add Security Group For Image Management User</title>
- <para>There are three security groups related in the Image Management including 'IMAGEADMIN', 'IMAGEAPPROVE' and ' IMAGEUPLOAD'.</para>
- <para>
- <orderedlist>
- <listitem>
- <para>Go to 'Party' component.</para>
- <para>Search 'UserLogin' or 'Party Id'.</para>
- <para>Click 'UserLogin' or 'Party Id'.</para>
- <para>At 'User Name(s)', click 'Security Groups' button.</para>
- <para>At 'Add UserLogin to Security Group', select group 'IMAGEADMIN Image Management Admin' for use all operations in the Image Management.</para>
- <para>select 'IMAGEUPLOAD Image Management Upload': To add party's permission for uploading, or select 'IMAGEAPPROVE Image Management Approve': To add party's permission for approving.</para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>How To Add Role For Approve Image To Party Id</title>
- <para>When user click partyId into party's screen already. Select the submenu 'Role(s)' to add the role to party</para>
- <para>There is Add To Role screenlet, select role 'Image Approver'(on the combobox role type Id) then click 'add' button.</para>
- </section>
- <section>
- <title>Gallery</title>
- <section>
- <para>Gallery shows all images which have approved.</para>
- <para>Note: Everybody can access Gallery function.</para>
- <orderedlist>
- <listitem>
- <para>Click 'Gallery' button, then choose a 'Product Id' by type or click a find icon.</para>
- <para>Click 'Submit' button, then you will see all images which have approved.</para>
- <para>You can click 'Share' button that generates any codes to share your images to any people.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section>
- <title>Upload</title>
- <section>
- <para>In this function, you can upload image files into system. You can upload many image files up to 10 files.</para>
- <para>Note: You must have Image Management Upload permission for access Upload function.</para>
- <orderedlist>
- <listitem>
- <para>Go to 'Upload' section, Enter 'Product Id' by type or click a find icon.</para>
- <para>Optional, you can specify the size of images.</para>
- <para>Then click 'Browse' button to choose image file(s).</para>
- <para>Click 'Upload' button.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section>
- <title>Recently Approved</title>
- <section>
- <para>In this function, you can see the images which have been approved for 14 days recently.</para>
- <para>Note: You must have Image Management Admin permission for access this function.</para>
- <orderedlist>
- <listitem>
- <para>Click 'Recently Approved' Button, then you will see the lists of recently approved product which are separated by date.</para>
- <para>Click on product id to see its images with details.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section>
- <title>Approve</title>
- <section>
- <para>In this function, you can set the status of each image including 'Approve', 'Pending' and 'Rejected'.</para>
- <para>Note: You must have Image Management Admin permission for access this function.</para>
- <orderedlist>
- <listitem>
- <para>Click 'Approve' Button, then specify the status of each image.</para>
- <para>Choose 'Approve' status for approve image.</para>
- <para>Choose 'Reject' status for reject image..</para>
- <para>Choose 'Pending' status for pending image..</para>
- <para>Click 'Submit' button.</para>
- </listitem>
- </orderedlist>
- <para>The images will be approved if all image administrators approved them. But if only one person rejects an image then that image will be rejected.</para>
- </section>
- </section>
- <section>
- <title>Rejected</title>
- <section>
- <para>The Rejected function shows the images which have rejected.</para>
- <para>Note: You must have Image Management Admin permission for access this function.</para>
- <orderedlist>
- <listitem>
- <para>Click 'Rejected' button, then you specify the reason of rejection each image.</para>
- <para>Then click 'Submit' button.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section>
- <title>Manage</title>
- <section>
- <para>You can edit image such as add frame, crop image etc. You can also add caption, sort order, enable image and choose thumbnail in this function.</para>
- <para>Note: You must have Image Management Admin permission for access this function.</para>
- <orderedlist>
- <listitem>
- <para>Click 'Manage' Button, then you can choose action including 'Frame', 'Crop' and 'Rotate' (see below for more details).</para>
- <para>Enter your image caption.</para>
- <para>Sort order of image by enter order number.</para>
- <para>Enable image by tick enable checkbox.</para>
- <para>Select image thumbnail of product.</para>
- <para>Click 'Submit' button.</para>
- </listitem>
- </orderedlist>
- <section>
- <title>- Frame</title>
- <section>
- <para>In Frame function, you can merge your image with the frame image (transparent image file e.g. PNG type) together.</para>
- <para>The frame image should be larger than selected image.</para>
- <orderedlist>
- <listitem>
- <para>Choose 'Frame' then choose the image you want to merge frame.</para>
- <para>Select the frame image by browsing transparent image file, such as PNG type.</para>
- <para>Click 'Upload' button to upload the frame image.</para>
- <para>Enter width and height of image.</para>
- <para>Optional, you click 'Preview' to see example image.</para>
- <para>Click 'Create' button.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section>
- <title>- Crop</title>
- <section>
- <para>You can crop any images in this function.</para>
- <orderedlist>
- <listitem>
- <para>Choose 'Crop' then choose your image.</para>
- <para>Move your cursor on the image, then drag your mouse to crop image.</para>
- <para>You can see the preview image in the right hand side.</para>
- <para>Finally, you click 'Crop' button.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <section>
- <title>- Rotate</title>
- <section>
- <para>You can rotate images in this function.</para>
- <orderedlist>
- <listitem>
- <para>Choose 'Rotate' then click clockwise or counterclockwise button for ratating image.</para>
- <para>Click 'Submit' button</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- </section>
- </section>
- <section>
- <title>Replace</title>
- <section>
- <para>In this function, you can replace the selected image with other image.</para>
- <para>The image which you want to replace must be approved first.</para>
- <orderedlist>
- <listitem>
- <para>Click 'Replace' button, Enter 'Product Id' by type or click a find icon.</para>
- <para>Then choose the image which you want to replace.</para>
- <para>Choose the other image to replace with the selected image.</para>
- <para>Click 'Submit' button.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>
- <!--<section>
- <title>Automatic Resize</title>
- <section>
- <para>You can resize any images in this function.</para>
- <orderedlist>
- <listitem>
- <para>Go to 'Automatic Resize' section, Enter 'Product Id' by type or click a find icon.</para>
- <para>Choose Image to resize, then you can select a size.</para>
- <para>Click 'Upload Image'.</para>
- </listitem>
- </orderedlist>
- </section>
- </section>-->
-</section>
diff --git a/applications/product/data/helpdata/HELP_PRODCATALOG_main.xml b/applications/product/data/helpdata/HELP_PRODCATALOG_main.xml
deleted file mode 100644
index 42ca534..0000000
--- a/applications/product/data/helpdata/HELP_PRODCATALOG_main.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 Product Catalog overview</title>
- <para>The Catalog Manager creates or provides access to a variety of information. Whether Products, Catalogs, or Categories, this screen offers search tools and links to get you to the type of information you need or are working with quickly and accurately.</para>
- <para>
- <note><para>Different Visual Themes will represent the links differently the Visual Themes for this is Flat Grey</para></note>
- Down the left hand column are 4 sections:
-
- 1. Search Products,
- 2. Browse Catalogs,
- 3. Browse Categories, and
- 4. Product Categories.
- <tip>
- <para>
- You can click on the colored '_' to close a section; later, click on the colored '[]' to reopen the section. Each of those sections are discussed below before we begin to explore the Catalog Administration Main Page.
- Navigation Panel
-
- The Left-hand Navigation Panel is visible even when working under the other tabs. The content displayed will vary according to what choices you have made. This document is arranged to walk you through the Navigation Panel search tools (Search Products, Browse Catalogs, Browse Categories, and Category Products) and links first. As you come to the desired Edit or Creation window, jump in this document to the associated 'Edit' discussion.
- Some symbols used as shortcuts
- Brackets []
-
- Application links as found on the screens are represented in this document with brackets around them like [this]. When you see a bracketed item, you can know we are referring to a link or key or 'button' which will initiate the indicated action.
- Greater than symbols >>
-
- The single (>) or double (>>) greater than symbols can be read as 'takes you to' or 'leads to' or 'results in.' These are sometimes used in this document to indicate that from this screen, if you click on the [Bracketed Link], you will be taken to Next Process. Within the pop-up calendars, however, the (>>) jumps you ahead one year and the (<<) jumps you back a year.
- The Asterisk
-
- An asterisk * marks those items which must be completed on a screen before the desired action can occur.
- </para>
- </tip>
- </para>
- <section>
- <title>subsection heading</title>
- <para>Subsection content</para>
- </section>
- <section>
- <title>Subsection 2 title</title>
- <para>
- The Main accounting help screen. For more information please
- see the <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/CATALOG">OFBiz documentation site</link> for more info.
- </para>
- </section>
-</section>
-
diff --git a/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml b/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
deleted file mode 100644
index 1bbf15e..0000000
--- a/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
+++ /dev/null
@@ -1,64 +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 id="Promotions" 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> Promotions </title>
-
- <section>
- <title> Similar to Price Rules</title>
- <para>Promotions are similar to Price Rules (see Price Rules, below) but are used to record special promotional offers which apply to the entire order, rather than prices for a particular product. For example, the promotional manager can be used to set up rules to give customers a percentage discount if they purchase a minimum quantity, or to create a coupon code.
-</para>
- </section>
- <note>
- <title> Tied to Specific Stores</title>
- <para>Promotions are tied to specific stores, whereas price rules are applicable to all products (although you can specify the website, product catalog, or category for which a price rule is applicable).
-</para>
- </note>
- <section>
- <title> Opening Screen</title>
- <para>The opening screen lists all promotions which are currently available and a link for creating additional promotions; click on one to go to a promotion. You will also see a series of four tabs: [Promo], [Rules], [Stores] and [Codes].
-</para>
- </section>
- <section>
- <title> Promo tab</title>
- <para>At the top is general information about this promotion. Each promotion has an ID, a name and a longer descriptive text, which are shown to customers. If no text is entered, Apache OFBiz will automatically generate text for you.
-</para>
- </section>
- <note>
- <title> Rules discussion</title>
- <para>Rules for promotions are used to determine what actions should be taken in the promotion. Each promotion can have multiple rules, and each rule can have multiple conditions and actions. If a promotion had multiple rules, they would all be checked in sequence, and the rules whose conditions were true will be activated. This is especially helpful for complicated promotions that have multiple offers.
-</para>
- </note>
- <section>
- <title>Stores tab</title>
-<para>The stores tab shows a list of product stores in which this promotion is active.
- You can add additional stores here or delete them.
-</para>
- </section>
- <section>
- <title> Codes tab</title>
-<para>The codes tab is used to associate codes for a promotion, similar to coupon codes.
-
-
-</para>
- </section>
- </section>
-
diff --git a/applications/product/data/helpdata/HELP_PRODUCT_Features.xml b/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
deleted file mode 100644
index af5e039..0000000
--- a/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
+++ /dev/null
@@ -1,93 +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>Catalog Features overview </title>
- <anchor xml:id="ProductCatalogFeatures"/>
- <para>To Sell and to Differentiate Products
-Features are characteristics used to sell and to differentiate products. The Apache OFBiz catalog manager allows you to define any feature set you wish for your products. Typical features include size and color. In Apache OFBiz, features are associated, or applied, to products as Standard Features, Selectable Features, or Distinguishing Features.
-</para>
-
-
- <section>
- <title> Standard features</title>
- <anchor xml:id="Standardfeatures"/>
- <para>Standard features are features which are associated with every instance of a product. An example might be the brand name of a product -- all instances of the product share the same brand name.
-</para>
-
- </section>
- <section>
- <title> Selectable features</title>
- <anchor xml:id="Selectablefeatures"/>
- <para>Selectable features are features which the customer selects one from many available choices. For example, a shirt may be available in White, Blue, Green, Yellow, Pink. These colors would be selectable features of the variant product shirt, and the customer would be prompted to choose a color.
-</para>
- <para>Each color, though, would be a standard feature of the physical product. Thus, White would be a selectable feature of the virtual product 'shirt' but a standard feature of 'white shirt.'
-</para>
-
- </section>
- <section>
- <title> Distinguishing features</title>
- <anchor xml:id="Distinguishingfeatures"/>
- <para>Distinguishing features are features which distinguish one product from another and are used to show the customer which item she chose.
-</para>
-
- </section>
- <section>
- <title> Working with Product Features</title>
- <anchor xml:id="WorkingProductFeatures"/>
- <para>Click on Features tab. Defaults to Product Features</para>
-</section>
- <section>
- <title> Create and Maintain Product Features</title>
- <anchor xml:id="CreateMaintainProductFeatures"/>
- <para>These screens are for creating and maintaining product features, which are features or characteristics that are available for products. Here you will define what features can be available for products. Later, when working with the products, you will have a chance to define what features a particular product may have.
-</para>
-
- </section>
- <section>
- <title> Feature Categories and Feature Groups</title>
- <anchor xml:id="FeatureCategoriesandFeatureGroups"/>
- <para>Notice the sub-tabs for Feature Categories and Feature Groups. These are both used to help you organize your product features. Each feature can only belong to one category but as many groups as you need. For example, you can have a colors category that has colors White, Blue, Grey, Green, Yellow, Pink, Red, and Orange and a sizes category that has sizes XXS, XS, S, M, L, XL, XXL. Then, you can have one group for shirts that would have colors White, Blue, Grey and sizes S, M [...]
-
- </para>
- </section>
- <section>
- <title> Add Features to a Category</title>
- <para>Once you have created a feature category, you can click on it to add features to it. There is a link [Create new feature] which takes you to a screen to create a new product feature. Below this link is a list of product features already in this category. Important fields for product features are listed below.
-
- </para>
- </section>
- <section>
- <title> Feature Categories</title>
- <para>Click on [Feature Categories] (this is the default screen when you clicked on 'Features' above), and you will see a menu for editing a particular feature, if you remember its feature ID. (If not, you can edit it from the feature categories below.) Next, you will see a list of feature categories and their parent categories. The categories' ID codes are highlighted, and you can click on one to go to the feature category. At the very bottom is a menu for creating a new feature [...]
-
- </para>
- </section>
- <section>
- <title> Working with Feature Groups</title>
- <para>Click on [Feature Groups] and you will see a screen showing a list of available feature groups, and an option to create a new feature group at the bottom. Click on the ID of the feature group, and you will be taken to a screen which shows all the features in this group (if there are any) and a menu to add more features to this group. Like feature categories, the IDs of feature groups are automatically created.
-
- </para>
- </section>
- <section>
- <title>. Implement Feature-based Product Search</title>
- <para>You can associate feature categories or feature groups to a Product Category. Buy doing this will provide web store customer feature based product search ability. If customers choose to search within a given category and that category has features associated with it then they will be displayed as selectable filtering options (based on the associated product features) on the search form.</para>
- </section>
-</section>
-
diff --git a/applications/product/data/helpdata/HELP_PRODUCT_Product_Stores.xml b/applications/product/data/helpdata/HELP_PRODUCT_Product_Stores.xml
deleted file mode 100644
index a1505ee..0000000
--- a/applications/product/data/helpdata/HELP_PRODUCT_Product_Stores.xml
+++ /dev/null
@@ -1,129 +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 id="ProductStores" 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> Product Stores</title>
-<para>A product store has all the information needed to sell products. It is composed of a series of catalogs, which are composed of product categories and products. Each store can have its own shipping, fulfillment, notification, promotions, payment processing, and tax calculation policies. A product store can point to several different websites, allowing the same products to be sold on multiple hosted sites or domains. Alternatively, multiple stores, each with their own website, can be [...]
-
-</para>
-
-<section>
- <procedure>
-
- <step performance="required">
- <para>Go to Catalog Manager
-</para>
- </step>
- <step performance="required">
- <para> Go to Catalog Manager - Stores tab
-Stores tab (with a store selected) brings up Roles, Promos, Catalogs, Web Sites, Sales Tax, Shipping, Payments, Emails, Surveys, and Override tabs to perform a host of other store-related functions.
-</para>
- </step>
- <step performance="required">
- <para> Select existing store
-</para>
- </step>
- <step performance="required">
- <para>If none, Create New Product Store
-</para>
- </step>
- <step performance="required">
- <para> Complete fields
-</para>
- </step>
- <step performance="required">
- <para>Click on Update]</para> </step>
- </procedure>
-
-
-
-</section>
-<section>
- <title> Working with Product Stores</title>
-<para>When you click on 'Stores,' you will see a list of product stores that have been defined. Click on one and you will see several tabs for administering different aspects of that store. Some of those aspects are discussed below.
-</para>
-</section>
-<section>
- <title> Why use stores?</title>
- <para>The 'Stores' tab in the catalog manager as used to define all the properties of a working store, is a group of products sold together under the same policies. Stores greatly improve the flexibility of Apache OFBiz applications. It is possible for a company to set up multiple stores, each with its warehouses, fulfillment policies, currencies, languages, promotions, and look-and-feel. These stores can be web-based b2b or consumer ecommerce stores or for internal order entry. They co [...]
-</para>
-</section>
-<section>
- <title> Product Store</title>
- <para>This very complete screen provides entry for all of the myriad choices available which define the store and establish parameters.
-</para>
-</section>
-<section>
- <title> Roles</title>
- <para>Defines parties with specific roles for this store. For an employee to be able to take orders using the internal order manager application, he must be defined as a 'Sales Representative' here. Restrictions are enforced through the Party Manager - SecurityGroupsList which grants rights according to party roles.
-</para>
-</section>
-<section>
- <title> Promos</title>
- <para>Shows a list of active promotions for this store.
-</para>
-</section>
-<section>
- <title> Catalogs</title>
- <para>Catalogs which are available for the current store and the sequence in which they are to be shown to the user in a navigation menu.
-</para>
-</section>
-<section>
- <title> Web Sites</title>
- <para>Websites which are related to this store. This is directly used to link a store to a web application. Each web application has a configuration file called web.xml, and it is defined to reference a particular web site. The web site in turn is defined to relate to a product store. Thus, by setting a store on a web site, it becomes 'live' on that web application.
-NOTE: It is possible for a web application to have more than one store associated with it, as long as the application knows how to use the correct one.
-
-</para>
-</section>
-<section>
- <title> Shipping</title>
- <para>This page shows the shipping options available to store customers. A list of shipping options and their pricing is shown. Click on View for a shipping option shows all the settings for this shipping option. At this point, this tab can only view shipping options available and can not be used to define them.
-</para>
-</section>
-<section>
- <title>Payments</title>
-<para>his is used to set up payment processing for the store. The payment processing interfaces are defined as Apache OFBiz services. Each payment method will have a series of service types available to it, such as for authorizing, capturing, and refunding payment. This page links the payment types and the services together by their purpose. Thus, one service would be used for credit card authorizations, another for credit card capture, and so forth
-</para>
-</section>
-<section>
- <title>EMails</title>
- <para>This defines emails which the store would send to customers. The actual email services are either mounted in the controller, such as the order confirmation email, or from scheduled services, such as back order notifications. This page defines where the template for the email is located on the file system, the addresses and subject of each email, and a content type (which can be left blank).
-</para>
-</section>
-<section>
- <title> Surveys</title>
- <para>This page is for adding surveys to the store. Surveys can be associated with certain events or with products and categories.
-</para>
-</section>
-<section>
- <title>Override</title>
- <para>Allows certain keywords to be ascendant at this store for a particular time period.
-</para>
-</section>
-<section>
- <title>Segments</title>
- <para>Identifies the Sales or Market Segments targeted for this Store. The actual assignment is made under the Marketing tab > Segment sub-tab. Here under the Product Store you will see a summary table of those assignments along with links to make any additions or changes.
-</para>
-</section></section>
diff --git a/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml b/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
deleted file mode 100644
index caaf041..0000000
--- a/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
+++ /dev/null
@@ -1,111 +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 id="WorkingwithCatalogs" 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> Working with Catalogs</title>
-
-<section>
- <title> Working with Catalogs</title>
- <para>
-To follow this topic, click on the 'Catalog Detail List' in the left-hand panel under the 'Browse Catalogs' section.
- Then click on any catalog in the table of current catalogs presented in the main screen.
-You will see the top-level editing screen for that catalog.
- Along the top of the working screen are four sub-tabs: Catalog, Stores, Parties and Catalogs.
-Each of those are discussed as a topic below.
-
-</para>
-</section>
-<section>
- <title> Catalogs in general</title>
- <para>
-A product catalog is used to group many product categories together and forms an intermediate step in the organization between products, categories, and stores. The product catalog can be used to define a common look and feel for all categories in this catalog and specify the way different categories will behave. For example, it is very useful for stores which sell products from different manufacturer or completely different product types that require differing presentations to the customer.
-</para>
-</section>
-<note>
- <title> Sequence from a Store to the Products</title>
- <para>
-Although the process sequence through the tabs discussed below does not correspond with the tab layout within the Catalog Manager, the progression of the steps is intentional. Promotions and Price Rules cannot exist without Products. Products are usually so numerous that you wish to divide them into Categories and distinguish them by their Features. Categories are then the major sections of your Catalogs. And Catalogs must be associated with their related Stores. Therefore, when setting [...]
-</para></note>
-<section>
- <title> Catalog tab</title>
- <para>
-The main Catalog tab for a product catalog is mostly for establishing the look and feel. Each catalog can have its own style sheet (CSS), its own logo, and its own content repository (the content path prefix) and templates prefix (where its freemarker templates are located).
-</para>
-</section>
-<section>
- <title> The Stores tab</title>
- <para>
-The 'Stores' tab shows a list of Stores that this Catalog is currently featured in. Note that Stores and Catalogs do not have a one-to-one relationship: the same Store can feature multiple Catalogs, and the same Catalog could be featured in many Stores.
-
-</para>
-</section>
-<section>
- <title>The Parties tab</title>
- <para>
-Here you identify which Party is responsible for or assigned to work with the specific Catalog selected. The Party's Role is assigned or identified and, if appropriate, a start and/or finish date for the assignment can be specified.
-
-</para>
-</section>
-<section>
- <title>Categories tab</title>
- <para>
-The 'categories' tab shows the different product categories and their roles for this catalog. Specifically:
-
- * Each catalog can (should) have a 'Browse Root' category, which is used as the root category for navigation. For example, the navigation menu would start at this category and show its child categories.
- * Each catalog can also have a 'Promotions' category, which is shown first to the customer when he signs in to the site.
- * There is also a 'Default Search' category. Products in this category are used for search results first.
- * 'Quick add' categories are used to specify categories where products can be added in bulk to the cart from the same screen.
-
-</para>
-</section>
-<section>
- <title> Browse Categories links</title>
- <para>
-In the left-hand panel is a section labeled 'Browse Categories.' You can click on one of the -indented- categories to begin editing it directly, or click on the [Choose Top Category] link to view a list of links to all Parent categories.
-
-</para>
-</section>
-<section>
- <title> Catalog Administration Main Page</title>
- <para>
-The catalog administration main page has several small menus for finding catalogs, categories, or products. The first three menus allow you to edit catalogs, categories, or products by their respective IDs, or create new catalogs, categories, or products. The last one allows you to look for a product using an ID other than its product ID, such as upc or isbn number (see below.) Under these menus are two more links. [Auto create keywords] and [Fast load catalog into cache].
-
-</para>
-</section>
-<section>
- <title> Auto create keywords</title>
- <para>
-[Auto create keywords] will create keywords for all of the products identified with the current Catalog. The keywords are based on product descriptions and are used for searching for products.
-
-</para>
-</section>
-<section>
- <title> Fast load catalog</title>
- <para>
-[Fast load catalog into cache] will load all products and product categories into the cache; this is good for improved application performance. Note that only basic product and category information from the first Product and Category tabs is loaded, so additional information such as content, associations, and pricing will still have to be retrieved from the database and cached later by the applications.
-
-</para>
-</section>
-
-</section>
-
diff --git a/applications/product/widget/catalog/CommonScreens.xml b/applications/product/widget/catalog/CommonScreens.xml
index cbaf3e6..5b3aa28 100644
--- a/applications/product/widget/catalog/CommonScreens.xml
+++ b/applications/product/widget/catalog/CommonScreens.xml
@@ -40,6 +40,7 @@ under the License.
<set field="activeApp" value="catalogmgr" global="true"/>
<set field="applicationMenuName" value="CatalogAppBar" global="true"/>
<set field="applicationMenuLocation" value="component://product/widget/catalog/CatalogMenus.xml" global="true"/>
+ <set field="helpAnchor" from-field="helpAnchor" default-value="_catalog"/>
<set field="applicationTitle" from-field="uiLabelMap.ProductCatalogManagerApplication" global="true"/>
<set field="layoutSettings.javaScripts[+0]" value="/common/js/jquery/ui/js/jquery.cookie-1.4.0.js" global="true"/>
</actions>
@@ -233,7 +234,7 @@ under the License.
</decorator-section>-->
<decorator-section name="left-column">
<include-screen name="leftbar"/>
- </decorator-section>
+ </decorator-section>
<decorator-section name="body">
<section>
<!-- do check for CATALOG, _VIEW permission -->
@@ -302,7 +303,7 @@ under the License.
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
<decorator-section name="left-column">
<include-screen name="leftbar"/>
- </decorator-section>
+ </decorator-section>
<decorator-section name="body">
<container style="button-bar">
<link target="EditCategory" text="${uiLabelMap.ProductNewCategory}" style="buttontext create"/>
@@ -325,7 +326,7 @@ under the License.
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
<decorator-section name="left-column">
<include-screen name="leftbar"/>
- </decorator-section>
+ </decorator-section>
<decorator-section name="body">
<platform-specific><html><html-template location="component://product/template/FastLoadCache.ftl"/></html></platform-specific>
</decorator-section>
@@ -333,7 +334,7 @@ under the License.
</widgets>
</section>
</screen>
-
+
<screen name="categorytree">
<section>
<actions>
@@ -371,6 +372,7 @@ under the License.
<set field="headerItem" value="main"/>
<set field="productId" from-field="parameters.productId"/>
<entity-one entity-name="Product" value-field="product"/>
+ <set field="helpAnchor" value="_help_for_the_party_find_screen"/>
</actions>
<widgets>
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
@@ -400,6 +402,7 @@ under the License.
<section>
<actions>
<set field="headerItem" value="Imagemanagement"/>
+ <set field="helpAnchor" from-field="helpAnchor" default-value="_image_management"/>
</actions>
<widgets>
<decorator-screen name="main-decorator" location="${parameters.mainDecoratorLocation}">
[ofbiz-framework] 11/11: Documented: Framework,
delete all docbook files related to migration to asciidoc
(OFBIZ-11587)
Posted by ho...@apache.org.
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 9ec3d9ca771dd379af1b8eb942fc36bf329686d7
Author: holivier <ho...@apache.org>
AuthorDate: Tue Jul 14 17:06:56 2020 +0200
Documented: Framework, delete all docbook files related to migration to
asciidoc (OFBIZ-11587)
Add a link to developer-manual for webtools in old help system
---
applications/content/data/WebtoolsHelpData.xml | 11 +++--------
framework/webtools/data/HELP_WEBTOOLS.xml | 24 ++++++++++++++++++++++++
2 files changed, 27 insertions(+), 8 deletions(-)
diff --git a/applications/content/data/WebtoolsHelpData.xml b/applications/content/data/WebtoolsHelpData.xml
index 9c4c5c9..d688aab 100644
--- a/applications/content/data/WebtoolsHelpData.xml
+++ b/applications/content/data/WebtoolsHelpData.xml
@@ -21,14 +21,9 @@ under the License.
<!-- webtools help data -->
<DataResource dataResourceId="HELP_WEBTOOLS" localeString="en" dataResourceTypeId="OFBIZ_FILE"
- objectInfo="framework/webtools/data/helpdata/HELP_WEBTOOLS.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
+ objectInfo="framework/webtools/data/HELP_WEBTOOLS.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS"
dataResourceName="Webtools Overview" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="HELP_WEBTOOLS" contentTypeId="DOCUMENT" contentName="Framework Webtools" templateDataResourceId="HELP_TEMPL"
+ <Content contentId="HELP_WEBTOOLS" contentTypeId="DOCUMENT" contentName="Framework Webtools" templateDataResourceId="HELP_TEMPL"
dataResourceId="HELP_WEBTOOLS" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
<ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_WEBTOOLS" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/>
-
- <DataResource dataResourceId="WEBTOOLS_main" localeString="en" dataResourceTypeId="OFBIZ_FILE"
- objectInfo="framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="List parties Help" mimeTypeId="text/xml" isPublic="Y" />
- <Content contentId="WEBTOOLS_main" contentTypeId="DOCUMENT" contentName="Webtools main menu." templateDataResourceId="HELP_TEMPL" dataResourceId="WEBTOOLS_main" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/>
- <ContentAssoc contentId="HELP_WEBTOOLS" contentIdTo="WEBTOOLS_main" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="WEBTOOLS_main"/>
-</entity-engine-xml>
\ No newline at end of file
+ </entity-engine-xml>
\ No newline at end of file
diff --git a/framework/webtools/data/HELP_WEBTOOLS.xml b/framework/webtools/data/HELP_WEBTOOLS.xml
new file mode 100644
index 0000000..98a74aa
--- /dev/null
+++ b/framework/webtools/data/HELP_WEBTOOLS.xml
@@ -0,0 +1,24 @@
+<?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 Webtools Help redirection.</title>
+ <para>Webtools 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/developer-manual.html#_web_tools">OFBiz Developer documentation site / Webtools</link>
+ </para>
+</section>
\ No newline at end of file
[ofbiz-framework] 09/11: Documented: Framework,
migration all docbook files to asciidoc (OFBIZ-11587)
Posted by ho...@apache.org.
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 b0f445b123e0df6dd71786ad945384972c43bd4d
Author: holivier <ho...@apache.org>
AuthorDate: Tue Apr 14 12:22:17 2020 +0200
Documented: Framework, migration all docbook files to asciidoc
(OFBIZ-11587)
- common-sending-email: include in email
- datafile: move as a include at the end of entity-engine section
- entity-engine: list of link to OFBiz wiki about entity configuration
- service-engine: a link to OFBiz wiki Service Engine Guide
- webtools: help for main screen
- mini-lang: include a link to OFBiz wiki mini-lang-reference at the
beginning of minilang-to-groovy-manual
move minilang-to-groovy-manual to Development environment
section
- unit-test: include as Junit test, and use README to list gradle
command available (so add a tag in REAME.adoc)
- base: add a link to OFBiz wiki Configuration Guide, in deployment
section
- SingleSignOn with LDAP: move to plugin LDAP and include in deployment
section
developer-manual is updated with some include lines or with directly a
sentence.
---
README.adoc | 2 +
docs/asciidoc/developer-manual.adoc | 21 ++-
.../{email.adoc => _include/email-sending.adoc} | 11 +-
framework/base/src/docs/asciidoc/email.adoc | 2 +
.../datafile/src/docs/asciidoc/datafiles.adoc | 111 ++++++++++++++
.../src/docs/asciidoc/entity-engine.adoc} | 11 +-
.../docs/asciidoc/minilang-to-groovy-manual.adoc | 9 +-
.../testtools/src/docs/asciidoc/SingleSignOn.adoc | 159 +++++++++++++++++++++
.../testtools/src/docs/asciidoc/unit-tests.adoc | 155 ++++++++++++++++++++
.../src/docs/asciidoc/_include/webtools-main.adoc | 38 +++++
10 files changed, 507 insertions(+), 12 deletions(-)
diff --git a/README.adoc b/README.adoc
index 2ed7bff..9d3d513 100644
--- a/README.adoc
+++ b/README.adoc
@@ -481,6 +481,7 @@ parameters are passed:
[[testing-tasks]]
=== Testing tasks
+# tag::testingtasks[]
[[execute-all-unit-tests]]
==== Execute all unit tests
@@ -540,6 +541,7 @@ listens on port *5005*
`gradlew "ofbiz --test component=entity --test suitename=entitytests" --debug-jvm`
+# end::testingtasks[]
[[miscellaneous-tasks]]
diff --git a/docs/asciidoc/developer-manual.adoc b/docs/asciidoc/developer-manual.adoc
index 3e07ab9..ef1261c 100644
--- a/docs/asciidoc/developer-manual.adoc
+++ b/docs/asciidoc/developer-manual.adoc
@@ -199,7 +199,7 @@ include::../../framework/webapp/src/docs/asciidoc/webapp.adoc[leveloffset=+1]
==== Views
-== Entity Engine
+include::../../framework/entity/src/docs/asciidoc/entity-engine.adoc[leveloffset=+1]
=== Entities
@@ -213,6 +213,8 @@ include::../../framework/webapp/src/docs/asciidoc/webapp.adoc[leveloffset=+1]
=== XML Data
+include::../../framework/datafile/src/docs/asciidoc/datafiles.adoc[leveloffset=+2]
+
=== Entity engine configuration
=== Supported databases
@@ -220,6 +222,8 @@ include::../../framework/webapp/src/docs/asciidoc/webapp.adoc[leveloffset=+1]
include::../../applications/datamodel/DATAMODEL_CHANGES.adoc[leveloffset=+2]
== Service Engine
+A description of the service engine can be found at the
+https://cwiki.apache.org/confluence/display/OFBIZ/Service+Engine+Guide[OFBiz wiki Service Engine Guide]
=== Declaration and Implementation
@@ -264,19 +268,30 @@ include::../../themes/docs/themes.adoc[leveloffset=+2]
==== Database
=== Web tools
+The Webtools application is the UI-gateway to all the framework functions.
+
+include::../../framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc[leveloffset=+3]
+
+include::../../framework/minilang/src/docs/asciidoc/minilang-to-groovy-manual.adoc[leveloffset=+1]
== Testing
-=== Unit Tests
+include::../../framework/testtools/src/docs/asciidoc/unit-tests.adoc[leveloffset=+2]
=== Integration Tests
== Deployment
+For a core configuration guide check
+https://cwiki.apache.org/confluence/display/OFBIZ/Framework+Configuration+Guide[the OFBiz configuration Guide]
+ (some points are not up to date).
+
+
include::../../framework/base/src/docs/asciidoc/email.adoc[leveloffset=+2]
+include::../../plugins/ldap/src/docs/asciidoc/SingleSignOn.adoc[leveloffset=+2]
+
include::../../framework/security/src/docs/asciidoc/security.adoc[leveloffset=+1]
== Appendices
-include::../../framework/minilang/docs/asciidoc/minilang-to-groovy-manual.adoc[leveloffset=+1]
diff --git a/framework/base/src/docs/asciidoc/email.adoc b/framework/base/src/docs/asciidoc/_include/email-sending.adoc
similarity index 61%
copy from framework/base/src/docs/asciidoc/email.adoc
copy to framework/base/src/docs/asciidoc/_include/email-sending.adoc
index 6408da3..7e098fa 100644
--- a/framework/base/src/docs/asciidoc/email.adoc
+++ b/framework/base/src/docs/asciidoc/_include/email-sending.adoc
@@ -16,8 +16,13 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= email
+= Sending Email in OFBiz
+Various parts in the OFBiz application are sending out email for various reasons.
-== HowTo use email in OFBiz
+Sending out email is controlled in the ${ofbiz install dir}/framework/common/config/general.properties file with
+ the following parameters:
-include::_include/email-receiving.adoc[leveloffset=+2]
+* SMTP Server (relay host): mail.smtp.relay.host
+* SMTP Username (if needed): mail.smtp.auth.user
+* SMTP Password (if needed): mail.smtp.auth.password
+* Turn on email notifications by setting the mail.notifications.enabled property to "Y".
diff --git a/framework/base/src/docs/asciidoc/email.adoc b/framework/base/src/docs/asciidoc/email.adoc
index 6408da3..39fadab 100644
--- a/framework/base/src/docs/asciidoc/email.adoc
+++ b/framework/base/src/docs/asciidoc/email.adoc
@@ -21,3 +21,5 @@ under the License.
== HowTo use email in OFBiz
include::_include/email-receiving.adoc[leveloffset=+2]
+
+include::_include/email-sending.adoc[leveloffset=+2]
diff --git a/framework/datafile/src/docs/asciidoc/datafiles.adoc b/framework/datafile/src/docs/asciidoc/datafiles.adoc
new file mode 100644
index 0000000..186586f
--- /dev/null
+++ b/framework/datafile/src/docs/asciidoc/datafiles.adoc
@@ -0,0 +1,111 @@
+////
+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 Datafiles
+
+== Intoduction
+There is a data import tool in OFBiz called the DataFile tool. +
+It uses XML files that describe flat file formats (including character delimited, fixed width, etc) and parses the flat files
+based on those definitions. So, by design it is somewhat like the Entity Engine.
+
+It uses a generic object to represent a row in the flat file. +
+It includes features like a line type code for each line and can support hierarchical flat files
+(ie where parent/child relationships are implied by sub-records).
+
+The code is in the ofbiz/framework/datafile directory, and there is an XSD there to describe how the data file definition XML
+file should look.
+
+The DataFile has a web page in WebTools to parse data files and generate entity xml files (that can be imported in OFBiz)
+from them, and to do in/outtesting.
+
+both the import of fixed width flat files and character delimited files are implemented.
+
+== Definitions
+* File : this is an xml file that contains one or more "Data File Definition"s;
+ ** the grammar of the file is defined in framework/datafile/dtd/datafile.xsd
+* Data file Definition : the definition of a data file structure (e.g. names/types of the fields/columns
+ in a "Data File";
+ ** the same "Data File" could have more than one "Data File Definition"s (e.g. the definitions could consider
+ different subsets of all the fields available in the data file).
+* Data file : the text file that contains all the data (a fixed width or a character delimited text file)
+
+== How to use the "Work With Data Files" screen in the Webtools application
+_Prerequisites_: a definition file (containing the fields' definition of the data file) and a data file
+(containing the data you want to parse/import) should be available in the OFBiz server.Steps:
+
+. connect to the Webtools application
+. go to the "Work With Data Files" screen
+. enter the path to the your definition file in the "Definition Filename or URL" input field
+. click on the submit button>
+. the "Data File Definition Name" input field will be changed into a drop down box containing all the definitions
+ available in the definition file
+. select the definition you want to use from the drop down box>
+. enter the path to the your data file in the "Data Filename or URL" input field
+. if you want to generate an entity xml file that can be later imported in OFBiz, enter a path for it in the
+ "Save to entity xml file:
+. input field and click on the submit button; the file will be created +
+ (see the paragraph "Tips to create Entity Xml Files" for more details)
+
+[source]
+<field name="productId" type="String">
+ </field>
+
+== Examples
+
+=== Sample fixed width CSV file posreport.csv to be imported:
+.An example of fixed width flat file import.
+[source,csv]
+
+021196033702 ,5031BB GLITTER GLUE PENS BRIGH ,1 ,5031BB , 1, 299,
+021196043121 ,BB4312 WONDERFOAM ASSORTED ,1 ,BB4312 , 1, 280,
+021196055025 ,9905BB PLUMAGE MULTICOLOURED ,1 ,9905BB , 4, 396,
+
+=== Sample xml definition file for importing select columns
+.Sample xml definition file for importing select columns posschema.xml:
+[source,xml]
+ <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <data-file name="posreport" separator-style="fixed-length" type-code="text">
+ <record name="tillentry" limit="many">
+ <field name="tillCode" type="String" length="16" position="0"></field>
+ <field name="name" type="String" length="32" position="17"></field>
+ <field name="prodCode" type="String" length="12" position="63"></field>
+ <field name="quantity" type="String" length="8" position="76"></field>
+ <field name="totalPrice" type="String" length="8" position="85"></field>
+ </record>
+ </data-file>
+ </data-files>
+
+.Another example reading fixed record little endian binary files
+[source, xml]
+ <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <data-file name="stockdata" separator-style="fixed-record" type-code="text" record-length="768">
+ <record name="stockdataitem" limit="many">
+ <field name="barcode" type="NullTerminatedString" length="12" position="0"></field>
+ <field name="prodCode" type="NullTerminatedString" length="12" position="68"></field>
+ <field name="price" type="LEInteger" length="4" position="80"></field>
+ <field name="name" type="NullTerminatedString" length="30" position="16"></field>
+ </record>
+ </data-file>
+ </data-files>
+
+=== Procedure:
+In the interface enter something like:
+
+. Definition Filename or URL: posschema.xml
+. Data File Definition Name: posreport
+. Data Filename or URL: posreport.csv
diff --git a/framework/base/src/docs/asciidoc/email.adoc b/framework/entity/src/docs/asciidoc/entity-engine.adoc
similarity index 65%
copy from framework/base/src/docs/asciidoc/email.adoc
copy to framework/entity/src/docs/asciidoc/entity-engine.adoc
index 6408da3..21f3640 100644
--- a/framework/base/src/docs/asciidoc/email.adoc
+++ b/framework/entity/src/docs/asciidoc/entity-engine.adoc
@@ -16,8 +16,13 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= email
+= The Entity Engine.
-== HowTo use email in OFBiz
+== Entity Engine guide.
+https://cwiki.apache.org/confluence/display/OFBIZ/Entity+Engine+Guide[Entity engine Guide]
-include::_include/email-receiving.adoc[leveloffset=+2]
+== Entity Engine Configuration Guide.
+https://cwiki.apache.org/confluence/display/OFBIZ/Entity+Engine+Configuration+Guide[entity engine configuration guide]
+
+== Entity overview.
+https://cwiki.apache.org/confluence/display/OFBIZ/General+Entity+Overview[Entity overview]
\ No newline at end of file
diff --git a/framework/minilang/docs/asciidoc/minilang-to-groovy-manual.adoc b/framework/minilang/src/docs/asciidoc/minilang-to-groovy-manual.adoc
similarity index 98%
rename from framework/minilang/docs/asciidoc/minilang-to-groovy-manual.adoc
rename to framework/minilang/src/docs/asciidoc/minilang-to-groovy-manual.adoc
index e453c3f..a029728 100644
--- a/framework/minilang/docs/asciidoc/minilang-to-groovy-manual.adoc
+++ b/framework/minilang/src/docs/asciidoc/minilang-to-groovy-manual.adoc
@@ -21,12 +21,15 @@ under the License.
This is a small guide for everybody involved in converting the Mini Language into Groovy.
-NOTE: *Why is this important?* +
+IMPORTANT: *Why is this important?* +
This tutorial is directly linked to the efforts of converting all scripts in Mini Language to newer Groovy Scripts.
All of this is done, because Groovy is much more readable and easier to review, more up to date and many other reasons, which can be found here: https://lists.apache.org/thread.html/253b41060a295b8ab68bc78763cc129fc74b712cf776f8716022097f@%3Cdev.ofbiz.apache.org%3E[Proposal for deprecating Mini Language] +
+
To contribute, or just be up to date with the current process, you can look at the existing https://issues.apache.org/jira/browse/OFBIZ-9350[JIRA issue OFBIZ-9350 - Deprecate Mini Lang]
+[NOTE]
+For memory, a description of the Mini Language guide can be found at the https://cwiki.apache.org/confluence/display/OFBIZ/Mini+Language+-+minilang+-+simple-method+-+Reference[OFBiz wiki - Mini Language Reference]
+
== Groovy DSL (dynamic scripting library)
=== How to get Groovy support in your IDE
@@ -63,7 +66,7 @@ Normal instance of the LocalDispatcher, which is used to call services and other
type: 'org.apache.ofbiz.security.Security'*` +
Normal instance of the Security-Interface with which permission checks are done.
-== Known Methods
+=== Known Methods
`*method name: 'runService' +
type: 'java.util.Map' +
params: [serviceName: 'String', inputMap: 'java.util.Map']*` +
@@ -507,7 +510,7 @@ a|[source,xml]
</condition-list>
</condition-list>
</entity-condition>
---
+--
a|[source,groovy]
--
diff --git a/framework/testtools/src/docs/asciidoc/SingleSignOn.adoc b/framework/testtools/src/docs/asciidoc/SingleSignOn.adoc
new file mode 100644
index 0000000..3fec4f6
--- /dev/null
+++ b/framework/testtools/src/docs/asciidoc/SingleSignOn.adoc
@@ -0,0 +1,159 @@
+////
+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.
+////
+= OFBiz Single Sign On using CAS and LDAP
+
+== Setup the Java Key Store
+From the directory in which you want to create the keystore, run keytool with the following parameters.
+
+. Generate the server certificate.
++
+[source]
+----
+ $ keytool -genkey -alias tomcat -keyalg RSA -keypass changeit -storepass changeit -keystore keystore.jks
+----
+When you press Enter, keytool prompts you to enter the server name, organizational unit, organization, locality, state,
+and country code.
+[NOTE]
+Note that you must enter the server name in response to keytool's first prompt, in which it asks for first and
+ last names.
++
+For testing purposes, this can be localhost.
+. Export the generated server certificate in keystore.jks into the file server.cer.
++
+[source]
+----
+ $ keytool -export -alias tomcat -storepass changeit -file server.cer -keystore keystore.jks
+----
+. To create the trust-store file cacerts.jks and add the server certificate to the trust-store, run keytool from
+ the directory where you created the keystore and server certificate. Use the following parameters:
++
+[source]
+----
+ $ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit
+----
+. Information on the certificate, such as that shown next, will display.
++
+[source]
+----
+ $ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit
+
+ Owner: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US
+ Issuer: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US
+ Serial number: 3e932169
+ Valid from: Tue Apr 08
+ Certificate fingerprints:
+ MD5: 52:9F:49:68:ED:78:6F:39:87:F3:98:B3:6A:6B:0F:90
+ SHA1: EE:2E:2A:A6:9E:03:9A:3A:1C:17:4A:28:5E:97:20:78:3F:
+ Trust this certificate? [no]:
+----
+. Enter yes, and then press the Enter or Return key. The following information displays:
++
+[source]
+----
+ Certificate was added to keystore
+ [Saving cacerts.jks]
+----
+
+
+== CAS Server
+. Download CAS server from http://www.jasig.org/cas[the CAS web site].
+. Deploy cas-server-webapp-[version].war to Tomcat
+. Set key store file to Tomcat
++
+[source]
+----
+ keystoreFile="path/to/keystore.jks"
+----
+. Start Tomcat
+
+
+== OFBiz Certificate
+Set trust store's file to Java Virtual Machine (JVM) before start OFBiz.
+[source]
+----
+ -Djavax.net.ssl.trustStore=path/to/cacerts.jks
+----
+
+== LDAP Component
+OFBiz uses the LDAP component in the plugins to check the security in a web application. +
+OFBiz disabled LDAP component as default, you can enable this component by take the comment out from
+plugins/component-load.xml file.
+
+=== LDAP Properties
+LDAP properties file is plugins/ldap/config/ldap.xml. +
+You can change a filter condition you want.
+
+==== Attributes
+. Attribute : LDAP attbitue for filter e.g. uid=%u
+. AuthenType : LDAP authentication method e.g. simple
+. AuthenticaionHandler : CAS handler class e.g. org.apache.ofbiz.ldap.cas.OFBizCasAuthenticationHandler
+. AutoPartyId : Party's id for user login e.g. admin
+. AutoSecurityGroupId : Security group's id for user login e.g. FULLADMIN
+. BaseDN : The top level ofbiz LDAP directory tree e.g. dc=example,dc=com
+. Filter : LDAP search filter e.g. (objectclass=*)
+. Scope : LDAP search scope parameter e.g. sub,one, etc.
+. URL : LDAP server's url e.g. ldap://localhost:389
+. UserOFBizLoginWhenLDAPFail : indicate that if LDAP fail then login with normal OFBiz's user or not.
+ (true/false)
+
+==== CAS
+. CasLoginUri : URI to CAS login e.g. /login
+. CasLogoutUri : URI to CAS logout e.g. /logout
+. CasUrl : CAS Server's URL e.g. https://localhost:8443/cas
+. CasValidateUri : URI to CAS validate e.g. /validate
+. CasLdapHandler : LDAP hanlder class e.g. org.apache.ofbiz.ldap.openldap.OFBizLdapAuthenticationHandler
+. CasTGTCookieName : CAS TGT's cookie name e.g. CASTGC
+
+
+== OpenLDAP
+The LDAP component need data from LDAP server (OpenLDAP). The server needs to install, configure and populate
+ OpenLDAP: see at http://www.openldap.org[the OpenLDAP web site].
+
+== Web Application Security Mapping
+Every web application you need to use LDAP (single sign on) feature, you need to change the event's path of
+ some the security request mappings to org.apache.ofbiz.ldap.LdapLoginWorker class.
+
+=== checkLogin
+[source, xml]
+ <request-map uri="checkLogin" edit="false">
+ <description>Verify a user is logged in.</description>
+ <security https="true" auth="false"/>
+ <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="checkLogin"/>
+ <response name="success" type="view" value="main"/>
+ <response name="error" type="view" value="login"/>
+ </request-map>
+
+=== login
+[source, xml]
+ <request-map uri="login">
+ <security https="true" auth="false"/>
+ <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="login"/>
+ <response name="success" type="view" value="main"/>
+ <response name="requirePasswordChange" type="view" value="requirePasswordChange"/>
+ <response name="error" type="view" value="login"/>
+ </request-map>
+
+=== logout
+[source, xml]
+ <request-map uri="logout">
+ <security https="true" auth="true"/>
+ <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="logout"/>
+ <response name="success" type="request-redirect" value="main"/>
+ <response name="error" type="view" value="main"/>
+ </request-map>
diff --git a/framework/testtools/src/docs/asciidoc/unit-tests.adoc b/framework/testtools/src/docs/asciidoc/unit-tests.adoc
new file mode 100644
index 0000000..e6faa48
--- /dev/null
+++ b/framework/testtools/src/docs/asciidoc/unit-tests.adoc
@@ -0,0 +1,155 @@
+////
+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.
+////
+= Unit Test (Using JUnit)
+
+== How to define a unit test?
+
+. Define test-suite in ofbiz-component.xml like this:
++
+[source, xml]
+----
+ <test-suite loader="main" location="testdef/servicetests.xml"/>
+----
+. Create test-case in test-suite file.
++
+[source, xml]
+----
+ <test-suite suite-name="servicetests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/test-suite.xsd">
+ ....
+ ....
+ <test-case case-name="test-case-name">
+ ...
+ </test-case>
+ ....
+ ....
+ </test-suite>
+----
+
+== How to create a test case?
+Define a test-case in an XML test-suite file like this:
+[source, xml]
+----
+ <test-case case-name="test-case-name">
+ ...
+ </test-case>
+----
+The test-case tag contains details of each test type:
+
+=== Entity XML
+Specific entity xml and its action would like to be tested in entity-xml-url attribute and action attribute
+respectively like this:
+[source, xml]
+----
+ <test-case case-name="service-dead-lock-retry-assert-data">
+ <entity-xml action="assert" entity-xml-url="component://service/testdef/data/ServiceDeadLockRetryAssertData.xml"/>
+ </test-case>
+----
+
+=== JUnit
+Specific class's name which will be tested, in a class-name attribute like this:
+[source, xml]
+----
+ <test-case case-name="service-tests">
+ <junit-test-suite class-name="org.apache.ofbiz.service.test.ServiceEngineTests"/>
+ </test-case>
+----
+
+=== Service
+Specific service's name which will be tested in a service-name attribute like this:
+[source, xml]
+----
+ <test-case case-name="service-lock-wait-timeout-retry-test">
+ <service-test service-name="testServiceLockWaitTimeoutRetry"/>
+ </test-case>
+----
+
+=== Simple Method
+Specific simple method's location and name which will be tested in a location and a name attribute respectively
+like this:
+[source, xml]
+----
+ <test-case case-name="auto-accounting-transaction-tests-PoReceipt">
+ <simple-method-test location="component://accounting/minilang/test/AutoAcctgTransTests.xml" name="testAcctgTransOnPoReceipts"/>
+ </test-case>
+----
+
+== How to run a unit test?
+You can run unit test by run 'gradle' with following target:
+
+include::../../../../../README.adoc[tag=testingtasks]
+
+
+== Possible error messages
+Some error messages in the log are not important and often caused by the test.
+
+=== Roll back
+Roll back error message occurred when transaction roll back data.
+This error message will be in between starting and finished test cass line like this:
+[source]
+----
+ [java] 2009-12-22 16:05:28,349 (main) [ TestRunContainer.java:238:INFO ] [JUNIT] : [test case's name] starting...
+ [java] 2009-12-22 16:05:28,355 (main) [ TransactionUtil.java:336:ERROR]
+ ....
+ ....
+ ....
+ [java] ---- exception report ----------------------------------------------------------
+ [java] [TransactionUtil.rollback]
+ [java] Exception: java.lang.Exception
+ [java] Message: Stack Trace
+ [java] ---- stack trace ---------------------------------------------------------------
+ [java] java.lang.Exception: Stack Trace
+ [java] org.apache.ofbiz.entity.transaction.TransactionUtil.rollback(TransactionUtil.java:335)
+ [java] org.apache.ofbiz.entity.transaction.TransactionUtil.rollback(TransactionUtil.java:317)
+ [java] org.apache.ofbiz.entity.test.EntityTestSuite.testTransactionUtilRollback(EntityTestSuite.java:437)
+ [java] sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
+ [java] sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
+ [java] sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
+ [java] java.lang.reflect.Method.invoke(Method.java:597)
+ [java] junit.framework.TestCase.runTest(TestCase.java:154)
+ [java] junit.framework.TestCase.runBare(TestCase.java:127)
+ [java] junit.framework.TestResult$1.protect(TestResult.java:106)
+ [java] junit.framework.TestResult.runProtected(TestResult.java:124)
+ [java] junit.framework.TestResult.run(TestResult.java:109)
+ [java] junit.framework.TestCase.run(TestCase.java:118)
+ [java] junit.framework.TestSuite.runTest(TestSuite.java:208)
+ [java] junit.framework.TestSuite.run(TestSuite.java:203)
+ [java] junit.framework.TestSuite.runTest(TestSuite.java:208)
+ [java] junit.framework.TestSuite.run(TestSuite.java:203)
+ [java] org.apache.ofbiz.testtools.TestRunContainer.start(TestRunContainer.java:146)
+ [java] org.apache.ofbiz.base.container.ContainerLoader.start(ContainerLoader.java:100)
+ [java] org.apache.ofbiz.base.start.Start.startStartLoaders(Start.java:272)
+ [java] org.apache.ofbiz.base.start.Start.startServer(Start.java:322)
+ [java] org.apache.ofbiz.base.start.Start.start(Start.java:326)
+ [java] org.apache.ofbiz.base.start.Start.main(Start.java:411)
+ [java] --------------------------------------------------------------------------------
+ [java]
+ ....
+ ....
+ ....
+ [java] 2009-12-22 16:05:28,366 (main) [ TransactionUtil.java:346:INFO ] [TransactionUtil.rollback] transaction rolled back
+ [java] 2009-12-22 16:05:28,370 (main) [ TestRunContainer.java:234:INFO ] [JUNIT] : [test case's name] finished.
+----
+
+== Test result
+After you run unit test, you can see the result of the testing. +
+If you use run-tests target, you can see test result web page by view runtime/logs/test-results/html/index.html
+file in web browser and see JUnit Test Result files for each test suite in runtime/logs/test-results directory. +
+If you use other target you only see JUnit Test Result file in runtime/logs/test-results.
diff --git a/framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc b/framework/webtools/src/docs/asciidoc/_include/webtools-main.adoc
new file mode 100644
index 0000000..9dae6b5
--- /dev/null
+++ b/framework/webtools/src/docs/asciidoc/_include/webtools-main.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 Webtools Main page.
+
+This is the default screen for the Webtools application. +
+Several links are present on this page to access specific tool screens directly. +
+Using the application menu you can select the tool you need.
+
+* The link:[Logging] section is used to view and configure the OFBiz system logs.
+* The link:[Cache & Debug] section is used to monitor the OFBiz cache system status.
+ You can even set or clear some cache content or force Garbage collection with this tool.
+* The link:[Artifact Info] section is used to navigate through all OFBiz artifact files. When accessing this section
+ the complete OFBiz code base is scanned and a list of all artifacts is offered to the user to be navigated.
+ Please note that the initial scan can take a while to be completed.
+* The link:[Entity Engine] section is used to interact with the entities defined in the system.
+ You can view the entity structures, search for entity content, navigate though related entities, etc.
+* The link:[Service Engine] section is used to interact with the services defined in the system.
+ You can view all services details, monitor the jobs that are running, the active threads.
+ You can even manually run a service or schedule a periodic/delaied job execution.
+* The link:[Import/Export] section is used to transfer entity content from the OFBiz system to external systems and viceversa.
+ Various import/export systems and formats are available.
+* The link:[Configuration] section is used to set parameters for the OFBiz system.
[ofbiz-framework] 10/11: Documented: Framework,
delete all docbook files related to migration to asciidoc
(OFBIZ-11587)
Posted by ho...@apache.org.
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 91fe7bf4cce245268319ca75efe365191e6867f9
Author: holivier <ho...@apache.org>
AuthorDate: Tue Apr 14 12:25:26 2020 +0200
Documented: Framework, delete all docbook files related to migration to
asciidoc
(OFBIZ-11587)
- common-sending-email: include in email
- datafile: move as a include at the end of entity-engine section
- entity-engine: list of link to OFBiz wiki about entity configuration
- service-engine: a link to OFBiz wiki Service Engine Guide
- webtools: help for main screen
- mini-lang: include a link to OFBiz wiki mini-lang-reference at the
beginning of minilang-to-groovy-manual
move minilang-to-groovy-manual to Development environment
section
- unit-test: include as Junit test, and use README to list gradle
command available (so add a tag in REAME.adoc)
- base: add a link to OFBiz wiki Configuration Guide, in deployment
section
- SingleSignOn with LDAP: move to plugin LDAP and include in deployment
section
---
framework/common/documents/FrameworkCommon.xml | 30 ---
framework/common/documents/SendingEmail.xml | 45 ----
framework/documents/DataFiles.xml | 239 -----------------
framework/documents/Framework.xml | 28 --
framework/documents/SingleSignOn.xml | 282 ---------------------
framework/documents/UnitTest.xml | 228 -----------------
framework/entity/documents/EntityEngine.xml | 48 ----
framework/minilang/documents/MiniLang.xml | 28 --
framework/service/documents/ServiceEngine.xml | 28 --
framework/webtools/data/helpdata/HELP_WEBTOOLS.xml | 22 --
.../webtools/data/helpdata/HELP_WEBTOOLS_main.xml | 48 ----
framework/webtools/documents/Webtools.xml | 30 ---
12 files changed, 1056 deletions(-)
diff --git a/framework/common/documents/FrameworkCommon.xml b/framework/common/documents/FrameworkCommon.xml
deleted file mode 100644
index ce0d252..0000000
--- a/framework/common/documents/FrameworkCommon.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<?xml version="1.0"?>
-<!--
-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.
--->
-<chapter 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 Framework Common Component.</title>
- <para>
- The framework Common component contains all functions which do not justify a separate framework component.
- </para>
- <xi:include href="SendingEmail.xml" />
-</chapter>
diff --git a/framework/common/documents/SendingEmail.xml b/framework/common/documents/SendingEmail.xml
deleted file mode 100644
index f369156..0000000
--- a/framework/common/documents/SendingEmail.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 ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>Sending Email in OFBiz</title>
- <para>
- Various parts in the OFBiz application are sending out email for various reasons. Sending out email is controlled in the
- ${ofbiz install dir}/framework/common/config/general.properties file with the following parameters:
- <orderedlist>
- <listitem><para>
- SMTP Server (relay host): mail.smtp.relay.host
- </para></listitem>
- <listitem><para>
- SMTP Username (if needed): mail.smtp.auth.user
- </para></listitem>
- <listitem><para>
- SMTP Password (if needed): mail.smtp.auth.password
- </para></listitem>
- <listitem><para>
- Turn on email notifications by setting the mail.notifications.enabled property to "Y".
- </para></listitem>
- </orderedlist>
- </para>
-</section>
-
diff --git a/framework/documents/DataFiles.xml b/framework/documents/DataFiles.xml
deleted file mode 100644
index 8b90139..0000000
--- a/framework/documents/DataFiles.xml
+++ /dev/null
@@ -1,239 +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.
--->
-<chapter id="Working with Ofbiz Data files" version="5.0" xsi:schemaLocation="http://www.docbook.org/xml/5.0b3/xsd/docbook.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns="http://docbook.org/ns/docbook">
- <title>The OFBiz Datafiles</title>
- <section>
- <section id="Intoduction">
- <title>Intoduction</title>
- <para>There is a data import tool in OFBiz called the DataFile tool. It uses XML files that describe flat file formats (including character delimited, fixed width, etc) and parses the flat files based on those definitions. So, by design it is somewhat like the Entity Engine. It uses a generic object to represent a row in the flat file. It includes features like a line type code for each line and can support hierarchical flat files (ie where parent/child relationships are impl [...]
- </para>
- <para>The code is in the ofbiz/framework/datafile directory, and there is an XSD there to describe how the data file definition XML file should look.
- </para>
- <para>The DataFile has a web page in WebTools to parse data files and generate entity xml files (that can be imported in OFBiz) from them, and to do in/outtesting.
- </para>
- <para>both the import of fixed width flat files and character delimited files are implemented.
- </para>
- </section>
- <section id="Definitions">
- <title>Definitions</title>
- <para>Definition file*: this is an xml file that contains one or more "Data File Definition"s; the grammar of the file is defined in framework/datafile/dtd/datafile.xsd
- </para>
- <para>Data File Definition*: the definition of a data file structure (e.g. names/types of the fields/columns in a "Data File"; the same "Data File" could have more than one "Data File Definition"s (e.g. the definitions could consider different subsets of all the fields available in the data file).
- </para>
- <para>Data file*: the text file that contains all the data (a fixed width or a character delimited text file)
- </para>
- </section>
- <section>
- <title>How to use the "Work With Data Files" screen in the Webtools application</title>
- <procedure>
-
- <title>How to use the "Work With Data Files" screen in the Webtools application</title>_Prerequisites_: a definition file (containing the fields' definition of the data file) and a data file (containing the data you want to parse/import) should be available in the OFBiz server.Steps:
-
- <step performance="required">
-<para>
- connect to the Webtools application
-</para>
- </step>
- <step performance="required">
- <para>go to the "Work With Data Files" screen</para>
-
- </step>
- <step performance="required">
- <para>
- enter the path to the your definition file in the "Definition Filename or URL" input field
-</para>
- </step>
-
- <step performance="required">
- <para>
-click on the submit button>
-</para>
- </step>
- <step performance="required">
- <para>
- the "Data File Definition Name" input field will be changed into a drop down box containing all the definitions available in the definition file
-</para>
- </step>
- <step performance="required">
- <para>
- select the definition you want to use from the drop down box>
-</para>
- </step>
- <step performance="required">
- <para>
- enter the path to the your data file in the "Data Filename or URL" input field
- </para>
- </step>
- <step performance="required">
- <para>
-if you want to generate an entity xml file that can be later imported in OFBiz,
-enter a path for it in the "Save to entity xml file:
- </para>
- </step>
- <step performance="required">
- <para>
- input field and click on the submit button; the file will be created
-(see the paragraph "Tips to create Entity Xml Files" for more details)</para>
-
- </step>
- </procedure>
-
-
- </section>
- <section>The field.name attribute must contain the name of the entity field in which the records will be imported
- (for example<programlisting><![CDATA[:<field name="productId" type="String">
- </field>
- ]]></programlisting>
- </section>
- <section>
- <title>Examples</title>
- <section>
- <example>
- <title>An example of fixed width flat file import.</title>Sample fixed width CSV file posreport.csv to be imported:
-<programlisting><![CDATA[
-021196033702 ,5031BB GLITTER GLUE PENS BRIGH ,1 ,5031BB , 1, 299,
-021196043121 ,BB4312 WONDERFOAM ASSORTED ,1 ,BB4312 , 1, 280,
-021196055025 ,9905BB PLUMAGE MULTICOLOURED ,1 ,9905BB , 4, 396,
-]]></programlisting>
- </example>
-
- </section>
- <section>
- <title>Sample xml definition file for importing select columns</title>
- <example>
- <title> posschema.xml:</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="posreport" separator-style="fixed-length" type-code="text">
- <record name="tillentry" limit="many">
- <field name="tillCode" type="String" length="16" position="0">
- </field>
- <field name="name" type="String" length="32" position="17">
- </field>
- <field name="prodCode" type="String" length="12" position="63">
- </field>
- <field name="quantity" type="String" length="8" position="76">
- </field>
- <field name="totalPrice" type="String" length="8" position="85">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
-
- The types listed in this sample are simple String's but the usual types are available such as Date, Long etc
-
- </section>
- <section>
- <example>
- <title>Another example reading fixed record little endian binary files</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="stockdata" separator-style="fixed-record" type-code="text" record-length="768">
- <record name="stockdataitem" limit="many">
- <field name="barcode" type="NullTerminatedString" length="12" position="0">
- </field>
- <field name="prodCode" type="NullTerminatedString" length="12" position="68">
- </field>
- <field name="price" type="LEInteger" length="4" position="80">
- </field>
- <field name="name" type="NullTerminatedString" length="30" position="16">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
- <procedure>
-
- <title>In the interface enter something like:</title>
-
- <step performance="required">
-<para>
- Definition Filename or URL: posschema.xml
-</para>
- </step>
- <step performance="required">
-<para>
- Data File Definition Name: posreport
-</para>
- </step>
- <step performance="required">
-<para>
- Data Filename or URL: posreport.csv
-</para>
- </step>
-
- </procedure>
- </section>
- </section>
- <section>
- <example>
-
- <title>Sample xml definition file for importing select columns posschema.xml:</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="posreport" separator-style="fixed-length" type-code="text">
- <record name="tillentry" limit="many">
- <field name="tillCode" type="String" length="16" position="0">
- </field>
- <field name="name" type="String" length="32" position="17">
- </field>
- <field name="prodCode" type="String" length="12" position="63">
- </field>
- <field name="quantity" type="String" length="8" position="76">
- </field>
- <field name="totalPrice" type="String" length="8" position="85">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
-
- In the interface enter something like:* Definition Filename or URL: posschema.xml* Data File Definition Name: posreport* Data Filename or URL: posreport.csvThe types listed in this sample are simple String's but the usual types are available such as Date, Long etc.
- </section>
- <section>
- <example>
-
- <title> Another example reading fixed record little endian binary files</title>
- <programlisting><![CDATA[
- <data-files xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/datafiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <data-file name="stockdata" separator-style="fixed-record" type-code="text" record-length="768">
- <record name="stockdataitem" limit="many">
- <field name="barcode" type="NullTerminatedString" length="12" position="0">
- </field>
- <field name="prodCode" type="NullTerminatedString" length="12" position="68">
- </field>
- <field name="price" type="LEInteger" length="4" position="80">
- </field>
- <field name="name" type="NullTerminatedString" length="30" position="16">
- </field>
- </record>
- </data-file>
- </data-files>
- ]]></programlisting>
- </example>
-
- </section>
-
- </section>
-</chapter>
diff --git a/framework/documents/Framework.xml b/framework/documents/Framework.xml
deleted file mode 100644
index 31acd2e..0000000
--- a/framework/documents/Framework.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-<chapter 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 ../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The OFBiz Framework Introduction.</title>
- <para>
- For a core configuration guide check <link xl:href="http://ofbiz.apache.org/docs/coreconfig.html">the OFBiz website.</link>
- </para>
-</chapter>
diff --git a/framework/documents/SingleSignOn.xml b/framework/documents/SingleSignOn.xml
deleted file mode 100644
index 568f53c..0000000
--- a/framework/documents/SingleSignOn.xml
+++ /dev/null
@@ -1,282 +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.
--->
-<chapter xml:id="CASLDAP" 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 ../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>OFBiz Single Sign On using CAS and LDAP</title>
- <section>
- <title>Setup the Java Key Store</title>
- <para>
- From the directory in which you want to create the keystore, run keytool with the following parameters.
- </para>
- <orderedlist>
- <listitem>
- <para>
- Generate the server certificate.
- <programlisting>
- $ keytool -genkey -alias tomcat -keyalg RSA -keypass changeit -storepass changeit -keystore keystore.jks
- </programlisting>
- When you press Enter, keytool prompts you to enter the server name, organizational unit, organization, locality, state, and country code. Note that you must enter the server name in response to keytool's first prompt, in which it asks for first and last names. For testing purposes, this can be localhost.
- </para>
- </listitem>
- <listitem>
- <para>
- Export the generated server certificate in keystore.jks into the file server.cer.
- <programlisting>
- $ keytool -export -alias tomcat -storepass changeit -file server.cer -keystore keystore.jks
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- To create the trust-store file cacerts.jks and add the server certificate to the trust-store, run keytool from the directory where you created the keystore and server certificate. Use the following parameters:
- <programlisting>
- $ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Information on the certificate, such as that shown next, will display.
- <programlisting>
- $ keytool -import -v -trustcacerts -alias tomcat -file server.cer -keystore cacerts.jks -keypass changeit -storepass changeit
-
- Owner: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US
- Issuer: CN=localhost, OU=Sun Micro, O=Docs, L=Santa Clara, ST=CA, C=US
- Serial number: 3e932169
- Valid from: Tue Apr 08
- Certificate fingerprints:
- MD5: 52:9F:49:68:ED:78:6F:39:87:F3:98:B3:6A:6B:0F:90
- SHA1: EE:2E:2A:A6:9E:03:9A:3A:1C:17:4A:28:5E:97:20:78:3F:
- Trust this certificate? [no]:
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Enter yes, and then press the Enter or Return key. The following information displays:
- <programlisting>
- Certificate was added to keystore
- [Saving cacerts.jks]
- </programlisting>
- </para>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>CAS Server</title>
- <para>
- <orderedlist>
- <listitem>
- <para>
- Download CAS server from <link xl:href="http://www.jasig.org/cas">the CAS web site</link>.
- </para>
- </listitem>
- <listitem>
- <para>
- Deploy cas-server-webapp-[version].war to Tomcat
- </para>
- </listitem>
- <listitem>
- <para>
- Set key store file to Tomcat
- <programlisting>
- keystoreFile="path/to/keystore.jks"
- </programlisting>
- </para>
- </listitem>
- <listitem>
- <para>
- Start Tomcat
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>OFBiz Certificate</title>
- <para>
- Set trust store's file to Java Virtual Machine (JVM) before start OFBiz.
- <programlisting>
- -Djavax.net.ssl.trustStore=path/to/cacerts.jks
- </programlisting>
- </para>
- </section>
- <section>
- <title>LDAP Component</title>
- <para>
- OFBiz uses the LDAP component in the plugins to check the security in a web application. OFBiz disabled LDAP component as default, you can enable this component by take the comment out from plugins/component-load.xml file.
- </para>
- <section>
- <title>LDAP Properties</title>
- <para>
- LDAP properties file is plugins/ldap/config/ldap.xml. You can change a filter condition you want.
- </para>
- <section>
- <title>Attributes</title>
- <para>
- <orderedlist>
- <listitem>
- <para>
- Attribute : LDAP attbitue for filter e.g. uid=%u
- </para>
- </listitem>
- <listitem>
- <para>
- AuthenType : LDAP authentication method e.g. simple
- </para>
- </listitem>
- <listitem>
- <para>
- AuthenticaionHandler : CAS handler class e.g. org.apache.ofbiz.ldap.cas.OFBizCasAuthenticationHandler
- </para>
- </listitem>
- <listitem>
- <para>
- AutoPartyId : Party's id for user login e.g. admin
- </para>
- </listitem>
- <listitem>
- <para>
- AutoSecurityGroupId : Security group's id for user login e.g. FULLADMIN
- </para>
- </listitem>
- <listitem>
- <para>
- BaseDN : The top level ofbiz LDAP directory tree e.g. dc=example,dc=com
- </para>
- </listitem>
- <listitem>
- <para>
- Filter : LDAP search filter e.g. (objectclass=*)
- </para>
- </listitem>
- <listitem>
- <para>
- Scope : LDAP search scope parameter e.g. sub,one, etc.
- </para>
- </listitem>
- <listitem>
- <para>
- URL : LDAP server's url e.g. ldap://localhost:389
- </para>
- </listitem>
- <listitem>
- <para>
- UserOFBizLoginWhenLDAPFail : indicate that if LDAP fail then login with normal OFBiz's user or not. (true/false)
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>CAS</title>
- <para>
- <orderedlist>
- <listitem>
- <para>
- CasLoginUri : URI to CAS login e.g. /login
- </para>
- </listitem>
- <listitem>
- <para>
- CasLogoutUri : URI to CAS logout e.g. /logout
- </para>
- </listitem>
- <listitem>
- <para>
- CasUrl : CAS Server's URL e.g. https://localhost:8443/cas
- </para>
- </listitem>
- <listitem>
- <para>
- CasValidateUri : URI to CAS validate e.g. /validate
- </para>
- </listitem>
- <listitem>
- <para>
- CasLdapHandler : LDAP hanlder class e.g. org.apache.ofbiz.ldap.openldap.OFBizLdapAuthenticationHandler
- </para>
- </listitem>
- <listitem>
- <para>
- CasTGTCookieName : CAS TGT's cookie name e.g. CASTGC
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- </section>
- </section>
- <section>
- <title>OpenLDAP</title>
- <para>
- The LDAP component need data from LDAP server (OpenLDAP). The server needs to install, configure and populate OpenLDAP: see at <link xl:href="http://www.openldap.org">the OpenLDAP web site</link>.
- </para>
- </section>
- <section>
- <title>Web Application Security Mapping</title>
- <para>
- Every web application you need to use LDAP (single sign on) feature, you need to change the event's path of some the security request mappings to org.apache.ofbiz.ldap.LdapLoginWorker class.
- </para>
- <section>
- <title>checkLogin</title>
- <para>
- <programlisting>
- <request-map uri="checkLogin" edit="false">
- <description>Verify a user is logged in.</description>
- <security https="true" auth="false"/>
- <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="checkLogin"/>
- <response name="success" type="view" value="main"/>
- <response name="error" type="view" value="login"/>
- </request-map>
- </programlisting>
- </para>
- </section>
- <section>
- <title>login</title>
- <para>
- <programlisting>
- <request-map uri="login">
- <security https="true" auth="false"/>
- <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="login"/>
- <response name="success" type="view" value="main"/>
- <response name="requirePasswordChange" type="view" value="requirePasswordChange"/>
- <response name="error" type="view" value="login"/>
- </request-map>
- </programlisting>
- </para>
- </section>
- <section>
- <title>logout</title>
- <para>
- <programlisting>
- <request-map uri="logout">
- <security https="true" auth="true"/>
- <event type="java" path="org.apache.ofbiz.ldap.LdapLoginWorker" invoke="logout"/>
- <response name="success" type="request-redirect" value="main"/>
- <response name="error" type="view" value="main"/>
- </request-map>
- </programlisting>
- </para>
- </section>
- </section>
-</chapter>
\ No newline at end of file
diff --git a/framework/documents/UnitTest.xml b/framework/documents/UnitTest.xml
deleted file mode 100644
index f8f6304..0000000
--- a/framework/documents/UnitTest.xml
+++ /dev/null
@@ -1,228 +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.
--->
-<chapter 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 ../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title><anchor xml:id="TheOFBizUnitTest"/>The OFBiz Unit Test (Using JUnit)</title>
- <section>
- <title>How to define a unit test?</title>
- <orderedlist>
- <listitem>
- <para>
- Define test-suite in ofbiz-component.xml like this:
- </para>
- <programlisting>
- <test-suite loader="main" location="testdef/servicetests.xml"/>
- </programlisting>
- </listitem>
- <listitem>
- <para>
- Create test-case in test-suite file.
- </para>
- <programlisting>
- <test-suite suite-name="servicetests"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:noNamespaceSchemaLocation="http://ofbiz.apache.org/dtds/test-suite.xsd">
- ....
- ....
- <test-case case-name="test-case-name">
- ...
- </test-case>
- ....
- ....
- </test-suite>
- </programlisting>
- </listitem>
- </orderedlist>
- </section>
- <section>
- <title>How to create a test case?</title>
- <para>
- Define a test-case in an XML test-suite file like this:
- <programlisting>
- <test-case case-name="test-case-name">
- ...
- </test-case>
- </programlisting>
- The test-case tag contains details of each test type:
- </para>
- <section>
- <title>1. Entity XML</title>
- <para>
- Specific entity xml and its action would like to be tested in entity-xml-url attribute and action attribute respectively like this:
- <programlisting>
- <test-case case-name="service-dead-lock-retry-assert-data">
- <entity-xml action="assert" entity-xml-url="component://service/testdef/data/ServiceDeadLockRetryAssertData.xml"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- <section>
- <title>2. JUnit</title>
- <para>
- Specific class's name which will be tested, in a class-name attribute like this:
- <programlisting>
- <test-case case-name="service-tests">
- <junit-test-suite class-name="org.apache.ofbiz.service.test.ServiceEngineTests"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- <section>
- <title>3. Service</title>
- <para>
- Specific service's name which will be tested in a service-name attribute like this:
- <programlisting>
- <test-case case-name="service-lock-wait-timeout-retry-test">
- <service-test service-name="testServiceLockWaitTimeoutRetry"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- <section>
- <title>4. Simple Method</title>
- <para>
- Specific simple method's location and name which will be tested in a location and a name attribute respectively like this:
- <programlisting>
- <test-case case-name="auto-accounting-transaction-tests-PoReceipt">
- <simple-method-test location="component://accounting/minilang/test/AutoAcctgTransTests.xml" name="testAcctgTransOnPoReceipts"/>
- </test-case>
- </programlisting>
- </para>
- </section>
- </section>
- <section>
- <title>How to run a unit test?</title>
- <para>
- You can run unit test by run 'ant' with following target:
- </para>
- <section>
- <title>1. run-tests</title>
- <para>
- Run OFBiz default tests.
- </para>
- </section>
- <section>
- <title>2. run-test-list</title>
- <para>
- Run all configured tests, stopping/starting ofbiz between each test.
- </para>
- </section>
- <section>
- <title>3. run-single-test</title>
- <para>
- Run a single test, require two arguments:
- <orderedlist>
- <listitem>
- <para>
- 'test.component' is a name of test component.
- </para>
- </listitem>
- <listitem>
- <para>
- 'test.case' is a name of test case.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- <section>
- <title>4. run-single-test-suite</title>
- <para>
- Run a single test suite, requiring two arguments:
- <orderedlist>
- <listitem>
- <para>
- 'test.component' is a name of test component.
- </para>
- </listitem>
- <listitem>
- <para>
- 'test.suiteName' is a name of test suite.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </section>
- </section>
- <section>
- <title>Possible error messages</title>
- <para>
- Some error messages in the log are not important and often caused by the test.
- </para>
- <section>
- <title>1. Roll back</title>
- <para>
- Roll back error message occurred when transaction roll back data. This error message will be in between starting and finished test cass line like this:
- <programlisting>
- [java] 2009-12-22 16:05:28,349 (main) [ TestRunContainer.java:238:INFO ] [JUNIT] : [test case's name] starting...
- [java] 2009-12-22 16:05:28,355 (main) [ TransactionUtil.java:336:ERROR]
- ....
- ....
- ....
- [java] ---- exception report ----------------------------------------------------------
- [java] [TransactionUtil.rollback]
- [java] Exception: java.lang.Exception
- [java] Message: Stack Trace
- [java] ---- stack trace ---------------------------------------------------------------
- [java] java.lang.Exception: Stack Trace
- [java] org.apache.ofbiz.entity.transaction.TransactionUtil.rollback(TransactionUtil.java:335)
- [java] org.apache.ofbiz.entity.transaction.TransactionUtil.rollback(TransactionUtil.java:317)
- [java] org.apache.ofbiz.entity.test.EntityTestSuite.testTransactionUtilRollback(EntityTestSuite.java:437)
- [java] sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
- [java] sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
- [java] sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
- [java] java.lang.reflect.Method.invoke(Method.java:597)
- [java] junit.framework.TestCase.runTest(TestCase.java:154)
- [java] junit.framework.TestCase.runBare(TestCase.java:127)
- [java] junit.framework.TestResult$1.protect(TestResult.java:106)
- [java] junit.framework.TestResult.runProtected(TestResult.java:124)
- [java] junit.framework.TestResult.run(TestResult.java:109)
- [java] junit.framework.TestCase.run(TestCase.java:118)
- [java] junit.framework.TestSuite.runTest(TestSuite.java:208)
- [java] junit.framework.TestSuite.run(TestSuite.java:203)
- [java] junit.framework.TestSuite.runTest(TestSuite.java:208)
- [java] junit.framework.TestSuite.run(TestSuite.java:203)
- [java] org.apache.ofbiz.testtools.TestRunContainer.start(TestRunContainer.java:146)
- [java] org.apache.ofbiz.base.container.ContainerLoader.start(ContainerLoader.java:100)
- [java] org.apache.ofbiz.base.start.Start.startStartLoaders(Start.java:272)
- [java] org.apache.ofbiz.base.start.Start.startServer(Start.java:322)
- [java] org.apache.ofbiz.base.start.Start.start(Start.java:326)
- [java] org.apache.ofbiz.base.start.Start.main(Start.java:411)
- [java] --------------------------------------------------------------------------------
- [java]
- ....
- ....
- ....
- [java] 2009-12-22 16:05:28,366 (main) [ TransactionUtil.java:346:INFO ] [TransactionUtil.rollback] transaction rolled back
- [java] 2009-12-22 16:05:28,370 (main) [ TestRunContainer.java:234:INFO ] [JUNIT] : [test case's name] finished.
- </programlisting>
- </para>
- </section>
- </section>
- <section>
- <title>Test result</title>
- <para>
- After you run unit test, you can see the result of the testing. If you use run-tests target, you can see test result web page by view runtime/logs/test-results/html/index.html file in web browser
- and see JUnit Test Result files for each test suite in runtime/logs/test-results directory. If you use other target you only see JUnit Test Result file in runtime/logs/test-results.
- </para>
- </section>
-</chapter>
diff --git a/framework/entity/documents/EntityEngine.xml b/framework/entity/documents/EntityEngine.xml
deleted file mode 100644
index 2f57c1b..0000000
--- a/framework/entity/documents/EntityEngine.xml
+++ /dev/null
@@ -1,48 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Entity Engine.</title>
-
- <section>
- <title>Entity Engine guide.</title>
- <para>
- <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Entity+Engine+Guide">Entity engine Guide</link>
- </para>
- </section>
-
- <section>
- <title>Entity Engine Configuration Guide.</title>
- <para>
- <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Entity+Engine+Configuration+Guide">entity engine configuration guide</link>
- </para>
- </section>
-
- <section>
- <title>Entity overview.</title>
- <para>
- <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/General+Entity+Overview">Entity overview</link>
- </para>
-
- </section>
-
-</section>
diff --git a/framework/minilang/documents/MiniLang.xml b/framework/minilang/documents/MiniLang.xml
deleted file mode 100644
index ba4b309..0000000
--- a/framework/minilang/documents/MiniLang.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Entity Engine</title>
- <para>
- A description of the Mini Language guide can be found at the <link xl:href="http://cwiki.apache.org/confluence/display/OFBIZ/Mini-Language+Guide">OFBiz documentation site</link>
- </para>
-</section>
diff --git a/framework/service/documents/ServiceEngine.xml b/framework/service/documents/ServiceEngine.xml
deleted file mode 100644
index e56e3fb..0000000
--- a/framework/service/documents/ServiceEngine.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Service Engine</title>
- <para>
- A description of the service engine can be found at the <link xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Service+Engine+Guide">OFBiz documentation site</link>
- </para>
-</section>
diff --git a/framework/webtools/data/helpdata/HELP_WEBTOOLS.xml b/framework/webtools/data/helpdata/HELP_WEBTOOLS.xml
deleted file mode 100644
index 1ce2368..0000000
--- a/framework/webtools/data/helpdata/HELP_WEBTOOLS.xml
+++ /dev/null
@@ -1,22 +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 Webtools Introduction.</title>
- <xi:include href="HELP_WEBTOOLS_main.xml" />
-</section>
\ No newline at end of file
diff --git a/framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml b/framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml
deleted file mode 100644
index cd7f9aa..0000000
--- a/framework/webtools/data/helpdata/HELP_WEBTOOLS_main.xml
+++ /dev/null
@@ -1,48 +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 Webtools Main page.</title>
- <para>
- This is the default screen for the Webtools application. Several links are present on this page to access specific tool screens directly. Using the application menu you can select the tool you need.
- </para>
- <itemizedlist>
- <listitem>
- <para>The <link xl:href="">Logging</link> section is used to view and configure the OFBiz system logs.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Cache & Debug</link> section is used to monitor the OFBiz cache system status. You can even set or clear some cache content or force Garbage collection with this tool.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Artifact Info</link> section is used to navigate through all OFBiz artifact files. When accessing this section the complete OFBiz code base is scanned and a list of all artifacts is offered to the user to be navigated.
- Please note that the initial scan can take a while to be completed.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Entity Engine</link> section is used to interact with the entities defined in the system. You can view the entity structures, search for entity content, navigate though related entities, etc.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Service Engine</link> section is used to interact with the services defined in the system. You can view all services details, monitor the jobs that are running, the active threads. You can even manually run a service or schedule a periodic/delaied job execution.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Import/Export</link> section is used to transfer entity content from the OFBiz system to external systems and viceversa. Various import/export systems and formats are available.</para>
- </listitem>
- <listitem>
- <para>The <link xl:href="">Configuration</link> section is used to set parameters for the OFBiz system.</para>
- </listitem>
- </itemizedlist>
-</section>
diff --git a/framework/webtools/documents/Webtools.xml b/framework/webtools/documents/Webtools.xml
deleted file mode 100644
index cbdc455..0000000
--- a/framework/webtools/documents/Webtools.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-<chapter 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 ../../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook">
- <title>The Webtools, framework menus</title>
- <para>
- The Webtools option is the gateway to all the framework functions.
- </para>
- <xi:include href="../data/helpdata/HELP_WEBTOOLS.xml" />
-
-</chapter>
[ofbiz-framework] 07/11: Documented: Check all docbook file in each
applications-component documents directory (OFBIZ-11587)
Posted by ho...@apache.org.
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 e5d49b26053a8244772b7a1716280f0ceeb46472
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 10 17:47:05 2020 +0200
Documented: Check all docbook file in each applications-component
documents directory
(OFBIZ-11587)
theses files have no content except for marketing component (2
sentences, migrated to overview for marketing and sfa)
---
applications/marketing/src/docs/asciidoc/marketing.adoc | 3 +++
applications/marketing/src/docs/asciidoc/sfa.adoc | 5 +++++
2 files changed, 8 insertions(+)
diff --git a/applications/marketing/src/docs/asciidoc/marketing.adoc b/applications/marketing/src/docs/asciidoc/marketing.adoc
index 458927a..d2b67e2 100644
--- a/applications/marketing/src/docs/asciidoc/marketing.adoc
+++ b/applications/marketing/src/docs/asciidoc/marketing.adoc
@@ -22,6 +22,9 @@ The overall purpose of the Marketing application is the support to select leads
or marketing segment to convert to opportunities by contacting these parties via a contact-list related to a marketing campaign. +
(contact-list generation support not yet implemented)
+The marketing application is supporting you to create, select and follow sales opportunities in order to create sales orders
+for the company.
+
The first option of the marketing application is the definition of a datasource [DataSource], and connecting or
loading party information to it [PartyDataSource]. In the party application a data source Id can be added to the party.
diff --git a/applications/marketing/src/docs/asciidoc/sfa.adoc b/applications/marketing/src/docs/asciidoc/sfa.adoc
index 1e86333..f187bd8a 100644
--- a/applications/marketing/src/docs/asciidoc/sfa.adoc
+++ b/applications/marketing/src/docs/asciidoc/sfa.adoc
@@ -26,6 +26,11 @@ The main purpose of the SFA application is to support the process of creating or
The SFA application is for a specific user to list his leads, contacts accounts and opportunities. +
He can create new parties or he can assign existing parties to himself.
+It is very much based on the party application as its source. +
+Records from the party application are selected with only one basic reason: a possible sale in the future. +
+That also means that records in the party manager should be complete, especially the role is pretty important.
+Not All roles, but at least 'lead' 'contact' and 'Account' should be defined.
+
== SFA in User Interface
=== Main screen
[ofbiz-framework] 08/11: Documented: Check all docbook file in each
applications-component documents directory (OFBIZ-11587)
Posted by ho...@apache.org.
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 b36943d56faadaf650cb7c96c889e68a4dc8ac6b
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 10 17:49:25 2020 +0200
Documented: Check all docbook file in each applications-component
documents directory
(OFBIZ-11587)
remove all files
---
applications/accounting/documents/Accounting.xml | 39 -------------
applications/commonext/documents/Setup.xml | 27 ---------
applications/content/documents/Content.xml | 30 ----------
applications/humanres/documents/Humanres.xml | 51 -----------------
.../manufacturing/documents/manufacturing.xml | 64 ----------------------
applications/marketing/documents/Marketing.xml | 47 ----------------
applications/order/documents/Order.xml | 29 ----------
applications/party/documents/Party.xml | 32 -----------
applications/product/documents/Product.xml | 33 -----------
9 files changed, 352 deletions(-)
diff --git a/applications/accounting/documents/Accounting.xml b/applications/accounting/documents/Accounting.xml
deleted file mode 100644
index 7c18673..0000000
--- a/applications/accounting/documents/Accounting.xml
+++ /dev/null
@@ -1,39 +0,0 @@
-<?xml version="1.0"?>
-<!--
-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.
--->
-<chapter 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 Accounting Component.</title>
- <xi:include href="../data/helpdata/HELP_ACCOUNTING.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_main.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_invoices.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_payments.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_payment_gateway.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_payment_gateway_config.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_billing_accounts.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_financial_accounts.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_tax_authorities.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_agreements.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_global_gl_settings.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_organization_gl_settings.xml" />
- <xi:include href="../data/helpdata/HELP_ACCOUNTING_Features.xml" />
-</chapter>
diff --git a/applications/commonext/documents/Setup.xml b/applications/commonext/documents/Setup.xml
deleted file mode 100644
index 9d72809..0000000
--- a/applications/commonext/documents/Setup.xml
+++ /dev/null
@@ -1,27 +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.
--->
-<chapter 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><anchor xml:id="componentSetup"/>The Setup Component</title>
- <xi:include href="../data/helpdata/HELP_SETUP.xml" />
-</chapter>
diff --git a/applications/content/documents/Content.xml b/applications/content/documents/Content.xml
deleted file mode 100644
index 717eabd..0000000
--- a/applications/content/documents/Content.xml
+++ /dev/null
@@ -1,30 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-<chapter 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 Content Component</title>
- <section>
- <title>Introduction</title>
- <para>
- </para>
- </section>
-</chapter>
diff --git a/applications/humanres/documents/Humanres.xml b/applications/humanres/documents/Humanres.xml
deleted file mode 100644
index 9864fd8..0000000
--- a/applications/humanres/documents/Humanres.xml
+++ /dev/null
@@ -1,51 +0,0 @@
-<?xml version="1.0"?>
-<!--
-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.
--->
-<chapter 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 Human Resource Application.</title>
- <para>
- The human resource application is supporting you to ...WIP, to be completed...
- </para>
-
- <section>
- <title>Human resource in Apache OFBiz, an overview.</title>
- <para>
- WIP, to be completed...
- </para>
-
- </section>
-
- <xi:include href="../data/helpdata/HELP_HR.xml" />
- <xi:include href="../data/helpdata/HELP_HR_main.xml" />
- <xi:include href="../data/helpdata/HELP_HR_training.xml" />
-
- <!-- xi:include href="../data/helpdata/HELP_HUMANRES_employees.xml" />
- <xi:include href="../data/helpdata/HELP_HUMANRES_employees_positions.xml" />
- <xi:include href="../data/helpdata/HELP_HUMANRES_performance_review.xml" />
- <xi:include href="../data/helpdata/HELP_HUMANRES_skills.xml" />
- <xi:include href="../data/helpdata/HELP_HUMANRES_recruitment.xml" /-->
- <!--xi:include href="../data/helpdata/HELP_HUMANRES_employment_applications.xml" />
- <xi:include href="../data/helpdata/HELP_HUMANRES_resumes.xml" />
- <xi:include href="../data/helpdata/HELP_HUMANRES_leave.xml" />
- <xi:include href="../data/helpdata/HELP_HUMANRES_global_HR_settings.xml" /-->
-</chapter>
diff --git a/applications/manufacturing/documents/manufacturing.xml b/applications/manufacturing/documents/manufacturing.xml
deleted file mode 100644
index 8f63fea..0000000
--- a/applications/manufacturing/documents/manufacturing.xml
+++ /dev/null
@@ -1,64 +0,0 @@
-<?xml version="1.0"?>
-<!--
-
- 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.
--->
-<chapter 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>Manufacturing</title>
- <xi:include href="../data/helpdata/Help_MFG.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_BomSimulation.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_CreateProductionRun.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditCalendar.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditCalendarExceptionDay.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditCalendarExceptionWeek.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditCalendarWeek.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditCostCalcs.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditProductBom.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditProductManufacturingRules.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditProductionRun.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditRouting.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditRoutingProductLink.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditRoutingTask.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditRoutingTaskAssoc.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditRoutingTaskCost.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditRoutingTaskFixedAsset.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_EditRoutingTaskProduct.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_FindBom.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_FindCalendar.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_FindInventoryEventPlan.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_FindProductionRun.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_FindRouting.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_FindRoutingTask.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ListCalendarWeek.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ListRoutingTaskProducts.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ManufacturingReports.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ProductionRunAssocs.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ProductionRunComponents.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ProductionRunContent.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ProductionRunCosts.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ProductionRunFixedAssets.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ProductionRunTasks.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_RunMRP.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_ShowProductionRun.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_WorkWithShipmentPlans.xml"/>
- <xi:include href="../data/helpdata/Help_MFG_main.xml"/>
-</chapter>
diff --git a/applications/marketing/documents/Marketing.xml b/applications/marketing/documents/Marketing.xml
deleted file mode 100644
index d31f1ed..0000000
--- a/applications/marketing/documents/Marketing.xml
+++ /dev/null
@@ -1,47 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-<chapter 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><anchor xml:id="TheMarketingApplication"/>The Marketing Application.</title>
-
- <para>
- The marketing application is supporting you to create, select and follow sales opportunities
- in order to create sales orders for the company.
- </para>
-
- <section>
- <title>Marketing, CRM and SFA in Apache OFBiz, an overview.</title>
- <para>
- It is very much based on the party application as its source.
- Records from the party application are selected with only one basic reason: a possible sale in the future.
- That also means that records in the party manager should be complete, especially the role is pretty important.
- Not All roles, but at least 'lead' 'contact' and 'Account' should be defined.
- </para>
-
- </section>
-
- <xi:include href="../data/helpdata/HELP_MARKETING.xml" />
- <xi:include href="../data/helpdata/HELP_SFA.xml" />
-</chapter>
diff --git a/applications/order/documents/Order.xml b/applications/order/documents/Order.xml
deleted file mode 100644
index e42f01f..0000000
--- a/applications/order/documents/Order.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0"?>
-<!--
-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.
--->
-<chapter 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 Order Component.</title>
- <xi:include href="../data/helpdata/HELP_ORDERMGR.xml" />
- <xi:include href="../data/helpdata/HELP_ORDERMGR_View.xml" />
- <xi:include href="../data/helpdata/HELP_ORDERMGR_Report.xml" />
-</chapter>
diff --git a/applications/party/documents/Party.xml b/applications/party/documents/Party.xml
deleted file mode 100644
index ee5c915..0000000
--- a/applications/party/documents/Party.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?xml version="1.0"?>
-<!--
-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.
--->
-<chapter 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 Party Application.</title>
- <section>
- <title>Introduction</title>
- <para>
- Please find here a general introduction to the party application (to be continued)
- </para>
- </section>
- <xi:include href="../data/helpdata/HELP_PARTY_findparty.xml" />
-</chapter>
diff --git a/applications/product/documents/Product.xml b/applications/product/documents/Product.xml
deleted file mode 100644
index 6b237f2..0000000
--- a/applications/product/documents/Product.xml
+++ /dev/null
@@ -1,33 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-<chapter 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 Product Catalog Component</title>
- <anchor xml:id="ProductCatalogComponent"/>
- <section>
- <title>Introduction Paragraph</title>
- <para>
- and a introduction paragraph
- </para>
- </section>
- <xi:include href="../data/helpdata/HELP_PRODCATALOG_main.xml" />
-</chapter>
[ofbiz-framework] 06/11: Documented: Framework/base migration to
asciidoc (OFBIZ-11587)
Posted by ho...@apache.org.
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 5f56177d0276f8ad03cf0aac7ce2f352ec3243c1
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 10 16:07:50 2020 +0200
Documented: Framework/base migration to asciidoc
(OFBIZ-11587)
Delete docbook files
---
framework/base/documents/FrameworkBase.xml | 32 --------------------
framework/base/documents/ReceivingEmail.xml | 46 -----------------------------
2 files changed, 78 deletions(-)
diff --git a/framework/base/documents/FrameworkBase.xml b/framework/base/documents/FrameworkBase.xml
deleted file mode 100644
index 8c9d488..0000000
--- a/framework/base/documents/FrameworkBase.xml
+++ /dev/null
@@ -1,32 +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.
--->
-<chapter 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>Framework Base components</title>
- <para>
- This part of the framework contain the basic components like the several different connectors, catalina(tomcat)
- which are the base of the other framework.
- </para>
-
- <xi:include href="ReceivingEmail.xml" />
-</chapter>
-
diff --git a/framework/base/documents/ReceivingEmail.xml b/framework/base/documents/ReceivingEmail.xml
deleted file mode 100644
index d28d033..0000000
--- a/framework/base/documents/ReceivingEmail.xml
+++ /dev/null
@@ -1,46 +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>Receiving Email.</title>
- <para>
- OFBiz can receive email for multiple email addresses and via an MCA can create Communication events
- for the involved parties of the email. Email attachments, via again the MCA are stored in the content component
- and can be accessed via the content Id. Examples of an MCA can be found in the Party and Content Component.
- </para>
- <para>
- To receive email a single POP/IMAP mailbox is polled at regular intervals. This is configured in the
- ${ofbiz install dir}/framework/base/config/ofbiz-containers.xml file. Any email address you want to be handled
- by OFBiz need to be forwarded to this single mailbox by an external mail server. OFBiz then will try to match the
- email addresses to existing parties and will create a single communication event referring to the found parties.
- </para>
- <para>
- If an incoming email address cannot be matched against a party, the communication event will get a special status
- and the receiving party can either delete the communication event or can ask the system to automatically create a party
- from the incoming email address.
- </para>
- <para>
- By default the configuaration file has the email poller commented out. The parameters to this function are pretty self
- explanatory.
- </para>
-</section>
-
[ofbiz-framework] 04/11: Documented: Workeffort migration to
asciidoc (OFBIZ-11587)
Posted by ho...@apache.org.
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 28e82c217b866ae580dc932c0ebbac9c4c70e827
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 10 12:44:04 2020 +0200
Documented: Workeffort migration to asciidoc
(OFBIZ-11587)
deleted related docbook file
---
.../data/helpdata/HELP_PORTLET_CALENDAR.xml | 30 ----------------------
1 file changed, 30 deletions(-)
diff --git a/applications/workeffort/data/helpdata/HELP_PORTLET_CALENDAR.xml b/applications/workeffort/data/helpdata/HELP_PORTLET_CALENDAR.xml
deleted file mode 100644
index 711dddc..0000000
--- a/applications/workeffort/data/helpdata/HELP_PORTLET_CALENDAR.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 Calendar Portlet</title>
- <para>
- It provides an overview on a dayly/weekly/or month period.
- You will see the particular view with the ability to add an event.
- </para>
-</section>
[ofbiz-framework] 05/11: Documented: Framework/base migration to
asciidoc (OFBIZ-11587)
Posted by ho...@apache.org.
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 2c700e86af00afa3f70e4267fb8ab2d774e231f2
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 10 16:06:05 2020 +0200
Documented: Framework/base migration to asciidoc
(OFBIZ-11587)
only one file about receiving email, so create email.adoc which included
receiving and later sending.
email.adoc is included in developer-manual.adoc in deployment section
---
docs/asciidoc/developer-manual.adoc | 2 ++
.../docs/asciidoc/_include/email-receiving.adoc | 39 ++++++++++++++++++++++
framework/base/src/docs/asciidoc/email.adoc | 23 +++++++++++++
3 files changed, 64 insertions(+)
diff --git a/docs/asciidoc/developer-manual.adoc b/docs/asciidoc/developer-manual.adoc
index 6895acd..3e07ab9 100644
--- a/docs/asciidoc/developer-manual.adoc
+++ b/docs/asciidoc/developer-manual.adoc
@@ -273,6 +273,8 @@ include::../../themes/docs/themes.adoc[leveloffset=+2]
== Deployment
+include::../../framework/base/src/docs/asciidoc/email.adoc[leveloffset=+2]
+
include::../../framework/security/src/docs/asciidoc/security.adoc[leveloffset=+1]
== Appendices
diff --git a/framework/base/src/docs/asciidoc/_include/email-receiving.adoc b/framework/base/src/docs/asciidoc/_include/email-receiving.adoc
new file mode 100644
index 0000000..2e3c7c2
--- /dev/null
+++ b/framework/base/src/docs/asciidoc/_include/email-receiving.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.
+////
+= Receiving Email.
+
+OFBiz can receive email for multiple email addresses and via an MCA can create Communication events for the involved parties
+of the email. +
+Email attachments, via again the MCA are stored in the content component and can be accessed via the content Id. +
+Examples of an MCA can be found in the Party and Content Component.
+
+To receive email a single POP/IMAP mailbox is polled at regular intervals. +
+This is configured in the ${ofbiz install dir}/framework/service/ofbiz-component.xml file in the commented section
+JavaMail Listener Container.
+
+Any email address you want to be handled by OFBiz need to be forwarded to this single mailbox by an external mail server. +
+OFBiz then will try to match the email addresses to existing parties and will create a single communication event referring
+to the found parties.
+
+If an incoming email address cannot be matched against a party, the communication event will get a special status and
+the receiving party can either delete the communication event or can ask the system to automatically create a party
+from the incoming email address.
+
+By default the configuaration file has the email poller commented out. +
+The parameters to this function are pretty self explanatory.
\ No newline at end of file
diff --git a/framework/base/src/docs/asciidoc/email.adoc b/framework/base/src/docs/asciidoc/email.adoc
new file mode 100644
index 0000000..6408da3
--- /dev/null
+++ b/framework/base/src/docs/asciidoc/email.adoc
@@ -0,0 +1,23 @@
+////
+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.
+////
+= email
+
+== HowTo use email in OFBiz
+
+include::_include/email-receiving.adoc[leveloffset=+2]