Configuring opentaps for Your Business

From Opentaps Wiki
Revision as of 21:40, 21 July 2009 by Claudefeistel2 (talk | contribs) (New page: ==Preliminary Setup== First, make sure that you: * properly installed opentaps and have it running, following the [
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Preliminary Setup

First, make sure that you:


Setting up Your Company

Next, you should start setting up your company. For your convenience, we have provided a configuration template in the hot-deploy/mycompany directory of opentaps to help you configure your company. You should start by copying this directory over to another hot-deploy directory for your company's use. For example, if you are configuring opentaps for XYZ Company, then make a copy of mycompany to xyzcompany:

opentaps-1.0$ cp -r hot-deploy/mycompany hot-deploy/xyzcompany

Then, remove the .svn directories inside xyzcompany, so you won't be getting conflicting updates from the main opentaps repository later. In Linux, you can do that by

opentaps-1.0$ cd hot-deploy/xyzcompany
xyz-company$ find . -name '.svn' -exec rm -rf {} \;

Now you are ready to start editing the files in hot-deploy/xyzcompany/data. The following XML files are available:

  • CRMSFATypes.xml: used for configuring custom field types for the opentaps CRM application, such as industries, lead sources, etc.
  • CompanyData.xml: name, address, and other contact information for your company
  • Warehouses.xml: your company's warehouses and their locations
  • Shipping.xml: This file configures the carriers and their shipping methods, including service codes and sizes of packaging. Standard data for US-based carriers, like UPS, FedEx, U.S. Postal Service, and DHL are provided here.
  • Store.xml: this file configures your products stores. You should create a different file for each product store you wish to set up. In general, each product store embodies a set of sales policies, including sales or VAT tax, payment processing settings, shipping rates, notification e-mails, and order fulfillment policies. The configuration of product stores is discussed in greater detail in Basic Catalog Manager Documentation.
  • Catalog.xml: this file contains the basic product catalog set up to get you started with your products.
  • ChartOfAccount.xml, DefaultInvoiceItemTypeGlAccounts.xml, Accounting.xml: these three files contain the accounting configurations for your company. They contain a chart of accounts and instructions on how the chart of accounts should be used. See Configuring the General Ledger.
  • Users.xml: this file can be used to create the initial administrative users.

For more information on how to use these files to configure your company, see the Users Manual

After editing these files, edit the file ofbiz-component.xml in your company's directory and add any additional files that you may have created. WARNING: Do not change the sequence of the data files in ofbiz-component.xml or changed their reader-name.

Finally, edit the file hot-deploy/component-load.xml and add your new company component so that it will be loaded during installation:

<load-component component-location="${ofbiz.home}/hot-deploy/xyzcompany"/>

Now you are ready. To install your company's settings, go to the opentaps directory and run the install command:

opentaps-1.0$ ./ant run-install-seed

IMPORTANT: make sure you are using run-install-seed and not run-install. Otherwise, the demo data will be installed into the database as well.

When the installation is finished, you can start opentaps, according to the general installation instructions.

After Installation


Your administrative user login is set with an initial password which is by default configured to be "opentaps" in the Users.xml. You should log into the party manager and change this right away. Then, you should prevent the administrative user login to be accidentally reset back to this password by making the following changes:

  • Edit the file applications/securityext/ofbiz-component.xml and comment out the line:
   <entity-resource type="data" reader-name="seed" loader="main" location="data/PasswordSecurityData.xml"/>
  • Edit the file hot-deploy/xyzcompany/ofbiz-component.xml and comment out the line:
   <entity-resource type="data" reader-name="seed" loader="main" location="data/Users.xml"/>

Setting Up More Users

From the party manager, you can create additional users, assign them userlogins, and security permissions.

Importing Legacy Data

To import legacy data, you can use the Data Import component of opentaps. This component has a series of tables into which you can import your legacy data (say by using the flat file import tools of your database), and then it will parse those tables to create corresponding entries in a much more complex opentaps data model. All these tables are prefixed by DataImport: DataImportCustomer for customers, DataImportSuppliers for suppliers, DataImportProduct for products, etc.

Once you have loaded your data into the tables, use the services which start with import* to read them into opentaps. For example, use importCustomers to load the customers and importProducts to load the products. You can run the services from Webtools > Service Reference screen.

If there are rows which cannot be imported, they will be flagged in the original DataImport tables. You can use Webtools > Entity Maintenance screens to look for your tables, or use a database browser such as phpMyAdmin or phpPgAdmin.

See Importing Data with Dataimport for more technical information on how to customize the data import to meet your needs.