 |
FAQ - Upgrade Instructions for older openCRX Versions
Upgrading to a new patch version <= 1.8.1 (e.g. from openCRX v1.4.0 to openCRX v1.4.1)
- stop the application server
- backup your database
- if the new openCRX version contains a script to upgrade the database (named upgrade-from-X.Y.Z-to-X.Y.P.sql), run that script (details depend on your database, but the steps involved should be similar to what you did to create the tables when you initially installed openCRX) - do not run any other database scripts included in the distribution as you do not want to recreate the database (potential data loss)! Please note that sometimes we are not in a position to provide a script that automatically upgrades your particular instance as some transformations require intervention of a skilled database administrator (DBA). We recommend to consult the readme file of the respective DB scripts distributed with the openCRX version you want to upgrade to.
- copy the file opencrx-core-CRX-App.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- copy the files opencrx-core-CRX-web.ear and opencrx-core-CRX-Root-web.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- as mentioned in the README, update the openMDX library openmdx-kernel.jar; copy the library to the lib directory of your application server (e.g. .../jboss-4.0.1/server/default/lib)
- delete all temporary files (e.g. remove everything contained in the directories .../jboss-4.0.1/server/default/tmp and .../jboss-4.0.1/server/default/work)
- start your application server
Upgrading to a new minor version (e.g. from openCRX v1.4.0 to openCRX v1.5.0)
Special Instructions: Upgrading from openCRX v1.3.0 to openCRX v1.5.0
This upgrade requires that you follow the instructions carefully as the access control plugin introduced with openCRX v1.4.0 is quite unforgiving if there are objects with bad security settings.
I) Steps to be performed once
- stop the application server
- upgrade your DB by first running upgrade-from-1.3.0-to-1.4.0.sql and then running upgrade-from-1.4.0-to-1.5.0.sql
- verify the segment settings in the table kernel_Segment; verify that the access levels of all segments are set to (deep, basic, basic) and replace principals of the sort admin@<SegmentName> with the new format admin-<SegmentName>
- copy the file opencrx-core-CRX-App.ear contained in the openCRX application distribution (v1.5.0) to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- copy the files opencrx-core-CRX-web.ear and opencrx-core-CRX-Root-web.ear contained in the openCRX application distribution (v1.5.0) to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- update the openMDX library openmdx-kernel.jar; copy the library to the lib directory of your application server (e.g. .../jboss-4.0.1/server/default/lib)
- enable outgoing e-mail service (SMTP Adapter) by following the relevant instructions of the openCRX Installation and QuickStart Guide
- start your application server
- connect to the root provider and login as admin-Root
- set access levels to (global, basic, basic) for Codes and UOMs:

II) Steps to be performed for each segment (Standard, ...)
- set the default access levels in your DB by running set-access-level.sql (all objects will be owned by admin-<SegmentName> and the access levels will be set to (deep, basic, basic); you need to adapt the script to the segment at hand)
- connect to the root provider and login as admin-Root
- recreate the segment (by executing the operation [Create Administrator]) so that the newly introduced user loader-<SegmentName> is properly created; this special user is used to load/import data during the startup-phase ensuring that (a) data is imported with the appropriate security settings and (b) the notification services is not triggered by each newly created or modified object.
- logoff from the root provider
- connect to the standard provider and login as admin-<SegmentName> (you might get various error messags "can not create object. No permission" - simply ignore them)
- delete all UserHomes with the exception of admin-<SegmentName> and loader-<SegmentName>
- verify that the UserGroup Administrators is a member if the Group Users (if not, add it).
- restart (i.e. stop and then start) your application server
- connect to the standard provider and login as admin-<SegmentName> (if you still get error messages related to security (e.g. no permission, etc.) you need to go back to beginning of the segment-specific steps
- run the operation [Add Owning Group] on all segments to add the UserGroup Users recurively:

- logoff from the standard provider
- connect to the root provider and login as admin-Root
- delete all user principals related to the segment at hand and recreate them (add them to the Group Users as usual)
- logoff from the root provider
- connect to the standard provider and login as admin-Standard
- recreate all the UserHomes
Special Instructions: Upgrading from openCRX v1.4.0 to openCRX v1.5.0
I) Steps to be performed once
II) Steps to be performed for each segment (Standard, ...)
- connect to the root provider and login as admin-Root
- set access levels to (global, basic, basic) for Codes and UOMs:

- recreate all the existing segments (by executing the operation [Create Administrator]) so that the newly introduced user loader-<SegmentName> (e.g. loader-Standard) is properly created for each of the already existing segments; this special user is used to load/import data during the startup-phase ensuring that (a) imported data is assigned the appropriate security settings and (b) the notification services is not triggered by each newly created or modified object.
Special Instructions: Upgrading from openCRX v1.5.0 to openCRX v1.6.1
I) Steps to be performed once
- backup your database
- please make sure that you have the database scripts with version number v1.6.1
- go through the usual steps as explained in upgrading to a minor version
- connect to the root provider and login as admin-Root
- set access levels to (global, basic, basic) for Codes and UOMs:

