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 13:47:31 UTC
[ofbiz-plugins] 01/02: Documented: ofbiz-plugins / ebayStore,
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 0d8efd4a1bb40d7fe093522be834a7408b37b4ed
Author: holivier <ho...@apache.org>
AuthorDate: Mon Apr 20 10:55:05 2020 +0200
Documented: ofbiz-plugins / ebayStore, migration for Help docbook file
to asciidoc (OFBIZ-11587)
- ebay-store.adoc include directly some content and call (with include)
other files
---
docs/asciidoc/plugins-user-manual.adoc | 2 +
ebaystore/src/docs/asciidoc/_include/ebs-main.adoc | 34 +++++++
.../asciidoc/_include/ebs-new-ebay-account.adoc | 25 +++---
.../asciidoc/_include/ebs-product-inventory.adoc | 70 +++++++++++++++
.../docs/asciidoc/_include/ebs-store-setting.adoc | 50 +++++++++++
ebaystore/src/docs/asciidoc/ebay-store.adoc | 100 +++++++++++++++++++++
6 files changed, 270 insertions(+), 11 deletions(-)
diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc
index becac7c..972cbcd 100644
--- a/docs/asciidoc/plugins-user-manual.adoc
+++ b/docs/asciidoc/plugins-user-manual.adoc
@@ -28,3 +28,5 @@ endif::[]
:sectnums:
include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1]
+
+include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1]
diff --git a/ebaystore/src/docs/asciidoc/_include/ebs-main.adoc b/ebaystore/src/docs/asciidoc/_include/ebs-main.adoc
new file mode 100644
index 0000000..546e40e
--- /dev/null
+++ b/ebaystore/src/docs/asciidoc/_include/ebs-main.adoc
@@ -0,0 +1,34 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+= Ebay Store main screen.
+This screen allows the user to access to ebay store by using their account and you can set up and manage your ebay store in ofbiz.
+
+Before you take action on this function, you should already have an ebay store and ebay account on the ebay site
+because ebay does not allow to create a store from third party site.
+
+== How to start ebay store in ofbiz?
+. Register with ebay developer site to obtain keys and certificate (eBayExport.devId,eBayExport.appId,eBayExport.cerId and
+ eBayExport.token etc.) at https://developer.ebay.com/join/[Join with ebay developers]
+. Press 'New Ebay Account' button to create your ebay account in ofbiz. After you have created ,the system will generate new
+ product store in ofbiz which link to ebay store. (note :An ebay account in ofbiz use for access to your ebay store on
+ the ebay site)
+. Put your keys in Ebay Configurations Tab.
+
+== How to connect to your ebay store?
+. Go to 'Ebay Accounts' section select your account then press 'submit' button,the system will show functions.
diff --git a/docs/asciidoc/plugins-user-manual.adoc b/ebaystore/src/docs/asciidoc/_include/ebs-new-ebay-account.adoc
similarity index 58%
copy from docs/asciidoc/plugins-user-manual.adoc
copy to ebaystore/src/docs/asciidoc/_include/ebs-new-ebay-account.adoc
index becac7c..db9592d 100644
--- a/docs/asciidoc/plugins-user-manual.adoc
+++ b/ebaystore/src/docs/asciidoc/_include/ebs-new-ebay-account.adoc
@@ -16,15 +16,18 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= Apache OFBiz Plugins
-The Apache OFBiz Project
-Release trunk
-:imagesdir: ./images
-ifdef::backend-pdf[]
-:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center]
-:source-highlighter: rouge
-endif::[]
-:toc:
-:sectnums:
+= New Ebay Account.
+This screen allows the user to add new ebay account for access to using their ebay store.
-include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1]
+== Fields Description :
+. Enter 'Salutation' (ex:Mr,miss,Missis)
+. Enter 'First Name' (ex:Demo)
+. Enter 'Middle Name'
+. Enter 'Last Name' (ex: DemoLastName)
+. Enter 'Gender'
+. Enter 'User Login Id' (ex:exbaySandBox123) which you registered on ebay
+. Enter 'Current Password' the same which you registered on ebay
+. Press the 'Create' button.
+
+[NOTE]
+Go to Party module -> Search your party -> then you can update your profiles
diff --git a/ebaystore/src/docs/asciidoc/_include/ebs-product-inventory.adoc b/ebaystore/src/docs/asciidoc/_include/ebs-product-inventory.adoc
new file mode 100644
index 0000000..e763fb1
--- /dev/null
+++ b/ebaystore/src/docs/asciidoc/_include/ebs-product-inventory.adoc
@@ -0,0 +1,70 @@
+////
+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.
+////
+= Handle Ebay Product Inventory.
+This screen allows the user to manage reserve products from ofbiz inventory to their ebay store and then user can use
+this screen to upload that products into ebay product inventory on ebay site following an ebay account.
+
+In this screen user can manage their ebay store inventory from ofbiz, the screen will show status of product on
+ebay product inventory (Product Avialabel to list, active, sold, unsold and scheduled
+
+== This function used for :
+. Handle ofbiz inventory and ebay product inventory follow an ebay account
+. Reserve product from ofbiz inventory
+. Upload product to ebay product inventory
+. Show status of product(QTY, Avialable to listing, scheduled, sold, unsold and active listing)
+. Show Quantity of product
+
+== How to go to reserve product?
+. Go to inventory Details section.
+. Press on "Reserve product inventory" button
+. The system will show reserve product screen
+
+== How to update inventoy and status on ebay site?
+. Go to inventory Details section.
+. Press on "Update to ebay inventory" button
+. The system will update product and qty to ebay inventory on ebay site
+
+== Fields Description :
+. ProductId (productId in ofbiz catalog)
+. ProductName (Name of product)
+. Qty Reserved (Quantity of product that user reserved from ofbiz inventory)
+. Available To Promise Listing (Quantity of product that user can use create listing)
+. Ebay Product Id +
+ (this field used for keep productId from ebay inventory because Ebay site not allow user to create productId to their system)
+. Active Listing (Quantity of product that user can use create listing)
+. sold (Quantity of product that sold)
+. un Sold (Quantity of product that still un sold)
+. reserved date
+. Note: The user can not create ebay listing and sell product on ebay site greater than amount they made a reservation only.
+
+
+== Notes :
+. Please subscribed to Selling Manager Pro before you use this function because ebay product inventory will open when you start
+ selling manager pro on ebay site
+. http://pages.ebay.com/selling_manager_pro[To subscribe for production site ]
+. http://k2b-bulk.sandbox.ebay.com/ws/eBayISAPI.dll?MyeBaySellingPendingListings[To upgrade store level for sandbox site ]
+ (The normal level for sandbox store is basic, the user should upgrade to premium when you want to use inventory function
+ with ebay sandbox.)
+. How to upgrade sandbox store level?
+. Click on the link "To upgrade store level for sandbox site"
+. Go to "Selling Related links" section
+. Click on "Edit my eBay store"
+. Page Manage my eBay store will show up
+. Go to "Store Usage Information" section
+. Click upgrade at "Subscription level" then select "Premium Store" and "Selling Manager Pro" submit.
diff --git a/ebaystore/src/docs/asciidoc/_include/ebs-store-setting.adoc b/ebaystore/src/docs/asciidoc/_include/ebs-store-setting.adoc
new file mode 100644
index 0000000..c950733
--- /dev/null
+++ b/ebaystore/src/docs/asciidoc/_include/ebs-store-setting.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.
+////
+= Ebay Store Detail screen.
+This screen allows the user to manage store display setting (store detail, theme, and font color,logo etc.).
+You can setting in this screen and submit the system will sent your setting to your ebay store and store will update detail.
+
+== Fields Description :
+. Store Name(define 35 charactors)
+. Store Descrption(define 300 charactors)
+. Store Url
+. Store Logo Url(enter your company logo are located at the following URL..)
+. All of your Store's pages will appear with the theme you choose, On ebay there are two basic types of themes to choose from.
+. Store Advanced Theme (This is predesigned themes offer professionally designed background graphics and color combinations. +
+ Use one of these if you want to save time on creating an appealing, consistent look for your Store)
+. Store Advanced Theme Color
+. Store Basic Theme(Easily Customizable themes lend themselves to creating a more custom look. +
+ Use one of these if you'd prefer to have more control over the colors in your store)
+. http://developer.ebay.com/DevZone/XML/docs/WebHelp/images/CustomStoreLookAndFeelWithCallouts.jpg[See example layout on ebay]
+. Primary Color
+. Secondary Color
+. Accent Color
+. Store Name(Font,Size and Color)
+. Store Title(Font,Size and Color)
+. Store Description(Font,Size and Color)
+. Header Display +
+ - Select No, do not include additional information in the header, +
+ - Select Yes, include additional information
+ in the header. (Enter in text area below))
+. Select the eBay header style
+. Item List Display
+. Item Sort
+. Store Merch Display
+. Subscription Level
+. Press 'submit' to submit data to your ebay store site
diff --git a/ebaystore/src/docs/asciidoc/ebay-store.adoc b/ebaystore/src/docs/asciidoc/ebay-store.adoc
new file mode 100644
index 0000000..c978492
--- /dev/null
+++ b/ebaystore/src/docs/asciidoc/ebay-store.adoc
@@ -0,0 +1,100 @@
+////
+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 Store
+
+The Ebay Store component provides an interface to the Ebay website. +
+It's desactivate in the default configuration.
+
+It is possible to export products from your store into eBay category also import an orders from ebay.
+
+== Ebay Store management in User Interface
+
+include::_include/ebs-main.adoc[leveloffset=+2]
+
+include::_include/ebs-new-ebay-account.adoc[leveloffset=+2]
+
+include::_include/ebs-store-setting.adoc[leveloffset=+2]
+
+=== Export categories to ebay store screen.
+The screen allow user to export categories and product to eBay store.
+
+First you should select catalog and click on Export to eBay store button to complete function. +
+When you click Export to eBay store button, this function will add your categories that in catalog selected
+to eBay store also add product to categories too.
+
+=== EBay Leave Feedback.
+This screen have 3 tab button All, bought, sold.
+
+* "All" = bought and sold,
+* "bought" = this account is buyer,
+* "sold" = this account is seller.
+
+All item in the list can leave message to buyer and seller multi action that mean each item is seperated.
+
+If item is bought it have 3 options to select and then when select "Positive", "Neutral" and "Negative" a rating
+section appear:
+
+. add rating to seller, and comment,
+. if select "I'll leave Feedback later" a rating section disappear.
+
+If item is sold it have 2 options to select and then when select "Positive" a comment box appear to add comment
+text to buyer, +
+if select "I'll leave Feedback later" this comment box will disappear.
+
+[NOTE]
+If you don't add comment in text box, leave feedback don't send.
+
+=== EBay Feedback.
+==== Items Awaiting Feedback
+This section list Items, they are sold or bought and have link to Leave Feedback screen.
+
+This list you can see itemId, title, user and link to leave feedback to buyer or seller.
+http://developer.ebay.com/DevZone/support/knowledgebase/[See more info]
+
+==== Recent Feedback
+This section list recent feedback message from commentator (buyer) who do transaction with this account.
+
+=== Ebay Store Auto-Setting
+This section contains all Auto setting of specify Account.
+
+=== Automation Re-list Items
+Automation Re-list Items is setting when items are sold or quantity empty or don't active and then auto re-listing those items.
+
+. Start Date have to start before today or finish date. Format: yyyy-MM-dd HH:mm:ss.SSS"
+. Finish Date have to is after start date. Format: yyyy-MM-dd HH:mm:ss.SSS"
+
+[NOTE]
+If you don't set finish date Automation Re-list continue to do.
+
+include::_include/ebs-product-inventory.adoc[leveloffset=+2]
+
+=== Reserve Product From Ofbiz Inventory.
+This screen allows the user to reserve products from ofbiz inventory for create listing and sell on ebay site.
+
+==== How to reserve product?
+. Go to Reserve Product section
+. Enter field productId (Click "look up" to find product or type in text the system will show list of product)
+. Enter quantity of product you want to reserve.
+. Press "" button
+
+=== Block item that out of stock.
+The screen allow user to block items that out of stock on eBay inventory.
+
+. First you should input your store id and click on Block out of stock button to complete this function.
+. When you click Block out of stock button, this function will block your items on inventory that quantity is zero.