You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository contains a short guide to get started with [Camunda
4
-
Platform 8](https://camunda.com/products/cloud/). It contains instructions on how to
5
-
model your first process, create a user task form, and automate a service task.
6
-
During the guide you will use Console, Modeler, Zeebe, Operate, and Tasklist.
7
-
8
-
# Table of contents
9
-
10
-
-[Camunda Platform 8 - Get Started](#camunda-platform-8---get-started)
11
-
-[Table of contents](#table-of-contents)
12
-
-[Repository structure](#repository-structure)
13
-
-[Set up the environment](#set-up-the-environment)
14
-
-[Model the process](#model-the-process)
15
-
-[Model the user task form](#model-the-user-task-form)
16
-
-[Configure user task to use form](#configure-user-task-to-use-form)
17
-
-[Configure service task](#configure-service-task)
18
-
-[Deploy process](#deploy-process)
19
-
-[Deploy using Camunda Modeler](#deploy-using-camunda-modeler)
20
-
-[Deploy using Web Modeler](#deploy-using-web-modeler)
21
-
-[Deploy using zbctl](#deploy-using-zbctl)
22
-
-[Deploy using code](#deploy-using-code)
23
-
-[Start process instance](#start-process-instance)
24
-
-[Start instance using Camunda Modeler](#start-instance-using-camunda-modeler)
25
-
-[Start instance using Web Modeler](#start-instance-using-web-modeler)
26
-
-[Start instance using zbctl](#start-instance-using-zbctl)
27
-
-[Start instance using code](#start-instance-using-code)
28
-
-[Complete the user task](#complete-the-user-task)
29
-
-[Complete the service task](#complete-the-service-task)
30
-
-[Further references](#further-references)
31
-
-[Developer setup of Camunda 8](#developer-setup)
1
+
# Get started with Camunda 8
2
+
3
+
This repository gets users started with [Camunda 8](https://camunda.com/platform/) and contains instructions on how to:
4
+
5
+
- Model your first process
6
+
- Create a user task form
7
+
- Automate a service task
8
+
9
+
During this guide, you will use Console, Modeler, Zeebe, Operate, and Tasklist.
32
10
33
11
# Repository structure
34
12
35
13
The repository contains the following folders:
36
14
37
-
-[_csharp_](csharp/) - C# example for deploy, create instance, and a job worker
38
-
-[_go_](go/) - Go example for deploy, create instance, and job worker
39
-
-[_images_](images/) - Contains screenshots and images for the guide
40
-
-[_java_](java/) - Plain Java example for deploy, create instance, and a job worker
41
-
-[_nodejs_](nodejs/) - Node.js example for deploy, create instance, and a job worker
42
-
-[_process_](process/) - Contains the BPMN process and the user task form
43
-
-[_spring_](spring/) - Spring Boot example for deploy, create instance, and a job worker
15
+
-[_csharp_](csharp/) - C# example for deploy, create instance, and a job worker.
16
+
-[_go_](go/) - Go example for deploy, create instance, and a job worker.
17
+
-[_images_](images/) - Contains screenshots and images for the guide.
18
+
-[_java_](java/) - Plain Java example for deploy, create instance, and a job worker.
19
+
-[_nodejs_](nodejs/) - Node.js example for deploy, create instance, and a job worker.
20
+
-[_process_](process/) - Contains the BPMN process and the user task form.
21
+
-[_spring_](spring/) - Spring Boot example for deploy, create instance, and a job worker.
44
22
45
-
# Set up the environment
23
+
# Configure your environment
46
24
47
-
To follow this guide, we need a running Camunda Platform 8 cluster. For this purpose,
48
-
we use the Camunda Platform 8 SaaS offering at https://camunda.io.
25
+
To follow this guide, you first need a running Camunda 8 cluster. For this purpose,
26
+
use the Camunda 8 SaaS offering at [https://camunda.io](https://camunda.io).
49
27
50
-
If you prefer a local setup, visit the [end of this guide](#developer-setup).
28
+
If you prefer a local developer setup where you can run the getting started guide against a locally-hosted instance, follow the [Camunda 8 deployment guide](https://docs.camunda.io/docs/self-managed/platform-deployment/overview/).
51
29
52
-
After the sign-up and log-in at https://camunda.io, we need to [create a new cluster](https://docs.camunda.io/docs/guides/getting-started/create-your-cluster/) with the latest stable version of Zeebe and the name **Test Cluster**.
30
+
To set up your environment using the SaaS offering, take the following steps:
31
+
32
+
1.[Sign up and log in](https://docs.camunda.io/docs/next/guides/getting-started/) at [https://camunda.io](https://camunda.io).
33
+
2.[Create a new cluster](https://docs.camunda.io/docs/guides/create-cluster/) with the latest stable version of Zeebe and the name **Test cluster**.
53
34
54
35
55
36
56
-
After the cluster is available, we need to create a pair of [Client
3. After the cluster is available, [create client credentials](https://docs.camunda.io/docs/components/console/manage-clusters/manage-api-clients/). To do this:
38
+
1. From Console, navigate to the **Clusters** detail page.
39
+
2. Click on your cluster and switch to the **API** tab.
40
+
3. Click **Create new client** and name your client accordingly.
59
41
60
-
1. Navigate to the **Clusters** detail page.
61
-
2. Switch to the **API** tab.
62
-
3. Create a new client credential and either note down the **client id** and **client secret**, or
63
-
download the credentials file.
42
+
**NOTE: Ensure you keep the generated client credentials in a safe place. The client secret will not be shown again. For your convenience, you can also download the client information to your computer.**
64
43
65
44
# Model the process
66
45
67
-
In this example, we'll model a simple process to send an email message.
46
+
In this example, we'll model a process to send an email message.
standard to model your business processes. The process consists of two
72
-
tasks: a user task to allow a human to enter the message content, and a service
73
-
task to automatically send the email message.
51
+
tasks: a [user task](https://docs.camunda.io/docs/next/guides/orchestrate-human-tasks/) to allow a human to enter the message content, and a [service
52
+
task](https://docs.camunda.io/docs/next/guides/orchestrate-microservices/) to automatically send the email message.
74
53
75
54
76
55
77
-
**Note**: To keep the scope of this guide easy to follow, we only build the
78
-
scaffolding for this process automation example and will not actually send
79
-
an email. This can be a task for you to extend the example and connect to a mail
80
-
provider.
81
-
82
-
To create the process, we use the desktop [Camunda Modeler] or [Web Modeler].
56
+
**NOTE: To keep the scope of this guide limited, this guide only steps through the framework for this process automation example and will not actually send an email. If you would like to send an email, you may extend the example and [connect to a mail provider](https://docs.camunda.io/docs/next/guides/configuring-out-of-the-box-connectors/).**
83
57
84
-
Find the finished process at [process/send-email.bpmn](process/send-email.bpmn).
58
+
To create the process, use [Modeler](https://docs.camunda.io/docs/components/modeler/about-modeler/).
85
59
86
-
## Model the user task form
60
+
Find the finished process at [process/send-email.bpmn](process/send-email.bpmn), and learn more about [designing a process using BPMN](https://docs.camunda.io/docs/next/guides/automating-a-process-using-bpmn/).
87
61
88
-
To help users complete the user task **Enter Message**, we create a user
89
-
task form using the modeler.
62
+
## Model and configure the user task form
90
63
91
-
Use [Camunda Modeler] or [Web Modeler] to create the form.
64
+
To help users complete the user task **Enter message**, [create a user
65
+
task form using Modeler](https://docs.camunda.io/docs/next/guides/utilizing-forms/).
92
66
93
-
Find the finished form at [process/enter-email-message.form](process/enter-email-message.form).
67
+
Find the finished form at [process/enter-email-message.form](process/enter-email-message.form)
94
68
95
-
## Configure user task to use form
96
-
97
-
Now that we've created a form, we must configure the user task to use the form.
98
-
To do this, we copy the JSON content of the form into the **Form Json
99
-
Configuration** field under the **Forms** tab of the modeler.
69
+
Configure the user task to use the form.
70
+
To do this, copy the JSON content of the form into the **Form JSON configuration** field under the **Form** tab in the Modeler properties panel.
100
71
101
72
102
73
103
-
## Configure service task
74
+
## Configure a service task
75
+
76
+
The last step is defining the job type of the service task.
104
77
105
-
The last step is defining the job type of the service task. The job type is
106
-
needed for a job worker to subscribe to the jobs of the task and
107
-
complete them. The [Camunda Platform 8 Documentation](https://docs.camunda.io) contains more information about
needed for a [job worker](https://docs.camunda.io/docs/components/concepts/job-workers/) to subscribe to the jobs of the task and
80
+
complete them.
109
81
110
82
111
83
112
84
# Deploy process
113
85
114
-
Deploy the process using [Camunda
115
-
Modeler](#deploy-using-camunda-modeler), [Web
116
-
Modeler](#deploy-using-web-modeler), [zbctl](#deploy-using-zbctl), or your [own
117
-
code](#deploy-using-code).
86
+
Deploy the process using [Web
87
+
Modeler](#deploy-using-web-modeler), [Desktop Modeler](#deploy-using-desktop-modeler), [zbctl](#deploy-using-zbctl), or your [own code](#deploy-using-code).
118
88
119
-
## Deploy using Camunda Modeler
89
+
## Deploy using Web Modeler
120
90
121
-
To deploy the [process](process/send-email.bpmn) using Camunda Modeler,
To deploy the process using Web Modeler, click **Deploy** in the upper right corner of the modeling screen. See [deploy a process](https://docs.camunda.io/docs/components/modeler/web-modeler/run-or-publish-your-process/#deploy-a-process) for additional details.
123
92
124
-
## Deploy using Web Modeler
93
+
## Deploy using Desktop Modeler
125
94
126
-
To deploy the [process](process/send-email.bpmn) using Web Modeler,
Modeler](#start-instance-using-web-modeler), [zbctl](#start-instance-using-zbctl), or your [own
155
-
code](#start-instance-using-code).
118
+
Start a new instance of the process using [Web Modeler](#start-instance-using-web-modeler), [Desktop Modeler](#start-instance-using-desktop-modeler), [zbctl](#start-instance-using-zbctl), or your [own code](#start-instance-using-code).
156
119
157
-
## Start instance using Camunda Modeler
120
+
## Start instance using Web Modeler
158
121
159
-
After the process is deployed, follow [these steps](click **Start Current Diagram**) to start an instance of the process with Camunda Modeler.
122
+
To start an instance of the process using Web Modeler, click **Run** in the top right corner of the modeling screen. See [run or publish your process](https://docs.camunda.io/docs/components/modeler/web-modeler/run-or-publish-your-process/) for additional details.
160
123
161
-
## Start instance using Web Modeler
124
+
## Start instance using Desktop Modeler
162
125
163
-
To start an instance of the process using Web Modeler, follow [these steps](https://docs.camunda.io/docs/components/modeler/web-modeler/start-instance/).
126
+
After the process is deployed, click **Start Current Diagram** to start an instance of the process with Desktop Modeler.
164
127
165
128
## Start instance using zbctl
166
129
167
-
To start a process instance of the BPMN process id `send-email` using `zbctl`,
168
-
use the following command:
130
+
To start a process instance of the BPMN process id `send-email` using `zbctl`, insert your cluster id and client credentials, and run the following command:
The first task of the process is the [user task](https://docs.camunda.io/docs/components/modeler/bpmn/user-tasks/)
148
+
**Enter message**.
191
149
192
150
193
151
194
-
To complete the user task, we use Tasklist. To do this, visit the cluster's
195
-
details page in Camunda Platform 8 and launch Tasklist.
152
+
To complete the user task, take the following steps where we will use [Tasklist](https://docs.camunda.io/docs/components/tasklist/introduction-to-tasklist/):
196
153
197
-
Take the following steps:
198
-
199
-
1. In Tasklist, select the **Enter Message** task from the list of tasks.
200
-
2. Click the **Claim** button to assign the task to you to work on it.
201
-
3. Fill out the **E-Mail Content** field with the message you want to send.
202
-
4. Select **Complete Task**.
154
+
1. Navigate to Tasklist by clicking the square-shaped **Camunda components** icon in the top left corner. Click **Tasklist**.
155
+
2. On the **Tasks** page, change the **Filter options** to **All open**.
156
+
3. Select the **Enter message** task from the list of tasks, and click **Assign to me**.
157
+
4. Fill out the **E-Mail Content** field with the message you want to send.
203
158
204
159
205
160
161
+
5. Select **Complete Task**. This will now show up under the **Filter option** that is **Completed**.
The second task of the process is the [service task](https://docs.camunda.io/docs/components/modeler/bpmn/service-tasks/)
166
+
**Send email**.
211
167
212
168
213
169
214
-
To complete the service task, we need to implement the business logic. Therefore, we must create a [job
215
-
worker](https://docs.camunda.io/docs/components/concepts/job-workers/) for
170
+
To complete the service task, we need to implement the business logic. Therefore, we must create a [job worker](https://docs.camunda.io/docs/components/concepts/job-workers/) for
216
171
the task type we defined in the diagram. The job worker will subscribe to all
217
172
jobs with the same task type.
218
173
219
174
To define the task type, we select the service task in the diagram and use
220
175
the properties panel to set the task type to `email`.
221
176
222
177
To implement the logic, we implement a job worker. Check out the
223
-
programming language[specific folders](#repository-structure) to find the job
178
+
[programming language folders](#repository-structure) to find the job
224
179
worker implementations.
225
180
226
181
# Further references
227
182
228
-
Find more information in the [Camunda Platform 8 Documentation](https://docs.camunda.io), or join the [Camunda Platform 8
229
-
Forum](https://forum.camunda.io) and [Camunda Platform 8
To run the getting started guide against a locally-hosted instance, follow the [Camunda 8 Platform Deployment Guide](https://docs.camunda.io/docs/self-managed/platform-deployment/overview/).
183
+
Find more information in the [Camunda 8 documentation](https://docs.camunda.io), or join the [Camunda 8
0 commit comments