Persistence

This chapter introduces the Persistence Configuration Editor and the Persistence API of Axon Ivy. The persistence framework is based on the Jakarta Persistence API (also known as the Java Persistence API or JPA) and the Jakarta Data API. It offers support for storing and retrieving business objects to and from a database.

To use automated persistence in your business or User Dialog processes, you need to define Entity Classes first. An entity class is similar to a data class (i.e., a business object) but holds additional information that is used to map the class to a database table and its attributes to database table columns.

You need to define at least one persistence unit configuration. A persistence unit manages some or all of your entity classes and specifies the database where those entities are stored. Once you have configured one or more persistence units, you can use them in your process steps either with the convenient Data Repository API or, for complex use cases, with the Persistence API. These APIs allow you to perform create, read, update, and delete (CRUD) operations on entity objects directly in the database. The Data Repository API provides a straightforward and efficient way to manage your data for most scenarios, while the Persistence API offers greater flexibility and control for handling more intricate and specialized data manipulation tasks.

• Entity Classes
• New Entity Class Wizard
• Entity Class Editor
• Persistence Configuration Editor
• Generate database schema
• Data Repository API
• Persistence API