Skip to content

Commit

Permalink
Docs modeler renaming (#2564)
Browse files Browse the repository at this point in the history
* modeler renaming

* rename modeler page

* resolve comments
  • Loading branch information
christinaausley authored Sep 11, 2023
1 parent 2c2c6c6 commit 3ac432b
Show file tree
Hide file tree
Showing 113 changed files with 215 additions and 209 deletions.
6 changes: 3 additions & 3 deletions docs/components/modeler/about-modeler.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Any executable process needs a BPMN diagram designed and configure
keywords: ["process mapping tool"]
---

<span class="badge badge--cloud">Camunda Platform 8 only</span>
<span class="badge badge--cloud">Camunda 8 only</span>

Any executable process needs a **[Business Process Model and Notation (BPMN)](./bpmn/bpmn.md) diagram** designed and configured beforehand.

Expand All @@ -15,7 +15,7 @@ In tandem, different events and implementation details (such as the conditions w

Camunda offers two tools to design and implement your diagrams:

- [Web Modeler](./web-modeler/launch-cloud-modeler.md): Integrate seamlessly with Camunda Platform 8 SaaS and Self-Managed installations alongside [Console](../console/introduction-to-console.md).
- [Web Modeler](./web-modeler/launch-cloud-modeler.md): Integrate seamlessly with Camunda 8 SaaS and Self-Managed installations alongside [Console](../console/introduction-to-console.md).
- [Desktop Modeler](./desktop-modeler/index.md): Design, view, and edit models using this desktop application. Install and use Desktop Modeler locally, all while integrating your local development environment.

:::note
Expand All @@ -26,7 +26,7 @@ In this guide, we'll demonstrate modeling BPMN diagrams using both Web Modeler a

## Next steps

- [Modeling BPMN](/guides/automating-a-process-using-bpmn.md) - Learn how to model an automated process in this tutorial using Web Modeler with Camunda Platform 8 SaaS.
- [Modeling BPMN](/guides/automating-a-process-using-bpmn.md) - Learn how to model an automated process in this tutorial using Web Modeler with Camunda 8 SaaS.
- [Camunda Forms](/guides/utilizing-forms.md) - Design and configure forms, and connect them to a user task or start event to implement a task form in your application.
- [DMN](./dmn/dmn.md) - In DMN, model and execute decisions using the same language. As a business analyst, model the rules that lead to a decision in comprehensive tables, and execute these tables directly by a decision engine like Camunda.
- [Out-of-the-box Connectors](/guides/configuring-out-of-the-box-connector.md) - Utilize pre-built connectivity with a number of outside systems. Connectors are modular by nature, reusable, and accelerate automation across those systems.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/bpmn/bpmn.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Let's start modeling by creating a BPMN diagram.
---

:::note
BPMN diagrams must be created for the process engine they intend to be deployed on. You cannot run a BPMN diagram modeled for Camunda Platform 7 in Camunda Platform 8, or vice versa, at this time.
BPMN diagrams must be created for the process engine they intend to be deployed on. You cannot run a BPMN diagram modeled for Camunda 7 in Camunda 8, or vice versa, at this time.
:::

## Start modeling
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ modeled in [Decision Model and Notation](https://www.omg.org/dmn/) (DMN).
![task](assets/business-rule-task.png)

:::info
Camunda Platform 8 supports alternative task implementations for the business rule task. If you want
Camunda 8 supports alternative task implementations for the business rule task. If you want
to use your own implementation for a business rule task, refer to the [job worker
implementation](#job-worker-implementation) section below. The sections before this job worker implementation apply to the DMN
decision implementation only.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "An inclusive gateway (or OR-gateway) allows you to make multiple d

:::note

Currently, Camunda Platform 8 only supports the diverging (i.e. splitting, forking) inclusive gateway. It does not yet support the converging (i.e. merging, joining) inclusive gateway. A combination of parallel and exclusive gateways can be used as an alternative way to merge the flows.
Currently, Camunda 8 only supports the diverging (i.e. splitting, forking) inclusive gateway. It does not yet support the converging (i.e. merging, joining) inclusive gateway. A combination of parallel and exclusive gateways can be used as an alternative way to merge the flows.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/bpmn/script-tasks/script-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ JavaScript, or Python.
![task](assets/script-task.png)

:::info
Camunda Platform 8 supports alternative task implementations for the script task. To use your own
Camunda 8 supports alternative task implementations for the script task. To use your own
implementation for a script task, refer to the [job worker implementation](#job-worker-implementation) section below. The
sections before this job worker implementation apply to the [FEEL expression](/components/modeler/feel/language-guide/feel-expressions-introduction.md)
implementation only.
Expand Down
4 changes: 2 additions & 2 deletions docs/components/modeler/bpmn/user-tasks/user-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ For [Tasklist](/components/tasklist/introduction-to-tasklist.md) to claim the ta
the value of the `assignee` must be the user's **unique identifier**.
The unique identifier depends on the authentication method used to login to Tasklist:

- Camunda Platform 8 (login with email, Google, GitHub): `email`
- Camunda 8 (login with email, Google, GitHub): `email`
- Default Basic Auth (elasticsearch): `username`
- IAM: `username`

:::note
For example, say you log into Tasklist using Camunda Platform 8 login with email using your email address `[email protected]`. Every time a user task activates with `assignee` set to value `[email protected]`, Tasklist automatically assigns it to you. You'll be able to find your new task under the task dropdown option `Claimed by me`.
For example, say you log into Tasklist using Camunda 8 login with email using your email address `[email protected]`. Every time a user task activates with `assignee` set to value `[email protected]`, Tasklist automatically assigns it to you. You'll be able to find your new task under the task dropdown option `Claimed by me`.
:::

## Scheduling
Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/data-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Data handling
description: "Get editor support for variables by defining the variables in the process model."
---

<span class="badge badge--cloud">Camunda Platform 8 only</span>
<span class="badge badge--cloud">Camunda 8 only</span>

The FEEL editor will suggest variables in the current element's scope when defining input and output mappings in a process. The variables created by the mapping are automatically picked up and added to the suggestions.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: connect-to-camunda-platform-8
id: connect-to-camunda-8
title: Deploy your first diagram
description: "Follow these steps to directly deploy diagrams and start process instances in Camunda Platform 8."
description: "Follow these steps to directly deploy diagrams and start process instances in Camunda 8."
---

Desktop Modeler can directly deploy diagrams and start process instances in Camunda Platform 8. Follow the steps below to deploy a diagram to **Camunda Platform 8 SaaS**. To deploy to a local installation, visit the [Camunda Platform 8 Self-Managed guide](../../../self-managed/modeler/desktop-modeler/deploy-to-self-managed.md).
Desktop Modeler can directly deploy diagrams and start process instances in Camunda 8. Follow the steps below to deploy a diagram to **Camunda 8 SaaS**. To deploy to a local installation, visit the [Camunda 8 Self-Managed guide](../../../self-managed/modeler/desktop-modeler/deploy-to-self-managed.md).

1. Click the deployment icon:

Expand All @@ -16,7 +16,7 @@ Desktop Modeler can directly deploy diagrams and start process instances in Camu

3. Input the `Cluster URL` and the credentials (`Client ID`, `Client Secret`) of your [API client](../../console/manage-clusters/manage-api-clients.md):

![deployment via Camunda Platform 8](./img/deploy-diagram-camunda-cloud-remember.png)
![deployment via Camunda 8](./img/deploy-diagram-camunda-cloud-remember.png)

4. Toggle **Remember credentials** to locally store the connection information.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: c7-defining-templates
title: Defining templates in Camunda Platform 7
title: Defining templates in Camunda 7
description: "Learn about JSON schema compatibility, supported BPMN types, defining template properties, and more."
---

<span class="badge badge--platform">Camunda Platform 7 only</span>
<span class="badge badge--platform">Camunda 7 only</span>

Templates are defined in template descriptor files as a JSON array:

Expand Down Expand Up @@ -64,7 +64,7 @@ For example, given the following `$schema` definition, the application takes `0.
"$schema": "https://unpkg.com/@camunda/[email protected]/resources/schema.json"
```

The JSON schema versioning is backward-compatible, meaning all versions including or below the current one are supported. In case no `$schema` is defined, Camunda Modeler assumes the latest JSON schema version for Camunda Platform 7 element templates.
The JSON schema versioning is backward-compatible, meaning all versions including or below the current one are supported. In case no `$schema` is defined, Camunda Modeler assumes the latest JSON schema version for Camunda 7 element templates.

## Supported BPMN types

Expand Down Expand Up @@ -215,7 +215,7 @@ The resulting properties panel control looks like this:
#### Omitted type

:::note
Omitting the type is supported in Camunda Platform 7 element templates only.
Omitting the type is supported in Camunda 7 element templates only.
:::

By omitting the `type` configuration, the default UI component is rendered for the respective binding.
Expand Down Expand Up @@ -328,7 +328,7 @@ Notice that adherence to the following configuration options is enforced by desi

### Scoped bindings

Scoped bindings allow you to configure nested elements, such as [Camunda Platform 7 Connectors](https://docs.camunda.org/manual/latest/user-guide/process-engine/connectors/#use-connectors).
Scoped bindings allow you to configure nested elements, such as [Camunda 7 Connectors](https://docs.camunda.org/manual/latest/user-guide/process-engine/connectors/#use-connectors).

```json
{
Expand Down Expand Up @@ -366,7 +366,7 @@ exposed to the user in a separate custom fields section.

#### Supported scopes

Camunda Platform 7 supports the following scope bindings:
Camunda 7 supports the following scope bindings:

| Name | Target |
| ------------------- | ------------------------------------------------------------------------------------------ |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ As seen in the code snippet, a template consists of a number of important compon

:::note

The `$schema` attribute is **required** for Camunda Platform 8 element templates.
The `$schema` attribute is **required** for Camunda 8 element templates.
:::

Example:
Expand Down
4 changes: 2 additions & 2 deletions docs/components/modeler/desktop-modeler/flags/flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ To display a custom version information in the status bar of the app, configure

> :information_source: The Modeler will read trusted certificates from your operating system's trust store.
Provide additional certificates to validate secured connections to a Camunda Platform 8 installation.
Provide additional certificates to validate secured connections to a Camunda 8 installation.

Configure your `flags.json` like this:

Expand All @@ -92,7 +92,7 @@ Configure your `flags.json` like this:

Additional information adapted from the [upstream documentation](https://nodejs.org/docs/latest/api/tls.html#tlscreatesecurecontextoptions):

> The peer (Camunda Platform 8) certificate must be chainable to a CA trusted by the app for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided.
> The peer (Camunda 8) certificate must be chainable to a CA trusted by the app for the connection to be authenticated. When using certificates that are not chainable to a well-known CA, the certificate's CA must be explicitly specified as trusted or the connection will fail to authenticate. If the peer uses a certificate that doesn't match or chain to one of the default CAs, provide a CA certificate that the peer's certificate can match or chain to. For self-signed certificates, the certificate is its own CA, and must be provided.
### Default execution platform version

Expand Down
8 changes: 4 additions & 4 deletions docs/components/modeler/desktop-modeler/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
id: index
title: Desktop Modeler
sidebar_label: About
description: "Camunda Desktop Modeler is a desktop app for modeling BPMN, DMN, and Forms, compatible with Camunda Platform 7 and Camunda Platform 8."
description: "Camunda Desktop Modeler is a desktop app for modeling BPMN, DMN, and Forms, compatible with Camunda 7 and Camunda 8."
---

<span class="badge badge--cloud">Camunda Platform 7 and 8</span>
<span class="badge badge--cloud">Camunda 7 and 8</span>

Desktop Modeler is a desktop application for modeling BPMN, DMN, and Forms and supports you in building executable diagrams with Camunda.

Expand All @@ -14,7 +14,7 @@ Desktop Modeler is a desktop application for modeling BPMN, DMN, and Forms and s
## Features

- Design [BPMN](../bpmn/bpmn.md), [DMN](../dmn/dmn.md), and [Forms](../forms/camunda-forms-reference.md)
- Implement process applications for Camunda Platform 7 and 8
- Implement process applications for Camunda 7 and 8
- Deploy and run processes directly from the application
- Validate your diagrams using [configurable lint rules](https://github.com/camunda/camunda-modeler-custom-linter-rules-plugin)
- [Customize](./flags/flags.md) and [extend](./plugins/plugins.md) the application
Expand All @@ -25,7 +25,7 @@ Download the app for Windows, Linux, or MacOS from the [Camunda downloads page](

## Get started

Learn how to [develop your first process](./model-your-first-diagram.md) and [deploy it](./connect-to-camunda-platform-8.md) to Camunda Platform 8.
Learn how to [develop your first process](./model-your-first-diagram.md) and [deploy it](./connect-to-camunda-8.md) to Camunda 8.

## Resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Elements that support different types can be reconfigured by clicking on the cor

![properties panel](img/properties-panel.png)

5. Once you finish modeling and configuring your diagram, you can deploy it to a [Camunda Platform 8 cluster](./connect-to-camunda-platform-8.md).
1. Once you finish modeling and configuring your diagram, you can deploy it to a [Camunda 8 cluster](./connect-to-camunda-8.md).
4 changes: 2 additions & 2 deletions docs/components/modeler/desktop-modeler/start-instance.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: start-instance
title: Start a new process instance
description: "After you have deployed your process to Camunda Platform 8, you can start a new instance of this process via the play icon."
description: "After you have deployed your process to Camunda 8, you can start a new instance of this process via the play icon."
---

After you have [deployed your process to Camunda Platform 8](./connect-to-camunda-platform-8.md), you can start a new instance of this process via the play icon:
After you have [deployed your process to Camunda 8](./connect-to-camunda-8.md), you can start a new instance of this process via the play icon:

![start instance icon](./img/start-instance-icon.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ These events include the following properties:

The `Deployment Event` is sent in the following situations:

- User deploys a BPMN or DMN diagram to Camunda Platform 7 or Camunda Platform 8
- User deploys a Form to Camunda Platform 7
- User deploys a BPMN or DMN diagram to Camunda 7 or Camunda 8
- User deploys a Form to Camunda 7

The `Deployment Event` and `Start Instance` have the following properties:

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/desktop-modeler/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ You can connect to Zeebe via [`zbctl`](../../../apis-tools/cli-client/index.md)

### Secure connection to Zeebe fails

When connecting securely to Camunda Platform 8 SaaS, Camunda Platform 8 Self-Managed, or a standalone Zeebe instance (via `https` endpoint URL), Desktop Modeler tries to establish a secure connection. In the process, it strictly validates the server certificates presented against well-known certificate authorities. Failure to connect may have several reasons:
When connecting securely to Camunda 8 SaaS, Camunda 8 Self-Managed, or a standalone Zeebe instance (via `https` endpoint URL), Desktop Modeler tries to establish a secure connection. In the process, it strictly validates the server certificates presented against well-known certificate authorities. Failure to connect may have several reasons:

#### The (remote) endpoint is not configured for secure connections

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/dmn/decision-requirements-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The name describes the DRG. It is set as the `name` attribute on the `definition

The id is the technical identifier of the DRG. It is set in the `id` attribute on the `definitions` element.

Each DRG should have an unique id when it is deployed to the Camunda Platform.
Each DRG should have an unique id when it is deployed to Camunda.

```xml

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/dmn/decision-table-input.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ XML element.

## Input id

The input id is a unique identifier of the decision table input. It is used by the Camunda Platform to reference the
The input id is a unique identifier of the decision table input. It is used by Camunda to reference the
input clause. Therefore, it is required. It is set as the `id` attribute of the `input` XML element.

```xml
Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/dmn/decision-table-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ XML element.

## Output id

The output id is a unique identifier of the decision table output. It is used by the Camunda Platform to reference the
The output id is a unique identifier of the decision table output. It is used by Camunda to reference the
output clause. Therefore, it is required. It is set as the `id` attribute of the `output` XML element.

```xml
Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/dmn/decision-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The id is the technical identifier of the decision. It is set in the `id`
attribute on the `decision` element. Just as the `name`, the `id` can be changed via the Properties Panel after
selecting the respective "Decision" in the Decision Requirements Diagram view.

Each decision should have an unique id when it is deployed to the Camunda Platform.
Each decision should have an unique id when it is deployed to Camunda.

:::caution

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/dmn/dmn-data-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Data types
description: On overview of the available data types in DMN.
---

The Camunda Platform supports the following data types for DMN:
Camunda supports the following data types for DMN:

| Type name | Associated FEEL type |
| ----------------- | --------------------------------------------------------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/components/modeler/forms/camunda-forms-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ description: Streamline your human workflows with the help of Camunda Forms
---

:::note Support for Camunda Forms
The initial release of Camunda Forms includes a debut minimal feature set, which will be expanded with upcoming versions. The Camunda Forms feature was added with the 7.15.0 release of Camunda Platform 7 and the 4.7.0 release of [Camunda Modeler](../about-modeler.md). Therefore, they can be used within BPMN diagrams running on Camunda Platform 7 version 7.15.0 or later.
The initial release of Camunda Forms includes a debut minimal feature set, which will be expanded with upcoming versions. The Camunda Forms feature was added with the 7.15.0 release of Camunda 7 and the 4.7.0 release of [Camunda Modeler](../about-modeler.md). Therefore, they can be used within BPMN diagrams running on Camunda 7 version 7.15.0 or later.
:::

The Camunda Forms feature allows you to design and configure forms. Once configured, they can be connected to a user task or start event to implement a task form in your application.

While you can incorporate Camunda Forms solely within Camunda Platform 8, you can also utilize Camunda Forms in Camunda Platform 7. After deploying a diagram with an embedded form, Tasklist imports this form schema and uses it to render the form on every task assigned to it.
While you can incorporate Camunda Forms solely within Camunda 8, you can also utilize Camunda Forms in Camunda 7. After deploying a diagram with an embedded form, Tasklist imports this form schema and uses it to render the form on every task assigned to it.

To learn more about how Camunda Forms are created in Camunda Modeler and embedded in Camunda Tasklist, visit our guide on [user task forms](../../../guides/utilizing-forms.md).

Expand Down
Loading

0 comments on commit 3ac432b

Please sign in to comment.