Release Notes VERSION 3.8.4

Transcription

1 VERSION June 2014

2 1155 Perimeter Center West, Suite 700, Atlanta, GA Copyright Copyright 2014 Aptean. All Rights Reserved. The information provided by Aptean in this document is for informational purposes only, without representation or warranty of any kind, and Aptean shall not be liable for errors or omissions with respect to the information. The only warranties for Aptean products and services are those set forth in the express warranty statements accompanying such products and services, if any, and nothing herein shall be construed as constituting an additional warranty. No part of this document shall be reproduced or transmitted in any form or for any purpose without the express written permission of Aptean. The information contained herein may be changed without prior notice. Some products marketed by Aptean contain proprietary software components of other software vendors. Aptean and other Aptean products and services referenced herein as well as their respective logos are registered trademark or trademarks of Aptean or its affiliated companies. Page 2

3 Contents Contents Compiere Release Summary... 1 Audience... 1 Downloading Compiere... 1 Recommended Infrastructure... 2 Process to Log Support Requests... 2 Additional Information... 3 New in Compiere Technical Notes... 4 Bugs Fixed in Compiere Known Issues in Compiere Known Issues in the Migration Process... 8 Known Issues in the Installation Process Appendix A Migration Instructions Prerequisites Preserving Customizations Migration Process Migrating to a New Release Multi-server Installation for Compiere Enterprise Edition Appendix B Compiere Installation Instructions Prerequisites Installing Database Installing Java Installing Application Server Installing JBoss Installing Tomcat Page i

4 Contents Installing Compiere Running the Application Server Starting Compiere Appendix C Application Extensions - Compiere Partners Registration of Application Extensions Application Provider (Partner) Creation of Application.car file Application Provider (Partner) Installation Application Consumer (Customer) Appendix D Command Line Scripts CLInstall CLMigrate CLUpdateLicense Page ii

5 Compiere Release Summary Compiere is a maintenance release, which includes following new features in Web UI along with customer reported bug fixes. Personal Lock Reports and Documents For more information, see New in Compiere Compiere may include certain prototype features and beta functionality as indicated in their respective user interfaces with a beta checkbox. These features are not recommended for production, but are intended only for evaluation as beta version. Audience The is intended for Compiere business partners and customers. It also provides essential information to Compiere administrators who are planning to install or migrate to Compiere The following are the prerequisites for working with Compiere 3.8.4: Working knowledge of Compiere ERP and CRM Compiere Web Store access JDK 1.7 (recommended), or Java JDK 1.6 Database Oracle XE, Oracle 10gR2, Oracle 11gR2, or EnterpriseDB Postgres Plus Advanced Server 8.3, or higher Application server: Tomcat Version 7, or JBoss 7 or higher Downloading Compiere Download Compiere from the Support Center at Page 1

6 Recommended Infrastructure The following are the infrastructure required: Java JDK 7 Update 5 or later (not just JRE). Support for JDK 7 is now included. Database: Oracle XE, Oracle 10gR2, Oracle 11gR2, or EnterpriseDB Postgres Plus Advanced Server 8.3, or later. It is recommended that you use a Unicode character set. Database approved Linux Operating System, Windows Server 2003 or 2008, Windows 7 Tomcat Version 7 or JBoss 7 or higher TCP/IP connection and internet access Disk Space: 5 GB (includes database) or more Swap Space: 1 GB or more Memory: For Windows, 4GB or more. For Linux, 2 GB or more Firefox browser 13 or higher is recommended for the web user interface, but Internet Explorer 7 and higher is also supported. If you are using Internet Explorer, ensure that the options, Always switch to new tabs when they are created, and A new tab in the current window are enabled. To enable these options, go to Tools > Internet Options > General tab, and then click Settings under Tab. Process to Log Support Requests To ensure timely service for any issues, visit our Support Center. Page 2

7 Additional Information The following table lists the additional information available in this document: Process Section Migration instructions Installation instructions Information on application extensions Information on command line scripts See Appendix A See Appendix B See Appendix C See Appendix D Page 3

8 New in Compiere Compiere release includes following new features in Web User Interface Personal Lock - Allows the user to restrict access to a specific record. If a Personal Lock is applied, only that user and those user's whose role has Personal Access enabled have access to the record. This restriction is over and above any security rules that have been defined. Ability to Reports and Documents has been added to the Web User interface. The above features were available in earlier releases of Compiere in Swing UI only. Note: If you are migrating Compiere with JBoss as the application server, you must install JBoss 7 or higher separately, as it is no longer a part of the Compiere installation package. Technical Notes Compiere does not support the Business View Layer Component on EnterpriseDB (Postgres Plus AS) due to some technical constraints to enforce the Compiere security model. You can get Jasper Reports to work in EnterpriseDB by setting up the Jasper reports directly against the Compiere schema, but the report developer will need to manually apply the security rules. The following reports can be used as an example to set up Jasper Reports in EnterpriseDB: Trial Balance Profit and Loss Statement Balance Sheet Page 4

