Page History

...

NOTE: this is the business setup guide for OFBiz, for the technical oriented one, look here. 

Written by: David E. Jones With feedback and contributions from Ruth Hoffman, Andy Zeneski, Si Chen, Chris Chesney, Hans Bakker, and Al Byers

Sponsored by:
Integral Business Solutions (http://www.go-integral.com)
Hotwax Media, Inc (http://www.hotwaxmedia.com)
Antwebsystems Co,.Ltd (http://www.antwebsystems.com)

Table of Contents

1. Purpose and Goal of This Document
2. Data To Gather for Setup
3. General Terms and Information
   1. OFBiz "Manager" Applications
   2. Other OFBiz Terms
4. Business Setup Process
   1. General Company Setup
      1. Company Contact Information
   2. Facility (Warehouse) Setup
   3. WebSite Setup
   4. Store Setup
      1. Store Settings
      2. Store Role Settings
      3. Promotional Settings
      4. Catalog Settings
      5. Web Site Settings
      6. Sales Tax Settings
      7. Store Shipping Settings
         1. UPS Online Rate Estimates
         2. UPS XPCI Integration
         3. USPS Online Rate Estimates
      8. Store Payment Settings
         1. Payment Processor Details
         2. PayPal Payment Setup
         3. Payflow Pro Payment Setup
         4. CyberSource Payment Setup
         5. Giftcards
         6. Authorize.net Payment Setup
         7. RBS WorldPay Payment Setup
         8. Giftcards
      9. e-mail Settings
      10. Survey Settings
      11. General Settings Override
   5. Catalog, Category, Product Setup
      1. Catalog Setup
      2. Category Setup
      3. Product Setup
         1. Add Content to the New Product
         2. Add Prices to the Product
   6. Accounting Organization and Setup Process
   7. Marketing introduction

Purpose and Goal of This Document

Anchor
purpAndGoal purpAndGoal

...

NOTE: We recommend that you read this entire document before starting the process or making any changes. While you are reading it is helpful to look at the files and web pages in question so you can visualize better where things go and what they look like. Naturally you can ignore this, but a half hour studying this document could save you a lot of time late
 
Note on Typographic Conventions Used in This Document

Wiki MarkupText enclosed in a square box such as \ [\[ \ ]\] represents an OFBiz application browser tab selection.

Throughout the document the author has provided expert advice or other observations. These notations are indicated as follows:

...

Manager applications which will be referenced in this document include the:
"Catalog Manager" accessed at:

http://localhost:8080/catalog/control/main

"Party Manager" accessed at:

http://localhost:8080/partymgr/control/main

More technical web based tools, or tools for the OFBiz framework are available in the "Web Tools" application: http://localhost:8080/webtools/control/main

...

This is where you can associate promotions (setup in the Promos header tab) with the store, including effective dating, sequencing and so forth.unmigrated-wiki-markup

There are all example promotions and it is good to keep them in the database for future reference, but you can delete all of these store associations so they won't get in the way for this store. Just click on the "\[Delete\]" link for each one.

Catalog Settings

Anchor
catalogSettings catalogSettings

Wiki MarkupThis tab shows all Product Catalogs associated with this Store. The demo data has two Catalogs associated by default, and you can remove both of them since we will be creating a new Catalog later. These two you can leave in the database as examples for future reference, but click on the "\[Delete\]" buttons here to remove the associations with the This tab shows all Product Catalogs associated with this Store. The demo data has two Catalogs associated by default, and you can remove both of them since we will be creating a new Catalog later. These two you can leave in the database as examples for future reference, but click on the "[Delete]" buttons here to remove the associations with the Store.

Web Site Settings

Anchor
webSiteSettings webSiteSettings

...

This is configured using various properties in the file:

${ofbiz install dir}/applications/product/config/shipment.properties

1. UPS XPCI Access License Number
   1. o shipment.ups.access.license.number
   2. o Example: TEST262223144CAT
   3. o This license number is used for both the UPS shipment estimate online service and the UPS XPCI shipping interface services (described below)
2. Shipper Default Pickup Type
   1. shipment.ups.shipper.pickup.type
   2. Example: 06
   3. Valid options:
      1. 01 - Daily Pickup
      2. 03 - Customer Counter
      3. 06 - One Time Pickup
      4. 07 - On Call Air Pickup
      5. 11 - Suggested Retail Rates (UPS Store)
      6. 19 - Letter Center
      7. 20 - Air Service Center
   4. Choose the option that represents your relationship with UPS. This affects the estimated rate you will get back since UPS varies their prices based on how you get your packages to them.
3. Estimate split into packages
   1. shipment.ups.max.estimate.weight
   2. Example: "90" meaning 90 pounds
   3. This number is used as the max weight per package when the total weight is > than this weight the weights are split into packages not exceeding max.

...

This is configured using various properties in the file:

${ofbiz install dir}/applications/product/config/shipment.properties

1. UPS Shipper Number
   1. shipment.ups.shipper.number
   2. Example: 486915
2. UPS Bill Shipper Account Number
   1. shipment.ups.bill.shipper.account.number
   2. Example: 486915
3. UPS XPCI Access License Number
   1. shipment.ups.access.license.number
   2. Example: TEST262223144CAT
4. UPS XPCI Access User ID
   1. shipment.ups.access.user.id
5. UPS XPCI Access Password
   1. shipment.ups.access.password
6. Setting to save files needed for UPS certification
   1. shipment.ups.save.certification.info=true
   2. shipment.ups.save.certification.path=/ofbiz/work/ofbiz/upscert
   3. This option is used to create the artifacts the UPS needs to certify client implementation. It is generally required for each customer to go through this process and for UPS to verify the results. Once this is done the shipment.ups.save.certification.info property should be set to false. For more information on this process, see the UPS XPCI documentation and additional information in the UpsServices.java file.

...

This is configured using various properties in the file:

${ofbiz install dir}/applications/product/config/shipment.properties

1. USPS Connection URL & timeout in seconds
   1. shipment.usps.connect.url
   2. Example: http://localhost/facility/ShippingAPI.dll
   3. shipment.usps.connect.timeout
   4. Example: 60
2. USPS Credentials
   1. shipment.usps.access.userid
   2. shipment.usps.access.password
3. Estimate split into packages
   1. shipment.usps.max.estimate.weight
   2. Example: 70

...

While the payment services and high level settings are configured in the Store section of the Catalog Manager the detailed configuration for the various payment processing services are configured in the file:

${ofbiz install dir}/applications/accounting/config/payment.properties

1. There are many comments in this file and sections for each of the major payment processing services.
2. If you are using any credit card payment processor, be sure to check and if necessary change the properties near the beginning of the payment.properties file that follow the pattern: "payment.general.reauth.*.days".

PayPal Payment Setup

Anchor
payPalPaymentSetup payPalPaymentSetup

The PayPal details for OFBiz are setup in the payment.properties file and have the prefix "payment.paypal.".

The ones that always need to be changed for use of PayPal are:

1. payment.paypal.business - set to an email address on your PayPal account
2. payment.paypal.notify - just change domain name and port to the production values you are using
3. payment.paypal.return - set to the URL where you want PayPal to send customers once payment is complete, typically back to your ecommerce web site
4. payment.paypal.cancelReturn - set to the URL where you want PayPal to send customers when they cancel their payment
5. payment.paypal.image - set to the URL of the image or logo you want PayPal to display to help customers know that the payment is being received on your behalf

The other properties beginning with "payment.paypal." can be set, but unless you know what you are doing we recommending leaving them as-is.

In addition to the settings in the payment.properties file, there is also a setting that you must change on the PayPal web site in your account so that notifications will be sent back to OFBiz to verify payment:

1. Login to your account at PayPal.com
2. Click on the "Profile" link in the header, near the top-right of the page
3. In the "Selling Preferences" column click on the "Instance Payment Notification Preferences"
4. It will show you the current settings. To chance click on the "Edit" button.
5. Check the check box near the top of this page, just under the "Instant Payment Notification (IPN)" heading.
6. Enter the notification URL in the text box. This should be the same as the value of the payment.paypal.notify property in the payment.properties file.
7. Click on the "Save" button.

...

1. Go to Accounting - Payment Gateway Config and select "PayPal Payment Gateway" from the list
2. Please fill all those fields to made working correctly to work with PayPal:
   Image Added
   Business Email : Email address of your business
   Notify URL : PayPal Notify URL (example (http://yourServerName/ecommerce/control/payPalNotify)
   Return URL : PayPal Return URL (example (http://yourServerName/ecommerce/control/orderhistory)
   Cancel Return URL : PayPal Return On Cancel URL (example http://yourServerName/ecommerce/control/payPalCancel/main)
   Image URL : Image To Use On PayPal (example (http://yourServerName/images/ofbiz_logo.gif)
   Confirm Template : Thank-You / Confirm Order Template (example /order/emailconfirmation.ftl)
   Redirect URL : PayPal Redirect URL (Sandbox http://www.sandbox.paypal.com/us/cgi-bin/webscr Production https://www.paypal.com/cgi-bin/webscr)
   Confirm URL : PayPal Confirm URL (Sandbox https://www.sandbox.paypal.com/us/cgi-bin/webscr Production http://www.paypal.com/cgi-bin/webscr)
3. Once PayPal Payment Gateway has been configurated you have to go to Catalog - Stores - select your Store - Payments tab
   Image Added
4. Edit the Payment Method Type Paypal and choose as Payment Gateway Config Id "PayPal Config".
   Image Added

5. As deprecated use you can alternatively change the configuration parameters into

   No Format
   ${ofbiz install dir}/applications/accounting/config/payment.properties

   
   
   The ones that always need to be changed for use of PayPal are:

   1. payment.paypal.business - set to an email address on your PayPal account
   2. payment.paypal.notify - just change domain name and port to the production values you are using
   3. payment.paypal.return - set to the URL where you want PayPal to send customers once payment is complete, typically back to your ecommerce web site
   4. payment.paypal.cancelReturn - set to the URL where you want PayPal to send customers when they cancel their payment
   5. payment.paypal.image - set to the URL of the image or logo you want PayPal to display to help customers know that the payment is being received on your behalf

The other properties beginning with "payment.paypal." can be set, but unless you know what you are doing we recommending leaving them as-is.

In addition to the settings in the payment.properties file, there is also a setting that you must change on the PayPal web site in your account so that notifications will be sent back to OFBiz to verify payment:

1. 1. Login to your account at PayPal.com
   2. Click on the "Profile" link in the header, near the top-right of the page
   3. In the "Selling Preferences" column click on the "Instance Payment Notification Preferences"
   4. It will show you the current settings. To chance click on the "Edit" button.
   5. Check the check box near the top of this page, just under the "Instant Payment Notification (IPN)" heading.
   6. Enter the notification URL in the text box. This should be the same as the value of the payment.paypal.notify property in the payment.properties file.
   7. Click on the "Save" button.

Payflow Pro Payment Setup

Anchor
payflowProPaymentSetup payflowProPaymentSetup

1. Put payflow.jar from Payflow Pro's Java SDK in the directory in

   No Format
   ${ofbiz install dir}applications/accounting/lib.

2. Change the accounting build.xml and comments to not exclude verisign sources like here :
   <!- <exclude name="org/ofbiz/accounting/thirdparty/verisign/**"/> ->
3. Confirm that applications/accounting/build/classes/org/ofbiz/accounting/thirdparty/verisign/PayflowPro.class was built and exists
4. The installation of certificate is now no more necessary
5. Go to Accounting - Payment Gateway Config and select "Payflow Pro Payment Gateway" from the list
6. Please fill all those fields to made working correctly to work with Payflow Pro:
   Image Added
   Certs Path : Path the the VeriSign Certificate (No more used from version v4)
   Host Address : Address of the payment processor (example (Test pilot-payflowpro.paypal.com or Production payflowpro.paypal.com)
   Host Port : Port of the payment processor (default is 443)
   Timeout : Timeout (default is 80 seconds)
   Proxy Address : Proxy Address
   Proxy Port : Proxy Port (default is 80)
   Proxy Logon : Proxy Logon
   Proxy Password : Proxy Password
   Vendor : Vendor of account information
   User Id : PayFlow UserID of account information
   Pwd : PayFlow Password of account information
   Partner : PayFlow Partner of account information
   Check Avs : Use Address Verification
   Check Cvv2 : Require CVV2 Verification
   Pre Auth : Pre-Authorize Payments (if set to N will auto-capture)
   Enable Transmit : Set to false to not transmit anything
   Log File Name : Log file name
   Logging Level : Logging level
   Max Log File Size : Max log file size
   Stack Trace On : Stack trace on/off
7. Once Payflow Pro Payment Gateway has been configurated you have to go to Catalog - Stores - select your Store - Payments tab
   Image Added
8. Edit the Payment Method Type Credit Card and after selected a Service Type (Authorize, Capture, ...) you can choose the Custom Method related to the Service Type choosen and as Payment Gateway Config Id "Payflow Pro Config".
   Image Added

As deprecated use you can alternatively change the configuration parameters into

${ofbiz install dir}/applications/accounting/config/payment.properties

Configure all the parameters starting with name "payment.verisign" in payment.properties including directory, vendor, partner, user and password all.

CyberSource Payment Setup

Anchor
cyberSourcePaymentSetup cyberSourcePaymentSetup

1. Put cybsclients15.jar, cybssecurity.jar and xalan.jar from CyberSource SDK in the directory in

   No Format
   ${ofbiz install dir}applications/accounting/lib/cybersource.

2. Change the accounting build.xml and comments to not exclude verisign sources like here :
   <!- <exclude name="org/ofbiz/accounting/thirdparty/cybersource/**"/> ->
3. Confirm that applications/accounting/build/classes/org/ofbiz/accounting/thirdparty/cybersource/IcsPaymentServices.class was built and exists
4. The installation of certificate is requested and you can follow the instructions into the CyberSource Certificate Update manual.
5. Go to Accounting - Payment Gateway Config and select "CyberSource Payment Gateway" from the list
6. Please fill all those fields to made working correctly to work with CyberSource:
   Image Added
   Merchant Id : your merchant Id
   CyberSource API version : target API version (now is 1.43)
   Directory of the keys from CyberSource : Generate using online tools
   Name of the keystore : keystore file name (default is "merchantID".p12)
   Log transaction information : log activated true/false (default is true)
   Log directory : Log directory (default is runtime/logs)
   Log File Name : Log file name (default is cybersource.log)
   Max log size : Megabytes allowed for the log file
   Merchant Description : Shown on credit card statement Vendor
   Merchant Description Contact Information : Shown on credit card statement Vendor
   Auto-Bill In Authorization : Capture automatically true/false (default is false)
   Use DAV In Authorization : May not be supported any longer
   Use Fraud Scoring In Authorization : May not be supported any longer
   Ignore AVS results : Ignore Address Verification Service true/false (default is false)
   Disable AVS for Capture : May not be supported any longer
   AVS Decline Codes : May not be supported any longer
7. Once CyberSource Payment Gateway has been configurated you have to go to Catalog - Stores - select your Store - Payments tab
   Image Added
8. Edit the Payment Method Type Credit Card and after selected a Service Type (Authorize, Capture, ...) you can choose the Custom Method related to the Service Type choosen and as Payment Gateway Config Id "CyberSource Config".
   Image Added

As deprecated use you can alternatively change the configuration parameters into

${ofbiz install dir}/applications/accounting/config/payment.properties

Configure all the parameters starting with name "payment.cybersource" in payment.properties including directory, vendor, partner, user and password all.

Authorize.net Payment Setup

Anchor
authorizenetPaymentSetup authorizenetPaymentSetup

1. The installation of certificate is requested and you can follow also use the instructions from Andreas Sterbenz's blog documented in Google Checkout Integration.
2. Go to Accounting - Payment Gateway Config and select "Authorize Dot Net Payment Gateway" from the list
3. Please fill all those fields to made working correctly to work with Authorize.net:
   Image Added
   Transaction URL : Test/Production Transaction Url
   Certificate Alias : Certificate Alias in the Keystore.
   Authorize Dot Net API version : currently 3.1
   Delimited Data : if the authorize.net response should delimited
   Delimited Character : the delimiter to use in the response.
   Method (only CC supported) : credit card processing.
   Email to Customer : if should send an email to the customer for each transaction
   Email to Merchant : if should send email to the merchant for each transaction
   Test Mode : Forces the URL property to the test URL and adds more logging info to the logs
   Relay Response : if should relay the reposnse to a different server
   Transaction Key : Authorizer.net transaction key.
   User Id : Your Authorize.net user id.
   Pwd : Your Authorize.net password.
   Trans Description : Your Transaction Description.
4. Once Authorize.net Payment Gateway has been configurated you have to go to Catalog - Stores - select your Store - Payments tab
   Image Added
5. Edit the Payment Method Type Credit Card and after selected a Service Type (Authorize, Capture, ...) you can choose the Custom Method related to the Service Type choosen and as Payment Gateway Config Id "Authorize Dot Net Config".
   Image Added

As deprecated use you can alternatively change the configuration parameters into

${ofbiz install dir}/applications/accounting/config/payment.properties

Configure all the parameters starting with name "payment.authorizedotnet" in payment.properties.

RBS WorldPay Payment Setup

Anchor
RBSWorldPayPaymentSetup RBSWorldPayPaymentSetup

1. Go to Accounting - Payment Gateway Config and select "RBS WorldPay Payment Gateway" from the list
2. Please fill all those fields to made working correctly to work with RBS WorldPay:
   Image Added
   Redirect URL : Test/Production Redirect Url
   Worldpay Instance Id : Your Worldpay Instance Id.
   Authorization Mode : Full-Authorize / Pre-Authorize.
   Contact details not-editable : Will displace contact info on WorldPay in non-editable format
   Contact details to be hidden : Will hide the contact info completely
   Currency drop-down to be hidden : Will hide the currency info
   Shopper language Id : locale to be used
   Suppressed Language Menu : if should the language menu to be suppressed.
   Delivery Address Editable : if should the delivery address editable.
   Test Mode : Approve/Cancelled/Live Mode.
3. Once RBS WorldPay Payment Gateway has been configurated you have to go to Catalog - Stores - select your Store - Payments tab
   Image Added
4. Edit the Payment Method Type Credit Card and after selected a Service Type (Authorize, Capture, ...) you can choose the Custom Method related to the Service Type choosen and as Payment Gateway Config Id "RBS WorldPay Config".
   Image Added

As deprecated use you can alternatively change the configuration parameters into

${ofbiz install dir}/applications/accounting/config/payment.properties

Configure all the parameters starting with name "payment.worldpay" in payment.properties

...

.

Giftcards Setup

Anchor
giftCardsSetup giftCardsSetup

...

1. Click on the "Content" tab/button for the product you just created. Here you can setup text and images for your product.
2. You will see some forms at the top for administering managed content (ie from the Content Manager) with the product. For more advanced product related content needs use this, but for more common and simple needs, this can be more difficult to administer and slower at run time.
3. Wiki MarkupNear the bottom of the page is a section labeled "Override Simple Fields". Here you will typically want to specify a Product Name, Product Description, and Long Description. If you have images to associate with the product, you can specify their locations here, or upload them. Note that there are default locations for the images (can be quickly set by clicking on the "\[.jpg\]" or "\[.gif\]" buttons). We recommend using these locations, but of course you can put your images anywhere. These can be an absolute URL, or will be relative to the current server address, or the content URL prefix if one is specified in the url.properties file.

Add Prices to the Product

...

Make sure to put each product in a browse category, and in the All Products category so that it can be searched for, viewed, and purchased in your catalog.

Also, if you want to know "How to localize Product and Categories descriptions"

Expert Recommendation: These are the basics, but there is a lot more information about products that you can, or may need to, setup. We recommend reviewing the more detailed documentation or engaging the services of an experienced consulting to help you through this.

...

See the end-user documentation space for details on how to set these things up and what they mean. Also see this for more advanced options for Products, Categories, and so on.

Accounting data organization and Setup

Anchor
accountingSetup accountingSetup

(field/entitynames in brackets[])

...

General principles

1. The general ledger of ofbiz consists out of a list of 'ledger buckets = glAccounts' with a non meaningfull ID: [glAccountId] and a meaningfull code [accountCode] and a meaningfull name [accountName] Initially, in the demo data, the account id and code are the same. When reorganizations are required these codes can be easily renamed without changing the glAccountId.
2. The buckets are in a hierachy hierarchy where totals of the lower levels are added together and be shown at the higher levels, therefore every ledger bucket has a parent [parentGlAccountId]; with one exeption if the glaccount is a toplevel glAccount/bucket.
3. Every glAccount has a account type id [glAccountTypeId] with a organization dependent second default glAccountId [GlAccountTypeDefault.glAccountId] to be able for the system to create the double booking. (Currently the system will do that always to "ACCOUNTS_RECEIVABLE" default glAccountTypeId for sales invoices).
4. Transactions are created for several reasons like posting of invoices or payments, inventory movements and workeffort costs.
5. GlAccount class is used for categorization and reporting.

General Setup (accounting -> global GlSettings)

1. Company data and internal organizations
   demo file at: /applications/accounting/data/DemoOrganizationData.xml
2. All glAccounts are predefined [GlAccount] and can be viewed on the globalGlSettings->chartOfAccounts screen.
   demo file at /applications/accounting/data/DemoGeneralChartOfAccounts.xml
3. Load the Sales/purchase InvoiceItemType table and default glAccountId general setup for all organizations.
   demo file at /applications/accounting/data/DemoGlSetupData.xml

Organizational Setup (accounting -> organizational settings -> setup).

1. The predefined glAccounts are assigned to an organization [GlAccountOrganization] on screen chartOfAccounts (this file can only be loaded and not changed)
   demo file at /applications/accounting/data/DemoGlSetupData.xml
2. if required override the invoiceItem type type assignement for a particular organization at the glAccountDefaults->SalesInvoice/PurchaseInvoice
3. Enter/load the payment TYPE GlType Mapping file [PaymentGlAccountTypeMap] at
   glAccountDefaults->PaymentTypeGlMapping
4. Enter/load the payment METHOD GlType Mapping file [PaymentMethodTypeGlAccount] at
   glAccountDefaults->PaymentMethodTypeGlMapping

Creating ledger transactions.(to be completed)

1. Sales invoice
2. Purchase invoice
3. Incoming payment
4. Outgoing payment
5. Inventary adjustment
6. Workeffort costs

Marketing overview

Anchor
marketingSetup marketingSetup

text now maintained within ofbiz, check