Skip to content

Commit

Permalink
docs(operate): update incidents and variables page
Browse files Browse the repository at this point in the history
Related with #82 #83
  • Loading branch information
ralfpuchert committed Dec 7, 2020
1 parent 532b40b commit 6c24777
Show file tree
Hide file tree
Showing 22 changed files with 11 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: basic-operate-navigation
title: Getting Familiar With Operate
---

This section "Getting Familiar With Operate" and the next section “Incidents and Payloads” assumes that you’ve deployed a workflow to Zeebe and have created at least one workflow instance.
This section "Getting Familiar With Operate" and the next section “Variables & Incidents” assumes that you’ve deployed a workflow to Zeebe and have created at least one workflow instance.

If you’re not sure how to deploy workflows or create instances, we recommend going through the [Getting Started tutorial](../../zeebe/getting-started/index)

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -69,31 +69,31 @@ And we’ll publish a message that will be correlated with the instance so we ca

In the Operate interface, you should now see that the workflow instance has an <!-- FIXME: [“Incident”](/reference/incidents.html) --> incident, which means there’s a problem with workflow execution that needs to be fixed before the workflow instance can progress to the next step.

![operate-incident-workflow-view](./img/Operate-Workflow-View-Incident.png)
![operate-incident-workflow-view](./img/operate-workflow-view-incident_dark.png)

Operate provides tools for diagnosing and resolving incidents. Let’s go through incident diagnosis and resolution step-by-step.

When we inspect the workflow instance, we can see exactly what our incident is: `Expected to evaluate condition 'orderValue>=100' successfully, but failed because: Cannot compare values of different types: STRING and INTEGER`

![operate-incident-instance-view](./img/Operate-View-Instance-Incident.png)
![operate-incident-instance-view](./img/operate-view-instance-incident_dark.png)

We have enough information to know that to resolve this incident, we need to edit the `orderValue` variable so that it’s an integer. To do so, first click on the edit icon next to the variable you’d like to edit.

![operate-incident-edit-variable](./img/Operate-View-Instance-Edit-Icon.png)
![operate-incident-edit-variable](./img/operate-view-instance-edit-icon_dark.png)

Next, edit the variable by removing the quotation marks from the `orderValue` value. Then click on the checkmark icon to save the change.

We were able to solve this particular problem by _editing_ a variable, but it’s worth noting that you can also _add_ a variable if a variable is missing from a workflow instance altogether.

![operate-incident-save-variable-edit](./img/Operate-View-Instance-Save-Var-Edit.png)
![operate-incident-save-variable-edit](./img/operate-view-instance-save-var-edit_dark.png)

There’s one last step we need to take: initiating a “retry” of the workflow instance. There are two places on the workflow instance page where you can initiate a retry:

![operate-retry-instance](./img/Operate-Workflow-Retry-Incident.png)
![operate-retry-instance](./img/operate-workflow-retry-incident_dark.png)

You should now see that the incident has been resolved, and the workflow instance has progressed to the next step. Well done!

![operate-incident-resolved-instance-view](./img/Operate-Incident-Resolved.png)
![operate-incident-resolved-instance-view](./img/operate-incident-resolved_dark.png)

If you’d like to complete the workflow instance, you can create a worker for the “Ship Without Insurance” task:

Expand All @@ -114,3 +114,7 @@ If you’d like to complete the workflow instance, you can create a worker for t
```
./bin/zbctl.exe --insecure create worker ship-without-insurance --handler "findstr .*"
```

The completed workflow instance with the path taken:

![operate-incident-resolved-path-view](./img/operate-incident-resolved-path_dark.png)

0 comments on commit 6c24777

Please sign in to comment.