diff --git a/docs/documentation/installation/database-schema.md b/docs/documentation/installation/database-schema.md index 5ec2cfbb..6894dd54 100644 --- a/docs/documentation/installation/database-schema.md +++ b/docs/documentation/installation/database-schema.md @@ -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-.tar.gz` and extracts to `operaton-sql-scripts-`. + :::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. @@ -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-.tar.gz` asset. +Open the `operaton-sql-scripts-/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: @@ -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-.tar.gz` asset. +Open the `operaton-sql-scripts-/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: @@ -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-.tar.gz` asset. +Open the `operaton-sql-scripts-/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. @@ -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-.tar.gz` asset. +Open the `operaton-sql-scripts-/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. @@ -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. \ No newline at end of file +Patch level updates will be delivered once applicable patches are issued, since no such updates have been needed so far. diff --git a/docs/documentation/installation/full/tomcat/pre-packaged.md b/docs/documentation/installation/full/tomcat/pre-packaged.md index 040a5504..043e9ad9 100644 --- a/docs/documentation/installation/full/tomcat/pre-packaged.md +++ b/docs/documentation/installation/full/tomcat/pre-packaged.md @@ -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-.tar.gz` (or `.zip`) - - Operaton Tomcat distribution: `operaton-bpm-tomcat-.tar.gz` (or `.zip`) - - Operaton Wildfly distribution: `operaton-bpm-wildfly-.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-.tar.gz` or `operaton-bpm-tomcat-.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. diff --git a/docs/documentation/installation/full/wildfly/pre-packaged.md b/docs/documentation/installation/full/wildfly/pre-packaged.md index 5c362dfb..09500a04 100644 --- a/docs/documentation/installation/full/wildfly/pre-packaged.md +++ b/docs/documentation/installation/full/wildfly/pre-packaged.md @@ -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-.tar.gz` or `operaton-bpm-wildfly-.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. diff --git a/docs/documentation/installation/operaton-bpm-run.md b/docs/documentation/installation/operaton-bpm-run.md index 66091d1e..226f1f5e 100644 --- a/docs/documentation/installation/operaton-bpm-run.md +++ b/docs/documentation/installation/operaton-bpm-run.md @@ -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-.tar.gz` or `operaton-bpm-.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). diff --git a/docs/documentation/installation/camunda-modeler.md b/docs/documentation/installation/operaton-modeler.md similarity index 100% rename from docs/documentation/installation/camunda-modeler.md rename to docs/documentation/installation/operaton-modeler.md diff --git a/docs/documentation/introduction/downloading-operaton.md b/docs/documentation/introduction/downloading-operaton.md index d186e348..cfe02bd2 100644 --- a/docs/documentation/introduction/downloading-operaton.md +++ b/docs/documentation/introduction/downloading-operaton.md @@ -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 diff --git a/docs/documentation/introduction/supported-environments.md b/docs/documentation/introduction/supported-environments.md index aeb6ce06..8c6c8394 100644 --- a/docs/documentation/introduction/supported-environments.md +++ b/docs/documentation/introduction/supported-environments.md @@ -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. ::: @@ -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 diff --git a/docs/documentation/modeling-bpmn/index.md b/docs/documentation/modeling-bpmn/index.md index e96b7dd8..c14dbb69 100644 --- a/docs/documentation/modeling-bpmn/index.md +++ b/docs/documentation/modeling-bpmn/index.md @@ -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). diff --git a/docs/documentation/reference/bpmn20/custom-extensions/extension-elements.md b/docs/documentation/reference/bpmn20/custom-extensions/extension-elements.md index ff90026d..b785c46d 100644 --- a/docs/documentation/reference/bpmn20/custom-extensions/extension-elements.md +++ b/docs/documentation/reference/bpmn20/custom-extensions/extension-elements.md @@ -1181,7 +1181,7 @@ The following attributes are extension attributes for the `camunda` namespace `h If the parent operaton:properties element is directly added as an extension element, - for example by the Camunda Modeler, only the attributes name and value + for example by the Operaton Modeler, only the attributes name and value are used. diff --git a/docs/documentation/reference/cmmn11/index.md b/docs/documentation/reference/cmmn11/index.md index 4e8b5314..57594ce6 100644 --- a/docs/documentation/reference/cmmn11/index.md +++ b/docs/documentation/reference/cmmn11/index.md @@ -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: ``` { @@ -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 diff --git a/docs/documentation/user-guide/operaton-bpm-run.md b/docs/documentation/user-guide/operaton-bpm-run.md index 3e110d8e..c055e0b1 100644 --- a/docs/documentation/user-guide/operaton-bpm-run.md +++ b/docs/documentation/user-guide/operaton-bpm-run.md @@ -9,7 +9,7 @@ This guide gives an introduction to Operaton Run, a pre-packaged, lightweight di ## Prerequisites and audience -To use this guide, you should at least know what Operaton is and what it does. Check out the [Get Started guides](https://docs.operaton.org/get-started/quick-start/) if you have never used Operaton before. The [Installation guide](../installation/operaton-bpm-run.md) is also worth looking at if you are completely new to Operaton. +To use this guide, you should at least know what Operaton is and what it does. Check out the [Get Started guides](/docs/get-started/quick-start/) if you have never used Operaton before. The [Installation guide](../installation/operaton-bpm-run.md) is also worth looking at if you are completely new to Operaton. This guide will teach you about Operaton Run and how to configure it. It can serve as a reference page for configuration and operation options. It will not give you a step-by-step guide on how to install Operaton Run. Head over to the [Installation guide](../installation/operaton-bpm-run.md) for details on how to install and start Operaton Run. @@ -26,7 +26,9 @@ Operaton Run is a full distribution of Operaton. It includes: ## Starting with Operaton Run -To start with Operaton Run, download the [distribution](https://downloads.camunda.cloud/release/operaton-bpm/run/) and unpacking it. You will find the following structure: +To start with Operaton Run, download the `operaton-bpm-.tar.gz` or `operaton-bpm-.zip` +distribution from the [latest Operaton release](https://github.com/operaton/operaton/releases/latest) +and unpack it. You will find the following structure: ``` operaton-bpm-run @@ -256,7 +258,7 @@ If you want to allow cross-origin requests to the [REST API](../reference/rest/o .allowed-origins - Origins that are allowed to make CORS requests. Multiple origins can be separated with commas. To support both HTTP authentication and CORS, allowed-origins must not be \*. To allow Camunda Modeler to deploy with authentication, including file:// in the allowed origins. + Origins that are allowed to make CORS requests. Multiple origins can be separated with commas. To support both HTTP authentication and CORS, allowed-origins must not be \*. To allow Operaton Modeler to deploy with authentication, include file:// in the allowed origins. \* (all origins, including file://) diff --git a/docs/documentation/user-guide/task-forms/index.md b/docs/documentation/user-guide/task-forms/index.md index b1c60b57..9f490c73 100644 --- a/docs/documentation/user-guide/task-forms/index.md +++ b/docs/documentation/user-guide/task-forms/index.md @@ -12,7 +12,7 @@ There are different types of forms which are primarily used in Tasklist. To impl Forms are referenced using Form Keys or Form References and can either be embedded in Operaton Tasklist or handled by a custom application. Depending on your use-case, different Form Types can be used: 1. [Embedded Task Forms](#embedded-task-forms) allow you to embed custom HTML and JavaScript forms into Tasklist. -2. [Operaton Forms](#operaton-forms) offer visual editing of forms in the Camunda Modeler and can be used for less complex forms. Operaton Forms are the only form type that can be referenced either by Form Key or by Form Reference. +2. [Operaton Forms](#operaton-forms) offer visual editing of forms in the Operaton Modeler and can be used for less complex forms. Operaton Forms are the only form type that can be referenced either by Form Key or by Form Reference. 3. [External Task Forms](#external-task-forms) can be used to link to custom applications. The Form will not be embedded in Tasklist. If no form key is present, a [Generic Task Form](#generic-task-forms) will be shown. @@ -35,7 +35,7 @@ Form keys that are used in Tasklist have the structure `FORM-TYPE:LOCATION:FORM. Can be either deployment or app:
    -
  • deployment: The file is part of your deployment (e.g., by adding it to your process archive or by deploying from the Camunda Modeler), which means that it is stored in the Operaton database. It can then be loaded from there. Note that this allows versioning of your form alongside the process model.
    • +
  • deployment: The file is part of your deployment (e.g., by adding it to your process archive or by deploying from the Operaton Modeler), which means that it is stored in the Operaton database. It can then be loaded from there. Note that this allows versioning of your form alongside the process model.
  • app: Add the file to your development project in a folder src/main/webapp/forms. The form file will be packaged into your deployment artifact (typically a WAR archive). During runtime it will be loaded from there.
@@ -47,7 +47,7 @@ Form keys that are used in Tasklist have the structure `FORM-TYPE:LOCATION:FORM. -To configure the form in your process, open the process with the [Camunda Modeler](http://operaton.org/bpmn/tool/) and select the desired [UserTask][user-tasks] or [StartEvent][start-event]. Open the properties panel and enter the Form Key. The relevant XML tag looks like this: +To configure the form in your process, open the process with the [Operaton Modeler](../../installation/operaton-modeler.md) and select the desired [UserTask][user-tasks] or [StartEvent][start-event]. Open the properties panel and enter the Form Key. The relevant XML tag looks like this: ```xml **Type** -> **Input Data** -> **Dynamic options** -> **Input values key** for the respective component. +To bind a variable to a dynamic component, define its name in Operaton Modeler's form builder in the Properties Panel under **Options Source** -> **Type** -> **Input Data** -> **Dynamic options** -> **Input values key** for the respective component. Operaton Forms support the following variable types that can represent JSON: @@ -186,7 +186,7 @@ If you are about to prototype your application, you can also use the shortcut fo ``` ### Deployment -If you want to include your Operaton Form as part of the `deployment`, then you need to deploy the `.form` file in the same deployment as the respective `.bpmn` diagram - for example using the Camunda Modeler (since Modeler Version 5.0.0). +If you want to include your Operaton Form as part of the `deployment`, then you need to deploy the `.form` file in the same deployment as the respective `.bpmn` diagram, for example using the Operaton Modeler. :::warning[Automatic deployment] Operaton Forms are not automatically deployed as part of a [process archive](../../reference/deployment-descriptors/tags/process-archive.md) by default. @@ -279,7 +279,7 @@ The Operaton process engine supports generating HTML task forms based on Form Da ``` -Form metadata can be graphically edited using the [Camunda Modeler](https://camunda.com/products/operaton-platform/modeler/). +Form metadata can be graphically edited using the [Operaton Modeler](../../installation/operaton-modeler.md). This form would look like this in Tasklist: diff --git a/docs/documentation/webapps/cockpit/bpmn/process-definition-view.md b/docs/documentation/webapps/cockpit/bpmn/process-definition-view.md index 3c88ec28..ad3d94be 100644 --- a/docs/documentation/webapps/cockpit/bpmn/process-definition-view.md +++ b/docs/documentation/webapps/cockpit/bpmn/process-definition-view.md @@ -125,7 +125,7 @@ Delete the current process definition version by using this feature. In the proc ![Example img](/img/documentation/webapps/cockpit/bpmn/cockpit-documentation.png)Set Job Priority -This feature allows you to inspect documentation added in the Camunda Modeler. To do so, open the Documentation tab. Elements with a documentation are indicated with a info-sign in the diagram. The documentation table lists all documented elements. Click on a table row to highlight the element in the diagram. +This feature allows you to inspect documentation added in the Operaton Modeler. To do so, open the Documentation tab. Elements with a documentation are indicated with a info-sign in the diagram. The documentation table lists all documented elements. Click on a table row to highlight the element in the diagram. To view long documentations, click on the info-sign on the element or the documentation link in the table. This opens a modal which displays the formated documentation in a textbox. To copy the documentation to the clipboard, click on copy button. @@ -164,4 +164,4 @@ For more drill down options on call activities you can check out the [process in and the [process history views][process-history-views]. -[process-history-views]: ../bpmn/process-history-views.md \ No newline at end of file +[process-history-views]: ../bpmn/process-history-views.md diff --git a/docs/get-started/apache-maven.md b/docs/get-started/apache-maven.md index 2f5b2079..7282bfc5 100644 --- a/docs/get-started/apache-maven.md +++ b/docs/get-started/apache-maven.md @@ -12,7 +12,23 @@ menu: This page lists the most commonly used Apache Maven Coordinates for Operaton. -Most Operaton artifacts are pushed to [maven central](https://central.sonatype.com/search?q=org.operaton.bpm). +Operaton release artifacts are published to [Maven Central](https://central.sonatype.com/search?q=org.operaton.bpm). +Snapshot artifacts are published to Central's snapshot repository. Add it only when you intentionally depend on `*-SNAPSHOT` versions: + +```xml + + + central-snapshots + https://central.sonatype.com/repository/maven-snapshots/ + + false + + + true + + + +``` ## Operaton BOM (Bill of Materials) diff --git a/docs/get-started/archive/java-process-app/install.md b/docs/get-started/archive/java-process-app/install.md index 02fde9e9..8882f2fa 100644 --- a/docs/get-started/archive/java-process-app/install.md +++ b/docs/get-started/archive/java-process-app/install.md @@ -8,11 +8,11 @@ menu: name: "Download and Installation" parent: "get-started-pa" identifier: "get-started-pa-install" - description: "Install the Operaton Platform and Camunda Modeler on your machine." + description: "Install the Operaton Platform and Operaton Modeler on your machine." --- -First you need to set up your development environment and install the Operaton Platform and the Camunda Modeler. +First you need to set up your development environment and install the Operaton Platform and the Operaton Modeler. ## Prerequisites @@ -27,11 +27,11 @@ Make sure you have the following set of tools installed: ## Operaton Platform -First, download a distribution of the Operaton Platform. You can choose from different distributions for various application servers. In this tutorial, we will use the Apache Tomcat based distribution. Download it from [the download page](https://camunda.com/download#download-other-menu). +First, download a distribution of the Operaton Platform. You can choose from different distributions for various application servers. In this tutorial, we will use the Apache Tomcat based distribution. Download it from [the latest Operaton release](https://github.com/operaton/operaton/releases/latest). After having downloaded the distribution, unpack it inside a directory of your choice. We will call that directory `$OPERATON_HOME`. -After you have successfully unpacked your distribution of the Operaton Platform, execute the script named `start-camunda.bat` (for Windows users), respectively `start-camunda.sh` (for Unix users). +After you have successfully unpacked your distribution of the Operaton Platform, execute the script named `start.bat` (for Windows users) or `start.sh` (for Unix users). This script will start the application server and open a welcome screen in your web browser. If the page does not open, go to [http://localhost:8080/operaton-welcome/index.html](http://localhost:8080/operaton-welcome/index.html). @@ -40,6 +40,6 @@ If you have trouble setting up the Operaton Platform, you can ask for assistance ::: -## Camunda Modeler +## Operaton Modeler -Follow the instructions in the [Camunda Modeler](/docs/documentation/installation/camunda-modeler) section. +Follow the instructions in the [Operaton Modeler](/docs/documentation/installation/operaton-modeler) section. diff --git a/docs/get-started/archive/javaee7/install.md b/docs/get-started/archive/javaee7/install.md index 3ae94d32..9a59c35f 100644 --- a/docs/get-started/archive/javaee7/install.md +++ b/docs/get-started/archive/javaee7/install.md @@ -7,11 +7,11 @@ menu: main: parent: "get-started-java-ee" identifier: "get-started-java-ee-install" - description: "Install Operaton Platform and Camunda Modeler on your machine." + description: "Install Operaton Platform and Operaton Modeler on your machine." --- -First you need to set up your development environment and install the Operaton Platform and the Camunda Modeler. +First you need to set up your development environment and install the Operaton Platform and the Operaton Modeler. ## Prerequisites @@ -25,13 +25,13 @@ Make sure you have the following set of tools installed: ## Install Operaton Platform -First, download a distribution of the Operaton Platform. You can choose from different application servers. In this tutorial, we will use a WildFly-based distribution. Download it from [the download page](https://downloads.camunda.cloud/release/operaton-bpm/wildfly/). +First, download a distribution of the Operaton Platform. You can choose from different application servers. In this tutorial, we will use a WildFly-based distribution. Download it from [the latest Operaton release](https://github.com/operaton/operaton/releases/latest). After having downloaded the distribution, unpack it inside a directory of your choice. We will call that directory `$OPERATON_HOME`. After you have successfully unpacked your distribution of the Operaton Platform, execute the script named -`start-camunda.bat` for Windows users, respectively `start-camunda.sh` for Unix users. +`start.bat` for Windows users or `start.sh` for Unix users. This script will start the application server and open a welcome screen in your Web browser. If the page does not open, go to http://localhost:8080/operaton-welcome/index.html. @@ -40,6 +40,6 @@ If the page does not open, go to http://localhost:8080/operaton-welcome/index.ht If you have trouble setting up the Operaton Platform, you can ask for assistance in the [Forum](https://forum.operaton.org/). ::: -## Install Camunda Modeler +## Install Operaton Modeler -Follow the instructions in the [Camunda Modeler](/docs/documentation/installation/camunda-modeler) section. \ No newline at end of file +Follow the instructions in the [Operaton Modeler](/docs/documentation/installation/operaton-modeler) section. diff --git a/docs/get-started/dmn/install.md b/docs/get-started/dmn/install.md index 550b3d5c..7c451ec6 100644 --- a/docs/get-started/dmn/install.md +++ b/docs/get-started/dmn/install.md @@ -8,19 +8,19 @@ menu: name: "Download and Installation" parent: "get-started-dmn" identifier: "get-started-dmn-install" - description: "Install the Operaton Platform and Camunda Modeler on your machine." + description: "Install the Operaton Platform and Operaton Modeler on your machine." aliases: [/dmn/install/] --- -First you need to set up your development environment and install the Operaton Platform and the Camunda Modeler. +First you need to set up your development environment and install the Operaton Platform and the Operaton Modeler. ## Prerequisites Make sure you have the following set of tools installed: -* Java JDK 11+, +* Java JDK 17+, * Apache Maven (optional, if not installed you can use embedded Maven inside Eclipse.) * A modern web browser (recent Firefox, Chrome or Microsoft Edge will work fine) * Eclipse integrated development environment (IDE) @@ -28,11 +28,11 @@ Make sure you have the following set of tools installed: ## Operaton Platform -First, download a distribution of the Operaton Platform. You can choose from different distributions for various application servers. In this tutorial, we will use the Apache Tomcat based distribution. Download it from [the download page](https://camunda.com/download/). +First, download a distribution of the Operaton Platform. You can choose from different distributions for various application servers. In this tutorial, we will use the Apache Tomcat based distribution. Download it from [the latest Operaton release](https://github.com/operaton/operaton/releases/latest). After having downloaded the distribution, unpack it inside a directory of your choice. We will call that directory `$OPERATON_HOME`. -After you have successfully unpacked your distribution of the Operaton Platform, execute the script named `start-camunda.bat` (for Windows users), respectively `start-camunda.sh` (for Unix users). +After you have successfully unpacked your distribution of the Operaton Platform, execute the script named `start.bat` (for Windows users) or `start.sh` (for Unix users). This script will start the application server and open a welcome screen in your web browser. If the page does not open, go to [http://localhost:8080/operaton-welcome/index.html](http://localhost:8080/operaton-welcome/index.html). @@ -40,6 +40,6 @@ This script will start the application server and open a welcome screen in your If you have trouble setting up the Operaton Platform, you can ask for assistance in the [Operaton Users Forum](https://forum.operaton.org/). ::: -## Camunda Modeler +## Operaton Modeler -Follow the instructions in the [Camunda Modeler](../../documentation/installation/camunda-modeler) section. +Follow the instructions in the [Operaton Modeler](../../documentation/installation/operaton-modeler) section. diff --git a/docs/get-started/quick-start/install.md b/docs/get-started/quick-start/install.md index 6f1590e5..8af244fd 100644 --- a/docs/get-started/quick-start/install.md +++ b/docs/get-started/quick-start/install.md @@ -4,7 +4,7 @@ sidebar_position: 1 --- # Download and Installation (1/6) -First, you need to install the Operaton Platform and the Camunda Modeler. +First, you need to install the Operaton Platform and the Operaton Modeler. In the following section, we'll describe how to install the Operaton Platform locally on your machine. @@ -16,7 +16,7 @@ docker pull operaton/operaton:latest docker run -d --name operaton -p 8080:8080 operaton/operaton:latest ``` -Afterwards, you can [install the Camunda Modeler](#camunda-modeler). +Afterwards, you can [install the Operaton Modeler](#operaton-modeler). [More information regarding the docker image](https://hub.docker.com/r/operaton/operaton) ::: @@ -26,14 +26,14 @@ Afterwards, you can [install the Camunda Modeler](#camunda-modeler). Please make sure you have the following installed: -* Java Runtime Environment 11 +* Java Runtime Environment 17 You can verify this by using your terminal, shell, or command line: ```sh java -version ``` -If you need to install Java Runtime Environment, you can [find the download from Oracle here](https://www.oracle.com/technetwork/java/javase/downloads/index.html). +If you need to install Java Runtime Environment, you can [find the download from Oracle here](https://www.oracle.com/java/technologies/downloads/). :::note[Supported Java versions] Make sure to use a Java version from [Operaton's list of supported environments](/docs/documentation/introduction/supported-environments/#java-runtime). @@ -41,7 +41,7 @@ Make sure to use a Java version from [Operaton's list of supported environments] ## Operaton Platform -First, download a distribution of the Operaton Platform. You can choose from different distributions for [various application servers](/docs/documentation/installation/full/). In this tutorial, we'll use Operaton Platform Run. Download it from [the download page](https://camunda.com/download/). +First, download a distribution of the Operaton Platform. You can choose from different distributions for [various application servers](/docs/documentation/installation/full/). In this tutorial, we'll use Operaton Platform Run. Download it from [the latest Operaton release](https://github.com/operaton/operaton/releases/latest). After downloading the distribution, unpack it inside a directory of your choice. @@ -49,14 +49,10 @@ After you've successfully unpacked your distribution of the Operaton Platform, e This script will start the application server. Open your web browser and navigate to [http://localhost:8080/](http://localhost:8080/) to visit the Welcome Page. -## Camunda Modeler +## Operaton Modeler -Download the Camunda Modeler from [the download page](https://camunda.com/download/modeler/). - -After downloading the Modeler, simply unzip the download in a folder of your choice. - -After you have successfully unpacked the zip, run `camunda-modeler.exe` (for Windows users), `camunda-modeler.app` (for Mac users), or `camunda-modeler.sh` (for Linux users). +Follow the instructions in the [Operaton Modeler](/docs/documentation/installation/operaton-modeler) section. :::note[Next Step] -Once you've installed the Operaton Platform and the Camunda Modeler, you can move to the next step to [model and execute your first process](/docs/get-started/quick-start/service-task/). +Once you've installed the Operaton Platform and the Operaton Modeler, you can move to the next step to [model and execute your first process](/docs/get-started/quick-start/service-task/). :::