II) Steps to be performed for each existing segment (Standard, ...)
- backup your database
- connect to the root provider and login as admin-Root
- recreate the segment (by executing the operation [Create Administrator]) so that the new security groups are properly created
- IMPORTANT: this step is only required if you have activities in your database that you would like to migrate to openCRX v1.6.1, i.e. there is no need to migrate your database if you either have no existing activities or do not mind if they are discarded
you can migrate activities in your database to openCRX v1.6.1 by running the script migrate-from-1.5.0-to-1.6.1.sql - please note that you must adjust the segment name in the script; furthermore, there might be some minor issues with certain statements of the migrate script depending on the type/version of your database and the actual data in that database - we advise to execute the statements of the migrate script one by one so that you can carefully verify the result - you might have to consult an experienced DBA if you run into problems
- connect to the standard provider of the respective segment and login as admin-<SegmentName> (e.g. admin-Standard)
- navigate to Workflows > Topics and delete all existing topics
- restart the application server (i.e. stop the application server and then start it again)
- connect to the standard provider of the respective segment and login as admin-<SegmentName> (e.g. admin-Standard)
- navigate to Workflows > Topics and verify whether workflow topics provided with openCRX v1.6.1 were loaded
- verify whether all data of the segment was migrated correctly
Special Instructions: Upgrading from openCRX v1.6.0 to openCRX v1.6.1
- stop the application server
- copy the file opencrx-core-CRX-App.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- copy the files opencrx-core-CRX-web.ear and opencrx-core-CRX-Root-web.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- delete all temporary files (e.g. remove everything contained in the directories .../jboss-4.0.1/server/default/tmp and .../jboss-4.0.1/server/default/work)
- start your application server
Special Instructions: Upgrading from openCRX v1.6.1 to openCRX v1.7.1
I) Steps to be performed once
- backup your database
- please make sure that you have the database scripts with version number v1.7.0
- go through the usual steps as explained in upgrading to a minor version
- connect to the root provider and login as admin-Root
- set access levels to (global, basic, basic) for Codes and UOMs:

II) Steps to be performed for each existing segment (Standard, ...)
- backup your database
- connect to the root provider and login as admin-Root
- recreate the segment (by executing the operation [Create Administrator]) so that the new security groups are properly created
- database migration to openCRX v1.7.0 by running the script migrate-from-1.6.1-to-1.7.0.sql - please note that you must adjust the segment name in the script; furthermore, there might be some minor issues with certain statements of the migrate script depending on the type/version of your database and the actual data in that database - we advise to execute the statements of the migrate script one by one so that you can carefully verify the result - you might have to consult an experienced DBA if you run into problems
- restart the application server (i.e. stop the application server and then start it again)
- connect to the standard provider of the respective segment and login as admin-<SegmentName> (e.g. admin-Standard)
- verify whether all data of the segment was migrated correctly
Special Instructions: Upgrading from openCRX v1.7.0 to openCRX v1.7.1
- stop the application server
- copy the file opencrx-core-CRX-App.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- copy the files opencrx-core-CRX-web.ear and opencrx-core-CRX-Root-web.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.1/server/default/deploy in the case of JBoss)
- delete all temporary files (e.g. remove everything contained in the directories .../jboss-4.0.1/server/default/tmp and .../jboss-4.0.1/server/default/work)
- start your application server
Special Instructions: Upgrading from openCRX v1.7.1 to openCRX v1.8.1
I) Steps to be performed once for each application
- stop the application server
- backup your database
- please make sure that you have the database scripts with version number v1.8.1
- go through the usual steps as explained in upgrading to new patch version
II) Steps to be performed for each existing Segment (Standard, ...) in each of your applications
- stop the application server
- backup your database
- database migration to openCRX v1.8.1 by running the script migrate-from-1.7.1-to-1.8.1.sql - please note that you must adjust the segment name in the script (the default segment name is Standard if you followed our installation notes); furthermore, there might be some minor issues with certain statements of the migrate script depending on the type/version of your database and the actual data in that database - we advise to execute the statements of the migrate script one by one so that you can carefully verify the result - you might have to consult an experienced DBA if you run into problems. With respect to the security-related changes between openCRX v1.7.1 and openCRX v1.8.1 the migrate script does the following:
- All subjects are moved into the Segment Root (previous to openCRX v1.8.1 subjects resided in the respective Segments, e.g. Standard - starting with openCRX v1.8.1 all subjects reside in the Segment Root).
Please note that some of the statements might fail if you had principals with the same name in more than one Segment; decide for one principal (i.e. subject-to-be) to keep and ignore the other ones.
- References to the moved subjects are adjusted for all principals.
- All LocalUserGroups and membership information are deleted (the Segment Administrator must recreate them manually as PrincipalGroups and update membership information at a later stage). You might want to keep the list of LocalUserGroups sent to the console for later reference.
III) Steps to be performed once for each application
- stop the application server
- backup your database
- run the script drop-from-1.7.1-to-1.8.1.sql
- start the application server
- connect to the root provider and login as admin-Root
- set access levels to (global, basic, basic) for Codes and UOMs:

