process-automation-beam
2.0.0-rc1
Migration guide
This version contains breaking changes. Please refer to the migration guide for more information about the changes and what code is affected. In summary:
- Breaking change: A database migration is required.
TaskJobQueueis renamed toTaskJob,WorkerNodeServiceis merged withWorkerNodeand the tablesBatchJob,JobFailureandTimerJobare added. - Breaking change: The
{Workflow}Schedulerapi changed.scheduleTransitionis replaced bysubmitTransition, which returns aTaskJobResult.performTransitionis removed, useforkTransitioninstead. ThecheckSuccesshelper of the event handlers is removed. -> ReplacecheckSuccess(scheduler.scheduleTransition(...))withscheduler.submitTransition(...).throwOnError() - Breaking change: The
TaskJobQueuedata elementData Element (DataElement). A fundamental data concept or entity within an application's domain, acting as an anthropomorphic translation of a real-life object or concept. is renamed toTaskJob, including all generated artifactsArtifactA build or deployment result, such as a Docker container image or Java archive, produced by a software project.. Its status valuesCommittedandCommitFailedare replaced byQueuedForBatch,Executing,CompleteandFailed. - Breaking change: Runtime classes moved or changed:
net.democritus.processautomation.TaskJob->net.democritus.processautomation.task.TaskJobPayloadnet.democritus.processautomation.execution.TaskJobExecutor->net.democritus.processautomation.task.TaskJobExecutor,execute()now returnsTaskJobResultTaskJobProcessor.executeJob()andscheduleJob()are replaced bysubmitJob(TaskJob, Context)TaskJobQueueDriver.submitJob()returnsTaskJobResultand the interface gainscompleteJob()andrejectJob()TaskJobExecutorServiceno longer extendsExecutorStateUpdateis replaced by the generatedTransitionParamsandTransitionResultTaskJobProcessorand the queue drivers are now CDI beans (@Inject @Named) instead of EJBs
- Breaking change: The deprecated
@EJB {DataElement}LocalfieldFieldA property of a DataElement expanded to a database column and user interface input element. is removed from the{Transition}Transitioner.executeWithTargetis removed andstartTransition,endTransition,failTransitionandrecoverTransitionhave new signatures. -> Adapt custom code in the transitioner anchorsAnchorA marker within generated source code reserved for adding custom logic during re-expansion. to use the{DataElement}{Field}TransitionService - Breaking change: The
{Workflow}Transitionenum constructor changed from(String, int)to(String, Priority, int attempts)andgetPriority()returns thePriorityenum. - Breaking change: The
WorkerNodefindersFinderA search specification combining field-operator pairs to execute standard data queries on a DataElement.findByNameEq,findExpiredOnlyandfindByIsLeaderEqare removed and replaced byfindByServiceEq,findExpired,findLeader,findAwaitRecoveryandfindByValues. -> UsefindByValues(filter onnode) instead offindByNameEq - Breaking change:
WorkerNodeService.startProcessingandstopProcessingtakeParameterContext<WorkerNodeDetails>instead ofParameterContext<WorkerNodeServiceInfo>.WorkflowRecoveryrequires aString getServiceName()method.PauseWorkerNodePerformer.withScheduler()takes aWorkerNodeRequestScheduler. - Breaking change:
Jackson.javamoved fromlogic/exttologic/genandOBJECT_MAPPERis now private. -> UseJackson.getObjectMapper()and remove overlays ofJackson.java - Breaking change: The
target.class.customoption on TaskElement is no longer supported. -> Use theMigrateCustomTargettransmutation to move it to thetransition.parameter.classoption on the Transition - Breaking change: The options
transition.noSelfLoop,workflow.priorityandprocessAutomation.TimerJob.enableare removed. -> Usejob.priorityinstead ofworkflow.priority. Self loops are always prevented and TimerJob is always enabled. - Transitions are now retried up to 5 times by default. Tasks must tolerate being executed more than once.
-> Set
job.attemptsto1on the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. to keep the old behavior
New features
- The beam now includes
process-automation-tracing, which logs each completed transition:Transition complete, target:<Order id=8489>, workflow:<Workflow name=OrderFlow>, transition:<Transition name=Fulfill>, from:<State name=Fulfilling>, to:<State name=Fulfilled>- For some cases this is too verbose or an alternative implementation exists. To disable the behavior add the
processAutomation.tracelog.excludeoption to the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. or the#processAutomation.tracelog.disabletag to your profile.
- For some cases this is too verbose or an alternative implementation exists. To disable the behavior add the
- Added
process-automation-angularwith thenet.democritus:feature-modules::process-automationAngular feature module. - Added automatic retries with exponential backoff for failed tasks.
- Added
job.attemptsoption to configure the max number of attempts (default: 5).
- Added
- Added
JobFailuredata elementData Element (DataElement). A fundamental data concept or entity within an application's domain, acting as an anthropomorphic translation of a real-life object or concept. to register failures of task and batch jobs, with aretrycommand. - Added
BatchJobdata elementData Element (DataElement). A fundamental data concept or entity within an application's domain, acting as an anthropomorphic translation of a real-life object or concept.. FlowEngine and Schedule triggers now submit batches to the queue. - Added
job.attemptsoption to configure the max number of attempts (default: 5). - Added
job.priorityoption to configure the priority of a job. - Added
batch.maxConcurrentJobsoption to configure the maximum number of concurrent jobs used for a batch. - Added
batch.jobSizeoption to configure the targeted number of tasks in a single batch job (default: 10). - Added
batch.maxFetchSizeoption to configure the LIMIT on batch trigger queries. - Added
batch.unmanagedoption to opt-out of managed batches for performance. Will submit all tasks directly to the queue instead. - Added
batch.timeoutoption to configure the window in which a batch must complete (default: 1h). - Added
transition.parameter.classoption to Transition as a replacement fortarget.class.customon TaskElement.- Added
MigrateCustomTargettransmutation to move thetarget.class.customoption of a TaskElement totransition.parameter.classon its Transitions.
- Added
- Added
transition.skipStatusUpdatesoption to Transition to skip the workflow status update, leaving all target state changes to the task implementation. - Added
PROCESS_AUTOMATION_STARTUP_DELAYenvironment variable to delay the startup of WorkerNodes (in seconds, negative to disable startup) andWorkerNodeStartupapi to decide when WorkerNodes are allowed to start.
Changes
TimerJobis always enabled. TheprocessAutomation.TimerJob.enableoption and#processAutomation.timerJobtag are no longer needed.WorkerNodehas a lifecycle and leader election for each service separately.maxConcurrentJobsof the QueuedProcessor is merged intomaxSubmittedJobs. The queue manages local caching.schedule.maxFetchSizeis renamed tobatch.maxFetchSize. The old name is still accepted.- A Schedule tick is skipped when the previous batch is still active.
on transitionevent handlers ignore self transitions.WorkerNodeshows the statusUnresponsivewhen it has not been updated for more than 8 seconds.- Removed
ErrorRatepolicy implementation.
Stability and fixes
- Fixed
TaskJobentries vanishing when an error occurred during execution.TaskJobnow keeps its state (Executing,Complete,Failed). - Fixed
WorkerNodeServiceillegally claiming the leader role in some cases. - Fixed Schedule triggers submitting jobs indefinitely when the queue stopped working.
- Fixed missing custom anchorsAnchorA marker within generated source code reserved for adding custom logic during re-expansion. for dynamic schedules.
Beam composition changed
- Replaced the
process-automation-componentdependency with its underlying expansion resourcesExpansion Resource (ExpansionResource). A reusable resource bundle containing expanders and features that provide specific application capabilities, defined in the expansion settings and added to the classpath during expansion.:net.democritus.processautomation:process-automation-core::2.0.0net.democritus.processautomation:process-automation-model::2.0.0net.democritus.processautomation:process-automation-knockout::2.0.0net.democritus.processautomation:process-automation-struts::2.0.0net.democritus.processautomation:process-automation-angular::2.0.0(new)net.democritus.workflow:process-automation-tracing::2.0.0(new)net.democritus.workflow:workflows-expanders::1.13.0net.democritus.workflow:workflows-enums-expanders::1.13.0
1.2.0 (2026-08-04)
- Updated
process-automation-componentto version1.14.1
Migration guide
net.democritus:Expanders::9.4.0is required, ifnet.democritus:Expandersis used. -> Useminimal-jee-beam::2.2.0+or removenet.democritus:Expandersfrom the dependencies completelynet.democritus:web-styles-expanders::2026.4.0is required, ifnet.democritus:web-styles-expandersis used. -> Useminimal-jee-beam::2.2.0+,knockout-frontend-beam::1.0.0+or removenet.democritus:web-styles-expandersfrom the dependencies completelynet.democritus.enumtypes:enum-type-expanders::2.5.0is required, ifnet.democritus.enumtypes:enum-type-expandersis used -> Usenet.democritus.bundles:enum-type-bundle::2.5.0+- When making use of the new TimerJobService (see below), a database migration is necessary. More info here.
- Adapt custom code if compilation errors occur. This will only be necessary when the custom code uses one of the (re)moved methods from the internal process-automation classes.
New features
- Added
TimerJobServiceto schedule jobs at a specific point in time.- Enabled through the
processAutomation.TimerJob.enableoption or#processAutomation.timerJobtag.
- Enabled through the
- Added
FieldTimertrigger based on the timestamp of a fieldFieldA property of a DataElement expanded to a database column and user interface input element..- Added option
trigger.timer.offsetto add an offset to a FieldTimer trigger.
- Added option
Stability and fixes
- Fixed missing error handling issue when cancelling processing policy timers.
- Fixed ApplicationPersistence queue crashing due to fetch timeout. Will now retry the fetch instead.
- Fixed ApplicationPersistence claim query to make use of the status index if available.
- Add semaphore to control the amount of jobs submitted to the ThreadPoolExecutor.
- Improved
/healthcheckstability by watching lastUpdatedAt and allowing more states to be considered active. - Moved various methods between internal classes to improve interfaces.
Known issue
- The asynchronous executor sometimes fails to schedule tasks, essentially halting some workflows. A workaround for this
is to use the
ExecutorServiceprocessing instead ofAsynchronousprocessing. See Processing Types.- This issue can occur in any of the process-automation-beam versions when used in combination with Jakarta
1.1.0 (2026-02-04)
Changed
- Updated
process-automation-componentto version1.12.2
Removed
- Breaking change: findByIsLeaderEq, findByStatusSe and findByRequestSe findersFinderA search specification combining field-operator pairs to execute standard data queries on a DataElement. of the WorkerNode data elementData Element (DataElement). A fundamental data concept or entity within an application's domain, acting as an anthropomorphic translation of a real-life object or concept. have been removed from the view layerLayerLogical separation of functionality within a single system/application, focused on code organization.