|
|
| Line 1: |
Line 1: |
| − | '''Information for Technical Support Staff who need to set up and configure components of the software system is provided in this section.''' | + | '''opentaps''' is a very flexible system for business process automation that is readily applied to a variety of different kinds of businesses. This means that '''opentaps''' comes with a number of configuration options that make it readily adaptable for business growth and change, as well as for different business operating assumptions. Configuration for this powerful business management vehicle is grouped into two major categories, requiring two distinct skill groups: |
| | + | 1. Technical Configuration for information systems specialists. |
| | + | (Skills like Linux and database administration are needed.) |
| | + | 2. Administrative Configuration for non-technical administrators. |
| | + | (Skills in business processes and end-user software are needed.) |
| | | | |
| − | ==Preliminary Setup==
| + | The following two sections provide introductions to configuration for those groups: |
| − | | + | * the for TECHS, the information systems specialist, |
| − | First, make sure that you:
| + | * and for ADMINS, the non-technical administrators of the business processes. |
| − | * properly installed opentaps and have it running, following the [http://www.opentaps.org/index.php?option=com_content&task=view&id=36&Itemid=62 general installation instructions]
| |
| − | * configured a database to run with opentaps. See instructions for [http://www.opentaps.org/index.php?option=com_content&task=view&id=37&Itemid=62 installing MySQL for opentaps] and [http://www.opentaps.org/index.php?option=com_content&task=view&id=38&Itemid=62 installing PostgreSQL for opentaps]
| |
| − | * if you need to, you can [http://www.opentaps.org/index.php?option=com_content&task=view&id=54&Itemid=62 change the port configurations for opentaps] | |
| − | * in opentaps version 1.0.3 and later, SSL is turned off by default for demo purposes. '''This is obviously not secure!''' To turn it back on, edit the file <tt>framework/webapp/config/url.properties</tt> and change the following flag:
| |
| − | port.https.enabled=Y
| |
| − | | |
| − | ==Setting up Your Company==
| |
| − | | |
| − | Next, you should start setting up your company. For your convenience, we have provided a configuration template in the <tt>hot-deploy/mycompany</tt> 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 <tt>hot-deploy/xyzcompany/data</tt>. The following XML files are available:
| |
| − | * <tt>CRMSFATypes.xml</tt>: used for configuring custom field types for the opentaps CRM application, such as industries, lead sources, etc.
| |
| − | * <tt>CompanyData.xml</tt>: name, address, and other contact information for your company
| |
| − | * <tt>Warehouses.xml</tt>: your company's warehouses and their locations
| |
| − | * <tt>Shipping.xml</tt>: 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.
| |
| − | * <tt>Store.xml</tt>: 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 [http://www.opentaps.org/docs/images/c/cd/Catalog_Manager.pdf Basic Catalog Manager Documentation]. | |
| − | * <tt>Catalog.xml</tt>: this file contains the basic product catalog set up to get you started with your products.
| |
| − | * <tt>ChartOfAccount.xml</tt>, <tt>DefaultInvoiceItemTypeGlAccounts.xml</tt>, <tt>Accounting.xml</tt>: 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]].
| |
| − | * <tt>Users.xml</tt>: 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 [[Opentaps_Users_Manual#Additional_Setup_and_Configuration|the Users Manual]]
| |
| − | | |
| − | After editing these files, edit the file <tt>ofbiz-component.xml</tt> 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 <tt>ofbiz-component.xml</tt> or changed their reader-name.'''
| |
| − | | |
| − | Finally, edit the file <tt>hot-deploy/component-load.xml</tt> 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 [http://www.opentaps.org/index.php?option=com_content&task=view&id=36&Itemid=62 general installation instructions].
| |
| − | | |
| − | ==After Installation==
| |
| − | | |
| − | ===Security===
| |
| − | | |
| − | Your administrative user login is set with an initial password which is by default configured to be "opentaps" in the <tt>Users.xml</tt>. 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 <tt>applications/securityext/ofbiz-component.xml</tt> and comment out the line:
| |
| − | <entity-resource type="data" reader-name="seed" loader="main" location="data/PasswordSecurityData.xml"/>
| |
| − | | |
| − | * Edit the file <tt>hot-deploy/xyzcompany/ofbiz-component.xml</tt> 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 <tt>DataImport</tt>: <tt>DataImportCustomer</tt> for customers, <tt>DataImportSuppliers</tt> for suppliers, <tt>DataImportProduct</tt> for products, etc.
| |
| − | | |
| − | Once you have loaded your data into the tables, use the services which start with <tt>import*</tt> to read them into opentaps. For example, use <tt>importCustomers</tt> to load the customers and <tt>importProducts</tt> 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 <tt>DataImport</tt> 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.
| |
