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/20 10:52:59 UTC
[ofbiz-plugins] 01/03: Documented: ofbiz-plugins / ebay,
migration for Help docbook file to asciidoc (OFBIZ-11587)
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-plugins.git
commit 7ecfaebc721a5393a46cdec4eb35740dbd875ea0
Author: holivier <ho...@apache.org>
AuthorDate: Fri Apr 17 17:54:53 2020 +0200
Documented: ofbiz-plugins / ebay, migration for Help docbook file to
asciidoc
(OFBIZ-11587)
- ebay.adoc call (with include) other files
---
.../asciidoc/_include/ebay-ShippingMethods.adoc | 38 ++++++++++++++
.../asciidoc/_include/ebay-configurations.adoc | 55 ++++++++++++++++++++
.../asciidoc/_include/ebay-export-to-ebay.adoc | 59 ++++++++++++++++++++++
.../ebay-filter-result-search-product.adoc | 37 ++++++++++++++
.../docs/asciidoc/_include/ebay-import-orders.adoc | 36 +++++++++++++
.../_include/ebay-import-single-transaction.adoc | 37 ++++++++++++++
ebay/src/docs/asciidoc/_include/ebay-intro.adoc | 52 +++++++++++++++++++
.../asciidoc/_include/ebay-search-product.adoc | 29 +++++++++++
ebay/src/docs/asciidoc/ebay.adoc | 50 ++++++++++++++++++
9 files changed, 393 insertions(+)
diff --git a/ebay/src/docs/asciidoc/_include/ebay-ShippingMethods.adoc b/ebay/src/docs/asciidoc/_include/ebay-ShippingMethods.adoc
new file mode 100644
index 0000000..a978136
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-ShippingMethods.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.
+////
+= Shipping Methods Configuration
+This screen allows the user to add shipping methods rate for intregrate ofbiz and Ebay.
+
+== How to add shipping methods?
+. Enter 'Shipment Method Name ' (ex:'LocalDelivery')
+. Select 'product store' (ex:'OFBiz E-Commerce Store [9000]')
+. Enter 'Amount'
+. Enter 'Additional Amount' (if you want )
+. Enter 'Additional Percent' (if you want )
+. Enter 'Method Type Enum Id' (ex:Flat Rate Shipping)
+. Enter 'Carrier Party Id' select from lookup (Default is UPS)
+. select 'Shipment Method Type Id'
+. Press the 'Add' button to add shipping method.
+
+== How to update shipping methods?
+. Update the fields required in the screen
+. Press the 'Update' button
+
+== How to delete shipping methods?
+. Press the 'Delete' button in each shipping method
diff --git a/ebay/src/docs/asciidoc/_include/ebay-configurations.adoc b/ebay/src/docs/asciidoc/_include/ebay-configurations.adoc
new file mode 100644
index 0000000..6ef5263
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-configurations.adoc
@@ -0,0 +1,55 @@
+////
+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.
+////
+= Configurations
+The default screen is for the Ebay Configurations tab is 'Ebay Configurations'.
+It is used to locate existing configurations that have been created automatically by the system or manually by the user.
+
+It can also be used to create a new configurations or edit to integration between OFBiz and eBay.
+
+== How to find Ebay configurations?
+. Select 'product store' you want to see configuration. (Example product store is 'OFBiz E-Commerce Store [9000]')
+. Select 'web site' if known.
+. Press the 'Search' button to view configurations.
+. Select 'Any' then Press the 'Search' button to view all configurations.
+
+== New/Edit Ebay configurations.
+This screen allows the user to create or edit an Ebay Configuration for intregrate ofbiz and Ebay.
+
+Press New on top or 'Edit' button at product store you want to edit configuration.
+System will show screen for edit/create configuration data.
+
+Ebay Configuration use for put keys and certificate get from ebay develop site after you register.
+
+=== How to edit Ebay configurations?
+. Please Select 'product store' you want to create configuration. Example product store is 'OFBiz E-Commerce Store [9000]')
+. Enter 'Dev Id' (ex:f3586481-93c7-4aaf-ab87-d383d56b71b1)
+. Enter 'App Id' (ex:antwebc0f-9bf9-4829-998b-e5e8fb773ac)
+. Enter 'Cert Id' (ex:7f363bc0-11d6-489a-a54d-4a44de82f790)
+. Enter 'Token' (# token key generated from ebay account ex:AgAAAA**AQAAAA**aAAAAA**Ccn7Sg.....)
+. Enter 'Compatibility Level' (ex:635)
+. Enter 'Site Id' (ex:0=US ,15=AU)
+. Enter 'Xml Gateway Uri' +
+ # sandbox -eBayExport.xmlGatewayUri=https://api.sandbox.ebay.com/ws/api.dll +
+ # production -eBayExport.xmlGatewayUri=https://api.ebay.com/ws/api.dll)
+. Enter 'Custom XML'
+. Enter 'Web Site' (ebay)
+. Press the 'Update' button to create configurations.
+
+== Delete Ebay configurations.
+. Press 'Delete' button at product store you want to delete configuration.
diff --git a/ebay/src/docs/asciidoc/_include/ebay-export-to-ebay.adoc b/ebay/src/docs/asciidoc/_include/ebay-export-to-ebay.adoc
new file mode 100644
index 0000000..d9f4ff4
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-export-to-ebay.adoc
@@ -0,0 +1,59 @@
+////
+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.
+////
+= Export to eBay (product)
+This screen allows the user to setup properties of products for the start auction on ebay, And allows the user to export product
+to the ebay site. +
+On the 'Export Products to eBay' section have many fields to use for start auction listing(products) on the ebay site.
+
+== Fields Description :
+. eBay Category : Ofbiz retrieve this field from ebay categories and threre are several levels. +
+ You may need to select several time to get your categories for example : +
+ Your product is in "Drawing" category but the category is lower level of "Art" and ".......". +
+ So you need to select "Art" first and .... and "Drawing" to get the category.
+. Country : use for select country you want to show the listing on the ebay site.
+. Location : for located item location.
+. Listing Duration is a duration for auction and show the listing on ebay.
+. Start Price is a price for start auction +
+ (note : if you product have a minimum price (* Purpose is 'eBay Auction') don't need to set this field,
+ the system will auto use the minimum price for start auctions. )
+. Quantity : Quantity of product
+. Website :
+. Web Site Url :
+. Payment Methods Accepted : This is Type of payment you want to use on the ebay.
+. PayPal email : We need it when you select payment by paypal.
+. Custom XML : It was auto generate from ebay configurations, it use for ebay know about currency,
+ shipping method and other informations for shipping with this listing.
+
+== How to set export products?
+. select ebay category you want to put products(listing). +
+ You may need to select several time to get your categories for example :
+ Your product is in "Drawing" category but the category is lower level of "Art" and ".......". +
+ So you need to select "Art" first and .... and "Drawing" to get the category.
+. select country you want to show the listing on the ebay site.
+. enter location
+. select duration for auction and show the listing on ebay.
+. enter start price, if you product have a minimum price (* Purpose is 'eBay Auction') don't need to set this field,
+ the system will auto use the minimum price for start auctions.
+. select Website but now this field
+. enter Website url (*require field)
+. Select at least one payment method
+. enter paypal email when you select payment by paypal.
+. For Custom XML it was auto generate from ebay configurations, but if you want to change you can edit.
+. Press 'Export to Ebay' button then system will post your listing to ebay site.
+. note : when export process is success system will be return message to show on the screen and tell you what is done.
diff --git a/ebay/src/docs/asciidoc/_include/ebay-filter-result-search-product.adoc b/ebay/src/docs/asciidoc/_include/ebay-filter-result-search-product.adoc
new file mode 100644
index 0000000..927bca2
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-filter-result-search-product.adoc
@@ -0,0 +1,37 @@
+////
+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.
+////
+= Filter result after search Products in category screen.
+This screen allows the user to see the results of products the find it from conditions. +
+The user can select products they want export to ebay categories in this screen.
+
+== How to remove the conditions to find products?
+In the section 'Search Products, you searched for:' you will see list of conditions show on the top in the section,
+ So you can click 'X' to remove the condition you don't want and then the results of products will have changes.
+
+== What is a 'refine search' button?
+The 'Refine search' button use for go back to page to put the conditions again.
+
+== How to select products?
+In the results section you can select products which you want to export by use checkbox in front of name of products.
+ You can select one or many products if you want.
+
+== What is 'Export To eBay' button?
+After you select products then you want to export it you can click 'Export To eBay' button.
+ It will take you to go to the screen for setup ebay categories, start price for auction and payment method before
+ you export the products.
diff --git a/ebay/src/docs/asciidoc/_include/ebay-import-orders.adoc b/ebay/src/docs/asciidoc/_include/ebay-import-orders.adoc
new file mode 100644
index 0000000..44a4f40
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-import-orders.adoc
@@ -0,0 +1,36 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Ebay Orders Import screen.
+This screen allows the user to find and import orders data from ebay site. +
+you can search an order by specify begin/end time then select orders to import
+
+== Section 'Search Options'.
+. select product store ex: use 'OFBiz E-Commerce Store' because example ebay catalog link with this store.
+. enter begin time in field 'From Date Time'
+. enter end time in field 'Thru Date Time'
+. Press 'Find' button then system will show results from ebay site.
+
+== Section 'Search Results'.
+This section show search results, it has many detail get from ebay site, +
+At the last filed on the screen left you will see checkbox for select the order rows and then import it into ofbiz.
+
+== How to import order from eBay?
+. Click checkbox at rows you want to import orders in the 'Search Result' section
+. Press 'Import Orders From ebay' button then system will return the message on the screen
+ and you can check orders list in the 'Order' module.
diff --git a/ebay/src/docs/asciidoc/_include/ebay-import-single-transaction.adoc b/ebay/src/docs/asciidoc/_include/ebay-import-single-transaction.adoc
new file mode 100644
index 0000000..33f5710
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-import-single-transaction.adoc
@@ -0,0 +1,37 @@
+////
+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.
+////
+= Import Single Transactions
+This screen allows the user to find orders transactions on ebay by specify begin/end time, and then select orders to import data
+into ofbiz system.
+
+== Section 'Search Single Transactions From eBay'
+(use for select conditions to search results)
+
+. select product store ex: use 'OFBiz E-Commerce Store' because example ebay catalog link with this store.
+. enter begin time in field 'From Date Time'
+. enter end time in field 'Thru Date Time'
+. Press 'Search Single Transactions From eBay' button then system will show results from ebay site.
+
+== Section 'Import Orders From eBay'.
+This section show search results, it has many detail get from ebay site, +
+At the last filed on the screen left you will see checkbox for select the transaction rows and then import it into ofbiz.
+
+== How to import single transactions from eBay?
+. Click checkbox at rows you want to import transaction in the 'Import Orders From eBay' section
+. Press 'Import Single Transactions' button then system will return the message on the screen.
diff --git a/ebay/src/docs/asciidoc/_include/ebay-intro.adoc b/ebay/src/docs/asciidoc/_include/ebay-intro.adoc
new file mode 100644
index 0000000..f89bcab
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-intro.adoc
@@ -0,0 +1,52 @@
+////
+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.
+////
+= Ebay appl. introduction.
+Ebay application will be use for merchant integration between OFBiz and eBay.
+It is possible to export products from your store into categories on Ebay site also import an orders from ebay.
+
+You can use fuctions on this application to setup auction on ebay for the sell your stuff on ebay.
+
+== How to setup OFBiz integration eBay.
+. Register with ebay developer site for obtain keys and certificate
+ (eBayExport.devId,eBayExport.appId,eBayExport.cerId and eBayExport.token etc.)
+ at https://developer.ebay.com/join/[Join with ebay developers]
+. After registered it should be following the keys below :
+ * ebay keys example
+ .. eBayExport.devID=f3586481-93c7-4aaf-ab87-d383d56b71b1
+ .. eBayExport.appID=antwebc0f-9bf9-4829-998b-e5e8fb773ac
+ .. eBayExport.certID=7f363bc0-11d6-489a-a54d-4a44de82f790
+
+ * token key generated from ebay account example :
+ .. eBayExport.token=AgAAAA**AQAAAA**aAAAAA**Ccn7Sg.....
+. Following file in plugins/ebay/config/eBayExport.properties. You will see Merchant configurations. +
+ * For eBayExport.xmlGatewayUri :
+ .. https://api.sandbox.ebay.com/ws/api.dll +
+ (sandbox environment used for testing and develoment ) +
+ if you want to use for testing should select sandbox enviroment.
+ .. https://api.ebay.com/ws/api.dll +
+ (production environment).
+ * For : eBayExport.siteID :
+ .. It was siteId you want to sell products ex: site id (0=US, 101=Italy, ...) obtain from
+ http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/types/SiteCodeType.html[SiteCodeType]
+. Go to ebay-->Ebay Configurations screen (see link in the bottom of page) +
+ This screen will displayed ebay configurations with each stores.
+ You need to "`add`" or "`edit`" the configuration keys you got from ebay for each productstores into this screen.
+ This configuration is for connect to ebay site and export or import data to ebay.
+. In eBay screen, go to ebay -> Export or eBay -> orders Import +
+ then try to test export products and import orders from ebay.
diff --git a/ebay/src/docs/asciidoc/_include/ebay-search-product.adoc b/ebay/src/docs/asciidoc/_include/ebay-search-product.adoc
new file mode 100644
index 0000000..22efa12
--- /dev/null
+++ b/ebay/src/docs/asciidoc/_include/ebay-search-product.adoc
@@ -0,0 +1,29 @@
+////
+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.
+////
+= Search Products in category screen.
+This screen allows the user to find products for export from ofbiz store to Ebay site. +
+First you must select product store, catalogs and category at products located.
+Then find products and select product you want to export to category on ebay site.
+
+== How to search products?
+. select products store you want to export products example : OFBiz E-Commerce [9000]
+. select catalog 'eBay Catalog'
+. select category in example you can use 'Ebay E-Commerce ... [eBay_ECom_Category]'
+. select the other condition if you want
+. Press 'Find' button at the below of page to find products
diff --git a/ebay/src/docs/asciidoc/ebay.adoc b/ebay/src/docs/asciidoc/ebay.adoc
new file mode 100644
index 0000000..9c4c9e6
--- /dev/null
+++ b/ebay/src/docs/asciidoc/ebay.adoc
@@ -0,0 +1,50 @@
+////
+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 Ebay Component
+
+The Ebay component provides an interface to the Ebay website.
+
+It is possible to export products from your store into eBay category also import an orders from ebay.
+
+include::_include/ebay-intro.adoc[leveloffset=+1]
+
+== main Features
+. Ebay configurations for ofbiz intregrate with ebay.
+. Setup shipping methods.
+. Export products into ebay categories.
+. Export products into ebay categories.
+. Import transactions from ebay
+. Import orders from ebay
+
+
+== Ebay management in User Interface
+
+include::_include/ebay-configurations.adoc[leveloffset=+2]
+
+include::_include/ebay-search-product.adoc[leveloffset=+2]
+
+include::_include/ebay-filter-result-search-product.adoc[leveloffset=+2]
+
+include::_include/ebay-import-orders.adoc[leveloffset=+2]
+
+include::_include/ebay-import-single-transaction.adoc[leveloffset=+2]
+
+include::_include/ebay-export-to-ebay.adoc[leveloffset=+2]
+
+include::_include/ebay-ShippingMethods.adoc[leveloffset=+2]