COMPIERE ERP
Release Notes
Version No: 3.8.9
September 2016
4325 Alexander Drive, Suite 100 • Alpharetta GA 30022-3740 • www.aptean.com • [email protected]
Copyright © 2016 Aptean. All Rights Reserved. Thesematerials are provided by Aptean forinformational purposes only, without representation or warranty of any kind, and Aptean shall notbe liable for errors or omissionswith respect to thematerials. The only warranties for Apteanproducts and services are those set forth in the expresswarranty statements accompanying suchproducts and services, if any, and nothing herein shall be construed as constituting an additionalwarranty. No part of this publicationmay be reproduced or transmitted in any form or for anypurpose without the expresswritten permission of Aptean. The information contained hereinmaybe changed without prior notice. Some productsmarketed by Aptean contain proprietarysoftware components of other software vendors. Aptean and other Aptean products andservices referenced herein aswell as their respective logos are registered trademarks ortrademarks of Aptean or its affiliated companies.
ContentsIntroduction 1Audience 1
Prerequisites 1
Download Compiere 1
Recommended Infrastructure 2
Process to Log Support Requests 2
Additional Information 2
What's New in Compiere 3.8.9 3Technical Notes 4
Bugs Fixed in Compiere 3.8.9 5Known Issues in Compiere 3.8.9 7Known Issues in the Migration Process 8Known Issues in the Installation Process 10Appendix A 12Migration Instructions 12
Prerequisites 12
Preserving Customizations 13
Migration Process 13
Preparation 14
Test Mode (optional) 14
Migrating to a New Release 14
Multi-server Installation for Compiere Enterprise Edition 25
Appendix B 26Compiere 3.8.9 – Installation Instructions 26
Prerequisites 26
Installing Database 26
Installing Java 27
Installing Application Server 27
InstallingWildfly 27
Installing Tomcat 27
Page i
Compiere ERP- 3.8.9
Release Notes
Installing Compiere 28
Running the Application Server 35
Common problems 35
Starting Compiere 36
Appendix C 38Application Extensions - Compiere Partners 38
Registration of Application Extensions – Application Provider (Partner) 38
Creation of Application .car file – Application Provider (Partner) 40
Installation – Application Consumer (Customer) 41
Appendix D 43Command Line Scripts 43
CLInstall 43
CLMigrate 44
CLUpdateLicense 44
Page ii
Compiere ERP- 3.8.9
Release Notes
Introduction
IntroductionCompiere 3.8.9 is amaintenance release, which includes customer reported bug fixes along with thefollowing features:
l Ability to disable/ hide buttons by role
l Menu search feature
l PDF compression
l Ability to search products based on the non-instance attributes within the Product Info window
Formore information, seeWhat's New in Compiere 3.8.9 section in this document.
Note: Compiere may include certain prototype features and beta functionality as indicated in
their respective user interfaces with a beta check box. These features are not
recommended for production and are intended only for evaluation as beta version.
AudienceThis Release Notes is intended for Compiere business partners and customers. It also providesessential information to Compiere administrators who are planning to install or migrate to Compiere3.8.9.
PrerequisitesThe following are the prerequisites for working with Compiere 3.8.9:
l Working knowledge of Compiere ERP and CRM
l Java JDK 1.8 (recommended), or Java JDK 1.7
Note: Java JDK 1.6 is not supported.
l DatabaseOracle XE, Oracle 10gR2, Oracle 11gR2, Oracle 12c or EnterpriseDB Postgres PlusAdvanced Server 8.3, or higher
l Application server: Tomcat Version 7, orWildfly 8.2.0.Final
Note: JBoss 7 is not supported.
Download CompiereDownload Compiere 3.8.9 from theDownloads section in Aptean Knowledge.
Page 1
Compiere ERP - 3.8.9
Release Notes
Introduction
Recommended Infrastructurel Java JDK 7Update 80 or later (not just JRE). Support for JDK 8 is now included.
l Database: Oracle XE, Oracle 10gR2, Oracle 11gR2, Oracle 12c or EnterpriseDB Postgres PlusAdvanced Server 8.3, or later. It is recommended that you use a Unicode character set.
l Database approved Linux Operating System, Windows Server 2003 or 2008, Windows 7,Windows 2012.
l Tomcat Version 7 orWildfly 8.2.0.Final
l TCP/ IP connection and internet access
l Disk Space: 5 GB (includes database) or more
l Swap Space: 1 GB ormore
l Memory: ForWindows, 4GB ormore. For Linux, 2 GB ormore
l Firefox browser 13 or higher is recommended for the web user interface, but Internet Explorer 7and higher is also supported. If you are using Internet Explorer, ensure that the options, “Alwaysswitch to new tabs when they are created”, and “A new tab in the current window” are enabled. Toenable these options, navigate to Tools > Internet Options > General tab, and select Settingsin the Tabs section.
Process to Log Support RequestsTo ensure timely services for any issue, use Aptean Knowledge to raise support tickets.
Additional Information
Process Section
Migration instructions See Appendix A
Installation instructions See Appendix B
Information on application extensions See Appendix C
Information on command line scripts See Appendix D
Page 2
Compiere ERP - 3.8.9
Release Notes
What's New in Compiere 3.8.9
What's New in Compiere 3.8.9Compiere 3.8.9 release includes the following new features:
l Ability to disable/ hide buttons by role - This allows the user to hide or show the requiredbuttons on the windows along with an editable functionality, based on a role from the RoleManagement window.
l Menu search feature - This feature provides the entire directory path of given searchmenu alongwith themenu name to locate it easily.
l PDF compression - This feature provides option to download the archived documents in theCompiere using 7ZIP.
l Ability to search products based on the non-instance attributes - The Attribute andDescription newly added search fields in the Product info window allow user to filter and searchthe specific products details.
Page 3
Compiere ERP - 3.8.9
Release Notes
What's New in Compiere 3.8.9
Technical NotesCompiere does not support the Business View Layer Component on EnterpriseDB (Postgres PlusAS) 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 againstthe Compiere schema, but the report developer must manually apply the security rules. The followingreports can be used as an example to set up Jasper Reports in EnterpriseDB:
l Trial Balance
l Profit and Loss Statement
l Balance Sheet
Page 4
Compiere ERP - 3.8.9
Release Notes
Bugs Fixed in Compiere 3.8.9
Bugs Fixed in Compiere 3.8.9The following table describes the bugs fixed in Compiere 3.8.9:
Bug ID Bug Description
10021415 When exporting a translation pack for Compiere from a system (including Compiereprofessional and custom modules) , the _Trl records for objects in target system ended upbeing linked to different parent objects than they belonged to source system.
This issue is resolved now; since the correct procedure to export Compiere Translationmodules across systems is to make sure that the custom sequences are greater than1000000.
10021599 When creating a sales order, in case of network latency, while saving the record in a rushbefore populating the dependent data in dependent fields during callouts, the systemallows user to access the Save button without any prohibition thus saves the data partially.Means, it will save the newly added data with old dependent data as the data is notcompletely populated.
This issue is resolved. Now, the system enables a transparent grayed out (opaque) screenand forbids the user to access any other buttons or link unless the complete data getspopulated in the fields.
10025499 In the case of multiple user access, multiple processes were acting upon a commonresource and it was leading to concurrency issues.
This issue is resolved as the Synchronization is implemented to avoid the same.
10025817 In the Compiere Swing andWeb versions, when negative quantity is entered in the SalesOrder Line, system was allowing to create and complete the sales orders.
This issue is resolved and now the system does not allow user to enter the negativequantity.
10024468 In the Compiere Swing version, when the user navigates from Detail to Header tab for anydocument type, the Read Only Logic for fields is not re-evaluated when the logic dependson virtual columns.
This issue is resolved and now the Read Only Logic is reevaluated in the Compiere Swingversion.
10094196 While running the Compiere application, three log files were generated for a day despitethe similar information or data in each.
This issue is resolved and now the system generates only one log file for one calendar day.
10087539 In the Compiere GWT version, for the Internet Explorer browser, the pop up windows wereunusually large and covering a parent window behind it; hence, the User Interface was notlooking desirable.
This issue is resolved now as the pop up window size is corrected and looks desirable.
10023734 In theWindow, Tab & Fieldmenu, when the underlying database is Enterprise DB, theCreate Columns from DB button was not working for creating a table.
This issue is resolved and now this button is working fine and allows creating table in the
Page 5
Compiere ERP - 3.8.9
Release Notes
Bugs Fixed in Compiere 3.8.9
Bug ID Bug Description
database. Also, it creates the Customary Audits columns in it.
10026135 In the Compiere Swing version, the Advanced Search feature was not working as thesearch criteria selection fields were not available on the Advanced Search tab.
This issue is resolved in the Swing version and now the Advanced Search feature isavailable for the search along with the fields.
Also, in the Compiere GWT version, the Created By search criteria was not retrieving anyresults.
This issue is resolved in the GWT version and now the system is retrieving results forCreated By search criteria.
112264 In the Compiere GWT version, if the user is searching for any particular sales order thesystem was allowing to create a new sales order only at first instance, but subsequently itwas not allowing to create multiple new sales orders.
This issue is resolved and now the system allows user to create multiple new sales ordersafter any particular record search.
118867 In the Compiere application, if the user is not assigned to any role and tries to log into theapplication with the correct credentials, system was prompting an error pop up window withthe message as user and Password incorrect.
This issue is resolved and now the system prompts an error message as User does nothave any active role, if the entered credentials are correct.
119571 In the case of multiple sales order, if the user creates a consolidated shipment for the samebusiness partner then for the first order the zoom cross target was working fine, but for theremaining orders it was prompting an error as No Zoom Target.
This issue is resolved. Now, the zoom across target is working fine and shows the target forthe second or remaining orders even when the consolidated shipments are generated.
Page 6
Compiere ERP - 3.8.9
Release Notes
Known Issues in Compiere 3.8.9
Known Issues in Compiere 3.8.9The following table describes the known issues in Compiere 3.8.9 release.
Issue Workaround
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.
For example, 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/2012 00:00:000”. But the
Sales Order screen shows the date ordered as “11/07/2012”.
Change the time
zone settings in
your browser so that
the settings match
with that of the
server.
While scrolling the main menu using Internet Explorer, at times, the menu items do
not get selected.
No workaround
In Internet Explorer 9, the page does not refresh while adding the product line. No workaround
While completing a Receipt with 50000 lines, a “500: Call failed server error”
message appears in the console.
No workaround
Page 7
Compiere ERP - 3.8.9
Release Notes
Known Issues in theMigration Process
Known Issues in the Migration ProcessThe following table lists the warnings and error messages youmay get during themigration process:
Migration Issues – Warning/Error Messages Database Comments
ORA-00001: unique constraint... violated All This indicates referential
issues in the 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 indicates referential
issues in the pre-migration
data. Review the problem
data.
ORA-02275: such a referential constraint already exists in
the table
All This indicates referential
issues in the pre-migration
data. Review the problem
data.
This is an acceptable
warning when upgrading
CBIZ and getting errors for
the tables AD_Dashboard*.
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 A_Asset_Delivery ALTER
Lot TYPE VARCHAR(255) , ALTER Lot SET DEFAULT
NULL
EnterpriseDB This is an acceptable
warning message.
No Key & No Parent - Table AD_RecentItem All This is an acceptable
warning message.
While executing RUN_Setup, refreshing an existing EnterpriseDB This is an acceptable
warning message.
Page 8
Compiere ERP - 3.8.9
Release Notes
Known Issues in theMigration Process
Migration Issues – Warning/Error Messages Database Comments
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]
All This is an acceptable
warning message.
ORA-01452: cannot CREATE UNIQUE INDEX; duplicate
keys found
- CREATE UNIQUE INDEX AD_PrintformatItem_Unique
ON AD_PrintFormatItem (AD_PrintFormat_ID,Name)
All Migration of additional
components (.car) with print
format items will not work
as expected.
ERROR: cannot alter type of a column used by a view or
rule
EnterpriseDB Database is updated
correctly.
ORA-00001: unique constraint... violated All This indicates referential
issues in the pre-migration
data. Review the problem
data.
Page 9
Compiere ERP - 3.8.9
Release Notes
Known Issues in the Installation Process
Known Issues in the Installation ProcessThe following table lists the known issues while installing Compiere 3.8.9:
Installation Issues – Warning/Error Messages Database Comments
-----------> g.a: DROP SEQUENCE T_Spool_Seq
-----------> g.a: ORA-02289: sequence does not exist
All This is an
acceptable
warning
message.
-----------> DB_PostgreSQL.convertStatement: Convert error! Converted
statement Number=2 (CREATE OR REPLACE VIEW … EnterpriseD
B
This is an
acceptable
warning
message.
-----------> DB.saveError: DBExecuteError - ORA-00001: unique constraint
(COMPIERE.C_REGION_NAME) 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,Created,CreatedBy,Description,IsActive,IsDefault,Name,Updated,Update
dBy) VALUES (0,0,216,438,TO_DATE('2006-02-23 15:43:34','YYYY-MM-DD
HH24:MI:SS'),0,'???(Miyasaki)','Y','N','???',TO_DATE('2006-02-23
15:43:34','YYYY-MM-DD HH24:MI:SS'),0) [null] [15]
java.sql.SQLException: ORA-00001: unique constraint (COMPIERE263.C_
REGION_NAME) violated; State=23000; ErrorCode=1
at oracle.jdbc.driver.DatabaseError.throwSqlException
(DatabaseError.java:125)
at oracle.jdbc.driver.T4CTTIoer.processError(T4CTTIoer.java:305)
at oracle.jdbc.driver.T4CTTIoer.processError(T4CTTIoer.java:272)
All These are
acceptable
if your
database is
not set for
Unicode
(UTF-8).
At the very end of the install process or when manually executing utils/RUN_
Support
13:07:55.094 Compiere.startup: Client lap-fr/10.104.139.177: 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
at javax.swing.plaf.basic.BasicScrollBarUI.layoutHScrollbar
(BasicScrollBarUI.java:676)
All No effect
on the
functionalit
y. You can
ignore this
error.
Error after clicking Save on the RUN_Setup window
===========> CConnection.createConnection: jdbc:oracle:thin:@//lap-
All No effect
on the
Page 10
Compiere ERP - 3.8.9
Release Notes
Known Issues in the Installation Process
Installation Issues – Warning/Error Messages Database Comments
fr:1521/xe, (1) AutoCommit=true,TrxIso=READ_COMMITTED - ORA-010
17: invalid username/password; logon denied [12]
-----------> CPreparedStatement.<init>: ALTER TABLE AD_System MODIFY
Summary NVARCHAR2(2000) [12]
java.lang.UnsupportedOperationException: No DBConnection
at org.compiere.util.DB.getConnectionRW(DB.java:228)
functionalit
y. You can
ignore this
error
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 ON M_Product (M_
Product_Category_ID) - java.sql.SQLException: ORA-00955: name is
already used by an existing object
All This is an
acceptable
warning
message.
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) REFERENCES C_SubscriptionType
(C_SubscriptionType_ID) - java.sql.SQLException: ERROR: constraint
"fk208_10919" for relation "m_product" already exists>>
…same error for other constraints…
All This is an
acceptable
warning
message.
Page 11
Compiere ERP - 3.8.9
Release Notes
Appendix A
Appendix AMigration Instructions
Use the following instructions tomigrate Compiere from a previous version to Compiere 3.8.9. If youare doing a new installation, refer to the installation instructions on Appendix B.
Prerequisites
The following are the prerequisites for migrating Compiere 3.8.9:
l A valid support contract
l Java JDK 7Update 80 (SDK) – or higher (not just JRE)
l DatabaseOracle XE, Oracle 10gR2, Oracle 11gR2, Oracle 12c or EnterpriseDB Postgres PlusAdvanced Server 8.4 or later
Page 12
Compiere ERP - 3.8.9
Release Notes
Appendix A
Preserving Customizations
Compiere will not modify any customizations as long as the customizations aremarkedappropriately. By default, all records added to the dictionary will have the entity type "UserMaintained".
For changes to existing dictionary records, select Customizations in theChange Auditwindow toindicate the changes that youmust preserve before running themigration. Before performing themigration, run the process in the test mode to ensure that all updated dictionary records have beenupdated to preserve these customizations.
Migration ProcessThemigration process consists of the following steps:
l Preparation
l Test Mode (optional)
l Migrate to a New Release
Page 13
Compiere ERP - 3.8.9
Release Notes
Appendix A
Preparation
Ensure the following before you start themigration process:
l The server must have access to the internet for http (port 80) and https (port 443).
l Stop the application server by executing utils/RUN_Server2Stop.
l Back up the database.
If you are running EnterpriseDB 8.2 or earlier, upgrade it to EnterpriseDB Postgres Plus AdvancedServer 8.3.
Test Mode (optional)
As an optional step, you can run themigration task in test mode. This allows you to evaluate theactions taken when running it against the database. Note that the first step (resolve ID conflicts) willnot show the correct future IDs in the test mode. It is expected to get errors in the test mode as thedatabase changes are not being executed. Also, the test mode is a useful tool to evaluate the schemachanges that are about to bemade.
Follow theRUN_setup steps for a regular migration, as mentioned in the next section, but asindicated in Step 18, select the Test Only box.
If the programmarks certain required tables for deletion, then recreate such tables in the datadictionary (Window Table/Column) with theEntity Type as User Defined or with your own entitytype.
If the programmarks certain required columns for deletion, make sure that the column has theEntityType as User orApplication. If the required column has the Entity TypeData Dictionary orCompiere and it is marked for deletion, then copy it under another name andmark the new column asCustom orApplication. The same applies to windows, tabs, fields, and so on.
TheMandatory User or Application Columns must have a default value defined.
Migrating to a New Release
If you aremigrating to Compiere 3.8.9 and if you are using JBoss as the application server, youmustdelete the existing JBoss folder from the “compiere2” folder on your machine, as shown in thefollowing figure. This is because unlike previous releases, JBoss is no longer a part of the Compiereinstallation package.
Page 14
Compiere ERP - 3.8.9
Release Notes
Appendix A
If you aremigrating from 3.0.x, youmust also delete all the .car files from the folderCompiere2/data.
Use the following steps tomigrate to the new release:
1. Download and unzip/untar the distribution file (for example, Compiere_3.8.9.zip). Ensure tooverwrite any existing files.
2. ExecuteRUN_setup.
3. In theDeployment field, ensure that the location where the application server is installed on yourmachine is specified. For example, C:\wildfly-8.2.0.Final.
Page 15
Compiere ERP - 3.8.9
Release Notes
Appendix A
4. Verify all the environment settings and click Save.
If you get any error while validating parameters, you will see a red icon right next to the parameterwith the problem. Make the required changes, click Test to validate again, and then click Save.
TheCompiere 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 an existing customer, enter all thesubscriber information (System Name, Email and Password), as it was registered in theCompiereWeb Store, to get a complete list of applications).
Page 16
Compiere ERP - 3.8.9
Release Notes
Appendix A
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 actionReinstall/Migrate.Compiere Standard is the core application that must “always” be installed or migrated to the latestrelease, but you can also select additional applications provided by Compiere or any of ourauthorized partners. If you do not want to install or migrate any of the applications listed, changethe action toNone. To install new applications, change the action toNew Install.
Note: If you do not provide the correct email or password, or if you do not have
internet connection, you will not be able to select Compiere Enterprise, or
any of the other optional components.
Page 17
Compiere ERP - 3.8.9
Release Notes
Appendix A
10. Next, read and accept theCompiere Public License Agreement. To accept, click Yes, IUnderstand and Accept.
Youmight get more than one license agreement depending on the applications that you areinstalling. Note that XUOM is a sample application extension.
11. If you are installing the Compiere Enterprise edition, read and accept the commercial licenseagreement that appears.
12. Click Start File Installation.
Page 18
Compiere ERP - 3.8.9
Release Notes
Appendix A
13. When the file installation is complete, click Start Migrate Database.
14. Enter theSystem Name, Registered Email, andPassword.
The information entered heremust match the CompiereWeb store registration details.
Page 19
Compiere ERP - 3.8.9
Release Notes
Appendix A
15. Click Check License to validate your asset information.
Note: The asset information may already be included if it was entered in the
system window.
If you get the “Core Invalid” error after you click Check License, it indicates that you did notselect the appropriate action for the core component. If so, close the setup and support windows,and executeRUN_setup file again and select Standard plus or any other component forinstallation.
Page 20
Compiere ERP - 3.8.9
Release Notes
Appendix A
16. Click Start Migration.
17. Click Yes in the Compiere VersionMigration Prompt.
Page 21
Compiere ERP - 3.8.9
Release Notes
Appendix A
18. Click Start, do not select Test Only check box.
19. Click Yes to confirm that you do have a backup of your database.
20. Click Yes to confirm that the Source and Target database versions from the Compiere VersionMigration window are correct.
Page 22
Compiere ERP - 3.8.9
Release Notes
Appendix A
21. Verify whether themigration process is completed without any error and themessage, “MigrationDone” appears.
Note: If you get any errors, review the list of known issues listed in this document
before logging a service request.
22. Verify the following log files for errors in theCompiere2 folder:
a. Migrate_yyyy_mm_dd_hh_mi_ss.log: Complete logs file of themigration 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 themigration log. For example,search for the file with the text "CompiereMigration 3.8")
Note: If you get any errors, review the list of known issues listed in this document
before logging a service request.
Page 23
Compiere ERP - 3.8.9
Release Notes
Appendix A
23. If you have a Compiere Enterprise Edition license, execute utils/RUN_Support, and clickCheck License to activate your license.
24. Click theCheck License button to see whether your Enterprise License is activated.
Page 24
Compiere ERP - 3.8.9
Release Notes
Appendix A
25. Click Close after the Compiere Enterprise license is updated.
Note: Do not click Start Migration.
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 EditionFormulti-server installation, after upgrading themain application server and database, youmust runthe following on the additional application servers that are used to load balance the web user interfaceconnections:
1. Unzip the binary distribution to update theCompiere2 folder.
2. Copy the template for the configuration file in the followingmanner:
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 aredoing 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 theCLFileInstall script. If you useCLInstall, itwill drop your database user.
5. Delete the file COMPIERE_HOME/jboss/server/compiere/deploy/compiereRoot.ear to ensurethat there will not be conflicts by havingmultiple 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.Ensure to use sticky sessions so that all requests from a session go to the same applicationserver.
Support for multi-server installation feature is only available for customers using EnterpriseEdition. For more details about the different Compiere Editions, visit www.compiere.com.
Note: After migration, reapply the language packs when needed.
Page 25
Compiere ERP - 3.8.9
Release Notes
Appendix B
Appendix BThis appendix describes the steps required to install Compiere 3.8.9.
Compiere 3.8.9 – Installation InstructionsUse the following instructions for a new installation of Compiere. If you already have a previousversion of Compiere, seeMigration instructions.
PrerequisitesThe following are the prerequisites for a new installation of Compiere:
l Java Version 1.7 Update 80 or higher, or Java JDK 1.8
l Application server: Tomcat Version 7 orWildfly 8.2.0.Final
l DatabaseOracle XE, Oracle 10gR2, Oracle 11gR2, Oracle 12c or
l EnterpriseDB Postgres Plus Advanced Server 8.3 or Later
Important: It is recommended that you use a Unicode character set.
l Database approved Linux Operating System
l Windows 2008, Windows 7, orWindows 2012
l Disk Space: > 5GB (includes database)
l Swap Space: > 2GB
l Memory: > 1GB Linux > 4GBWindows
l TCP/IP connection
l Network setup with DNS server and a domain. Do not use IP addresses.
l Internet access
Note: The screenshots in this document refer to the installation of Compiere 3.8.9
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).
Installing DatabaseInstall database – For the instructions on how to install Oracle XE and EnterpriseDB onWindows andLinux, use the install guide on the Compiere websitehttp://www.compiere.org/support/installation.php.
Page 26
Compiere ERP - 3.8.9
Release Notes
Appendix B
If you are using Oracle XE, youmust modify the following database parameters:
l Start SQL*Plus (Start > Programs > Oracle Database 10g Express Edition > Run SQLCommand Line)
l Connect system/xxxx
l Alter system set processes=100 scope=spfile;
l Restart the database (Start > Programs > Oracle Database 10g Express Edition > Stop DBand thenStart DB)
Installing JavaDownload and install JDK 7 (SDK), update 80 or higher.
Note: The Compiere server requires the JDK (not just JRE).
For installation instructions, see the JDK section in the following page:http://docs.oracle.com/javase/7/docs/webnotes/install/index.html
Installing Application ServerYou can useWildfly 8.2.0.Final version or the latest version of Apache Tomcat as the ApplicationServer.
Installing WildflyDownload and install Wildfly 8.2.0.Final. For more information, see http://wildfly.org/downloads/.
Installing TomcatDownload and install Apache Tomcat 7.0 or higher. For installation instructions, seehttp://tomcat.apache.org/tomcat-7.0-doc/setup.html
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 forWindows:
ForWindows youmust have the following in setenv.bat:
set JAVA_OPTS=-server –Xms256m –Xmx1024m
Page 27
Compiere ERP - 3.8.9
Release Notes
Appendix B
To update tomcat servicememory heap, run tomcat7w.exe command from <CATALINA_HOME>/bin folder and than update.
Installing CompiereThe following instructions aremeant for a new installation of Compiere.
Use the following steps to install or set up Compiere Server (this includes the Compiere client aswell).
1. Download the latest version of Compiere.
2. Extract the .zip file. For example, C:\Compiere2 inWindows 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 thePATH. For moreinformation, click here.
4. Verify that the bin directory for your database executables is included in thePATH. Also, if usingOracle XE on Linux, run $ORACLE_HOME/bin/oracle_env.sh.
5. Set theCOMPIERE_HOME system variable to the path of your Compiere installation (forexample, C:\Compiere2).
6. Execute the script $COMPIERE_HOME/RUN_Setup.
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 theServer Type (Wildfly or Tomcat).
8. InDeployment, enter the path where the application server is installed.
9. Select theDatabase Type (Oracle XE, Oracle (for Standard or Enterprise Editions) orPostgreSQL (for EnterpriseDB).
10. ForSystem Password, enter the System database User password (for example, manager).
11. ForDatabase Password, enter the Compiere database user password, (for example,‘compiere’).
12. In theApplication Server, Database Server, andMail Server fields, use the DNS name of theserver. Do not use local host (127.0.0.1) or IP addresses.
13. Enter or update any other parameters as necessary.
14. Click Get Help for information on any field.
Page 28
Compiere ERP - 3.8.9
Release Notes
Appendix B
15. Click Save.
TheKey Store Dialog box appears.
16. Click OK.
Page 29
Compiere ERP - 3.8.9
Release Notes
Appendix B
The Compiere Public License screen appears.
17. Click Yes, I understand and Accept to continue.
The following prompt appears describing your new Security Key.
18. Click OK.
19. Enter the correct Subscriber Information.
Note: Existing customers should provide the subscriber information (System
Name, Email, and Password) exactly as it was registered in the Compiere
Page 30
Compiere ERP - 3.8.9
Release Notes
Appendix B
Web Store to get a complete list of applications).
Click Check Available Applications to get a list of applications that are available to beinstalled. If you are a Community Edition user, leave the fields blank, and click Check availablecomponents to install the Community Edition.
20. Select the applications that you would like to install.
Note: You can include additional applications by using Add Application. 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.
21. Click OK.
Note: If you do not provide the correct email or password, or if you do not have an
internet connection, you will not be able to select Compiere Enterprise or
any of the other optional components.
Page 31
Compiere ERP - 3.8.9
Release Notes
Appendix B
22. In theCompiere Public License agreement andCompiere Commercial License agreementscreens that appear, click Yes, I Understand and Accept.
Youmight get more than one license agreement, depending on the applications that you areinstalling.
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.
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.
Page 32
Compiere ERP - 3.8.9
Release Notes
Appendix B
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 existingdatabase will be removed.
25. Verify that you see a “10: ** Finished’ message at the end of this step. Then a new window shouldpop-up to do the license validation.
TheCompiere Supportwindow appears.
26. Complete the necessary fields to validate your assets. If you only intend to use the CommunityEdition of Compiere 3.0, you can skip the following steps and go to the Application Serversection.
For customers with a valid support contract with Compiere, this is a required step to ensure thatthe features associated with the support level are enabled. If you are a customer and do not have
Page 33
Compiere ERP - 3.8.9
Release Notes
Appendix B
a web store login, contact your system administrator or Compiere Support first. If you are not acustomer and would like to obtain a trial license for the Enterprise Edition, Contact Us.
27. Provide the following information in exactly the sameway as it was registered in the CompiereWeb store, and click Check License to validate your asset information.
l System Name: The name provided during the web store registration.
l Registered Email: The email address provided during the web store registration.
l Password: The web store password.
27. To verify your license, click Check License.
Note: Do not click Start Migration.
28. Review whether your license information has been validated.
If you have a trial license for Compiere Enterprise edition, but you currently do not have a licensewith Compiere, you will see that the license for Standard is invalid. This is expected as the trialdoes not include Standard and youmay ignore the error.
29. 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
Page 34
Compiere ERP - 3.8.9
Release Notes
Appendix B
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).
30. Close any additional Setup, or Support windows.
Running the Application ServerBefore you access the Compiere web user interface, youmust start the application server.
Use the following steps to start the application server:
1. To start the application server, do the following:
l If you are using JBoss, go to the location where you have installed the application server, andrunStandalone.bat from the bin folder. (For example, C:\wildfly-8.2.0.Final >bin > Standalone.bat).
l If you are using Apache Tomcat, runStartup.bat from the bin folder (For example,C:\tomcat\apache-tomcat-7.0.28 > bin > Startup.bat).
2. Check the logs files from the following locations for any errors:
l C:\wildfly-8.2.0.Final\standalone\log
l C:\apache-tomcat-7.0.28\logs
Common problems
The common problems include ports already in use:
l 17:41:09,085 ERROR [NamingService] Could not start on port 1099
l java.net.BindException: Address already in use
l JVM_Bind at java.net.PlainSocketImpl.socketBind(NativeMethod)
l There is another program using port 1099; Stop it and restart Run_Server2 or setup Compiere touse another port in RUN_setup.
The following are the likely port conflicts:
l 80 - Other web server running (or you need privileges under Linux/Unix), or Skype
l 8080 – Used by Oracle Database
l 1099 - Often used by IDEs for debugging, or by internet messengers (for example, Skype, GoogleTalk, and so on).
Page 35
Compiere ERP - 3.8.9
Release Notes
Appendix B
Starting CompiereUse the following steps to start Compiere:
1. Start Compiere using any of the followingmethods:
l To start the Swing client, double-click the Compiere shortcut on your desktop, or double-clickRUN_Compiere2 from the $COMPIERE_HOME directory.
The default users and passwords for the sample GardenWorld application is asfollows:
o GardenUser/GardenUser
o GardenAdmin/GardenAdmin
o System/System
o SuperUser/System
l If you have access to the Enterprise Edition, you can launch Compiere from the browser byentering http://server:port/apps (for example, http://mycompany.com:80/apps)on thebrowser. For optimal performance, the Firefox browser is recommended for the Compiere webuser interface.
Page 36
Compiere ERP - 3.8.9
Release Notes
Appendix B
For additional information, see the Compiere home page http://www.compiere.com.
Page 37
Compiere ERP - 3.8.9
Release Notes
Appendix C
Appendix CApplication Extensions - Compiere Partners
Application extensions in Compiere are available as functionality for Partners only. This frameworkallows Partners to create application extensions that include both reference data and code. Suchapplication 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 withSystem Administrator as the role.
2. Open theEntity Typewindow (Application Dictionary > Entity Type) from themainmenu andcreate a new record.
Note: Do not to modify the entities C, D, CPRO, or XUOM.
3. Complete all themandatory fields. For entity type, the names beginning with “C” and “X” arereserved for Compiere and youmust use four characters.
Page 38
Compiere ERP - 3.8.9
Release Notes
Appendix C
4. Enter the optional details:
l Version: The version of your extension. Usually, 1.0 for the first version.
l Prerequisite version: The Compiere Core version that is required for this extension. Forexample, 3.3.0. You need to use the exact text as defined for the entity type D.
l Prerequisite applications: The entity type of the applications that need to be installed inorder to install this extension. For example, set it to CPRO if the extensionmust be applied ontop of the Enterprise edition.
l Classpath: List of additional jar files required for this extension.
l Model package: Specific model package from the jar files listed in theClasspath field.
Ensure that your System window contains the up-to-date information for your system and webstore email/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 will get an error, “Error:Already registered: XXXX”. Then, create a new record with the new entity type. Verify withCompiere 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.
Log a support request in our casemanagement system requesting the approval of yourcomponent. The request should include a description and the license type.
Page 39
Compiere ERP - 3.8.9
Release Notes
Appendix C
Creation of Application .car file – Application Provider (Part-ner)
Use the following steps to create theApplication.car file:
1. Make all the application dictionary changes using the entity type that you registered in theprevious step.
2. Generate the jar files for the custom code required by your extension.
3. Once the Entity Type is approved by Compiere, login to the Compiere web user interface withSystem Administrator as theRole, and then query the entity type that you registered in theprevious step.
4. Click Create Application File.
5. In Jar Directory, enter the directory for the jar file listed in theClasspath field.
Page 40
Compiere ERP - 3.8.9
Release Notes
Appendix C
6. Click OK.
The car file will be generated in theCOMPIERE_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 acustomer extracts the Compiere installation files into the samedirectory, it is possible to end up with both compiere_’CPRO’.caras well as compiere_CPRO.car. This in turn will cause CompiereEnterprise to show up twice in the installation window.
To avoid this situation, customers will need tomanually delete compiere_’CPRO’.car andcompiere_’XUOM’.car from COMPIERE_HOME/data directory. These are the only two .carfiles that Compiere has distributed prior to 3.2. If a customer has created any additional .car filesprior to 3.2, it is necessary to follow the same procedure for those .car files as well.
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. ExecuteRUN_Setup (see Appendix A for details on the setup information.)
Important: Be sure to have an internet connection available to be able to get thelicense terms for the application extensions that you plan to install.
3. In theCompiere Server Setup screen that appears, select the applications, besides theapplication extension that you need to install.
4. Select the actionReinstall/Migrate for Compiere Core 3.8.9. For more information, see theMigration instructions.
Page 41
Compiere ERP - 3.8.9
Release Notes
Appendix C
Page 42
Compiere ERP - 3.8.9
Release Notes
Appendix D
Appendix DCommand Line Scripts
Scripts are provided in the $COMPIERE_HOME/utils/CommandLine directory for experiencedCompiere users who would like to perform Compiere instance creation andmaintenance viacommand line or using automated scripts.
CLInstallPurpose: To create a new Compiere installation. When this script is run, a new Compiere instance iscreated on the database specified in the configuration file. Note that existing Compiere databaseinstance 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 andhence need to be connected to the internet while running and have the appropriate license to allowyou to install the components. The script also updates the license information after the instance iscreated.
All the component .car files present in $COMPIERE_HOME/datawill be installed as long as youprovide 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 canmake a copy and editthe configuration parameters for your specific installation. All the parameters have one to onecorrespondence with the parameters on the first window that comes up when runningRUN_setup.
Subscriber information for license validation: CL_SYSTEM_NAME, CL_WEBSTORE_EMAIL, 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 3.8.9 release, ensure that you update the following parameters: CL_COMPIERE_APPS_TYPE and COMPIERE_APPS_SERVER.
Examples:
Tomcat
@SET CL_COMPIERE_APPS_TYPE=tomcat
@SET CL_COMPIERE_APPS_SERVER= C:\Tomcat-7.0.27
Page 43
Compiere ERP - 3.8.9
Release Notes
Appendix D
JBoss
@SET CL_COMPIERE_APPS_TYPE=jboss
@SET CL_COMPIERE_APPS_SERVER= C:\wildfly-8.2.0.Final
SSL Settings: CL_COMPIERE_SSL_PORT, CL_COMPIERE_KEYSTOREPASS
Mail: CL_MAIL_SERVER, CL_ADMIN_EMAIL, 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 fileswithin the same directory.
CLMigrateThis is very similar toCLInstall.bat except that it performs themigration of a Compiere instanceinstead of dropping and recreating a new instance.
CLUpdateLicenseThis script can be run to update the license information instead of executingRUN_Support. Thescript can be only run in a successful Compiere installation created by runningRUN_Setup orinstallation/migration via command line. The script can be edited to provide different subscriberinformation for license validation.
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 --email xxx --password xxx
If the parameters are not specified, the subscriber information at the time of installation will be used toupdate the licenses.
Page 44
Compiere ERP - 3.8.9
Release Notes