Skip to content
Open
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
26 changes: 14 additions & 12 deletions docs/documentation/installation/database-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ Operaton supports the following ways of installing the database schema:
* Use the database migration tool [Liquibase](https://www.liquibase.org/) with the provided changelog for a semi-automatic installation and update. Liquibase keeps track of database schema changes. This allows you to focus on *when* changes should be applied rather than also on *which* changes are relevant. Starting with version `7.16.0`, Operaton comes with a curated *changelog file* that Liquibase can consume.
* Use the provided SQL scripts with the tools related to your database for a fully manual installation and update. A manual procedure allows you to fully control the SQL statements that are executed on your database instance and to adjust those statements to your needs if necessary.

SQL script archives are attached to the [Operaton GitHub releases](https://github.com/operaton/operaton/releases).
Stable release assets are attached to tags such as `v2.1.1`; snapshot assets are attached to prerelease tags such as `2.2.0-SNAPSHOT`.
The archive is named `operaton-sql-scripts-<schema-version>.tar.gz` and extracts to `operaton-sql-scripts-<schema-version>`.

:::note[Isolation level]
READ COMMITED is the required isolation level for database systems to run Operaton with.
You may have to change the default setting on your database when installing Operaton.
Expand All @@ -37,9 +41,8 @@ The [update](#update) paragraph provides more details on this topic.

Operaton comes with a maintained changelog file that Liquibase can consume.
This changelog defines which SQL statements to execute on a database.
You can find the changelog and its referenced resources on our [Artifact Repository].
Select the respective version (`$PLATFORM_VERSION`) and download the resources as a `zip` or `tar.gz` file.
Open the `operaton-sql-scripts-$PLATFORM_VERSION/liquibase` folder to find the changelog.
Select the matching Operaton release and download the `operaton-sql-scripts-<schema-version>.tar.gz` asset.
Open the `operaton-sql-scripts-<schema-version>/liquibase` folder to find the changelog.
In case you are using a [pre-packaged distribution], the Liquibase resources already reside in the `sql/liquibase` folder of the distribution.

The `liquibase` folder contains the following resources:
Expand Down Expand Up @@ -71,9 +74,9 @@ Furthermore, if you have defined a specific prefix for the entities of your data
### Manual installation

To install the database schema required for Operaton, we provide a set of scripts with prepared DDL statements.
Those scripts create all required tables and default indices. You can find the provided SQL scripts on our [Artifact Repository].
Select the respective version (`$PLATFORM_VERSION`) and download the scripts as a `zip` or `tar.gz` file.
Open the `operaton-sql-scripts-$PLATFORM_VERSION/create` folder to find all available scripts.
Those scripts create all required tables and default indices.
Select the matching Operaton release and download the `operaton-sql-scripts-<schema-version>.tar.gz` asset.
Open the `operaton-sql-scripts-<schema-version>/create` folder to find all available scripts.
In case you are using a [pre-packaged distribution], the SQL scripts already reside in the `sql/create` folder of the distribution.

The `create` folder contains the following SQL scripts:
Expand Down Expand Up @@ -112,8 +115,8 @@ Based on that changelog and the tracking tables, Liquibase determines which chan

Perform the following steps to update the database schema on your database instance:

1. Select the respective version you want to update to (`$Y`) on our [Artifact Repository] and download the resources as a `zip` or `tar.gz` file.
Open the `operaton-sql-scripts-$Y/liquibase` folder to find the changelog file.
1. Select the Operaton release you want to update to (`$Y`) and download the `operaton-sql-scripts-<schema-version>.tar.gz` asset.
Open the `operaton-sql-scripts-<schema-version>/liquibase` folder to find the changelog file.
In case you are using a [pre-packaged distribution], the Liquibase resources already reside in the `sql/liquibase` folder of the distribution with version `$Y`.
1. Run Liquibase's [update command](https://docs.liquibase.com/commands/community/update.html) referencing the new `operaton-changelog.xml` of version `$Y`.
Liquibase takes care of determining the necessary changes and applying them to your database according to the new changelog.
Expand Down Expand Up @@ -152,9 +155,8 @@ Updating from your current minor version (`$X`) to its follow-up version (`$Y`)
Follow the outlined procedure to perform this update:

1. Check for [available database patch scripts](#patch-level-update) for your database that are within the bounds of your update path.
You can find the scripts on our [Artifact Repository].
Select the respective version you want to update to (`$Y`) and download the scripts as a `zip` or `tar.gz` file.
Open the `operaton-sql-scripts-$Y/upgrade` folder to find all available scripts.
Select the Operaton release you want to update to (`$Y`) and download the `operaton-sql-scripts-<schema-version>.tar.gz` asset.
Open the `operaton-sql-scripts-<schema-version>/upgrade` folder to find all available scripts.
In case you are using a [pre-packaged distribution], the SQL scripts already reside in the `sql/upgrade` folder of the distribution with version `$Y`.
We highly recommend executing these patches before updating.
Execute those related to your database type (`$DATABASENAME`) in ascending order by version number.
Expand All @@ -171,4 +173,4 @@ If you need to apply multiple minor versions, you MUST execute the database alte

### Patch level update

Patch level updates will be delivered once applicable patches are issued, since no such updates have been needed so far.
Patch level updates will be delivered once applicable patches are issued, since no such updates have been needed so far.
14 changes: 7 additions & 7 deletions docs/documentation/installation/full/tomcat/pre-packaged.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ description: "Download and install Apache Tomcat with the Full Distribution pre-

### Installation Procedure

1. Download the pre-packaged distribution from "Assets" of https://github.com/operaton/operaton/releases/latest
- Operaton Standalone distribution: `operaton-bpm-<version>.tar.gz` (or `.zip`)
- Operaton Tomcat distribution: `operaton-bpm-tomcat-<version>.tar.gz` (or `.zip`)
- Operaton Wildfly distribution: `operaton-bpm-wildfly-<version>.tar.gz` (or `.zip`)
3. Unpack the distro to a directory.
4. Adjust the datasource according to your needs (see [Manual Installation](manual.md)).
5. Startup the server by running the `start.sh` script.
1. Download the pre-packaged Tomcat distribution from the [latest Operaton release](https://github.com/operaton/operaton/releases/latest).
Release assets are named `operaton-bpm-tomcat-<version>.tar.gz` or `operaton-bpm-tomcat-<version>.zip`;
snapshot assets are published in the [Operaton GitHub releases](https://github.com/operaton/operaton/releases)
as prereleases with tags such as `2.2.0-SNAPSHOT`.
2. Unpack the distro to a directory.
3. Adjust the datasource according to your needs (see [Manual Installation](manual.md)).
4. Startup the server by running the `start.sh` script.
5 changes: 4 additions & 1 deletion docs/documentation/installation/full/wildfly/pre-packaged.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ description: "Download and install WildFly Application Server with the Full Dist

### Installation Procedure

1. Download the pre-packaged distribution for [WildFly](https://downloads.camunda.cloud/release/operaton-bpm/wildfly/).
1. Download the pre-packaged distribution for WildFly from the [latest Operaton release](https://github.com/operaton/operaton/releases/latest).
Release assets are named `operaton-bpm-wildfly-<version>.tar.gz` or `operaton-bpm-wildfly-<version>.zip`;
snapshot assets are published in the [Operaton GitHub releases](https://github.com/operaton/operaton/releases)
as prereleases with tags such as `2.2.0-SNAPSHOT`.
2. Unpack the distro to a directory.
3. Adjust the datasource according to your needs (see [Manual Installation](manual.md)).
4. Startup the server by running `operaton-welcome.bat` or by using the `$WILDFLY_HOME/bin/standalone.{bat/sh}` script.
5 changes: 3 additions & 2 deletions docs/documentation/installation/operaton-bpm-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ java -version
If you need to install Java Runtime Environment, you can [find the download from Oracle here](https://www.oracle.com/java/technologies/javase-downloads.html).

## Installation Procedure
1. Download the pre-packed distribution of [Operaton here](tbd).
1. Download the `operaton-bpm-<version>.tar.gz` or `operaton-bpm-<version>.zip` distribution from the [latest Operaton release](https://github.com/operaton/operaton/releases/latest).
Snapshot assets are published in the [Operaton GitHub releases](https://github.com/operaton/operaton/releases) as prereleases with tags such as `2.2.0-SNAPSHOT`.
1. Unpack the distro to a directory.
1. Configure the distro as described in the [User Guide](../user-guide/operaton-bpm-run.md).
1. Start Operaton Run by executing the start script (start.bat for Windows, start.sh for Linux/Mac).
1. Start Operaton Run by executing the start script (`start.bat` on Windows, `start.sh` on Linux/macOS).
1. Access the Operaton webapps (Cockpit, Tasklist, Admin) via http://localhost:8080/operaton/app/.
1. Access the [REST API](../reference/rest/overview/index.md) via http://localhost:8080/engine-rest (e.g. http://localhost:8080/engine-rest/engine).
32 changes: 18 additions & 14 deletions docs/documentation/introduction/downloading-operaton.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,33 +39,37 @@ The full distribution bundles

* Process Engine configured as [shared process engine][shared-engine],
* Runtime Web Applications (Tasklist, Cockpit, Admin),
* Rest Api,
* Container / Application Server itself.
* REST API,
* the application server for the pre-packaged Tomcat and WildFly archives.

:::note[Server/Container]
If you download the full distribution for an open-source application
server/container, the container itself is included. For example, if you download the Tomcat
distribution, Tomcat itself is included and the Operaton binaries (process engine and
web apps) are pre-installed in the container. This is not true for the Oracle WebLogic
and IBM WebSphere downloads; these downloads do not include the application servers themselves.
Operaton publishes pre-packaged Tomcat and WildFly distributions as release assets.
Those archives include the application server and the Operaton binaries (process engine and web apps)
pre-installed in the container.
:::

:::note[Wildfly Application Server]
Wildfly Application Server is provided as part of the archives as a convenience. For a copy of the source code, the full set of attribution notices, and other relevant information please see https://github.com/wildfly/wildfly. We will also provide you with a copy of the source code if you [contact our Open-Source Compliance Team](https://docs.operaton.org/docs/documentation/introduction/licenses/#contact) at any time within three years of you downloading an archive (for which we may charge a nominal sum). Wildfly Application Server is copyright © JBoss, Home of Professional Open Source, 2010, Red Hat Middleware LLC [..and contributors].
:::note[WildFly Application Server]
WildFly Application Server is provided as part of the archives as a convenience. For a copy of the source code, the full set of attribution notices, and other relevant information please see https://github.com/wildfly/wildfly. We will also provide you with a copy of the source code if you [contact our Open-Source Compliance Team](./licenses.md#contact) at any time within three years of you downloading an archive (for which we may charge a nominal sum). WildFly Application Server is copyright © JBoss, Home of Professional Open Source, 2010, Red Hat Middleware LLC [..and contributors].
:::

Download stable distribution assets from the [latest Operaton release][operaton-releases-latest].
Snapshot distribution assets are published in the [Operaton GitHub releases][operaton-releases]
as prereleases with tags such as `2.2.0-SNAPSHOT`.

See the [Installation Guide][installation-guide-full] for additional details.


## Download Camunda Modeler
## Download Operaton Modeler

Camunda Modeler is a modeling Tool for BPMN 2.0 and DMN 1.3. Camunda Modeler can be downloaded
from the [community download page][community-download-page].
Operaton Modeler supports BPMN 2.0, DMN 1.3, CMMN 1.1, and Operaton Forms. You can find installation
instructions in the [Operaton Modeler installation guide][operaton-modeler-install].



[get-jdk]: https://www.oracle.com/technetwork/java/javase/downloads/index.html
[community-download-page]: https://camunda.com/download/
[get-jdk]: https://www.oracle.com/java/technologies/downloads/
[operaton-modeler-install]: ../installation/operaton-modeler.md
[operaton-releases]: https://github.com/operaton/operaton/releases
[operaton-releases-latest]: https://github.com/operaton/operaton/releases/latest
[shared-engine]: ./architecture.md#shared-container-managed-process-engine
[installation-guide-full]: ../installation/index.md
[run-with-spring-boot]: ../user-guide/spring-boot-integration/index.md
Expand Down
13 changes: 7 additions & 6 deletions docs/documentation/introduction/supported-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ menu:
Run Operaton in every Java-runnable environment. Operaton is supported with our QA infrastructure in the following environments.

:::note[Supported Environments]
Please note that the environments listed in this section depend on the version of Operaton. Please select the corresponding version of this documentation to see the environment that fits to your version of Operaton. e.g., [supported environments for version 7.15](http://docs.operaton.org/7.15/guides/user-guide/#introduction-supported-environments)
Please note that the environments listed in this section depend on the version of Operaton. Please select the corresponding version of this documentation to see the environment that fits your version of Operaton.
:::


Expand Down Expand Up @@ -68,21 +68,22 @@ Clustered or replicated databases are supported given the following conditions.

## Java

* Java 11 / 17 / 21 (if supported by your application server/container)
* Java 17 / 21 / 25 (if supported by your application server/container)


## Java Runtime

* Oracle JDK 11 / 17 / 21
* OpenJDK 11 / 17 / 21, including builds of the following products:
* Oracle JDK 17 / 21 / 25
* OpenJDK 17 / 21 / 25, including builds of the following products:
* Oracle OpenJDK
* Eclipse Temurin JDK
* Amazon Corretto
* Azul Zulu

## Camunda Modeler
## Operaton Modeler

[Supported environments](https://docs.camunda.io/docs/reference/supported-environments/#camunda-modeler) for Camunda Modeler have moved to [docs.camunda.io](https://docs.camunda.io/).
Operaton Modeler is documented separately. See the [Operaton Modeler installation guide](../installation/operaton-modeler.md)
and the [Operaton Modeler repository](https://github.com/operaton/operaton-modeler) for current installation and build information.

## Maintenance Policy

Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/modeling-bpmn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ sidebar_position: 45

---

You can continue to model your process models with the Desktop Modeler from Camunda. The processes from this can be imported and processed by Operaton.
You can model BPMN process models with Operaton Modeler. These process models can be imported and processed by Operaton.

You can find the Operaton Modeler and its documentation in the [Operaton Modeler repository](https://github.com/operaton/operaton-modeler).
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,7 @@ The following attributes are extension attributes for the `camunda` namespace `h
<td></td>
<td colspan="2">
If the parent <code>operaton:properties</code> element is directly added as an extension element,
for example by the Camunda Modeler, only the attributes <code>name</code> and <code>value</code>
for example by the Operaton Modeler, only the attributes <code>name</code> and <code>value</code>
are used.
</td>
</tr>
Expand Down
20 changes: 9 additions & 11 deletions docs/documentation/reference/cmmn11/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,22 @@ layout: "single"

This page provides an overview of the CMMN 1.1 elements and the current coverage of the process engine.

The CMMN editor is disabled using a flag per default in the latest version (4.5) of the Camunda Modeler. But you have full power to modify the flags and therefore you can still enable it if you wish!
The CMMN editor is hidden by default in Operaton Modeler, but it can be enabled with a flag.

In order to do that, you need to set a “flag”. You can choose between two options to do that:
You can choose between two options to set the flag:

#### Option 1. Pass the `--no-disable-cmmn` flag via the Comand Line Interface
#### Option 1. Pass the `--no-disable-cmmn` flag via the Command Line Interface

When starting the Modeler, you need to pass the `--no-disable-cmmn` via the Command Line.
So for example on linux, you run a command:
When starting Operaton Modeler, pass `--no-disable-cmmn` via the command line.
For example on Linux, run:

```$ ./camunda-modeler --no-disable-cmmn```
```$ ./operaton-modeler --no-disable-cmmn```

Likewise for example on Windows, you could start the .exe over the commandLine with the flag, or you could create a shortcut to the camunda-modeler.exe and append `--no-disable-cmmn` to the `target` of the shortcut.
Likewise on Windows, you can start `Operaton Modeler.exe` from the command line with the flag, or you can create a shortcut to `Operaton Modeler.exe` and append `--no-disable-cmmn` to the `target` of the shortcut.

#### Option 2. Define a flags.json file

You can locally create a file called `flags.json`, which defines the flags which the Camunda-Modeler should pick up when starting. In the file you would need to save the following text content:
You can locally create a file called `flags.json`, which defines the flags that Operaton Modeler should pick up when starting. Save the following text content in the file:

```
{
Expand All @@ -33,9 +33,7 @@ You can locally create a file called `flags.json`, which defines the flags which

The `flags.json` file needs to be saved either in your user-data-directory or application-data-directory.

There are more flags and therefore more options how to customize the Camunda Modeler to your specific use-case with flags. Please refer to the [flags documentation](https://docs.camunda.io/docs/components/modeler/desktop-modeler/flags/) to find out more.

> Thx Max for this detailed information, which comes from this [forum post](https://forum.camunda.io/t/how-to-access-cmmn-in-the-modeler/25127/4).
For the current list of supported flags, see the [Operaton Modeler flags source](https://github.com/operaton/operaton-modeler/blob/develop/client/src/util/Flags.js).

# Coverage

Expand Down
Loading