Skip to content

Align quick start deployment with Operaton #126

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hauptmedia wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Align quick start deployment with Operaton #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
417032e
Remove Operaton Cloud reference from quick start
hauptmedia Jun 16, 2026
9f267c4
Align quick start deployment with Operaton Modeler
hauptmedia Jun 17, 2026
08eb0d4
Align quick start modeler wording
hauptmedia Jun 17, 2026
2f2b64d
Use local docs links in quick start
hauptmedia Jun 17, 2026
5cc2c28
Fix quick start worker follow-up links
hauptmedia Jun 17, 2026
49d1505
Polish quick start modeler instructions
hauptmedia Jun 17, 2026
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
16 changes: 8 additions & 8 deletions docs/get-started/quick-start/decision-automation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ description: "Learn how to integrate DMN decision tables in the Process."
In this section, you'll learn how to add decision automation to your process by using [BPMN 2.0 *Business Rule Tasks*](/docs/documentation/reference/bpmn20/tasks/business-rule-task/) and [DMN 1.3 Decision Tables](/docs/documentation/reference/dmn/).

## Add a Business Rule Task to the Process
Use the Camunda Modeler to open the Payment Retrieval process then click on the Approve Payment Task. Change the activity type to *Business Rule Task* in the wrench button menu.
Use the Operaton Modeler to open the Payment Retrieval process, then click the Approve Payment Task. Change the activity type to *Business Rule Task* in the wrench button menu.

![Example image](/img/get-started/quick-start/modeler-businessrule-task1.png)

Next, link the Business Rule Task to a DMN table by changing `Implementation` to `DMN` and `Decision Ref` to `approve-payment` in the properties panel. In order to retrieve the result of the evaluation and save it automatically as a process instance variable in our process, we also need to change the `Result Variable` to `approved` and use `singleEntry` as the `Map Decision Result` in the properties panel.
Next, link the Business Rule Task to a DMN table by changing `Implementation` to `DMN` and `Decision Ref` to `approve-payment` in the properties panel. To retrieve the result of the evaluation and save it automatically as a process instance variable in our process, we also need to change the `Result Variable` to `approved` and use `singleEntry` as the `Map Decision Result` in the properties panel.

![Example image](/img/get-started/quick-start/modeler-businessrule-task2.png)

Save your changes and deploy the updated process using the `Deploy` Button in the Camunda Modeler.
Save your changes and deploy the updated process using the `Deploy` button in the Operaton Modeler.

## Create a DMN table using the Camunda Modeler
## Create a DMN table using the Operaton Modeler
First, create a new DMN diagram by clicking *File > New File > DMN Diagram*.
![Example image](/img/get-started/quick-start/modeler-new-dmn-diagram.png)

Expand All @@ -46,7 +46,7 @@ After setup, your DMN table should look like this:
![Example image](/img/get-started/quick-start/modeler-dmn5.png)

## Deploy the DMN table
To deploy the Decision Table, click on the Deploy button in the Camunda Modeler, give it Deployment Name "Payment Retrieval Decision", then hit the Deploy button.
To deploy the decision table, click the Deploy button in the Operaton Modeler, give it the deployment name "Payment Retrieval Decision", then click the Deploy button.
![Example image](/img/get-started/quick-start/modeler-dmn6.png)