9 Bugs Fixed in Compiere The following table describes the bugs fixed in Compiere 3.8.4: Bug ID Bug Description The default value in the file format drop-down for reports in web UI can be set in "user preferences" Printer default during login will be picked up from the "user preferences" in Compiere instead of the browser cookie. The printer user selects at the time of login will be saved as a user preference After login, user can change his preference The Zoom Across button in Web UI will list only those windows which user has access to If the Default Customization check box is selected on a window, it will be used as default zoom window In Performance Goal, the Measure Target field can be modified without any error In Print Format Item, field content stays inside of page/print area when using Line Alignment: Trailin In Web UI, when a change audit record is generated for a table which is not the main tab of a window, window with main tab is opened Session Time Out for web interface is stored in browser cookie. If there are multiple tabs open for the same session, this will ensure that web session does not time out when the user is active on one of the tabs and other tabs are idle When creating a cash journal for signed and unsigned entries where cash type = difference, the header values for beginning balance match the posting details Update / actualize Compiere Country list The Discount Printed check box on customer is used only in SO context. Page 5

10 Bug ID Bug Description Calculate SUM on print format item is working in combination with calculate count on other print format items Web UI Grid Editing: Use the keyboard down-arrow key to move down the list of orders in a grid after search (without clicking anywhere else), and then click on the Edit icon in the header of the grid to open the record with current focus Request for country list update. Page 6

11 Known Issues in Compiere The following table describes the known issues in Compiere release. Issue When the server and the user are in different time zones, the date fields like Date Ordered and Date Promised display the previous day s date. Consider that the user is accessing Compiere from California (PST) and the server is running in New York (EST). On the Sales Order screen, if the user enters Nov, 08, 2012 (11/08/2012) in the Date Ordered field and saves the transaction, the server saves the Date Ordered as 11/08/ :00:000. But the Sales Order screen shows the date ordered as 11/07/2012. While scrolling the main menu using Internet Explorer, at times, the menu items do not get selected. In Internet Explorer 9, the page does not refresh while adding the product line. While completing a Receipt with lines, a 500: Call failed server error message appears in the console. Trial Balance: When grouping and creating totals by Account and Project, the totals appear incorrectly. If grouped by Account first, and then Project, or vice versa, the following issues occur: If no project appears for an account, then Compiere does not calculate the group total. When the first account that has a project appears, Compiere calculates the total of all accounts before it. Solution Workaround: Change the time zone settings in your browser so that the settings match with that of the server. To be fixed. To be fixed. To be fixed. To be fixed. Page 7

12 Known Issues in the Migration Process The following table lists the warnings and error messages you may get during the migration process: Migration Issues Warning/Error Messages Database Comments ORA-00001: unique constraint... violated All This might indicate referential issues in your pre-migration data. Review the problem data. ORA-01408: such column list already indexed All This is an acceptable warning message. ORA-01440: column to be modified must be empty to decrease precision or scale All This is an acceptable warning message. ORA-02296: cannot enable constraint All This might indicate referential issues in your pre-migration data. Review the problem data. ORA-02275: such a referential constraint already exists in the table ALTER TABLE S_ResourceType MODIFY ChargeableQty NUMBER(10) DEFAULT NULL Failed SQL statements. ERROR: cannot alter type of a column used by a view or rule Detail: rule _RETURN on view rv_asset_delivery depends on column "lot" - ALTER TABLE All EnterpriseDB This might indicate referential issues in your pre-migration data. Review the problem data. This is an acceptable warning when upgrading CBIZ and getting errors for the tables AD_Dashboard*. This is an acceptable warning message. Page 8

13 Migration Issues Warning/Error Messages Database Comments A_Asset_Delivery ALTER Lot TYPE VARCHAR(255), ALTER Lot SET DEFAULT NULL No Key & No Parent - Table AD_RecentItem All This is an acceptable warning message. While executing RUN_Setup, refreshing an existing instance. ===========> DB_PostgreSQL.getDataSource: DB_EnterpriseDB[null] [12] java.lang.illegalargumentexception: DataSource with name 'CompiereDS' already exists! While executing RUN_Setup > ModelValidationEngine.addClasses: GardenWorld: compiere.model.myvalidator - java.lang.classnotfoundexception: compiere.model.myvalidator [12] > ModelValidationEngine.addClasses: Extended Units of Measure: org.compiere.xuom.xuommodelvalidator - java.lang.classno tfoundexception: org.compiere.xuom.xuommodelvalidator [12] ORA-01452: cannot CREATE UNIQUE INDEX; duplicate keys found - CREATE UNIQUE INDEX AD_PrintformatItem_Unique ON AD_PrintFormatItem (AD_PrintFormat_ID,Name) ERROR: cannot alter type of a column used by a view or rule EnterpriseDB All All EnterpriseDB This is an acceptable warning message. This is an acceptable warning message. Migration of additional components (.car) with print format items won t work as expected. Database is updated correctly. ORA-00001: unique constraint... violated All This might indicate referential issues in your pre-migration data. Review the problem data. Page 9