- restart the application server (i.e. stop the application server and then start it again)
- connect to the root provider and login as admin-Root
- verify Security Realms (screen shot) - you should have Realms Default and Root
- verify Security Subjects (screen shot) - you should have Subjects admin-Root, admin-<SegmentName> (e.g. admin-Standard), and guest
- verify Security Realms > Realm Default (screen shot) - you should have Principals admin-Root, admin-<SegmentName> (e.g. admin-Standard), and guest and they should point to an existing Subject; you should also have PrincipalGroups Administrators and Users
- verify Security Realms > Realm Root (screen shot) - you should have Principals admin-Root, admin-Root.User, admin-<SegmentName> (e.g. admin-Standard), admin-<SegmentName>.User (e.g. admin-Standard.User), guest, and guest.User and they should point to an existing Subject; you should also have PrincipalGroups Administrators and Users
IV) Steps to be performed for each existing Segment (Standard, ...) in each of your applications
- connect to the root provider and login as admin-Root
- recreate the segment (by executing the operation [Create Administrator]) so that the respective Realm gets created and the required admin Principals are added
- verify Security Realms > Realm <SegmentName> (e.g. Standard) (screen shot) - you should have Principals admin-<SegmentName> (e.g. admin-Standard), admin-<SegmentName>.User (e.g. admin-Standard.User), guest, and guest.User and they should point to an existing Subject; you should also have PrincipalGroups Administrators , Unassigned, Unspecified, and Users
- to the standard provider of the respective segment and login as admin-<SegmentName> (e.g. admin-Standard)
- verify whether all data of the segment was migrated correctly
- recreate the LocalUserGroups that were deleted in step III) as PrincipalGroups
- add Principalgroup memberships to the Principals as desired.
- verify whether all the data of the segment was migrated correctly
Special Instructions: Upgrading from openCRX v1.8.1 to openCRX v1.9.1
I) Steps to be performed once for each application with its own database
- stop the application server
- backup your database (the upgrade from openCRX v.1.8.1 to v1.9.1 involves the elimination of the REF table [among other transformations], i.e. it is strongly recommended that you actually make that database backup!)
- convert the REF tables with ant convert-from-181-to-191 - detailed instructions are available here
- run the upgrade script to upgrade-from-1.8.1-to-1.9.1.sql - do not run any other database scripts at this time! Please note that sometimes we are not in a position to provide a script that automatically upgrades your particular instance as some transformations require intervention of a skilled database administrator (DBA). We also recommend to consult the readme file of the respective DB scripts distributed with the openCRX version you want to upgrade to
II) Steps to be performed for each existing Segment (Standard, ...) in each of your applications
- database migration to openCRX v1.9.1 by running the script migrate-from-1.8.1-to-1.9.1.sql - please note that you must adjust the provider name and the segment name in the script (the default provider is CRX, the default segment name is Standard if you followed our installation notes); furthermore, there might be some minor issues with certain statements of the migrate script depending on the type/version of your database and the actual data in that database - we advise to execute the statements of the migrate script one by one so that you can carefully verify the result - you might have to consult an experienced DBA if you run into problems
III) Steps to be performed once for each application with its own database
- run the script drop-from-1.8.1-to-1.9.1.sql
- run the script dbcreate-views.sql - verify that old views (if any) are dropped and new views created
- run the script dbcreate-indexes.sql
- populate the table prefs_Preference by executing the SQL script populate-preferences.sql
- copy the file opencrx-core-CRX-App.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.3SP1/server/default/deploy in the case of JBoss)
- copy the file opencrx-core-CRX-web.ear contained in the openCRX application distribution to the appropriate deployment directory of your application server (e.g. .../jboss-4.0.3SP1/server/default/deploy in the case of JBoss)
- as mentioned in the README, update the openMDX library openmdx-kernel.jar; copy the library to the lib directory of your application server (e.g. .../jboss-4.0.3SP1/server/default/lib)
- delete all temporary files (e.g. remove everything contained in the directories .../jboss-4.0.3SP1/server/default/tmp and .../jboss-4.0.1/server/default/work)/li>
- start your application server
- connect and login as Root Administrator (e.g admin-Root)
- import new codes by eithe reloading the Root administrators home page or executing the operation View > Reload...
- set access levels to (global, basic, basic) for Codes:

