Skip to content
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.

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

Modeler renaming #721

Merged
merged 7 commits into from
Apr 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions docs/components/modeler/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ id: about-modeler
title: About Modeler
---

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

:::note

Web Modeler is only available for Camunda Cloud SaaS.
Web Modeler is only available for Camunda Platform 8 SaaS.

:::

Expand All @@ -22,7 +22,7 @@ Camunda offers a few tools to design your diagrams and implement them:
- [Web Modeler](./web-modeler/launch-cloud-modeler.md)
- [Desktop Modeler](./desktop-modeler/install-the-modeler.md)

Web Modeler and Desktop Modeler differ mainly in their environment. Web Modeler is part of Cloud Console and offers a seamless integration into Camunda Cloud to model BPMN. Desktop Modeler is a desktop application that can be installed and used locally, all while integrating your local development environment.
Web Modeler and Desktop Modeler differ mainly in their environment. Web Modeler is part of Cloud Console and offers a seamless integration into Camunda Platform 8 to model BPMN. Desktop Modeler is a desktop application that can be installed and used locally, all while integrating your local development environment.

In this guide, we'll demonstrate modeling BPMN diagrams using both Web Modeler and Desktop Modeler.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/bpmn/bpmn-coverage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: bpmn-coverage
title: "BPMN coverage"
description: "List of BPMN symbols compatible with Camunda Cloud"
description: "List of BPMN symbols supported in Modelers"
---

export const Highlight = ({children, color}) => (
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 @@ -13,7 +13,7 @@ If working in Camunda Platform 7, select **Create diagram > Create new BPMN diag
:::

:::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 Cloud, 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 Platform 7 in Camunda Platform 8, or vice versa, at this time.
:::

## Start modeling
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 @@ -45,12 +45,12 @@ book.author)`). The expressions are evaluated on activating the user task and mu
For [Tasklist](/components/tasklist/introduction.md) to claim the task for a known Tasklist user,
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 Cloud (login with email, Google, GitHub): `email`
- Camunda Platform 8 (login with email, Google, GitHub): `email`
- Default Basic Auth (elasticsearch): `username`
- IAM: `username`

:::note
For example, say you log into Tasklist using Camunda Cloud 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 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`.
:::

## Variable mappings
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: connect-to-camunda-cloud
title: Connect to Camunda Cloud
description: "Camunda Modeler can communicate directly with Camunda Cloud."
title: Connect to Camunda Platform 8
description: "Camunda Modeler can communicate directly with Camunda Platform 8."
---

Desktop Modeler can directly deploy diagrams and start process instances in Camunda Cloud. Follow the steps below to deploy a diagram:
Desktop Modeler can directly deploy diagrams and start process instances in Camunda Platform 8. Follow the steps below to deploy a diagram:

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](../../cloud-console/manage-clusters/manage-api-clients.md):

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

4. Select the **Remember** checkbox if you want to locally store the connection information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: additional-resources
title: Additional resources
---

