Skip to content

docs: state that instanceId and processInstanceId are the same value #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zambrovski merged 1 commit into from
Oct 7, 2026
Merged

docs: state that instanceId and processInstanceId are the same value #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api/src/main/kotlin/dev/bpmcrafters/processengineapi/CommonRestrictions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ object CommonRestrictions {

/**
* Id provided by the runtime identifying the process instance.
*
* In the meta of a task, the value is the same as
* [dev.bpmcrafters.processengineapi.process.ProcessInformation.instanceId] returned when that process
* instance was started. An engine which uses a different value in one of the two places has a bug.
*/
const val PROCESS_INSTANCE_ID = "processInstanceId"

Expand Down
5 changes: 5 additions & 0 deletions api/src/main/kotlin/dev/bpmcrafters/processengineapi/process/ProcessInformation.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ package dev.bpmcrafters.processengineapi.process
data class ProcessInformation(
/**
* Reference to the instance.
*
* When an engine puts [dev.bpmcrafters.processengineapi.CommonRestrictions.PROCESS_INSTANCE_ID] into the
* meta of a task of this instance, it is the same value. A caller can rely on that to match a delivered
* task to the process instance it started. An engine which uses a different value in one of the two places
* has a bug.
*/
val instanceId: String,
/**
Expand Down