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 gets user started with [Camunda 8](https://camunda.com/platform/) and contains instructions on how to:
3
+
This repository gets users started with [Camunda 8](https://camunda.com/platform/) and contains instructions on how to:
4
4
5
5
- Model your first process
6
6
- Create a user task form
@@ -22,20 +22,22 @@ The repository contains the following folders:
22
22
23
23
# Configure your environment
24
24
25
-
To follow this guide, we need a running Camunda 8 cluster. For this purpose,
26
-
we use the Camunda 8 SaaS offering at [https://camunda.io](https://camunda.io). 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/).
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).
27
27
28
-
After the sign-up and log-in at https://camunda.io, [create a new cluster](https://docs.camunda.io/docs/guides/create-cluster/) with the latest stable version of Zeebe and the name **Test Cluster**.
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/).
29
29
30
-
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**.
31
34
32
-
After the cluster is available, we need to create [client
1. From Console, navigate to the **Clusters** detail page.
37
-
2. Click on your cluster and switch to the **API** tab.
38
-
3. Click **Create new client** and name your client accordingly.
37
+
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.
39
41
40
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.**
41
43
@@ -46,27 +48,25 @@ In this example, we'll model a process to send an email message.
standard to model your business processes. The process consists of two
49
-
tasks: a user task to allow a human to enter the message content, and a service
50
-
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.
51
53
52
54
53
55
54
-
**NOTE: To keep the scope of this guide limited, we only build the scaffolding 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.**
55
-
56
-
To create the process, we use [Modeler](https://docs.camunda.io/docs/components/modeler/about-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/).**
57
57
58
-
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/).
59
59
60
-
## 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/).
61
61
62
-
To help users complete the user task **Enter Message**, we create a user
63
-
task form using Modeler.
62
+
## Model and configure the user task form
64
63
65
-
Find the finished form at [process/enter-email-message.form](process/enter-email-message.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/).
66
66
67
-
## Configure the user task to use the form
67
+
Find the finished form at [process/enter-email-message.form](process/enter-email-message.form)
68
68
69
-
Now, configure the user task to use the form.
69
+
Configure the user task to use the form.
70
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.
71
71
72
72
@@ -76,9 +76,8 @@ To do this, copy the JSON content of the form into the **Form JSON configuration
76
76
The last step is defining the job type of the service task.
77
77
78
78
The job type is
79
-
needed for a job worker to subscribe to the jobs of the task and
80
-
complete them. See the [Camunda 8 documentation](https://docs.camunda.io) for more information about
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.
94
92
95
93
## Deploy using Desktop Modeler
96
94
97
-
To deploy the [process](process/send-email.bpmn) using Desktop Modeler,
For **Camunda 8**, we need the cluster id and the [client credentials](#setup-the-environment).
113
-
114
110
## Deploy using code
115
111
116
112
Writing your own code allows you to deploy the process (for example, on application
@@ -123,16 +119,15 @@ Start a new instance of the process using [Web Modeler](#start-instance-using-we
123
119
124
120
## Start instance using Web Modeler
125
121
126
-
To start an instance of the process using Web Modeler, follow [these steps](https://docs.camunda.io/docs/components/modeler/web-modeler/start-instance/).
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.
127
123
128
124
## Start instance using Desktop Modeler
129
125
130
-
After the process is deployed, click **Start Current Diagram** to start an instance of the process with Camunda Modeler.
126
+
After the process is deployed, click **Start Current Diagram** to start an instance of the process with Desktop Modeler.
131
127
132
128
## Start instance using zbctl
133
129
134
-
To start a process instance of the BPMN process id `send-email` using `zbctl`,
135
-
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:
For **Camunda 8**, we need the cluster id and the [client credentials](#setup-the-environment).
145
-
146
139
## Start instance using code
147
140
148
141
Writing your own code allows you to start an instance of the process on an
@@ -152,44 +145,40 @@ visit the [programming language folders](#repository-structure).
152
145
# Complete the user task
153
146
154
147
The first task of the process is the [user task](https://docs.camunda.io/docs/components/modeler/bpmn/user-tasks/)
155
-
**Enter Message**.
148
+
**Enter message**.
156
149
157
150
158
151
159
-
To complete the user task, we use Tasklist. To do this, visit the cluster's
160
-
details page in Camunda 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/):
161
153
162
-
Take the following steps:
163
-
164
-
1. In Tasklist, select the **Enter Message** task from the list of tasks.
165
-
2. Click the **Claim** button to assign the task to you to work on it.
166
-
3. Fill out the **E-Mail Content** field with the message you want to send.
167
-
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.
168
158
169
159
170
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**.
176
167
177
168
178
169
179
-
To complete the service task, we need to implement the business logic. Therefore, we must create a [job
180
-
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
181
171
the task type we defined in the diagram. The job worker will subscribe to all
182
172
jobs with the same task type.
183
173
184
174
To define the task type, we select the service task in the diagram and use
185
175
the properties panel to set the task type to `email`.
186
176
187
177
To implement the logic, we implement a job worker. Check out the
188
-
programming language[specific folders](#repository-structure) to find the job
178
+
[programming language folders](#repository-structure) to find the job
189
179
worker implementations.
190
180
191
181
# Further references
192
182
193
-
Find more information in the [Camunda Platform 8 Documentation](https://docs.camunda.io), or join the [Camunda Platform 8
194
-
Forum](https://forum.camunda.io) and [Camunda Platform 8
0 commit comments