Use the [Camunda Cloud Connect plugin](https://docs.camunda.org/cawemo/latest/technical-guide/integrations/modeler/) to integrate the Camunda Modeler with [Cawemo](https://cawemo.com/) and retrieve templates from a Cawemo catalog project.
Use the [Camunda Cloud Connect Plugin for Camunda Platform 7](https://docs.camunda.org/cawemo/latest/technical-guide/integrations/modeler/) to integrate the Camunda Modeler with [Cawemo](https://cawemo.com/) and retrieve templates from a Cawemo catalog project.

Try playing around with custom elements and our example templates for [Camunda Platform 7](https://github.com/camunda/camunda-modeler/tree/master/resources/element-templates/samples.json) or [Camunda Platform 8](https://github.com/camunda/camunda-modeler/tree/master/resources/element-templates/cloud-samples.json).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Configuring templates

Element templates are defined as [JSON files](../defining-templates). There are two ways to integrate them into the Camunda Modeler:

1. **Retrieve from Cawemo:** use the [Camunda Cloud Connect plugin](https://docs.camunda.org/cawemo/latest/technical-guide/integrations/modeler/) to integrate the Camunda Modeler with [Cawemo](https://cawemo.com/). The Modeler can then retrieve templates from catalog projects setup in Cawemo. Note that the [Cloud Connect plugin](https://docs.camunda.org/cawemo/latest/technical-guide/integrations/modeler/) will keep Cawemo and your local Camunda Modeler installation in sync (e.g., deleting a template in Cawemo will delete it locally as well). Locally the synced templates will be stored in the `config.json` file in your [`{USER_DATA_DIRECTORY}`](../../search-paths#user-data-directory). You should not manually change the `config.json` unless you know what you're doing.
1. **Retrieve from Cawemo:** use the [Camunda Cloud Connect Plugin for Camunda Platform 7](https://docs.camunda.org/cawemo/latest/technical-guide/integrations/modeler/) to integrate the Camunda Modeler with [Cawemo](https://cawemo.com/). The Modeler can then retrieve templates from catalog projects setup in Cawemo. Note that the [Cloud Connect plugin](https://docs.camunda.org/cawemo/latest/technical-guide/integrations/modeler/) will keep Cawemo and your local Camunda Modeler installation in sync (e.g., deleting a template in Cawemo will delete it locally as well). Locally the synced templates will be stored in the `config.json` file in your [`{USER_DATA_DIRECTORY}`](../../search-paths#user-data-directory). You should not manually change the `config.json` unless you know what you're doing.
2. **Local filesystem:** Store element templates as `.json` file in the `resources/element-templates` folder, relative to the modelers executable _or_ relative to the modelers data directory ([see below](#example-setup)). Alternatively, they can be stored in a `.camunda/element-templates` directory that resides, relative to the currently opened diagram, anywhere in the diagrams path hierarchy.

New templates will be recognized when reconnecting to Cawemo or on Camunda Modeler reload/restart.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ Templates are defined in template descriptor files as a JSON array:

As seen in the code snippet a template consist of a number of important components:

* `$schema : String`: URI pointing towards the [JSON schema](https://json-schema.org/) which defines the structure of the element template `.json` file. Element template schemas are maintained in the [element templates JSON schema](https://github.com/camunda/element-templates-json-schema) repository. Following the [JSON schema](https://json-schema.org/) standard, you may use them for validation or to get assistance (e.g., auto-completion) when working with them in your favorite IDE. Note that the `$schema` attribute is **required** for Camunda Cloud element templates.
* `$schema : String`: URI pointing towards the [JSON schema](https://json-schema.org/) which defines the structure of the element template `.json` file. Element template schemas are maintained in the [element templates JSON schema](https://github.com/camunda/element-templates-json-schema) repository. Following the [JSON schema](https://json-schema.org/) standard, you may use them for validation or to get assistance (e.g., auto-completion) when working with them in your favorite IDE. Note that the `$schema` attribute is **required** for Camunda Platform 8 element templates.

Example (Camunda Platform 7)

```json
"$schema": "https://unpkg.com/@camunda/[email protected]/resources/schema.json"
```

Example (Camunda Cloud)
Example (Camunda Platform 8)

```json
"$schema": "https://unpkg.com/@camunda/[email protected]/resources/schema.json"
Expand All @@ -58,7 +58,7 @@ As seen in the code snippet a template consist of a number of important componen
The application uses the `$schema` property to ensure compatibility for a given element template. The latest supported [Camunda element templates JSON Schema versions](https://github.com/camunda/element-templates-json-schema) are

* `v0.8.0` (Camunda Platform 7)
* `v0.2.0` (Camunda Cloud)
* `v0.2.0` (Camunda Platform 8)

The Camunda Modeler will ignore element templates defining a higher `$schema` version and will log a warning message.

Expand Down Expand Up @@ -265,11 +265,11 @@ When set, the input field offers visual indications that a feel expression is ex

###### Supported Types

Camunda Platform
Camunda Platform 7

*Feel Inputs are currently not supported for Camunda Platform element templates.*
*Feel Inputs are currently not supported for Camunda Platform 7 element templates.*

Camunda Cloud
Camunda Platform 8

* `String`
* `Text`
Expand All @@ -282,9 +282,9 @@ Notice that adherence to the following configuration options is enforced by desi

<Tabs groupId="bindings" defaultValue="both" values={
[
{label: 'Bindings for Camunda Platform or Camunda Cloud', value: 'both', },
{label: 'Bindings for Camunda Platform', value: 'platform', },
{label: 'Bindings for Camunda Cloud', value: 'cloud', },
{label: 'Bindings for Camunda Platform 7 and 8', value: 'both', },
{label: 'Bindings for Camunda Platform 7', value: 'platform', },
{label: 'Bindings for Camunda Platform 8', value: 'cloud', },
]
}>

Expand Down Expand Up @@ -462,14 +462,14 @@ Camunda Platform 7

*Optional bindings are currently not supported for Camunda Platform 7 element templates.*

Camunda Cloud
Camunda Platform 8

* `zeebe:input`
* `zeebe:output`

#### Scoped Bindings

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

```json
{
Expand Down Expand Up @@ -510,8 +510,8 @@ __Supported Scopes__

<Tabs groupId="scopes" defaultValue="platformScopes" values={
[
{label: 'Scoped bindings for Camunda Platform', value: 'platformScopes', },
{label: 'Scoped bindings for Camunda Cloud', value: 'cloudScopes', }
{label: 'Scoped bindings for Camunda Platform 7', value: 'platformScopes', },
{label: 'Scoped bindings for Camunda Platform 8', value: 'cloudScopes', }
]
}>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Camunda Platform 7
camunda:modelerTemplateVesion="1" />
```

Camunda Cloud
Camunda Platform 8

```xml
<bpmn:serviceTask id="MailTask"
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 Cloud cluster](./connect-to-camunda-cloud.md).
5. Once you finish modeling and configuring your diagram, you can deploy it to a [Camunda Platform 8 cluster](./connect-to-camunda-cloud.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 Cloud, you can start a new instance of this process via the play icon."
description: "After you have deployed your process to Camunda Platform 8, you can start a new instance of this process via the play icon."
---

After you have [deployed your process to Camunda Cloud](./connect-to-camunda-cloud.md), 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-cloud.md), you can start a new instance of this process via the play icon:

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

Expand Down
12 changes: 6 additions & 6 deletions docs/components/modeler/desktop-modeler/telemetry/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ In the case of bpmn and form, we add the engine profile:
```json
{
"engineProfile": {
"executionPlatform": "Camunda Cloud",
"executionPlatformVersion": "1.1"
"executionPlatform": "<target platform>",
"executionPlatformVersion": "<target platform version>"
}
}
```
Expand Down Expand Up @@ -137,7 +137,7 @@ Also in the case of BPMN diagrams, we add selected diagram metrics:
### Deployment Event
The `Deployment Event` is sent in following situations:

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

The Deployment Event has the following core structure:
Expand All @@ -148,8 +148,8 @@ The Deployment Event has the following core structure:
"deployment": {
"outcome": "[success or failure]",
"context": "[deploymentTool or startInstanceTool]",
"executionPlatform": "[Camunda Cloud or Camunda Platform]",
"executionPlatformVersion": "[version deployed to]"
"executionPlatform": "[<target platform>]",
"executionPlatformVersion": "[<target platform version>]"
}
}
```
Expand Down Expand Up @@ -218,7 +218,7 @@ If it is set in the diagram, we also add target engine profile information:
```json
{
"engineProfile": {
"executionPlatform": "Camunda Cloud"
"executionPlatform": "<target platform>"
}
}
```
Expand Down
6 changes: 3 additions & 3 deletions docs/components/modeler/web-modeler/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Collaboration
description: Collaboration features and access rights for Web Modeler.
---

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

## Projects

Expand All @@ -18,7 +18,7 @@ When you access Web Modeler via the Cloud menu, you see the **Home** page with a

Users can have various levels of access to a project in Web Modeler, outlined in this section.

After creating a project, you can invite members of your Camunda Cloud organization to collaborate in Web Modeler.
After creating a project, you can invite members of your Camunda Platform 8 organization to collaborate in Web Modeler.
There are four roles with different levels of access rights that can be assigned to each user:

* **Project Admin**: The user can edit the project itself, all folders and diagrams within the project, and invite more users to collaborate.
Expand All @@ -36,7 +36,7 @@ On the right side of a project, view a list of your collaborators and invite mor
2. Choose a role for your new collaborator.
![invite choose role](img/collaboration/web-modeler-collaborator-invite-choose-role.png)

3. Begin typing the name of the individual and Web Modeler will suggest Camunda Cloud organization members that you can invite to the project.
3. Begin typing the name of the individual and Web Modeler will suggest Camunda Platform 8 organization members that you can invite to the project.
![invite suggestions](img/collaboration/web-modeler-collaborator-invite-suggestions.png)

4. Write a message to your new collaborator about their invitation to the project.
Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/web-modeler/import-diagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Import diagram
description: "You can import a BPMN diagram at any time with Web Modeler."
---

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

You can import a BPMN diagram at any time with Web Modeler, and there are several ways to accomplish this:

Expand Down
4 changes: 2 additions & 2 deletions docs/components/modeler/web-modeler/launch-cloud-modeler.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ id: launch-cloud-modeler
title: Launch Web Modeler
---

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

Since Web Modeler is embedded in the Camunda Cloud Console, it does not need to be started separately.
Since Web Modeler is embedded in the Camunda Platform 8 Console, it does not need to be started separately.

To launch Web Modeler, follow the steps below:

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/web-modeler/milestones.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Milestones
description: Working with milestones in Web Modeler
---

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

## Milestones

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Model your first diagram
description: "After you've created a BPMN diagram, you can start modeling it."
---

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

After you've created a BPMN diagram, you can start modeling it.

Expand Down
4 changes: 2 additions & 2 deletions docs/components/modeler/web-modeler/new-web-modeler.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ title: New Web Modeler
description: Your data was automatically migrated from the old Cloud Modeler to the new Web Modeler.
---

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

:::note

Web Modeler is only available for Camunda Cloud SaaS.
Web Modeler is only available for Camunda Platform 8 SaaS.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/web-modeler/save-and-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Save and deploy your diagram
description: "If a diagram is changed and autosaved, it has no effect on your cluster."
---

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

Web Modeler will autosave all your changes on a diagram. The changes will also be visible in real-time to any collaborators opening the same diagram.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/modeler/web-modeler/start-instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Start a new process instance
description: "If a BPMN diagram is deployed via Web Modeler, you can start a new instance of this diagram."
---

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

If a BPMN diagram is deployed via Web Modeler, you can start a new instance of this diagram.

Expand Down