14 Known Issues in the Installation Process The following table lists the known issues while installing Compiere 3.8.4: Installation Issues Warning/Error Messages Database Comments > g.a: DROP SEQUENCE T_Spool_Seq > g.a: ORA-02289: sequence does not exist > DB_PostgreSQL.convertState ment: Convert error! Converted statement Number=2 (CREATE OR REPLACE VIEW > DB.saveError: DBExecuteError - ORA-00001: unique constraint (COMPIERE.C_REGION_NA ME) violated [15] > MRegion.saveNewInsertSQL: Not inserted - C_Region [15] > ProgressPanel.publish: Unable to import Region, requires UNICODE database [15] ===========> DB.executeUpdate: INSERT INTO C_Region (AD_Client_ID,AD_Org_ID,C_ Country_ID,C_Region_ID,Crea ted,createdby,description,isa ctive,isdefault,name,updated,up datedby) VALUES All EnterpriseDB All This is an acceptable warning message. This is an acceptable warning message. These are acceptable if your database is not set for Unicode (UTF-8). Page 10

15 Installation Issues Warning/Error Messages (0,0,216,438,TO_DATE(' :43:34','YYYY-MM- DD HH24:MI:SS'),0,'???(Miyasaki)','Y','N','???',TO_DATE(' :43:34','YYYY-MM- DD HH24:MI:SS'),0) [null] [15] java.sql.sqlexception: ORA : unique constraint (COMPIERE263.C_REGION_ NAME) violated; State=23000; ErrorCode=1 at oracle.jdbc.driver.databaseerr or.throwsqlexception(databas eerror.java:125) at oracle.jdbc.driver.t4cttioer.p rocesserror(t4cttioer.java:3 05) at oracle.jdbc.driver.t4cttioer.p rocesserror(t4cttioer.java:2 72) Database Comments At the very end of the install process or when manually executing utils/run_support 13:07: Compiere.startup: Client lapfr/ : C:\Compiere2 - Java HotSpot(TM) Client VM 1.5.0_11-b03 - Windows XP 5.1 Service Pack 2 [15] Exception in thread "AWT- EventQueue-0" java.lang.nullpointerexception All No effect on the functionality. You may ignore this error. Page 11

16 Installation Issues Warning/Error Messages at javax.swing.plaf.basic.basicsc rollbarui.layouthscrollbar(basi cscrollbarui.java:676) Database Comments Error after clicking Save on the RUN_Setup window ===========> CConnection.createConnectio n: (1) AutoCommit=true,TrxIso=REA D_COMMITTED - ORA : invalid username/password; logon denied [12] > CPreparedStatement.<init>: ALTER TABLE AD_System MODIFY Summary NVARCHAR2(2000) [12] java.lang.unsupportedoperati onexception: No DBConnection at org.compiere.util.db.getconne ctionrw(db.java:228) Error installing the sample application extension XUOM Failed SQL statements: ORA-00955: name is already used by an existing object - CREATE INDEX M_Product_ProductCategory All All No effect on the functionality. You may ignore this error This is an acceptable warning message. Page 12

17 Installation Issues Warning/Error Messages ON M_Product (M_Product_Category_ID) - java.sql.sqlexception: ORA : name is already used by an existing object Database Comments Error installing the sample application extension XUOM. Create Views *********************************** ******* Starting to create views for entity: XUOM Created view #1 for entity: XUOM Failed SQL statements <<ERROR: ERROR: relation "m_product_expensetype" already exists - CREATE UNIQUE INDEX M_Product_ExpenseType ON M_Product (S_ExpenseType_ID) - java.sql.sqlexception: ERROR: relation "m_product_expensetype" already exists>> same error for other indexes: <<ERROR: ERROR: constraint "fk208_10919" for relation "m_product" already exists - ALTER TABLE M_Product ADD CONSTRAINT FK208_10919 FOREIGN KEY (C_SubscriptionType_ID) All This is an acceptable warning message. Page 13

18 Installation Issues Warning/Error Messages REFERENCES C_SubscriptionType (C_SubscriptionType_ID) - java.sql.sqlexception: ERROR: constraint "fk208_10919" for relation "m_product" already exists>> same error for other constraints Database Comments Page 14

19 Appendix A Migration Instructions Use the following instructions to migrate Compiere from a previous version to Compiere If you are doing a new installation, refer to the installation instructions on Appendix B. Prerequisites The following are the prerequisites for migrating Compiere 3.8.4: A valid support contract Java JDK 7 (SDK) or higher (not just JRE) Database Oracle XE, Oracle 10gR2, Oracle 11gR2 or EnterpriseDB Postgres Plus Advanced Server 8.4 or later <Doc: same> Page 15

20 Preserving Customizations Compiere will not modify any customizations as long as the customizations are marked appropriately. By default, all records added to the dictionary will have the entity type "User Maintained". For changes to existing dictionary records, select Customizations in the Change Audit window to indicate the changes that you need to preserve before running the migration. Before performing the migration, run the process in the test mode to ensure that all updated dictionary records have been updated to preserve these customizations. Page 16

21 Migration Process The migration process consists of the following steps: Preparation Test Mode (optional) Migrate to a New Release Preparation Ensure the following before you start the migration process: The server needs to have access to the internet for http (port 80) and https (port 443). Stop the application server by executing utils/run_server2stop. Back up the database. If you are running EnterpriseDB 8.2 or earlier, upgrade it to EnterpriseDB Postgres Plus Advanced Server 8.3. Test Mode (optional) As an optional step, you can run the migration task in test mode. This allows you to evaluate the actions taken when running it against the database. Note that the first step (resolve ID conflicts) will not show the correct future IDs in the test mode. It is expected to get errors in the test mode as the database changes are not being executed. Also, the test mode is a useful tool to evaluate the schema changes that are about to be made. Follow the RUN_setup steps for a regular migration, as mentioned in the next section, but as shown in step 18, select the Test Only box. If the program marks certain required tables for deletion, then recreate such tables in the data dictionary (Window Table/Column) with the Entity Type as User Defined or with your own entity type. If the program marks certain required columns for deletion, make sure that the column has the Entity Type as User or Application. If the required column has the Entity Type Data Dictionary or Compiere and it is marked for deletion, then copy it under another name and mark the new column as Custom or Application. The same applies to windows, tabs, fields, and so on. The Mandatory User or Application Columns must have a default value defined. Page 17

22 Migrating to a New Release If you are migrating to Compiere and if you are using JBoss as the application server, you must delete the existing JBoss folder from the compiere2 folder on your machine, as shown in the following figure. This is because unlike previous releases, JBoss is no longer a part of the Compiere installation package. If you are migrating from 3.0.x, you must also delete all the.car files from Compiere2/data/ folder. Use the following steps to migrate to the new release: 1. Download and unzip/untar the distribution file (for example, Compiere_3.8.4.zip). Ensure to overwrite any existing files. 2. Execute RUN_setup. Page 18

23 3. In the Deployment field, ensure that the location where the application server is installed on your machine is specified. For example, C:\jboss-as Final. 4. Verify all the environment settings and click Save. If you get any error while validating parameters, you ll see a red icon right next to the parameter with the problem. Make the required changes, click Test to validate again, and then click Save. Page 19

24 The Compiere Public License screen appears. 5. Click Yes, I Understand and Accept. If you have not set a security key file, the following prompt appears. 6. Click OK. 7. Enter all the required subscriber information. If you are in existing customer, enter all the subscriber information (System Name, and Password), as it was registered in the Compiere Web Store, to get a complete list of applications). Page 20

