CHANGELOG.md

Change Log

[1.0.3] - 2024-08-09

• save context changes before suspend and apply to new context after resume.

[1.0.2] - 2024-02-21

Changed

• fix resume from the same step when out variables are present.

[1.0.1] - 2022-02-04

Changed

• use GraalVM JS's Nashorn compatibility mode.

[1.0.0] - 2021-08-24

Changed

• use GraalVM JS as the default JavaScript runtime.

[0.59.0] - 2020-05-05

Added

• new EngineListener method onUnhandledException.

[0.58.2] - 2019-09-26

Changed

• forms: interpolate labels.

[0.58.1] - 2019-07-18

Changed

• fixed the ExecutionContext#CURRENT_FLOW_NAME_KEY variable state when copyAllCallActivityOutVariables is enabled.

[0.58.0] - 2019-06-20

Added

• boundary error events support for ScriptTasks.

[0.57.0] - 2019-06-09

Added

• new variable Execution#CURRENT_FLOW_NAME_KEY: contains the name of the current flow.

Changed

• detect cycles in arrays when interpolating values.

[0.56.1] - 2019-05-20

Changed

• improved behavior of the Interpolator in case of circular references;
• fixed FormExtension serialization issue - make it compatible with previously serialized versions.

[0.56.0] - 2019-05-17

Added

• support for expressions in form names in UserTask/FormExtension.

[0.55.0] - 2019-03-21

Added

• allow expressions in script names in ScriptTask.

Breaking

• ExecutionContext#suspend(String messageRef, Object payload) replaced with #suspend(String messageRef, Object payload, boolean resumeFromSameStep).

[0.53.0] - 2019-02-19

Changed

• refactor Interpolator to make it more useful outside of the tasks.

[0.52.1] - 2019-02-10

Changed

• change the visibility the utility methods of DefaultFormValidatorLocale for easier subclassing.

[0.52.0] - 2019-02-03

Added

• new version of Engine#start method: allow passing in predefined Variables.

[0.51.1] - 2019-01-27

Changed

• fixed the handling of the execution#suspend() flag when running a ScriptTask.

[0.51.0] - 2018-12-11

Added

• ability to override the order of EL resolvers.

Changed

• fixed handling of Sets in Interpolator.

[0.50.0] - 2018-11-05

Added

• support for custom form fields in form-based user tasks.

[0.49.0] - 2018-10-30

Changed

• implement eval and interpolate for read-only contexts;
• if a task fails, ignore OUT expression evaluation errors.

[0.48.0] - 2018-10-17

Added

• implemented MapBackedExecutionContext#getVariableNames and #toMap allowing tasks to enumerate all available variables.

[0.47.1] - 2018-08-14

Changed

• exceptions thrown while resolving IN variables are now correctly handled and can trigger boundary error events.

[0.47.0] - 2018-08-07

Added

