Plugin: Keikai Spreadsheet Enterprise Component

Creator: James Chu
SPONSOR: zkoss.org
iDempiere version: 13
License: This plugin is licensed under the GNU GPLv2 or later. The plugin source code itself does not include Keikai EE.
Source: GitHub repository
Dependencies: This plugin depends on Keikai EE and related ZK EE components, which are commercial products and are not covered by this plugin’s open-source license. Users must obtain valid licenses for these components separately for production use.

Description

This plugin enables iDempiere implementors to use Keikai Spreadsheet Enterprise in iDempiere without modifying iDempiere core. It is designed as an optional add-on: you can install/uninstall it as standard iDempiere OSGi plugins.
Keikai EE requires a proper commercial license/subscription from ZK. iDempiere core uses ZK CE by default. This plugin is intended for implementors who have Keikai EE access.
The plugin follows the OSGi fragment pattern. The fragment attaches Keikai runtime libraries to the iDempiere ZK host bundle, so ZK can discover Keikai components, resources, and exporters at runtime.

The fragment project provides Keikai Spreadsheet runtime libraries to the iDempiere runtime as an OSGi add-on.
Includes Keikai Enterprise modules such as keikai, keikai-ex, keikai-model, and keikai-pdf.
Registers the Keikai PDF exporter so spreadsheet content can be exported to PDF.
Includes an optional example form that renders a Keikai spreadsheet component in iDempiere.
The example form loads a workbook from web/blank.xlsx.
The example enables common spreadsheet UI features such as toolbar, formula bar, and context menu.
Example toolbar actions include New Book, Save Book, and Export PDF.
Keep iDempiere core unchanged through plugin-based integration.

Install both generated OSGi bundles into your iDempiere runtime:
- org.idempiere.keikai.fragment
- org.idempiere.keikai.example

Install them the same way as other iDempiere plugins, for example through the Apache Felix Web Console or by deploying them into the runtime plugin directory.

Note: A server restart is recommended after installing or updating the fragment. ZK reads component definitions and library properties during web application initialization, so fragment changes may not be fully picked up by hot-swapping only the example bundle.

After installation, confirm the fragment and example plugin are active in the OSGi runtime.
Log in to iDempiere and open the included Keikai example form from the menu.
Verify that the spreadsheet renders correctly and that the sample workbook loads.
Use the toolbar to test spreadsheet features such as editing, saving, and PDF export.
If you want to use Keikai Spreadsheet in your own windows/forms, add dependencies on this plugin and develop your own iDempiere form as usual.
Demo builds may include evaluation versions of Keikai EE for demonstration purposes only. A valid commercial license is required for production use.

The fragment host is org.adempiere.ui.zk.
The example plugin is a normal iDempiere plugin that registers a form and loads a ZUL page containing the Keikai spreadsheet component.
The Keikai workbook path is resolved by Keikai’s workbook loader. In the sample, the spreadsheet uses src="web/blank.xlsx".
PDF export requires the Keikai PDF module and its related runtime dependencies.

If you would like to discuss specific use cases or workflows for this plugin, we’d be happy to hear from you. Please feel free to contact the ZK Framework team at info@zkoss.org.
If you want to provide additional comments, please use:
- General support forum: iDempiere Community
- Issues for this plugin: GitHub Issues