25 8. Click Check available Applications to get a list of applications available for installation. Note: To install additional applications after installing or migrating to the latest Compiere Core version, you must select Compiere Core plus and any additional applications to install, and then run the Migration process. 9. Select the applications that you want to migrate and select the action Reinstall/Migrate. Compiere Standard is the core application that must always be installed or migrated to the latest release, but you also may choose additional applications provided by Compiere or any of our authorized partners. If you do not wish to install or migrate any of the applications listed, change the action to None- To install new applications, change the action to New Install. Note: If you don t provide the correct or password, or if you don t have internet connection, you won t be able to select Compiere Enterprise, or any of the other optional components. 10. Next, read and accept the Compiere Public License Agreement. Page 21

26 You might get more than one license agreement depending on the applications that you are installing. Note that XUOM is a sample application extension. 11. If you are installing the Compiere Enterprise edition, read and accept the commercial license agreement that appears. 12. Click Start File Installation. Page 22

27 13. When the file installation is complete, click Start Migrate Database. 14. Enter the System Name, Registered , and Password. The information entered here should match the Compiere Web store registration details. 15. Click Check License to validate your asset information. Page 23

28 Note: The asset information may already be included if it was entered in the system window. If you get the Core Invalid error after clicking the Check License button, it indicates that you did not select the appropriate action for the core component. If so, close the setup and support windows, and execute RUN_setup again and select Standard plus or any other component for installation. Page 24

