Migrate from ZK Spreadsheet

This section is designed for users coming from ZK Spreadsheet (ZSS). Please make sure to back-up your current project before upgrading.

Drop-in Upgrade (Evaluation Only)

This approach can quickly turn your existing ZSS application to Keikai (EE) application without modifying your source. Note that this is for evaluating purpose only as it does not cover all Keikai features. To officially migrate your existing ZSS application to Keikai, please read the next section: How to migrate from ZSS.

The steps for quick try are:

  1. download the latest keikai-zss-legacy-all-[VERSION].zip
  2. extract the zip. It produces 2 sub folders: bin and lib
  3. put your ZSS application war under the same folder
  4. go to the folder and run

/bin/repack.sh WAR_FILE_NAME.war

If it succeeds, the repacked, new WAR with the same name will be put under the same folder. Your original WAR will be renamed to WAR_FILE_NAME.backup. Just run the repacked WAR file – it is a Keikai App already!

(Note: This approach renames Keikai jar file in bytecode level at run-time by jarjar which is not recommended in the production environment.)

How to Migrate (Server-side)

It is very easy to migrate your existing ZSS project to Keikai, just need to handle the following changes:

JAR Change (zss*.jar –> keikai*.jar)

Replace all ZSS related JAR (OSE or EE) with Keikai related JAR (OSE or EE).

Maven Users

Please reference Keikai OSE pom.xml or EE pom.xml.

Non-Maven Users (manually include Jar)

  1. Download Keikai OSE (keikai-bin-[VERSION].zip) or Keikai EE (keikaiee-bin-[VERSION].zip) binary zip.
  2. Remove all zss*.jar
  3. copy /dist/*.jar in the zip into your Keikai project

Please don’t mix different versions of jar in the same war (e.g. you should not have both zk-8.0.2.jar and zk-9.0.0.jar), this will cause errors.

API Packages Change (org.zkoss.zss –> io.keikai)

Only the package names are changed, and all method names are unchanged. For example, org.zkoss.zss.api.Range.setValue() turns to be io.keikai.api.Range.setValue(). You just need to replace the old import package name (org.zkoss.zss) with new ones (io.keikai). It’s better to use your IDE keyboard shortcut to quickly replace import statements.

License Path Change

This is for paying customers only. Please refer to Applying License Key.

Sheet Tab Context Menu is Hidden by Default

Keikai adds a new attribute showSheetTabContextMenu. If you want to show the context menu on a sheet tab you need to specify as follows:

<spreadsheet showSheetbar="true" showSheetTabContextMenu="true"/>

Custom Function Prefix Change

The prefix now should be keikai like:

<?xel-method prefix="keikai" name="CHAIN" ...?> 
<?taglib uri="/WEB-INF/tld/function.tld" prefix="keikai" ?>

Deprecated Methods are Removed

Those classes and methods marked as deprecated in ZSS 3.9 are removed in Keikai. Usually, you will find an alternative method in the same class or you can check ZSS Javadoc.

Removed Component Attributes

Some deprecated setter method of Spreadsheet are removed which means the corresponding attributes are no long supported, either, e.g. maxrows. Please check Deprecated Methods at ZSS Javadoc.

How to Migrate (Client-side)

If you have previously applied any custom CSS or JavaScript to your existing ZSS application, it is very likely that it no longer works in Keikai since we have optimized Keikai’s UI and client widgets for better performance and usability. You may need to redo the corresponding customization on Keikai, or maybe there is a server-side approach in Keikai. We need to check this case by case. Please contact with us.

Client-side Major change between ZSS and Keikai

  • Scrollbar is simulated by HTML elements (ZSS uses browser native scrollbar)
  • Generate most CSS rules at client-side instead of server-side
  • Hidden rows now don’t render their DOM elements (save memory)
  • Upgrade Highcharts to
  • Minor change in auto filter popup style
  • Toolbar widget and its DOM structure, CSS class names changed, starting with k-toolbar. (If you need to customize toolbar, please refer to Toolbar Customization.) since 5.2.0

Backward Compatibility

The following configurations also change in Keikai, but you can keep your original one since Keikai still reads the old configuration.

Supported Excel format

While you can import xlsx (Excel 2007+) files and some of the xls (Excel 2003) files into ZSS, Keikai works best with the Open XML xlsx (Excel 2007+) format. The legacy xls format is not supported in Keikai.

Migrate ZSS App to Keikai App

If you have been using ZSS App, and you wish to migrate it to Keikai App, here are the steps:

  1. Download keikai-app
    Since the API package names are changed, you can’t just run the original ZSS App war with Keikai JARs. You will have to download Keikai App war file instead. Choose either the OSE edition or the EE edition based on the edition you are currently with.
  2. Move Excel files from zssapp to keikai-app
    The default folder to store Excel files is /WEB-INF/books/. If you have previously specified another path in zk.xml with the property zssapp.repository.root, then the files will be in the folder you specified. Copy these files from the folder to the corresponding folder in Keikai app.
  3. Migrate zk.xml from zssapp to keikai-app
    Copy /WEB-INF/zk.xml from the previous zssapp and overwrite keikai-app’s /WEB-INF/zk.xml. No additional change is required because Keikai app is made ready for backward compatibile and can read old(ZSS) property keys in zk.xml.

Upgrading ZK

If you were with “ZK Spreadsheet + ZK 8.0”, we recommend you to upgrade to “Keikai + ZK 9.x” or “Keikai + ZK 8.6.x”. Here are some tips for ZK upgrade. For a more complete ZK upgrade guide visit here

Default theme changed since ZK 8.5

Since ZK 8.5 the default theme has been changed to Iceblue which has a modern design and bigger padding and margin. This means you will need to adjust your application layout to fit the new default theme. If you are not ready for the new theme, you can fall back to the previous breeze/silvertail/sapphire themes. Alternatively for ZK 8.6+ you can use the iceblue compact theme which has a modern design but also a compatible padding and margin with breeze, so you can keep your existing layout.

Requires JDK 8+ since ZK 9.0

ZK 9 works with Java 8 and later versions. ZK 8.6 and older versions work with Java 6+.

jQuery version upgraded to 3.5.1 since ZK 9.1

jQuery is upgraded from 1.x to 3.5.1 since ZK 9.1.0. If you have patches or custom client-side code you may need to upgrade accordingly.

Get code at GitHub