- restart the application server (i.e. stop the application server and then start it again)/li>
IV) Steps to be performed for each existing Segment (Standard, ...) in each of your applications
- login as Segment Administrator (e.g. admin-Standard for the Segment Standard)
- navigate to Workflows > Workflow Processes and delete all Workflow Processes provided by openCRX
- navigate to Workflows > Topics and delete all Topics provided by openCRX
- restart the application server (i.e. stop the application server and then start it again)
Note: Workflow Processes and Topics will be regenerated automatically once the Subscription Handler of the respective Segment is started (see admin Guide for details) - if you do not delete old/existing Workflow Processes and Topics the Subscription Handler will not work properly.
Special Instructions: Upgrading from openCRX v1.9.1 to openCRX v1.10.0
- stop the application server
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views
- MS SQL only: drop all constraints with script drop-all-constraints.sql
- execute the script upgrade-from-1.9.1-to-1.10.0.sql
- run ant ... convert-from-1_9_1-to-1_10_0
you can run the command without parameters to view help information; the following table contains some example calls with parameters (but you must adapt these to your specific environment!):
| DBMS |
Example call of ant ... convert |
| DB2 |
ant -Ddb.jdbc.url="jdbc:db2://localhost:50000/CRX_CRX" -Ddb.jdbc.driver="com.ibm.db2.jcc.DB2Driver" -Ddb.jdbc.driver.classpath="C:\opt\ibm\jre-1.4\db2-9\lib\db2jcc.jar;C:\opt\ibm\jre-1.4\db2-9\lib\db2jcc_license_cu.jar" -Ddb.username="system" -Ddb.password="manager" convert-from-1_9_1-to-1_10_0 |
| MSSQL |
ant -Ddb.jdbc.url="jdbc:sqlserver://localhost:1433;databaseName=CRX-CRX" -Ddb.jdbc.driver="com.microsoft.sqlserver.jdbc.SQLServerDriver" -Ddb.jdbc.driver.classpath="C:\opt\microsoft\jre-1.4\sql-server-2005\lib\sqljdbc.jar" -Ddb.username="system" -Ddb.password="manager" convert-from-1_9_1-to-1_10_0 |
| MySQL |
ant -Ddb.jdbc.url="jdbc:mysql://localhost:3306/CRX-CRX" -Ddb.jdbc.driver="com.mysql.jdbc.Driver" -Ddb.jdbc.driver.classpath="C:\opt\mysql\jre-1.4\mysql-5\lib\mysql-connector-java-3.1.12-bin.jar" -Ddb.username="system" -Ddb.password="manager" convert-from-1_9_1-to-1_10_0 |
| Oracle |
ant -Ddb.jdbc.url="dbc:oracle:thin:@localhost:1521:XE" -Ddb.jdbc.driver="oracle.jdbc.driver.OracleDriver" -Ddb.jdbc.driver.classpath="C:\opt\oracle\jre-1.4\oracle-10\lib\ojdbc14.jar" -Ddb.username="system" -Ddb.password="manager" convert-from-1_9_1-to-1_10_0 |
| PostgreSQL |
ant -Ddb.jdbc.url="jdbc:postgresql://localhost/CRX-CRX" -Ddb.jdbc.driver="org.postgresql.Driver" -Ddb.jdbc.driver.classpath="C:\opt\postgresql\jre-1.4\postgresql-8\lib\postgresql-8.1-407.jdbc3.jar" -Ddb.username="system" -Ddb.password="manager" convert-from-1_9_1-to-1_10_0 |
Important: ant ... convert-from-1_9_1-to-1_10_0 must complete without errors!
If there are errors the problematic statement(s) will be displayed so that you can try to fix the problem(s) manually.
For production data it is advisable to keep track of all the problems that need fixing until the conversion completes successfully;
Apply all those fixes to the original DB and then run ant ... convert-from-1_9_1-to-1_10_0 so that it completes without errors.
Sample conversion logs (IBM DB2) are available here.
- execute the script drop-from-1.9.1-to-1.10.0.sql
- execute the script populate-preferences.sql
- build the runtime binaries (EARs) following instructions in the QuickStart Guide or in opencrx/core/README
- deploy the file opencrx-core-CRX-App.ear to your application server following the respective guide
- deploy the file opencrx-core-CRX-Web.ear to your application server following the respective guide
- as mentioned in the README, update the openMDX library openmdx-kernel.jar on your application server following the respective guide
- if you configured DB-based authentication you must adapt the select statements to reflect the new DB structure
(see for example JBoss Installation Guide)
- delete all temporary files (e.g. on JBoss remove everything contained in the directories .../jboss-4.0.5/server/default/tmp and .../jboss-4.0.1/server/default/work)
- start your application server
Special Instructions: Upgrading from openCRX v1.10.0 to openCRX v1.11.0
- stop the application server
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views
- execute the script upgrade-from-1.10.0-to-1.11.0.sql
- execute the script migrate-from-1.10.0-to-1.11.0.sql
- execute the script drop-from-1.10.0-to-1.11.0.sql
- create a new database (e.g. CRX2_CRX) and execute the script dbcreate-tables.sql
- run ant ... CopyDb
you can run the command without parameters to view help/usage information; the following table contains some example calls with parameters (but you must adapt these to your specific environment!). Please also note that the command must be entered as a single line without any line breaks (the example commands are multiline for easier readability):
| DBMS |
Example call of ant ... convert |
| DB2 |
ant -Dformat.source=openmdx1 -Dformat.target=openmdx2 -Ddb.jdbc.driver.classpath="..\opt\ibm\jre-1.5\db2-9\lib\db2jcc.jar;..\opt\ibm\jre-1.5\db2-9\lib\db2jcc_license_cu.jar" -Ddb.jdbc.url.source="jdbc:db2://localhost:50000/CRX_SOURCE" -Ddb.jdbc.driver.source="com.ibm.db2.jcc.DB2Driver" -Ddb.username.source="system" -Ddb.password.source="manager" -Ddb.jdbc.url.target="jdbc:db2://localhost:50000/CRX_TARGET" -Ddb.jdbc.driver.target="com.ibm.db2.jcc.DB2Driver" -Ddb.username.target="system" -Ddb.password.target="manager" CopyDb |
| MSSQL |
ant -Dformat.source=openmdx1 -Dformat.target=openmdx2 -Ddb.jdbc.driver.classpath="..\opt\microsoft\jre-1.5\sql-server-2005\lib\sqljdbc.jar" -Ddb.jdbc.url.source="jdbc:sqlserver://localhost:1433;databaseName=CRX_SOURCE;selectMethod=cursor" -Ddb.jdbc.driver.source="com.microsoft.sqlserver.jdbc.SQLServerDriver" -Ddb.username.source="system" -Ddb.password.source="manager" -Ddb.jdbc.url.target="jdbc:sqlserver://localhost:1433;databaseName=CRX_TARGET;selectMethod=cursor" -Ddb.jdbc.driver.target="com.microsoft.sqlserver.jdbc.SQLServerDriver" -Ddb.username.target="system" -Ddb.password.target="manager" CopyDb |
| MySQL |
ant -Dformat.source=openmdx1 -Dformat.target=openmdx2 -Ddb.jdbc.driver.classpath="..\opt\mysql\jre-1.5\mysql-5\lib\mysql-connector-java-3.1.12-bin.jar" -Ddb.jdbc.url.source=""jdbc:mysql://localhost:3306/CRX_SOURCE" -Ddb.jdbc.driver.source="com.mysql.jdbc.Driver" -Ddb.username.source="system" -Ddb.password.source="manager" -Ddb.jdbc.url.target="jdbc:mysql://localhost:3306/CRX_TARGET" -Ddb.jdbc.driver.target="com.mysql.jdbc.Driver" -Ddb.username.target="system" -Ddb.password.target="manager" CopyDb |
| Oracle |
ant -Dformat.source=openmdx1 -Dformat.target=openmdx2 -Ddb.jdbc.driver.classpath="..\opt\oracle\jre-1.5\oracle-10\lib\ojdbc14.jar" -Ddb.jdbc.url.source="dbc:oracle:thin:@localhost:1521:XE" -Ddb.jdbc.driver.source="oracle.jdbc.driver.OracleDriver" -Ddb.username.source="CRX_SOURCE" -Ddb.password.source="manager" -Ddb.jdbc.url.target="jdbc:oracle:thin:@localhost:1521:XE" -Ddb.jdbc.driver.target="oracle.jdbc.driver.OracleDriver" -Ddb.username.target="CRX_TARGET" -Ddb.password.target="manager" CopyDb |
| PostgreSQL |
ant -Dformat.source=openmdx1 -Dformat.target=openmdx2 -Ddb.jdbc.driver.classpath="..\opt\postgresql\jre-1.5\postgresql-8\lib\postgresql-8.1-407.jdbc3.jar" -Ddb.jdbc.url.source="jdbc:postgresql://localhost/CRX_SOURCE" -Ddb.jdbc.driver.source="org.postgresql.Driver" -Ddb.username.source="system" -Ddb.password.source="manager" -Ddb.jdbc.url.target="jdbc:postgresql://localhost/CRX_TARGET" -Ddb.jdbc.driver.target="org.postgresql.Driver" -Ddb.username.target="system" -Ddb.password.target="manager" CopyDb |
Important: ant ... DbCopy must complete without errors!
If there are errors the problematic statement(s) will be displayed so that you can try to fix the problem(s) manually.
Hint: you can safely ignore errors regarding the tables security_AUTHENTICATIONCONTEXT_N and security_SEGMENT_N
For production data it is advisable to keep track of all the problems that need fixing until the copy task completes successfully;
Apply all those fixes to the original DB and then run ant ... DbCopy so that it completes without errors.
- on the new database, run ant ... update-size-columns-1_11_0
to bring the new columns into a consistent state; you can run the command without parameters to view help/usage information; the following table contains some example calls with parameters (but you must adapt these to your specific environment!). Please also note that the command must be entered as a single line without any line breaks (the example commands are multiline for easier readability):
| DBMS |
Example call of ant ... convert |
| DB2 |
ant -Ddb.jdbc.url="jdbc:db2://localhost:50000/CRX_TARGET" -Ddb.jdbc.driver="com.ibm.db2.jcc.DB2Driver" -Ddb.jdbc.driver.classpath="..\opt\ibm\jre-1.5\db2-9\db2jcc.jar;..\jre-1.5\db2-9\db2jcc_license_cu.jar" -Ddb.username="system" -Ddb.password="manager" update-size-columns-1_11_0 |
| MSSQL |
ant -Ddb.jdbc.url="jdbc:sqlserver://localhost:1433;databaseName=CRX_TARGET" -Ddb.jdbc.driver="com.microsoft.sqlserver.jdbc.SQLServerDriver" -Ddb.jdbc.driver.classpath="..\opt\microsoft\jre-1.5\sql-server-2005\lib\sqljdbc.jar" -Ddb.username="system" -Ddb.password="manager" update-size-columns-1_11_0 |
| MySQL |
ant -Ddb.jdbc.url="jdbc:mysql://localhost:3306/CRX_TARGET" -Ddb.jdbc.driver="com.mysql.jdbc.Driver" -Ddb.jdbc.driver.classpath="..\opt\mysql\jre-1.5\mysql-5\lib\mysql-connector-java-3.1.12-bin.jar" -Ddb.username="system" -Ddb.password="manager" update-size-columns-1_11_0 |
| Oracle |
ant -Ddb.jdbc.url="jdbc:oracle:thin:@localhost:1521:XE" -Ddb.jdbc.driver="oracle.jdbc.driver.OracleDriver" -Ddb.jdbc.driver.classpath="..\opt\oracle\jre-1.5\oracle-10\lib\ojdbc14.jar" -Ddb.username="CRX_TARGET" -Ddb.password="manager" update-size-columns-1_11_0 |
| PostgreSQL |
ant -Ddb.jdbc.url="jdbc:postgresql://localhost/CRX_TARGET" -Ddb.jdbc.driver="org.postgresql.Driver" -Ddb.jdbc.driver.classpath="..\opt\postgresql\jre-1.5\postgresql-8\lib\postgresql-8.1-409.jdbc3.jar" -Ddb.username="system" -Ddb.password="manager" update-size-columns-1_11_0 |
Important: ant ... update-size-columns-1_11_0 must complete without errors!
If there are errors the problematic statement(s) will be displayed so that you can try to fix the problem(s) manually.
For production data it is advisable to keep track of all the problems that need fixing until the update task completes successfully.
- on the new database, execute the script dbcreate-views.sql
- on the new database, execute the script dbcreate-indexes.sql
- on the new database, execute the script populate-preferences.sql
- build the runtime binaries (EARs) following instructions in the QuickStart Guide or in opencrx/core/README
- deploy the file opencrx-core-CRX-App.ear to your application server following the respective guide
- deploy the file opencrx-core-CRX-Web.ear to your application server following the respective guide
- as mentioned in the README, update the openMDX library openmdx-kernel.jar on your application server following the respective guide
- if you configured DB-based authentication you must adapt the select statements to reflect the new DB structure
(see for example JBoss Installation Guide)
- delete all temporary files (e.g. on JBoss remove everything contained in the directories .../jboss-4.2.1.GA/server/default/tmp and .../jboss-4.2.1.GA/server/default/work)
- start your application server
Upgrading from openCRX v1.11.0 to openCRX v2.0
- stop the application server
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views
- execute the script upgrade-from-1.11.0-to-2.0.0.sql
- execute the script migrate-from-1.11.0-to-2.0.0.sql
- execute the script drop-from-1.11.0-to-2.0.0.sql
- on the new database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors.
- on the new database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide it as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using.
- on the new database, execute the script populate-preferences.sql
- either
or
^top
Upgrading from openCRX v2.0.0 to openCRX v2.1.0
 |