29 16. Click Start Migration. Page 25

30 17. At the Compiere Version Migration Prompt, click Yes. Page 26

31 18. Do not select the Test Only option, and then click Start. 19. Click Yes to confirm that you do have a backup of your database. Page 27

32 20. Click Yes to confirm that the Source and Target database versions from the Compiere Version Migration window are correct. 21. Verify whether the migration process is completed without any error and the message, Migration Done appears. Note: If you get any errors, review the list of known issues listed in this document before logging a service request. Page 28

33 22. Verify the following log files for errors in the Compiere2 folder: a. Migrate_yyyy_mm_dd_hh_mi_ss.log: Complete logs file of the migration process. b. Migrate_yyyy_mm_dd_hh_mi_ss.err.log: A subset of log with just errors. c. yyyy-mm-dd_#.log: Possible additional errors not printed to the migration log. For example, search for the file with the text "Compiere Migration 3.8") Note: If you get any errors, review the list of known issues listed in this document before logging a service request. 23. If you have a Compiere Enterprise Edition license, execute utils/run_support, and click Check License to activate your license. 24. Click the Check License button to see whether your Enterprise License has been activated. 25. After the Compiere Enterprise license has been updated, click Close. Note: Do not click Start Migration. Page 29

34 26. Start the application server. For more information, see Run Application Server. To start the Compiere web user interface after migration, empty the browser cache first. Multi-server Installation for Compiere Enterprise Edition For multi-server installation, after upgrading the main application server and database, you need to run the following on the additional application servers that are used to load balance the web user interface connections: 1. Unzip the binary distribution to update the Compiere2 folder. 2. Copy the template for the configuration file in the following manner: Compiere2/utils/CommandLine/CLConfigurationTemplate.sh/bat to Compiere2/utils/CommandLine/CLConfiguration.sh/ba 3. Configure the configuration file so that the application server is the local server where you are doing this installation, but the database server is the box where you already installed Compiere. 4. Execute the following script to run only the file installation: cd Compiere2/utils/CommandLine CLFileInstall CLConfiguration.sh Important: Ensure that you use the CLFileInstall script. If you use CLInstall, it will drop your database user. 5. Delete the file, COMPIERE_HOME/jboss/server/compiere/deploy/compiereRoot.ear, to ensure that there won t be conflicts by having multiple accounting, request, and other processors. 6. Start the application server. 7. Configure your load balancing solution to distribute part of the load to the additional servers. Be sure to use sticky sessions to ensure that all requests from a session go to the same application server. Support for multi-server installation feature is only available for customers using Enterprise Edition. For more details about the different Compiere Editions, visit Note: After migration, reapply the language packs when needed. Page 30

35 Appendix B This appendix describes the steps required to install Compiere Compiere Installation Instructions Use the following instructions for a new installation of Compiere. If you already have a previous version of Compiere, see Migration instructions. Prerequisites The following are the prerequisites for a new installation of Compiere: Java Version 1.6 or 1.7 Application server: Tomcat Version 7 or JBoss 7 or higher Database Oracle XE, Oracle 10gR2, Oracle 11gR2 or EnterpriseDB Postgres Plus Advanced Server 8.3 or Later Important: It is recommended that you use a Unicode character set. Database approved Linux Operating System Windows 2008, or Windows 7, or later Disk Space: > 5 GB (includes database) Swap Space: > 2GB Memory: > 1 GB Linux > 4GB Windows TCP/IP connection Network setup with DNS server and a domain. Do not use IP addresses. Internet access Note: The screenshots in this document refer to the installation of Compiere on Windows, but the installation process is the same for Linux, except for the paths (for example, C:\Compiere2 versus. /Compiere2) and the extension of the scripts (.bat vs..sh). Page 31

36 Installing Database Install database For the instructions on how to install Oracle XE and EnterpriseDB on Windows and Linux, use the install guide on the Compiere website If you are using Oracle XE, you need to modify the following database parameters: Start SQL*Plus (Start => Programs => Oracle Database 10g Express Edition => Run SQL Command Line) Connect system/xxxx Alter system set processes=100 scope=spfile; Restart the database (Start => Programs => Oracle Database 10g Express Edition => Stop DB & then Start DB) Installing Java Download and install JDK 7 (SDK), update 5 or higher. Note: The Compiere server requires the JDK (not just JRE). For installation instructions, see the JDK section on this page: Installing Application Server You can use the latest version of JBoss or Apache Tomcat as the Application Server. Installing JBoss Download and install JBoss 7 or higher. For more information, visit the following web page: Page 32

