Preparing Updates and Upgrades

You can update and upgrade the following:

• Modules: upload new versions of modules
• LSPS Application: deploy a newer version of the LSPS Application
• LSPS:
  • upgrade to a patch version of LSPS
  • upgrade to a minor or major version of LSPS

Preparing Module Update

When new versions of modules are ready and their previous versions are used in production, you need to handle their running model instances:

• If modules are not restartable, you need to perform model update on all running model instances. Mind that the process can be complex and is generally discouraged.
• If modules introduce changes to data models with shared records, you need to update the database tables that hold the data first (you can generate database schema update scripts for the new model versions from the Management perspective of PDS, and modify them as necessary).

The artifacts to distribute when updating modules are

• new modules and models exported with GO-BPMN export
• model update definition files
• database-schema update scripts

Update of the LSPS Application

If you have changed only the code of the LSPS Application, it is enough to build the new EAR and deploy it.

If you need to update modules as well, make sure

• to update modules, running model instances, and underlying database tables;
• the application does not introduce any backwards-incompatible changes; For example, if you have removed a custom function from your application and the function is being used by a running model instance, the update of the model instance will fail.

The artifacts necessary for update of LSPS Application with backwards-compatible changes are

• LSPS Application EAR If providing updated of modules as well:
• optionally:
  • new modules and models exported with GO-BPMN export
  • model update definition files
  • database-schema update scripts

Preparing LSPS Upgrade to a New Patch Version

If you want to upgrade to a new patch version of LSPS, To upgrade the entire LSPS stack to a new patch version (x.y.z), you need to do the following:

1. Install the new PDS with SDK.
2. In the root pom.xml, update the LSPS version:
   1. Update the parent version

      <parent>
        <groupId>com.whitestein.lsps</groupId>
        <artifactId>lsps</artifactId>
        <version><NEW_VERSION></version>
      </parent>
      

   2. Update the lsps version

      <properties>
        <lsps.version><NEW_VERSION></lsps.version>
      </properties>
      

   3. In the openejb.xml of the >YOUR_APP<-embedded, remove the h2 directory and change the path to the database to JdbcUrl jdbc:h2:tcp://localhost/./h2/h2;MVCC=TRUE;LOCK_TIMEOUT=60000
3. Build the application.
4. Deploy the EAR to your application server.

Note: If you perform an update to a minor or major version in this way the application might lack new features.

The artifacts to distribute:

• LSPS Application EAR

Preparing LSPS Upgrade to a New Minor or Major Version

To upgrade the entire LSPS stack to a new minor (x.y) of major version (x) of LSPS, do the following:

1. Install and run the new PDS with SDK.
2. Generate a new LSPS Application.
3. Commit the initial state of the application to separates your changes from the initial state of the application.
4. Apply the commits with customizations from your application: when under git, create a patch from the commits that customized the LSPS Application since it was generated and apply it on the newly generated LSPS Application.
5. Build the application.
6. Prepare upgraded modules:
   1. Import the modules into the workspace.
   2. For non-restartable models, prepare model update definitions;
   3. If the modules change the data model of persisted data (shared records and their relationships), prepare also the database-schema update scripts.
   4. Export the updated models with GO-BPMN Export.

The artifacts to distribute when upgrading LSPS are

• LSPS Application EAR
• modules and models exported with GO-BPMN export
• model update definition files
• database schema script for business data when applicable