|
- stop the application server
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views
- execute the script upgrade-from-2.0.0-to-2.1.0.sql
- execute the script migrate-from-2.0.0-to-2.1.0.sql
- execute the script drop-from-2.0.0-to-2.1.0.sql
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- either
or
Upgrading from openCRX v2.1.0 to openCRX v2.2.0
 |
|
- stop the application server
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views
- execute the script upgrade-from-2.1.0-to-2.2.0.sql
- execute the script migrate-from-2.1.0-to-2.2.0.sql
- execute the script drop-from-2.1.0-to-2.2.0.sql
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- either
- install openCRX 2.2 with the openCRX Server Installer (if you want to run openCRX on Tomcat). In case you made any changes to your previous installation (e.g. a different DBMS, etc.) you can follow these steps to upgrade your previous installation "in place" (for advanced users only!):
- copy the file .../bin/tomcat-juli.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../deployment-units/opencrx-core-CRX.ear from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../lib/catalina.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../lib/openmdx-tomcat.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- delete all subdirectories and files in the directory .../staging-area
- delete all subdirectories named "opencrx-..." in the directory .../webapps (e.g. opencrx-core-CRX, opencrx-groupware-CRX, ...)
- adapt the xml files in directory .../conf/Catalina/localhost (there are differences between openCRX v2.1 and v2.1)
or
- once you have openCRX running again, login as admin-Root, import codes and data, and then set the access levels of codes before you restart openCRX (detailed instructions are available in the openCRX Quick Start guide)
Upgrading from openCRX v2.2.0 to openCRX v2.2.1
 |
