Development

This section provides resources for developers working with OpenKM.

The OpenKM development environment is provided as an installer, giving the user full flexibility to choose the operating system (Windows or Linux), the database engine (MariaDB, MySQL, PostgreSQL, or Oracle), and the target machine — whether a dedicated host or a virtualized environment. For more details, refer to the Personal development environment section.

Recommended tools

The following tools are not required but are recommended to improve the development experience:

• IDE: We recommend using IntelliJ IDEA. Eclipse is also a valid option, though IntelliJ is our preferred choice.
• Database client: We recommend DBeaver, a free and versatile database client that works with all supported databases.
• Report design: If you plan to create reports, we recommend creating an account at jaspersoft.com and installing the community edition of JasperSoft Studio.

Note

Code samples and development examples are provided as part of the OpenKM Developer Course. If you are interested in accessing the course or require further information, please contact your OpenKM sales representative.

Javadoc

Each OpenKM version is created with a complete Javadoc available at http://docs.openkm.com/apidoc/.