## Verify the Deployment with Cockpit
Expand All @@ -56,7 +56,7 @@ Now, use Cockpit to see if the decision table was successfully deployed. Go to [

## Inspect using Cockpit and Tasklist

Next, use Tasklist to start two new Process Instances and verify that depending on your input, the Process Instance will be routed differently.
Next, use Tasklist to start two new process instances and verify that depending on your input, the process instance will be routed differently.
To do so, go to [http://localhost:8080/operaton/app/tasklist/](http://localhost:8080/operaton/app/tasklist/). Log in with *demo / demo*.

Click on the Start process button to start a process instance and choose the `Payment` process.
Expand All @@ -70,11 +70,11 @@ Use the generic form to add the variables as follows:
![Example image](/img/get-started/quick-start/tasklist-dmn2.png)

You'll see that depending on the input, the worker will either charge or not charge the credit card.
You can also verify that the DMN tables were evaluated by using Operaton Cockpit. Go to [http://localhost:8080/operaton/app/cockpit/](http://localhost:8080/operaton/app/cockpit/). Log in with the credentials *demo / demo*. Navigate to the "Decisions" section and click on Approve Payment. Check the different Decision Instances that were evaluated by clicking on the ID in the table.
You can also verify that the DMN tables were evaluated by using Operaton Cockpit. Go to [http://localhost:8080/operaton/app/cockpit/](http://localhost:8080/operaton/app/cockpit/). Log in with the credentials *demo / demo*. Navigate to the "Decisions" section and click on Approve Payment. Check the different decision instances that were evaluated by clicking on the ID in the table.

A single DMN table that was executed could look like this in Operaton Cockpit:
![Example image](/img/get-started/quick-start/cockpit-dmn-table.png)

:::note[Success!]
Congratulations! You've successfully completed the Operaton Platform Quick Start. Ready to continue? We recommend the [Operaton Platform documentation](https://docs.operaton.org/docs/documentation/).
Congratulations! You've successfully completed the Operaton Platform Quick Start. Ready to continue? We recommend the [Operaton Platform documentation](/docs/documentation/).
:::
20 changes: 10 additions & 10 deletions docs/get-started/quick-start/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ description: 'Deploy the Process to Operaton and start your first process instan
---
# Deploy the Process (3/6)

In the next step, you'll deploy the Process and start a new instance so you can see that your simple process is working correctly.
In the next step, you'll deploy the process and start a new instance so you can see that your simple process is working correctly.

:::note[Deployment Support]
BPMN diagrams must be created for the process engine they intend to be deployed on. You cannot run a BPMN diagram modeled for Operaton Platform in Operaton Cloud, or vice versa, at this time.
BPMN diagrams must be created for the process engine they intend to be deployed on. In the Operaton Modeler, make sure the execution platform is set to Operaton Platform before deploying to Operaton.
:::

## Use the Camunda Modeler to Deploy the Process
<span id="use-the-camunda-modeler-to-deploy-the-process"></span>

In order to deploy the Process, click on the deploy button in the Camunda Modeler, then give it the Deployment Name "Payment Retrieval" and click the Deploy button. From version 3.0.0 on, you will be required to provide an URL for an Endpoint Configuration along with Deployment Details. This can be either the root endpoint to the REST API (e.g. `http://localhost:8080/engine-rest`) or an exact endpoint to the deployment creation method (e.g. `http://localhost:8080/engine-rest/deployment/create`).
## Use the Operaton Modeler to Deploy the Process

To deploy the process, click the deploy button in the Operaton Modeler, give it the deployment name "Payment Retrieval", and click the Deploy button. When prompted for an Endpoint Configuration, use either the root endpoint to the REST API (e.g. `http://localhost:8080/engine-rest`) or the exact endpoint to the deployment creation method (e.g. `http://localhost:8080/engine-rest/deployment/create`).

![Example image](/img/get-started/quick-start/modeler-deploy1.png)
![Example image](/img/get-started/quick-start/modeler-deploy2.png)
You should see a success message in the Camunda Modeler:
You should see a success message in the Operaton Modeler:
![Example image](/img/get-started/quick-start/modeler-deploy3.png)

More details regarding the deployment from Camunda Modeler you can find [here](https://blog.camunda.com/post/2019/01/camunda-modeler-3.0.0-0-released/#completely-reworked-deployment-tool). For Camunda Modeler 2.2.4 and earlier, read [this blog post](https://blog.operaton.com/post/2018/03/camunda-modeler-1120-alpha-3-released/).

## Verify the Deployment with Cockpit

Next, use Cockpit to see if the process was successfully deployed. Go to [http://localhost:8080/operaton/app/cockpit/](http://localhost:8080/operaton/app/cockpit/) and log in with the credentials demo / demo. Your process *Payment Retrieval* should be visible on the dashboard.
Expand All @@ -34,7 +34,7 @@ Next, use Cockpit to see if the process was successfully deployed. Go to [http:/
## Start a Process Instance

In Operaton, there are different ways to start a new process instance.
You can leverage the Operaton REST API to start a new process instance by sending a POST Request.
You can leverage the Operaton REST API to start a new process instance by sending a POST request.

### a) curl

Expand All @@ -52,7 +52,7 @@ If you don't feel comfortable using curl for the REST request, you can instead m
Make a POST request to the following endpoint:
`http://localhost:8080/engine-rest/process-definition/key/payment-retrieval/start`

The JSON Body should look like this:
The JSON body should look like this:
```JSON
{
"variables": {
Expand All @@ -77,5 +77,5 @@ In your worker console (which we started in the previous section), you should no
This means you have successfully started and executed your first simple process.

:::note[Next Step]
In some cases, we'll want to involve humans in our process. Move onto the next step to [learn how you can involve humans in your process](/docs/get-started/quick-start/user-task/).
In some cases, we'll want to involve humans in our process. Move on to the next step to [learn how you can involve humans in your process](/docs/get-started/quick-start/user-task/).
:::
6 changes: 3 additions & 3 deletions docs/get-started/quick-start/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Now also name the new elements accordingly:

Next, open the properties panel and select the `<1000 €` Sequence Flow after the Gateway on the canvas. This will update the selection in the properties panel.
Scroll to the property named `Condition Type` and change it to `Expression`. Then input `${amount<1000}` as the Expression.
We are using the [Java Unified Expression Language](https://docs.operaton.org/docs/documentation/user-guide/process-engine/expression-language/) to evaluate the Gateway.
We are using the [Java Unified Expression Language](/docs/documentation/user-guide/process-engine/expression-language/) to evaluate the Gateway.

![Example image](/img/get-started/quick-start/modeler-gateway3.png)

Expand Down Expand Up @@ -53,7 +53,7 @@ Next, set variables for the process instance using the generic form as we learne

![Example image](/img/get-started/quick-start/start-form-generic.png)

Fill in the form as shown in the screenshot and make sure you use an amount that is larger or equal to 1000 in order to see the User Task *Approve Payment*.
Fill in the form as shown in the screenshot and make sure you use an amount that is greater than or equal to 1000 in order to see the User Task *Approve Payment*.
When you are done, click *Start*.

You should see the *Approve Payment* task when you click on *All Tasks*. In this quick start, we're logged into Tasklist as an admin user, and so we can see all tasks associated with our processes. However, it's possible to create [filters in Tasklist](/docs/documentation/webapps/tasklist/filters/) to determine which users can see which tasks based on [user authorization](/docs/documentation/webapps/admin/authorization-management/) as well as other criteria.
Expand All @@ -64,5 +64,5 @@ We should see that our worker prints something to the console.
Next, repeat the same steps, and this time, reject the payment. You should also create one instance with an amount less than 1000 to confirm that the first gateway works correctly.

:::note[Next Step]
Now you're ready for Decision Automation. Let's have a look how you can [add Business Rules to your Process](/docs/get-started/quick-start/decision-automation/).
Now you're ready for Decision Automation. Let's look at how you can [add Business Rules to your Process](/docs/get-started/quick-start/decision-automation/).
:::
30 changes: 15 additions & 15 deletions docs/get-started/quick-start/service-task.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

title: 'Executable Process'
sidebar_position: 2
description: 'Learn the basics of handling the Camunda Modeler, learn how to model and configure a fully executable process and learn how to integrate your own business logic.'
description: 'Learn the basics of handling the Operaton Modeler, learn how to model and configure a fully executable process and learn how to integrate your own business logic.'

---
# Executing automated steps (2/6)

In this section, you'll learn how to create your first BPMN 2.0 process with the Camunda Modeler and how to execute automated steps. Start by opening up Camunda Modeler.
In this section, you'll learn how to create your first BPMN 2.0 process with the Operaton Modeler and how to execute automated steps. Start by opening Operaton Modeler.

## Create a new BPMN Diagram

Expand Down Expand Up @@ -38,8 +38,8 @@ Add an End Event named *Payment Received*.

### Configure the Service Task

There are different ways to [execute service tasks](https://docs.operaton.org/docs/documentation/reference/bpmn20/tasks/service-task/) using Operaton Platform. In this guide, we'll use the external [task pattern](https://docs.operaton.org/docs/documentation/user-guide/process-engine/external-tasks/).
Open the Properties Panel within the Camunda Modeler and click on the Service Task you just created. Change the Implementation to `External` and use `charge-card` as the Topic.
There are different ways to [execute service tasks](/docs/documentation/reference/bpmn20/tasks/service-task/) using Operaton Platform. In this guide, we'll use the external [task pattern](/docs/documentation/user-guide/process-engine/external-tasks/).
Open the Properties Panel within the Operaton Modeler and click on the Service Task you just created. Change the Implementation to `External` and use `charge-card` as the Topic.

![Example image](/img/get-started/quick-start/modeler-step4.png)

Expand Down Expand Up @@ -85,7 +85,7 @@ In this section, you'll learn how to implement an external task worker in Java.

Make sure you have the following tools installed:

* JDK 11
* JDK 17
* An IDE for Java projects (e.g. [Eclipse](https://eclipse.org/))

#### Create a new Maven project
Expand All @@ -105,7 +105,7 @@ When you're done, click Finish. Eclipse will set up a new Maven project. The pro
#### Add Operaton External Task Client Dependency

The next step consists of setting up the Maven dependency to the external task client for your new process application.
Your pom.xml file of your project should look like this:
Your project's `pom.xml` file should look like this:

```xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
Expand All @@ -118,8 +118,8 @@ Your pom.xml file of your project should look like this:

<properties>
<operaton.external-task-client.version>1.0.3</operaton.external-task-client.version>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
</properties>

<dependencies>
Expand Down Expand Up @@ -147,7 +147,7 @@ Your pom.xml file of your project should look like this:
Next, we will create a new ExternalTaskClient which subscribes to the `charge-card` topic.

When the process engine encounters a service task that is configured to be externally handled, it creates an external task instance on which our handler will react.
We are using [Long Polling](https://docs.operaton.org/docs/documentation/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) in the ExternalTaskClient to make the communication more efficient.
We are using [Long Polling](/docs/documentation/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) in the ExternalTaskClient to make the communication more efficient.

Next, you need to create a package, e.g., *org.operaton.bpm.getstarted.chargecard* and add a Java class, e.g. *ChargeCardWorker*, to it.

Expand Down Expand Up @@ -182,7 +182,7 @@ public class ChargeCardWorker {
LOGGER.info("Charging credit card with an amount of '" + amount + "'€ for the item '" + item + "'...");

try {
Desktop.getDesktop().browse(new URI("https://docs.operaton.org/get-started/quick-start/complete"));
Desktop.getDesktop().browse(new URI("https://docs.operaton.org/docs/get-started/quick-start/user-task/"));
} catch (Exception e) {
e.printStackTrace();
}
Expand All @@ -197,7 +197,7 @@ public class ChargeCardWorker {

#### Run the worker

You can run the Java application by right clicking on the class `ChargeCardWorker` and choosing `Run as Java`.
You can run the Java application by right-clicking the class `ChargeCardWorker` and choosing `Run as Java`.

Note that the worker should remain running throughout the entirety of this quick start guide.

Expand Down Expand Up @@ -251,7 +251,7 @@ npm install -D open
Next, we'll create a new ExternalTaskClient that subscribes to the `charge-card` topic.

When the process engine encounters a service task that's configured to be externally handled, it creates an external task instance on which our handler will react.
We use [Long Polling](https://docs.operaton.org/docs/documentation/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) in the ExternalTaskClient to make the communication more efficient.
We use [Long Polling](/docs/documentation/user-guide/process-engine/external-tasks/#long-polling-to-fetch-and-lock-external-tasks) in the ExternalTaskClient to make the communication more efficient.

Next, you need to create a new JavaScript file, e.g. `worker.js`, that looks like the following:

Expand All @@ -268,17 +268,17 @@ const config = { baseUrl: 'http://localhost:8080/engine-rest', use: logger, asyn
// create a Client instance with custom configuration
const client = new Client(config);

// susbscribe to the topic: 'charge-card'
// subscribe to the topic: 'charge-card'
client.subscribe('charge-card', async function({ task, taskService }) {
// Put your business logic here

// Get a process variable
const amount = task.variables.get('amount');
const item = task.variables.get('item');

console.log(`Charging credit card with an amount of ```${amount}€ for the item '${item}'...`);
console.log(`Charging credit card with an amount of ${amount}€ for the item '${item}'...`);

open('https://docs.operaton.org/get-started/quick-start/success');
open('https://docs.operaton.org/docs/get-started/quick-start/user-task/');

// Complete the task
await taskService.complete(task);
Expand Down