|
- stop the application server
- backup your database
- upgrade your database as follows:
- either
- install openCRX 2.2.1 with the openCRX Server Installer (if you want to run openCRX on Tomcat). In case you made any changes to your previous installation (e.g. a different DBMS, etc.) you can follow these steps to upgrade your previous installation "in place" (for advanced users only!):
- copy the file .../bin/tomcat-juli.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../deployment-units/opencrx-core-CRX.ear from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../lib/catalina.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../lib/openmdx-tomcat.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- delete all subdirectories and files in the directory .../staging-area
- delete all subdirectories named "opencrx-..." in the directory .../webapps (e.g. opencrx-core-CRX, opencrx-groupware-CRX, ...)
- no need to change the xml files in directory .../conf/Catalina/localhost (there are no differences between openCRX v2.2.0 and v2.2.1)
or
- once you have openCRX running again, login as admin-Root, import codes and data, and then set the access levels of codes before you restart openCRX (detailed instructions are available in the openCRX Quick Start guide)
Upgrading from openCRX v2.2.1 to openCRX v2.3.0
 |
|
- stop the servlet container (Tomcat, application server)
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views (statements are available in the script dbcreate-views.sql)
- execute the script upgrade-from-2.2.1-to-2.3.0.sql
- execute the script migrate-from-2.2.1-to-2.3.0.sql
- execute the script drop-from-2.2.1-to-2.3.0.sql
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- either
- install openCRX 2.3 with the openCRX Server Installer (if you want to run openCRX on Tomcat). In case you made any changes to your previous installation (e.g. a different DBMS, etc.) you can follow these steps to upgrade your previous installation "in place" (for advanced users only!):
- copy the file .../bin/tomcat-juli.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../deployment-units/opencrx-core-CRX.ear from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../lib/catalina.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- copy the file .../lib/openmdx-tomcat.jar from the new installation to the same directory of the old installation (overwrite the old file...)
- delete all subdirectories and files in the directory .../staging-area
- delete all subdirectories named "opencrx-..." in the directory .../webapps (e.g. opencrx-core-CRX, opencrx-ical-CRX, ...)
- adapt the xml files in directory .../conf/Catalina/localhost (there are differences between openCRX v2.2 and v2.3)
or
- once you have openCRX running again, login as admin-Root, import codes and data, and then set the access levels of codes before you restart openCRX (detailed instructions are available in the openCRX Quick Start guide)
^top
Upgrading from openCRX v2.3.0 to openCRX v2.4.1
 |
- DB Scripts are contained in the openCRX SDK Installer
- pre-built EARs are contained in the openCRX Server Installer in the directory
<Server Installation Directory>\apache-tomcat-6\apps
- please note that the DB scripts of openCRX v2.4.1 are identical to the DB scripts of openCRX v2.4.0 (even the names are identical...)
|
- stop the servlet container (Tomcat, application server)
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views (statements are available in the script dbcreate-views.sql)
- execute the script upgrade-from-2.3.0-to-2.4.0.sql
- execute the script migrate-from-2.3.0-to-2.4.0.sql
execute the script drop-from-2.3.0-to-2.4.0.sql (not necessary as there is nothing to drop)
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- either
or
- once you have openCRX running again, login as admin-Root, import codes and data, and then set the access levels of codes before you restart openCRX (detailed instructions are available in the openCRX Installation Guide for Tomcat 6)
- in the case of HSQLDB, copy your upgrade over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
Upgrading from openCRX v2.4.0 to openCRX v2.4.1
if you have a working installation of openCRX v2.4.0, then you can upgrade to openCRX v2.4.1 as follows:
- stop Tomcat
- backup your database (always a good idea!)
- delete the contents of the following directories:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- download and install the openCRX 2.4.1 Software Development Kit
- copy the file openmdx-base.jar from the directory {openCRX_SDK_v2.4.1_INSTALL_DIR}/opencrx-2.4.1/opt/openmdx-2.4.1/jre-1.5/core/lib to the directory {TOMCAT_INSTALL_DIR}/lib (overwrite the existing file)
- copy the file opencrx-core-CRX.ear from the directory {openCRX_SDK_v2.4.1_INSTALL_DIR}/opencrx-2.4.1/jre-1.5/core/deployment-unit to the directory {TOMCAT_INSTALL_DIR}/apps
- copy the file opencrx-apps-CRX.ear from the directory {openCRX_SDK_v2.4.1_INSTALL_DIR}/opencrx-2.4.1/jre-1.5/apps/deployment-unit to the directory {TOMCAT_INSTALL_DIR}/apps
- start Tomcat
Upgrading from openCRX v2.4.0 / v2.4.1 to openCRX v2.5.0
 |
