Skip to main content

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. TaskJobQueue is renamed to TaskJob, WorkerNodeService is merged with WorkerNode and the tables BatchJob, JobFailure and TimerJob are added.
  • Breaking change: The {Workflow}Scheduler api changed. scheduleTransition is replaced by submitTransition, which returns a TaskJobResult. performTransition is removed, use forkTransition instead. The checkSuccess helper of the event handlers is removed. -> Replace checkSuccess(scheduler.scheduleTransition(...)) with scheduler.submitTransition(...).throwOnError()
  • Breaking change: The TaskJobQueue 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. is renamed to TaskJob, including all generated artifactsArtifactA build or deployment result, such as a Docker container image or Java archive, produced by a software project.. Its status values Committed and CommitFailed are replaced by QueuedForBatch, Executing, Complete and Failed.
  • Breaking change: Runtime classes moved or changed:
    • net.democritus.processautomation.TaskJob -> net.democritus.processautomation.task.TaskJobPayload
    • net.democritus.processautomation.execution.TaskJobExecutor -> net.democritus.processautomation.task.TaskJobExecutor, execute() now returns TaskJobResult
    • TaskJobProcessor.executeJob() and scheduleJob() are replaced by submitJob(TaskJob, Context)
    • TaskJobQueueDriver.submitJob() returns TaskJobResult and the interface gains completeJob() and rejectJob()
    • TaskJobExecutorService no longer extends Executor
    • StateUpdate is replaced by the generated TransitionParams and TransitionResult
    • TaskJobProcessor and the queue drivers are now CDI beans (@Inject @Named) instead of EJBs
  • Breaking change: The deprecated @EJB {DataElement}Local fieldFieldA property of a DataElement expanded to a database column and user interface input element. is removed from the {Transition}Transitioner. executeWithTarget is removed and startTransition, endTransition, failTransition and recoverTransition have 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}Transition enum constructor changed from (String, int) to (String, Priority, int attempts) and getPriority() returns the Priority enum.
  • Breaking change: The WorkerNode findersFinderA search specification combining field-operator pairs to execute standard data queries on a DataElement. findByNameEq, findExpiredOnly and findByIsLeaderEq are removed and replaced by findByServiceEq, findExpired, findLeader, findAwaitRecovery and findByValues. -> Use findByValues (filter on node) instead of findByNameEq
  • Breaking change: WorkerNodeService.startProcessing and stopProcessing take ParameterContext<WorkerNodeDetails> instead of ParameterContext<WorkerNodeServiceInfo>. WorkflowRecovery requires a String getServiceName() method. PauseWorkerNodePerformer.withScheduler() takes a WorkerNodeRequestScheduler.
  • Breaking change: Jackson.java moved from logic/ext to logic/gen and OBJECT_MAPPER is now private. -> Use Jackson.getObjectMapper() and remove overlays of Jackson.java
  • Breaking change: The target.class.custom option on TaskElement is no longer supported. -> Use the MigrateCustomTarget transmutation to move it to the transition.parameter.class option on the Transition
  • Breaking change: The options transition.noSelfLoop, workflow.priority and processAutomation.TimerJob.enable are removed. -> Use job.priority instead of workflow.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.attempts to 1 on 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.exclude option to the applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution. or the #processAutomation.tracelog.disable tag to your profile.
  • Added process-automation-angular with the net.democritus:feature-modules::process-automation Angular feature module.
  • Added automatic retries with exponential backoff for failed tasks.
    • Added job.attempts option to configure the max number of attempts (default: 5).
  • Added JobFailure 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. to register failures of task and batch jobs, with a retry command.
  • Added BatchJob 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.. FlowEngine and Schedule triggers now submit batches to the queue.
  • Added job.attempts option to configure the max number of attempts (default: 5).
  • Added job.priority option to configure the priority of a job.
  • Added batch.maxConcurrentJobs option to configure the maximum number of concurrent jobs used for a batch.
  • Added batch.jobSize option to configure the targeted number of tasks in a single batch job (default: 10).
  • Added batch.maxFetchSize option to configure the LIMIT on batch trigger queries.
  • Added batch.unmanaged option to opt-out of managed batches for performance. Will submit all tasks directly to the queue instead.
  • Added batch.timeout option to configure the window in which a batch must complete (default: 1h).
  • Added transition.parameter.class option to Transition as a replacement for target.class.custom on TaskElement.
    • Added MigrateCustomTarget transmutation to move the target.class.custom option of a TaskElement to transition.parameter.class on its Transitions.
  • Added transition.skipStatusUpdates option to Transition to skip the workflow status update, leaving all target state changes to the task implementation.
  • Added PROCESS_AUTOMATION_STARTUP_DELAY environment variable to delay the startup of WorkerNodes (in seconds, negative to disable startup) and WorkerNodeStartup api to decide when WorkerNodes are allowed to start.

Changes​

  • TimerJob is always enabled. The processAutomation.TimerJob.enable option and #processAutomation.timerJob tag are no longer needed.
  • WorkerNode has a lifecycle and leader election for each service separately.
  • maxConcurrentJobs of the QueuedProcessor is merged into maxSubmittedJobs. The queue manages local caching.
  • schedule.maxFetchSize is renamed to batch.maxFetchSize. The old name is still accepted.
  • A Schedule tick is skipped when the previous batch is still active.
  • on transition event handlers ignore self transitions.
  • WorkerNode shows the status Unresponsive when it has not been updated for more than 8 seconds.
  • Removed ErrorRate policy implementation.

Stability and fixes​

  • Fixed TaskJob entries vanishing when an error occurred during execution. TaskJob now keeps its state (Executing, Complete, Failed).
  • Fixed WorkerNodeService illegally 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-component dependency 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.0
    • net.democritus.processautomation:process-automation-model::2.0.0
    • net.democritus.processautomation:process-automation-knockout::2.0.0
    • net.democritus.processautomation:process-automation-struts::2.0.0
    • net.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.0
    • net.democritus.workflow:workflows-enums-expanders::1.13.0

1.2.0 (2026-08-04)​

  • Updated process-automation-component to version 1.14.1

Migration guide​

  • net.democritus:Expanders::9.4.0 is required, if net.democritus:Expanders is used. -> Use minimal-jee-beam::2.2.0+ or remove net.democritus:Expanders from the dependencies completely
  • net.democritus:web-styles-expanders::2026.4.0 is required, if net.democritus:web-styles-expanders is used. -> Use minimal-jee-beam::2.2.0+, knockout-frontend-beam::1.0.0+ or remove net.democritus:web-styles-expanders from the dependencies completely
  • net.democritus.enumtypes:enum-type-expanders::2.5.0 is required, if net.democritus.enumtypes:enum-type-expanders is used -> Use net.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 TimerJobService to schedule jobs at a specific point in time.
    • Enabled through the processAutomation.TimerJob.enable option or #processAutomation.timerJob tag.
  • Added FieldTimer trigger 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.offset to add an offset to a FieldTimer trigger.

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 /healthcheck stability 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 ExecutorService processing instead of Asynchronous processing. 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-component to version 1.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.

1.0.0 (2025-08-14)​

  • Created process-automation-beam project.

Added​

  • process-automation-component:1.10.1