37 Installing Tomcat Download and install Apache Tomcat 7.0 or higher. For installation instructions, visit the following web page: Note: The Tomcat application server must be started before starting Compiere. This will typically be run as a daemon process and will be started automatically. The following are the configuration settings for Tomcat: UNIX: $CATALINA_HOME/bin/setenv.sh with contents export JAVA_OPTS="-server Xms256m Xmx1024m" The following are the configuration settings for Windows: For Windows you will need, in setenv.bat, set JAVA_OPTS=-server Xms256m Xmx1024m To update tomcat service memory heap, run tomcat7w.exe Command from < CATALINA_HOME>/bin folder than update. Installing Compiere The following instructions are meant for a new installation of Compiere. Use the following steps to install or set up Compiere Server (this includes the Compiere client as well). 1. Download the latest version of Compiere. 2. Extract the.zip file. For example, C:\Compiere2 in Windows or /Compiere2 in Linux. 3. Set the JAVA_HOME system variable to the location of your java JDK installation (for example, C:\Program Files\Java\jdk1.7.0_05) and add JAVA_HOME/bin to the PATH. For more information, click here. 4. Verify that the bin directory for your database executables is included in the PATH. Also, if using Oracle XE on Linux, run $ORACLE_HOME/bin/oracle_env.sh. 5. Set the COMPIERE_HOME system variable to the path of your Compiere installation (for example, C:\Compiere2). 6. Execute the script $COMPIERE_HOME/RUN_Setup. Page 33

38 Note: Compiere requires an internet connection for installation. If you are using a proxy server, modify the script, Compiere2/RUN_setup, to set your proxy options. 7. Select the Server Type (JBoss or Tomcat). 8. In Deployment, enter the path where the application server is installed. 9. Select the Database Type (Oracle XE, Oracle (for Standard or Enterprise Editions) or PostgreSQL (for EnterpriseDB). 10. For System Password, enter the System database User password (for example, manager). 11. For Database Password, enter the Compiere database user password, (for example, compiere ). 12. In the Application Server, Database Server, and Mail Server fields, use the DNS name of the server. Do not use local host ( ) or IP addresses. 13. Enter or update any other parameters as necessary. 14. Click the Get Help button for information on any field. 15. Click Save. Page 34

39 The Compiere Public License screen appears. 16. Click Yes, I understand and Accept to continue. The following prompt appears describing your new Security Key. 17. Click OK. 18. Enter the correct Subscriber Information. Note: Existing customers should provide the subscriber information (System Name, , and Password) exactly as it was registered in the Compiere Web Store to get a complete list of applications). Page 35

40 19. Click Check Available Applications to get a list of applications that are available to be installed. If you are a Community Edition user, leave the fields blank, and click Check available components to install the Community Edition. 20. Select the applications that you would like to install. 21. Click OK. Note: You can include additional applications by using the Add Application button. By default, all available applications will be installed. If you do not wish to install one of them, you should change the action field from New Install to - None-. Note that Compiere Core is a Mandatory Prerequisite and must be selected. Note: If you don t provide the correct or password, or if you don t have an internet connection, you won t be able to select Compiere Enterprise or any of the other optional components. 22. In the Compiere Public License agreement and Compiere Commercial License agreement screens that appear, click Yes, I Understand and Accept button. Page 36

41 You might get more than one license agreement, depending on the applications that you are installing. 23. Click Start File Installation. Note: At this point, you must be connected to the internet to continue; otherwise, the installation will not succeed. Once the file installation is complete, click Start Create new Database. Page 37

42 Note: If you already have a Compiere database in your system, you will be presented with a split screen. Click Start DROP OLD and create NEW Database if you want to replace the existing database with a new database. 24. Click Yes to drop the existing database and create a new database. Warning: If you choose to replace the existing database, all data in the existing database will be removed. 25. Verify that you see a 10: ** Finished message at the end of this step. Then a new window should pop-up to do the license validation. The Compiere Support window appears. Page 38

43 26. Complete the necessary fields to validate your assets. If you only intend to use the Community Edition of Compiere 3.0, you may skip the following steps and go to the Application Server section. For customers with a valid support contract with Compiere, this is a required step to ensure that the features associated with the support level are enabled. If you are a customer and do not have a web store login, contact your system administrator or Compiere Support first. If you are not a customer and would like to obtain a trial license for the Enterprise Edition, Contact Us. 27. Provide the following information in exactly the same way as it was registered in the Compiere Web store, and then click Check License to validate your asset information. System Name: The name provided during the web store registration. Registered The address provided during the web store registration. Password: The web store password. 28. To verify your license, click the Check License button. Note: Do not click Start Migration. 29. Review whether your license information has been validated. Page 39