|
- stop the servlet container (Tomcat, application server)
- backup your database
- upgrade your database as follows:
- drop all (openCRX) views (statements are available in the script dbcreate-views.sql)
- execute the script upgrade-from-2.4.0-to-2.5.0.sql
- execute the script migrate-from-2.4.0-to-2.5.0.sql
- execute the script drop-from-2.4.0-to-2.5.0.sql
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- install openCRX 2.5.0 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.5.0 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- delete the following files of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/slf4j-openmdx1.jar
- {TOMCAT_INSTALL_DIR}/lib/slf4j.jar
- upgrade OpenEJB of your existing installation:
- delete the file {TOMCAT_INSTALL_DIR}/webapps/0-openmdx-openejb.war
- delete the directory {TOMCAT_INSTALL_DIR}/webapps/0-openmdx-openejb
- copy the file 0-openmdx-openejb.war from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/webapps)
- copy the files openmdx-base.jar, openmdx-base-ext.jar, and catalina.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib, overwrite existing files)
- copy the file tomcat.juli from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/bin, overwrite existing file)
- copy the files opencrx-core-CRX.ear and opencrx-apps-CRX.ear from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- you can now uninstall the new installation of openCRX as it is no longer needed
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- delete all codes
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- start openCRX
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
Upgrading from openCRX v2.5.0 to openCRX v2.5.1
 |
- Do NOT upgrade from 2.4.0/2.4.1 to 2.5.1 directly - you must upgrade to v2.5.0 to prepare for the upgrade to v2.5.1
|
 |
|
- stop the servlet container (Tomcat, application server)
- backup your database
- install openCRX 2.5.1 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.5.1 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- delete the following files of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/catalina.jar
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base.jar
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base-ext.jar
- copy the files openmdx-base.jar and catalina.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib)
- copy the file tomcat.juli from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/bin, overwrite existing file)
- copy the files opencrx-core-CRX.ear and opencrx-apps-CRX.ear from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- you can now uninstall the new installation of openCRX as it is no longer needed
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- delete all codes
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- start openCRX
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
Upgrading from openCRX v2.5.1 to openCRX v2.5.2
 |
|
 |
|
- stop the servlet container (Tomcat, application server)
- backup your database
- install openCRX 2.5.2 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.5.2 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- upgrade OpenEJB of your existing installation:
- delete the file {TOMCAT_INSTALL_DIR}/webapps/0-openmdx-openejb.war
- delete the directory {TOMCAT_INSTALL_DIR}/webapps/0-openmdx-openejb
- copy the file 0-openmdx-openejb.war from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/webapps)
- delete the following files of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/catalina.jar
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base.jar
- copy the files openmdx-base.jar and catalina.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib)
- copy the files opencrx-core-CRX.ear and opencrx-apps-CRX.ear (only needed if you want to run openCRX/Store) from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- start openCRX
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
- you can now uninstall the new installation of openCRX as it is no longer needed
- for each of your segments (e.g. Standard) login as segment administrator (e.g. admin-Standard) and adapt all your Calculation Rules as follows (by default there is only 1 Calculation Rule called "Default"):
- navigate to Pipeline > Calculation Rules
- click on the icon of the first Calculation Rule (e.g. Default) to inspect it
- edit the Calculation Rule and in the field Position amounts script on the 4th line make the following change:
old: ContractPosition
new: AbstractContractPosition
- save your changes and verify that your Calculation Rule looks as follows:
- if you created your own Calculation Rules, repeat the above for each of them
Upgrading from openCRX v2.5.2 to openCRX v2.5.3
 |
|
 |
|
 |
If you have custom projects, don't forget to adapt the schema paths in the ui and code files as indicated in the release notes. |
- stop the servlet container (Tomcat, application server)
- backup your database
- install openCRX 2.5.3 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.5.3 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- delete the following files of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/catalina.jar
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base.jar
- copy the files openmdx-base.jar and catalina.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib)
- copy the files opencrx-core-CRX.ear and opencrx-apps-CRX.ear (only needed if you want to run openCRX/Store) from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- start openCRX
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
- you can now uninstall the new installation of openCRX as it is no longer needed
- for each of your segments (e.g. Standard) login as segment administrator (e.g. admin-Standard) and delete the pre-configured favorites; regenerate them with the wizard Segment Setup.
Upgrading from openCRX v2.5.3 to openCRX v2.6.0
 |
- Do NOT upgrade from 2.5.0/2.5.1 to 2.5.2 directly - you must first upgrade to v2.5.3 to prepare for the upgrade to v2.6.0
|
 |
|
 |
