Migration notes 2.5

This page explains the changes required to migrate to the stated version of the Atoti Workflow Common Library.

Migrate to 2.5.0

Artifact group ID

The artifact’s group ID has changed. To import this dependency, you now need to use:

<dependency>
    <groupId>com.activeviam.solutions.services</groupId>
    <artifactId>workflow-core</artifactId>
    <version>${workflow-core.version}</version>
</dependency>

Changes to IAuditLogService

The IAuditLogService interface has been updated to include the following two methods:

/**
	 * @return The list of types of audit logs
	 */
	List<String> getTypes();

	/**
	 * Retrieves a subset of the audit logs
	 *
	 * @param type The type of the auditable object
	 * @return A filtered subset of audit entries matching type and key.
	 */
	List<AHistoryRecordDTO> getHistory(String type);

You must implement these in your custom implementations of the interface.

Database changes

The following changes have been made to the database schema and will require manual migrations:

  1. The measures field has been removed from the AWorkflowProcessDefinitionEntity class as it is not used. You should remove this column from any tables mapped to this entity in your database. For example, if you have a table mapped by the name processDefinition, this can be done by executing the following SQL statement:
    ALTER TABLE "PUBLIC"."processDefinition" DROP COLUMN "measures";
    
    This is not required to start Atoti Workflow Common Library, but is recommended to keep your database schema clean.

JPA changes

The JPA entities are now updated to their current version in their respective JPA repositories. This differs from the previous behavior where the repositories were append-only. To do this, the updatable = false annotation value that was previously present has been removed from the following entities:

  • AWorkflowProcessDefinitionEntity
  • ABitemporalObjectEntity