44 If you have a trial license for Compiere Enterprise edition, but you currently don t have a license with Compiere, you will see that the license for Standard is invalid. This is expected as the trial doesn t include Standard and you may ignore the error. 30. After the Compiere license has been verified, click Close. Note: If you get the error, You do not have an appropriate license to use this feature, when starting the web UI, then log in to the server and execute utils/run_support to validate your license again and restart the application server. When using the Swing client, ensure that your database connection information matches exactly with the information in the target URL in RUN_Support (including the fully qualified server name). 31. Close any additional Setup, or Support windows. Page 40

45 Running the Application Server Before you access the Compiere web user interface, you must start the application server. Use the following steps to start the application server: 1. To start the application server, do the following: If you are using JBoss, go to the location where you have installed the application server, and run Standalone.bat from the bin folder. (For example, C:\JBoss\jboss-as Final > bin > Standalone.bat). If you are using Apache Tomcat, run Startup.bat from the bin folder (For example, C:\tomcat\apache-tomcat > bin > Startup.bat). 2. Check the logs files from the following locations for any errors: C:\jboss-as Final\standalone\log C:\apache-tomcat \logs Common problems The common problems include ports already in use: 17:41:09,085 ERROR [NamingService] Could not start on port 1099 java.net.bindexception: Address already in use JVM_Bind at java.net.plainsocketimpl.socketbind(native Method) There is another program using port 1099; Stop it and restart Run_Server2 or setup Compiere to use another port in RUN_setup. The following are the likely port conflicts: 80 - Other web server running (or you need privileges under Linux/Unix), or Skype 8080 Used by Oracle Database Often used by IDEs for debugging, or by internet messengers (for example, Skype, Google Talk, and so on). Page 41

46 Starting Compiere Use the following steps to start Compiere: 1. Start Compiere using any of the following methods: To start the Swing client, double-click the Compiere shortcut on your desktop, or double-click RUN_Compiere2 from the $COMPIERE_HOME directory. The default users and passwords for the sample Garden World application is as follows: o GardenUser/GardenUser o GardenAdmin/GardenAdmin o System/System o SuperUser/System Page 42