• optional event payload (see Event#getPayload and ExecutionContext#suspend(messageRef, payload)).

Changed

• validate results of boolean expressions when branching.

[0.46.0] - 2018-07-18

Added

• support for expressions in CallActivity targets.

[0.45.0] - 2018-07-07

Added

• Element event's variables can now be retrieved using InterceptorElementEvent#getVariables.

[0.44.0] - 2018-05-09

Added

• new method ExecutionContextFactory#withOverrides. Used to create contexts with variable overrides.

Breaking

• ExecutionContextFactory moved to bpm-engine-api.

[0.43.0] - 2018-04-24

Added

• ExecutionContext#getProcessDefinitionId and #getElementId() methods to provide additional process metadata for tasks and expressions.

[0.42.0] - 2018-04-06

Added

• ExecutionContext#suspend to suspend a process from a task or an expresssion.

[0.41.0] - 2018-03-23

Added

• support for TerminateEvent.

[0.40.0] - 2017-12-14

Added

• support for custom field validators in the DefaultFormValidator.

Changed

• fixed handling of booleans in forms.

[0.39.0] - 2017-11-09

Added

• allow users to supply their own UuidGenerators in EngineBuilder.

[0.38.0] - 2017-10-24

Added

• added support for boolean form fields;

Changed

• fixed last expression result saving when using a JavaDelegate;
• cleaned up value removal and error handling in the LevelDB persistence provider.

[0.37.0] - 2017-10-13

Added

• io.takari.bpm.EngineListener interface to handle internal events;
• Engine#resume methods to resume a process and merge nested input data into the process' variables.

[0.36.2] - 2017-09-10

Changed

• preserve the order of variable definitions. This should fix the newly found issues with variable interpolation.

[0.36.1] - 2017-08-29

Changed

• fix the issue with non-standard JavaDelegates.

[0.36.0] - 2017-08-23

Added

• pluggable JavaDelegate handlers.

[0.35.0] - 2017-08-18

Added

• allow users to provide their own ExecutionContext implementations by introducing ExecutionContextFactory;
• support different ExecutionContext variable names other than execution.

[0.34.0] - 2017-08-15

Added

• ExpressionManager#interpolate can now interpolate recursive values in the same Map object;
• new ExecutionContext#interpolate method.

[0.33.1] - 2017-08-14

Changed

• small performance optimization of ExpressionManager#interpolate.

[0.33.0] - 2017-07-27

Added

• ScriptTask#copyAllVariables and ServiceTask#copyAllVariables options: if true, copies all variables of the current context in addition to any IN-variables set.

[0.32.1] - 2017-07-24

Changed

• fixed an issue with ProcessDefintionBuilder#tieForks() logic.

[0.32.0] - 2017-07-24

Added

• Configuration#copyAllCallActivityOutVariables: enables implicit copying of CallActivity's variables back into the parent context.

[0.31.2] - 2017-07-17

Changed

• forms are capturing only relevant environment values now;
• fixed the issue with loops and parallel gateways.

[0.31.1] - 2017-06-06

Changed

• fixed handling of end events in ProcessDefinitionBuilder.

[0.31.0] - 2017-06-04

Added

• form option values are now interpolated and can contain expressions.

Changed

• fixed an issue with interpolating immutable maps.

[0.30.0] - 2017-06-03

Changed

• default expression manager implementation switched to Glassfish EL 3.0.

[0.29.0] - 2017-05-26

Changed

• FormValidatorLocale now accepts FormField objects instead of just field names;
• DefaultFormValidatorLocale now uses form field labels (if available).

[0.28.0] - 2017-05-20

Added

• expose available task beans to ScriptTasks using the provided tasks binding.

Changed

• prevent errors from copying in another event's state.

[0.27.0] - 2017-05-17

Added

• handling of BpmnError thrown from a ScriptTask;
• Configuration#wrapAllExceptionsAsBpmnErrors: if true, then any non-BpmnError exceptions will be wrapped as one (without an error reference).

[0.26.1] - 2017-05-17

Changed

• now the last handled error available immediately in ExecutionContext.

[0.26.0] - 2017-05-12

Added

• script engine can now be selected based on an file extension of an external script used in a ScriptTask;

[0.25.0] - 2017-05-01

Added

• Form#options to store additional metadata for a form call;

[0.24.0] - 2017-04-25

Added

• expose all context variables to a ScriptTask. Now those variables can be used directly, without the need in execution.getVariable("myVar").

[0.23.0] - 2017-04-25

Added

• ExecutionContext#toMap method. It returns all variables defined in the specified context with changes applied and preserving shadowed values.

Changed

• upgrade Maven wrapper to 3.5.0;
• upgrade the parent pom.

[0.22.0] - 2017-04-11

Added

• new configuration parameter: Configuration#interpolateInputVariables. If set to true, then values of input variables (Engine#start) will be evaluated using a configured ExpressionManager.

[0.21.1] - 2017-04-02

Changed

• fix form defaults: copy existing values before calculating default field values.

[0.21.0] - 2017-03-30

Added

• FormField#allowedValue allows to specify an allowed value for a field. The value can be of any (serializable) type, process using ExpressionManager#interpolate and can contain expressions.

Breaking

• FormField#valueExpr replaced with FormField#defaultValue. This value will be processed using ExpressionManager#interpolate and can contain expressions.

[0.20.1] - 2017-03-27

Changed

• new parent POM version;

[0.20.0] - 2017-03-26

Added

• ProcessDefinitionBuilder#script method for adding ScriptTask elements;
• new method in ProcessDefinitionBuilder to add user tasks.
• support for form-based user tasks, a new UserTask.Extension and forms API.

[0.14.2] - 2017-03-14

Added

• support for values interpolation in in/out variable mappings. Any string in source values (including in deeply-nested collections) can be treated as an expression and eval'ed with the current process context. This feature available only on the model API level for now: see VariableMapping#interpolateValue.

[0.14.1] - 2017-03-12

Added

• evaluation results of ExpressionType.SIMPLE tasks now are stored with the ServiceTask.EXPRESSION_RESULT_VAR key in the context. This can be turned off by setting Configuration#setStoreExpressionEvalResultsInContext(false);
• new methods in ProcessDefinitionBuilder to add tasks with IN/OUT variables mapping;
• small improvements for ProcessDefinitionHelper#dump.

Changed

• DefaultExpressionManager now logs evaluation errors using WARN level.

[0.14.0] - 2017-03-11

Added

• new element: ScriptTask. Allows execution of JSR-223 compatible scripts;
• new extension point: ResourceResolver. Used for resolving external resources (e.g. scripts).

[0.13.0] - 2017-03-10

Added

• new element: UserTask;
• new extension point: UserTaskHandler interface to handle UserTask elements. Default implementation will simply skip those elements.

[0.12.0] - 2017-02-28

Added

• basic support for in/out variables in ServiceTask elements.
• new ProcessDefinitionBuilder.

[0.11.0] - 2016-12-12

Added

• initial implementation of the EventService API.

Changed

• serialization is working again (including the serialization benchmark).

[0.10.3] - 2016-12-08

Changed

• fixed the bug, preventing processes with multiple calls to a same activity from working with parallel or inclusive gateways.
• memory footprint optimizations.

[0.10.2] - 2016-11-15

Added

• the new methods ExecutionInterceptor#onScopeCreated and #onScopeDestroyed allow to monitor logical scopes creation and removal.

Deprecated

• ExecutionInterceptor#onError(String, Throwable) superseded by ExecutionInterceptor(InterceptorErrorEvent).

[0.10.1] - 2016-11-10

Added

• the ProcessDefinitionHelper#dump utility method to print a process structure as a String.

[0.10.0] - 2016-11-05

Added

• the new ExecutionInterceptor#onUnhandledError method can be used to track unhandled errors in suspended processes. E.g., in situations when one of Engine#resume branches fails, but the process is not finished due to other events waiting.

Changed

• do not throw unhandled BPMN errors if a process is not finished.
• the ExecutionContext#PROCESS_BUSINESS_KEY variable is now usable again.
• fixed ExecutionInterceptor#onElement not invoking for boundary event elements.

Breaking

• Configuration#throwExceptionOnErrorEnd is removed. See Configuration#unhandledBpmnErrorStrategy = PROPAGATE.

[0.9.5] - 2016-11-02

Changed

• fixed the scoping issue with subprocesses and error propagation.
• minor logging improvements.

[0.9.4] - 2016-11-01

Added

• avoid reloading a process definition on each CallActivity invocation. Enabled by the Configuration#avoidDefinitionReloadingOnCall flag.
• the new method AbstractEngine#run(ProcessInstance) to run a process using a state's snapshot.
• Configuration#unhandledBpmnErrorStrategy allows to specify the strategy for unhandled BPMN errors:
  • EXCEPTION - immediately throw an exception;
  • PROPAGATE - propagate an error to an higher level;
  • IGNORE - ignore an error and continue an execution.
• BpmnError now contains a process definition ID and an element ID of an error's source.

Changed

• a few uninformative log records moved to the DEBUG level.

[0.9.3] - 2016-10-14

Added

• EngineBuilder#wrapDefinitionProviderWith now can be used to decorate definition providers with some additional functionality like caching (see CachingIndexedProcessDefinitionProvider).
• SourceAwareProcessDefinition allows to store "source maps" - an additional metadata that links a process definition's source and resulting data structures.

[0.9.2] - 2016-10-07

Added

• more tests.
• automatically cleanup free scopes. Reduces the memory footprint and strain on serialization.
• IntermediateCatchEvent#messageRefExpression can now be used to generate event names. The result of evaluation must be a String.

[0.9.1] - 2016-10-07

Added

• EndEvent now can collect the cause of an error with an expression. Such expressions must return an instance of Throwable.

Breaking

• ExecutionContext#ERROR_CODE_KEY removed in favor of #LAST_ERROR_KEY. The new key is used to retrieve latest handled BpmnError.

[0.9.0] - 2016-10-07

Added

• ExecutionContext now can be accessed from the ScriptingExpressionManager (just like in the DefaultExpressionManager).
• SubProcess now supports out variables.

Breaking

• Event#groupId renamed to Event#scopeId. This may break deserialization of pre-existing data.

Changed

• Event scoping is completely rewritten in order to support more complex use cases.

[0.8.9] - 2016-10-02

Added

• a convenience constructor: Edge#(id, elementId, label, waypoints).
• an optional ability to discard all changes to variables made in a subprocess with the Subprocess#isUseSeparateContext flag.
• if the Configuration#throwExceptionOnUnhandledBpmnError flag is set then any unhandled (e.g. without a boundary error event) BpmnError will throw an ExecutionException.

[0.8.8] - 2016-09-23

Added

• VariableMapping now accepts a sourceValue in case if one needs to pass a raw value into a subprocess.

[0.8.7] - 2016-09-19

Added

• additional behaviour tweaks now can be configured via EngineBuilder#withConfiguration.
• introduced Configuration#throwExceptionOnErrorEnd. When enabled, the engine will throw an ExecutionException if process ends with an unhandled error end event.
• now it is possible to override a thread pool used by boundary timer events with the EngineBuilder#withThreadPool method.

[0.8.6] - 2016-09-11

Added

• a new constructor in the DefaultExpressionManager class allows customization of EL resolvers.
• process definition's attributes now accessible as ExecutionContext variables.

[0.8.5] - 2016-09-02

Added

• more fine-grained control over process deployment in EngineRule.
• minor logging improvements.
• ProcessDefinition can now contain additional attributes (e.g. parser's metadata).

Changed

• clarify the javadoc on the ProcessDefinitionProvider#getById method: it returns null if process is not found instead of throwing an exception.

[0.8.4] - 2016-08-29

Added

• new interceptor's method ExecutionInterceptor#onFailure(businessKey, errorRef), called for unhandled BPM errors.

Breaking

• io.takari.bpm.api.interceptors.ElementEvent renamed to InterceptorElementEvent.

Changed

• disabled caching for indexed instances of ProcessDefinition. It will stay disabled until the API provides a way to notify about process changes in an underlying definition store.

[0.8.3] - 2016-08-10

Added

• fallback to the activiti's XML namespace when parsing a ServiceTask declaration. This change is to ensure compatibility with the latest version of Activiti's BPMN editor.

Breaking

• bpmnjs-compat module moved to Orchestra as the default BPMN parser.

Changed

• fix for boundary error events handling: when no suitable error references are found, a default one is used.

[0.8.2] - 2016-08-05

Added

• BpmnError#getCause and the corresponding constructor are added.

[0.8.1] - 2016-07-28

Added

• initial support for JSR 223 (scripting for Java) in expressions.
• new method ExecutionContext#eval allows evaluation of expressions in JavaDelegate tasks.

Changes

• improved performance of boundary events lookup and handling. About 5% improvement for the most of scenarios.

[0.8.0] - 2016-07-23

Changes

• complete rewrite of internal state management. API and semantics weren't changed.
• fixed more bugs related to deep nested process handling.

[0.7.3] - 2016-07-19

Added

• CallActivity#copyAllVariables flag now can be used to copy all variables from the parent process to the called.

[0.7.2] - 2016-07-18

Changed

• a bug was preventing deeply-nested processes from handling events correctly.
• minor code and dependencies cleanup.

Added

• bpmnjs-compat module: a bpmn.io compactible xml format parser (only a partial support for the current set of elements).
• InclusiveGateway now supports expressions for outgoing flows. Some of outgoing SequenceFlow can be "inactive" (have their expressions evaluated to false).

Breaking

• io.takari.bpm.leveldb.LevelDbPersistenceManager -- a serializer removed from its constructor. It wasn't used in any way, just a relic of the past.

[0.7.1] - 2016-07-07

Changed

• a bug was preventing standalone intermediate catch events from working.
• fix a potential classloader problem while initializing JUEL's ExpressionFactory.

[0.7.0] - 2016-07-07

First public release.