If you have custom projects, don't forget to adapt the schema paths in the ui and code files as indicated in the release notes. |
- stop the servlet container (Tomcat, application server)
- backup your database
- upgrade your database as follows (DB scripts are available in the openCRX SDK, in the directory {openCRX_SDK_Install_Directory}\opencrx-2.6.0\core\src\sql):
- drop all (openCRX) views (statements are available in the script dbcreate-views.sql)
- execute the script upgrade-from-2.5-to-2.6.sql
- execute the script migrate-from-2.5-to-2.6.sql
- execute the script drop-from-2.5-to-2.6.sql
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning. You might have to remove statements trying to create indices that already exist.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- install openCRX 2.6.0 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.6.0 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- create the new directory {TOMCAT_INSTALL_DIR}/airsyncdir
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- delete the following files of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/catalina.jar
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base.jar
- copy the files openmdx-base.jar and catalina.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib)
- copy the files opencrx-core-CRX.ear and opencrx-apps-CRX.ear (the latter is only needed if you want to run openCRX/Store) from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- start openCRX
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
- you can now uninstall the new installation of openCRX as it is no longer needed
- for each of your segments (e.g. Standard) login as segment administrator (e.g. admin-Standard) and delete the pre-configured
- favorites (Home > Favorites)
- export profiles (Home > Export Profiles)
- document templates (Label Template, Contract Templates, ...) (Folders & Documents > Folders)
- document folders (Mail Merge Templates, Opportunity Templates, etc.) (Folders & Documents > Folders)
- for each of your segments (e.g. Standard) login as segment administrator (e.g. admin-Standard) and run the wizard Segment Setup (Home - Wizards > Segment Setup) to bring your configuration up to date
Upgrading from openCRX v2.6.0 to openCRX v2.7.0
 |
|
 |
|
- stop the servlet container (Tomcat, application server)
- backup your database
- upgrade your database as follows (DB scripts are available in the openCRX SDK, in the directory {openCRX_SDK_Install_Directory}\opencrx-2.7.0\core\src\sql):
- drop all (openCRX) views (statements are available in the script dbcreate-views.sql)
- execute the script upgrade-from-2.6-to-2.7.sql
- execute the script migrate-from-2.6-to-2.7.sql
- execute the script drop-from-2.6-to-2.7.sql
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning. You might have to remove statements trying to create indices that already exist.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- install openCRX 2.7.0 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.7.0 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- delete the following files of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base.jar
- copy the file openmdx-base.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib)
- copy the files opencrx-core-CRX.ear and opencrx-apps-CRX.ear (the latter is only needed if you want to run openCRX/Store) from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- start openCRX
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
- you can now uninstall the new installation of openCRX as it is no longer needed
- for each of your segments (e.g. Standard) login as segment administrator (e.g. admin-Standard) and run the wizard Segment Setup (Home - Wizards > Segment Setup) to bring your configuration up to date
Upgrading from openCRX v2.7.0 to openCRX v2.8.0
 |
|
 |
|
- stop the servlet container (Tomcat, application server)
- backup your database
- upgrade your database as follows (DB scripts are available in the openCRX SDK, in the directory {openCRX_SDK_Install_Directory}\opencrx-2.8.0\core\src\sql):
- drop all (openCRX) views (statements are available in the script dbcreate-views.sql)
- execute the script upgrade-from-2.7-to-2.8.sql
- execute the script migrate-from-2.7-to-2.8.sql
- execute the script drop-from-2.7-to-2.8.sql
- on the upgraded database, execute the script dbcreate-views.sql
Hint: in case execution of the script is stopped and rolled back because of failing statements, you need to investigate the issue. DROP statements of non-existing tables/views can safely be deleted from the script. However, the CREATE statements must execute without errors. You can safely execute this script multiple times until there are no more errors.
- on the upgraded database, execute the script dbcreate-indexes.sql
Hint: execution of this script is optional; we just provide some indices as a starting point; DB tuning depends very much on the data, the usage pattern, and obviously on the DBMS you are using. Hence, running is script is no replacement for database tuning. You might have to remove statements trying to create indices that already exist.
- on the upgraded database, execute the script populate-preferences.sql
Hint: execution of this script is required to configure the database plugin - if there are any errors you must investigate the issue. You can safely execute this script multiple times until there are no errors left.
- install openCRX 2.8.0 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.8.0 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- delete the following files of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base.jar
- copy the file openmdx-base.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib)
- copy the files opencrx-core-CRX.ear and opencrx-apps-CRX.ear (the latter is only needed if you want to run openCRX/Store) from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- restart openCRX (i.e. Tomcat)
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
- you can now uninstall the new installation of openCRX as it is no longer needed
- for each of your segments (e.g. Standard) login as segment administrator (e.g. admin-Standard) and run the wizard Segment Setup (Home - Wizards > Segment Setup) to bring your configuration up to date
Upgrading from openCRX v2.8.0 to openCRX v2.8.5
 |
- Do NOT upgrade from 2.8.0 (or older versions) to 2.8.5 directly - you must upgrade to v2.8.0 first to prepare for the upgrade to v2.8.5
|
 |
|
- stop the servlet container (Tomcat, application server)
- backup your database
- install openCRX 2.8.5 with the openCRX Server Installer in a new directory (that is the easiest way to get the new files, but you could also download and install the openCRX 2.8.5 Software Development Kit to build the same files) and then proceed as follows to upgrade your existing installation:
- delete the contents of the following directories of your existing installation:
- {TOMCAT_INSTALL_DIR}/apps
- {TOMCAT_INSTALL_DIR}/temp
- {TOMCAT_INSTALL_DIR}/work
- {TOMCAT_INSTALL_DIR}/conf/Catalina/localhost
- delete the following file of your existing installation:
- {TOMCAT_INSTALL_DIR}/lib/openmdx-base.jar
- copy the file openmdx-base.jar from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/lib)
- copy the file opencrx-core-CRX.ear from the new installation to your existing installation (directory {TOMCAT_INSTALL_DIR}/apps)
- start Tomcat of your old/upgraded installation
- once you have openCRX running again, proceed as follows (detailed instructions are available in the openCRX Installation Guide for Tomcat 6):
- login as admin-Root
- import codes and data
- set the access levels of codes (you must change to the Perspective Advanced)
- start openCRX
- in the case of HSQLDB, copy your upgraded DB over the DB installed by the openCRX Server Installer, or if you use another DBMS, adapt the database connector to your own database as explained here.
- you can now uninstall the new installation of openCRX as it is no longer needed
|
|