47 If you have access to the Enterprise Edition, you can launch Compiere from the browser by entering (for example, the browser. For optimal performance, the Firefox browser is recommended for the Compiere web user interface. For additional information, see the Compiere home page Page 43

48 Appendix C Application Extensions - Compiere Partners Application extensions in Compiere are available as functionality for Partners only. This framework allows Partners to create application extensions that include both reference data and code. Such application extensions can be distributed to their customers through Compiere. Registration of Application Extensions Application Provider (Partner) Use the following steps to register for Application Extensions: Log a support request with Compiere. 1. Login with System Administrator as the role. 2. Open the Entity Type window (Application Dictionary > Entity Type) from the main menu and create a new record. Note: Do not to modify the entities C, D, CPRO, or XUOM. Page 44

49 3. Complete all the mandatory fields. For entity type, the names beginning with C and X are reserved for Compiere and you must use four characters. 4. Enter the optional details: Version: The version of your extension. Usually, 1.0 for the first version. Prerequisite version: The Compiere Core version that is required for this extension. For example, You need to use the exact text as defined for the entity type D. Prerequisite applications: The entity type of the applications that need to be installed in order to install this extension. For example, set it to CPRO if the extension must be applied on top of the Enterprise edition. Classpath: List of additional jar files required for this extension. Model package: Specific model package from the jar files listed in the classpath field. Ensure that your System window contains the up-to-date information for your system and web store /password information. 5. Click Register Application to send your request to Compiere. If an entity type with the same name has already been registered, you ll get an error, Error: Already registered: XXXX. Then, create a new record with the new entity type. Verify with Compiere that the new entity type that you plan to use is available. 6. Leave the defaults in place and click OK. At this point, the status will be pending approval from Compiere. Page 45

50 Log a support request in our case management system requesting the approval of your component. The request should include a description and the license type. Creation of Application.car file Application Provider (Partner) Use the following steps to create the Application.car file: 1. Make all the application dictionary changes using the entity type that you registered in the previous step. 2. Generate the jar files for the custom code required by your extension. 3. After the Entity Type is approved by Compiere, login to the Compiere web user interface with System Administrator as the Role, and then query the entity type that you registered in the previous step. 4. Click Create Application File. Page 46

51 5. In Jar Directory, enter the directory for the jar file listed in the field classpath. 6. Click OK. The car file will be generated in the COMPIERE_HOME/data directory. The newly generated.car file will have a name of compiere_xxxx.car. Important: The naming convention for.car files has changed, (for example, compiere_ CPRO.car from 3.0 and 3.1 is now compiere_cpro.car in 3.3. That is, without quotes in the file name). If a customer extracts the Compiere installation files into the same directory, it is possible to end up with both compiere_ CPRO.car as well as compiere_cpro.car. This in turn will cause Compiere Enterprise to show up twice in the installation window. To avoid this situation, customers will need to manually delete compiere_ CPRO.car and compiere_ XUOM.car from COMPIERE_HOME/data directory. These are the only two.car files that Compiere has distributed prior to 3.2. If a customer has created any additional.car files prior to 3.2, it is necessary to follow the same procedure for those.car files as well. Page 47

52 Installation Application Consumer (Customer) Use the following steps to install the application: 1. After obtaining the car file for application extension, copy it to the directory COMPIERE_HOME/data. 2. Execute RUN_Setup (see Appendix A for details on the setup information.) Important: Be sure to have an internet connection available to be able to get the license terms for the application extensions that you plan to install. 3. In the Compiere Server Setup screen that appears, select the applications, besides the application extension that you need to install. 4. Select the option Reinstall/Migrate for Compiere Core For more information, see the Migration instructions. Page 48

53 Appendix D Command Line Scripts Scripts are provided in the $COMPIERE_HOME/utils/CommandLine directory for experienced Compiere users who would like to perform Compiere instance creation and maintenance via command line or using automated scripts. CLInstall Purpose: To create a new Compiere installation. When this script is run, a new Compiere instance is created on the database specified in the configuration file. Note that existing Compiere database instance is dropped and a fresh new Compiere instance is created when this script is run. The script validates the components that can be installed against Compiere License server and hence need to be connected to the internet while running and have the appropriate license to allow you to install the components. The script also updates the license information after the instance is created. All the component.car files present in $COMPIERE_HOME/data will be installed as long as you provide the correct subscriber information: otherwise, only the standard application will be installed. Set the environment variables, $COMPIERE_HOME and $JAVA_HOME. The configuration parameters to CLInstall are provided via a configuration file. A template, CLConfiguartionTemplate, is provided in the same directory, which you can make a copy and edit the configuration parameters for your specific installation. All the parameters have one to one correspondence with the parameters on the first window that comes up when running RUN_setup. Subscriber information for license validation: CL_SYSTEM_NAME, CL_WEBSTORE_ , CL_WEBSTORE_PASS Homes: CL_COMPIERE_HOME, CL_JAVA_HOME, CL_JAVA_TYPE Database: CL_COMPIERE_DB_TYPE, CL_COMPIERE_DB_SERVER, CL_COMPIERE_DB_PORT, CL_COMPIERE_DB_NAME, CL_COMPIERE_DB_SYSTEM, CL_COMPIERE_DB_USER, CL_COMPIERE_DB_PASSWORD Application server: CL_COMPIERE_APPS_TYPE, CL_COMPIERE_APPS_SERVER, CL_APPS_SERVER_DEPLOY_DIR, CL_COMPIERE_JNP_PORT, CL_COMPIERE_WEB_PORT. From Compiere release, ensure that you update the following parameters: CL_COMPIERE_APPS_TYPE and COMPIERE_APPS_SERVER. Page 49

54 Examples: CL_COMPIERE_APPS_SERVER= C:\Tomcat CL_COMPIERE_APPS_SERVER= C:\jboss-as Final SSL Settings: CL_COMPIERE_SSL_PORT, CL_COMPIERE_KEYSTOREPASS Mail: CL_MAIL_SERVER, CL_ADMIN_ , CL_MAIL_USER, CL_MAIL_PASSWORD Running: CLInstall takes in the configuration file as a parameter. Sample Usage: >CLInstall.bat CLConfiguration.bat Errors while running the script are displayed onto the console window and are also written to log files within the same directory. CLMigrate This is very similar to CLInstall.bat except that it performs the migration of a Compiere instance instead of dropping and recreating a new instance. CLUpdateLicense This script can be run to update the license information instead of executing RUN_Support. The script can be only run in a successful Compiere installation created by running RUN_Setup or installation/migration via command line. The script can be edited to provide different subscriber information for license validation. Page 50

55 The following line in CLUpdateLicense.bat, "%COMPIERE_JAVA%" %COMPIERE_JAVA_OPTIONS% -cp %CLASSPATH% com.compiere.client.updatelicense can be changed as follows to pass in the subscriber information, "%COMPIERE_JAVA%" %COMPIERE_JAVA_OPTIONS% -cp %CLASSPATH% com.compiere.client.updatelicense --sysname xxx -- xxx --password xxx If the parameters are not specified, the subscriber information at the time of installation will be used to update the licenses. Page 51