Skip to content

Commit

Permalink
docs: error variables clarification (#5171)
Browse files Browse the repository at this point in the history
  • Loading branch information
ana-vinogradova-camunda authored Mar 10, 2025
1 parent 1c9bdfb commit 9b25766
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/components/modeler/bpmn/error-events/error-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ An error can be thrown within the process using an error **end event**.
Alternatively, you can inform Zeebe that a business error occurred using a **client command**. This throw error client
command can only be used while processing a job.

In addition to throwing the error, this also disables the job and stops it from being activated or completed by other job workers. Refer to the [gRPC command](/apis-tools/zeebe-api/gateway-service.md#throwerror-rpc) for details.
In addition to throwing the error, this also disables the job and stops it from being activated or completed by other job workers. Refer to the [gRPC command](/apis-tools/zeebe-api/gateway-service.md#throwerror-rpc) and [REST request](/apis-tools/camunda-api-rest/specifications/throw-job-error.api.mdx) for details.

## Catching the error

Expand Down Expand Up @@ -79,7 +79,7 @@ In general, we recommend talking about business reactions, which are modeled in

## Variable mappings

All error variables are merged into the error catch event. These variables can be merged into the process instance by defining an output mapping at the error catch event.
Variables can be passed along into the error catch event with the payload when the error is thrown from the client command. These variables can be merged into the process instance by defining an output mapping at the error catch event.

Visit the documentation regarding [variable mappings](../../../concepts/variables/#inputoutput-variable-mappings) for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ An error can be thrown within the process using an error **end event**.
Alternatively, you can inform Zeebe that a business error occurred using a **client command**. This throw error client
command can only be used while processing a job.

In addition to throwing the error, this also disables the job and stops it from being activated or completed by other job workers. Refer to the [gRPC command](/apis-tools/zeebe-api/gateway-service.md#throwerror-rpc) for details.
In addition to throwing the error, this also disables the job and stops it from being activated or completed by other job workers. Refer to the [gRPC command](/apis-tools/zeebe-api/gateway-service.md#throwerror-rpc) and [REST request](/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx) for details.

## Catching the error

Expand Down Expand Up @@ -79,7 +79,7 @@ In general, we recommend talking about business reactions, which are modeled in

## Variable mappings

All error variables are merged into the error catch event. These variables can be merged into the process instance by defining an output mapping at the error catch event.
Variables can be passed along into the error catch event with the payload when the error is thrown from the client command. These variables can be merged into the process instance by defining an output mapping at the error catch event.

Visit the documentation regarding [variable mappings](../../../concepts/variables/#inputoutput-variable-mappings) for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ An error can be thrown within the process using an error **end event**.
Alternatively, you can inform Zeebe that a business error occurred using a **client command**. This throw error client
command can only be used while processing a job.

In addition to throwing the error, this also disables the job and stops it from being activated or completed by other job workers. Refer to the [gRPC command](/apis-tools/zeebe-api/gateway-service.md#throwerror-rpc) for details.
In addition to throwing the error, this also disables the job and stops it from being activated or completed by other job workers. Refer to the [gRPC command](/apis-tools/zeebe-api/gateway-service.md#throwerror-rpc) and [REST request](/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx) for details.

## Catching the error

Expand Down Expand Up @@ -79,7 +79,7 @@ In general, we recommend talking about business reactions, which are modeled in

## Variable mappings

All error variables are merged into the error catch event. These variables can be merged into the process instance by defining an output mapping at the error catch event.
Variables can be passed along into the error catch event with the payload when the error is thrown from the client command. These variables can be merged into the process instance by defining an output mapping at the error catch event.

Visit the documentation regarding [variable mappings](../../../concepts/variables/#inputoutput-variable-mappings) for more information.

Expand Down

0 comments on commit 9b25766

Please sign in to comment.