Skip to content
2 changes: 1 addition & 1 deletion docs/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once you completed a Getting Started Guide, you may find the following topics us
|--|--|--|
| [Overview](./introduction/) | [Installation](./installation/index.md) | [REST Api](./reference/rest/index.md) |
| [Download](./introduction/downloading-operaton.md) | [User Guide](./user-guide/index.md)| [Javadoc](#) |
| [Architecture](./introduction/architecture.md) | [Modeler](./modeler/index.md) | [BPMN 2.0](./reference/bpmn20/index.md) |
| [Architecture](./introduction/architecture.md) | [Modeler](./modeling-bpmn/index.md) | [BPMN 2.0](./reference/bpmn20/index.md) |
| [Supported Environments](./introduction/supported-environments.md) | [Web Applications](./webapps/index.md) |[CMMN 1.1](./reference/cmmn11/index.md) |
| | [Update & Migration](./update/index.md) | [DMN 1.3](./reference/dmn/index.md) |
| | | [HTML Forms](./reference/forms/index.md) |
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/installation/full/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ The [Full Distribution][full-distribution] includes a Shared Process engine and

The distribution is supported on a broad range of containers:

[full-distribution]: ../introduction/downloading-operaton.md
[full-distribution]: ../../introduction/downloading-operaton.md
10 changes: 5 additions & 5 deletions docs/documentation/installation/full/tomcat/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Note: If you use the pre-packaged distribution, the ldap plugin is already prese

### Adjust the Process Engine Configuration

Edit the file `bpm-platform.xml` located inside the folder `$TOMCAT_HOME/conf` and add the [LDAP Identity Provider Plugin](../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).
Edit the file `bpm-platform.xml` located inside the folder `$TOMCAT_HOME/conf` and add the [LDAP Identity Provider Plugin](../../../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../../../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).

```xml
<?xml version="1.0" encoding="UTF-8"?>
Expand Down Expand Up @@ -77,12 +77,12 @@ Edit the file `bpm-platform.xml` located inside the folder `$TOMCAT_HOME/conf` a

The `administratorUserName` property should contain the user id of the LDAP user you want to grant administrator authorizations to. You can then use this user to log in to the web application and grant authorizations to additional users.

See our user guide for complete documentation on the [LDAP Identity Provider Plugin](../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).
See our user guide for complete documentation on the [LDAP Identity Provider Plugin](../../../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../../../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).


## HAL Resource Caching

If you use LDAP as Indentity Provider, you should consider [activating caching](../reference/rest/overview/hal.md#caching-of-hal-relations) of
If you use LDAP as Indentity Provider, you should consider [activating caching](../../../reference/rest/overview/hal.md#caching-of-hal-relations) of
Users and Groups in the Operaton webapplication. In order to activate this, add the following
configuration to the `web.xml` file of Operaton webapplication
(`operaton-webapp-tomcat-$PLATFORM_VERSION.war/WEB-INF/web.xml`):
Expand Down Expand Up @@ -237,7 +237,7 @@ The following list describes all possible parameters you can use for the filter
</tr>
</table>

Please also see the detailed overview about the [Cookie Security](../webapps/shared-options/cookie-security.md).
Please also see the detailed overview about the [Cookie Security](../../../webapps/shared-options/cookie-security.md).

## Security-related HTTP headers in Webapps

Expand Down Expand Up @@ -284,4 +284,4 @@ You can change the default behavior by adding configuration parameters to the se
```

Please also see the detailed overview about the
[HTTP Header Security configuration settings](../webapps/shared-options/header-security.md#how-to-configure).
[HTTP Header Security configuration settings](../../../webapps/shared-options/header-security.md#how-to-configure).
2 changes: 1 addition & 1 deletion docs/documentation/installation/full/tomcat/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ menu:

---

This document describes the installation of the [Full Distribution](../introduction/downloading-operaton.md#full-distribution) for [Apache Tomcat Application Server](http://tomcat.apache.org/).
This document describes the installation of the [Full Distribution](../../../introduction/downloading-operaton.md#full-distribution) for [Apache Tomcat Application Server](http://tomcat.apache.org/).

There are different options for installing the Full Distribution:
6 changes: 3 additions & 3 deletions docs/documentation/installation/full/tomcat/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Before you can install the Operaton components, you need to perform a number of
In the default configuration of the distribution, the database schema and all required tables are automatically created in an H2 database when the engine starts up for the first time. If you do not want to use the H2 database, you have to

* Create a database schema for Operaton yourself.
* Install the database schema to create all required tables and default indices using our [database schema installation guide](../installation/database-schema.md).
* Install the database schema to create all required tables and default indices using our [database schema installation guide](../../database-schema.md).

When you create the tables manually, then you have to configure the engine to **not** create tables at startup by setting the `databaseSchemaUpdate` property to `false` (or, in case you are using Oracle, to `noop`). In Tomcat, this is done in the `bpm-platform.xml`, located in the `$TOMCAT_DISTRIBUTION\server\apache-tomcat-$VERSION\conf\` folder.

Expand Down Expand Up @@ -119,7 +119,7 @@ Furthermore, you have to merge your corresponding JDBC driver into the folder `$

## Add bpm-platform.xml

You have to add the file `bpm-platform.xml` to the folder `$TOMCAT_HOME/conf` or, optionally, you can configure the location through some available mechanisms, see [Configure location of the bpm-platform.xml file](../reference/deployment-descriptors/descriptors/bpm-platform-xml.md#configure-location-of-the-bpm-platform-xml-file):
You have to add the file `bpm-platform.xml` to the folder `$TOMCAT_HOME/conf` or, optionally, you can configure the location through some available mechanisms, see [Configure location of the bpm-platform.xml file](../../../reference/deployment-descriptors/descriptors/bpm-platform-xml.md#configure-location-of-the-bpm-platform-xml-file):

```xml
<?xml version="1.0" encoding="UTF-8"?>
Expand Down Expand Up @@ -192,7 +192,7 @@ The following steps are required to deploy the REST API:
3. Startup Tomcat.
4. Access the REST API on the context you configured.
For example, http://localhost:8080/engine-rest/engine should return the names of all engines of the platform, provided that you deployed the application in the context `/engine-rest`.
5. Enable authentication as described in the [REST API documentation](../reference/rest/overview/authentication.md)
5. Enable authentication as described in the [REST API documentation](../../../reference/rest/overview/authentication.md)


## Operaton Connect Plugin
Expand Down
10 changes: 5 additions & 5 deletions docs/documentation/installation/full/wildfly/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In order to setup LDAP for the WildFly Application Server distribution, you have

### Adjust the Process Engine Configuration

Edit the file `standalone.xml` (or `domain.xml`) provided by the WildFly Application Server and add the [LDAP Identity Provider Plugin](../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).
Edit the file `standalone.xml` (or `domain.xml`) provided by the WildFly Application Server and add the [LDAP Identity Provider Plugin](../../../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../../../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).

```xml
<subsystem xmlns="urn:org.operaton.bpm.jboss:1.1">
Expand Down Expand Up @@ -68,12 +68,12 @@ Edit the file `standalone.xml` (or `domain.xml`) provided by the WildFly Applica

The `administratorUserName` property should contain the user id of the LDAP user you want to grant administrator authorizations to. You can then use this user to log in to the web application and grant authorizations to additional users.

See our user guide for complete documentation on the [LDAP Identity Provider Plugin](../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).
See our user guide for complete documentation on the [LDAP Identity Provider Plugin](../../../user-guide/process-engine/identity-service.md#the-ldap-identity-service) and the [Administrator Authorization Plugin](../../../user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin).


## HAL Resource Caching

If you use LDAP as Identity Provider, you should consider [activating caching](../reference/rest/overview/hal.md#caching-of-hal-relations) of
If you use LDAP as Identity Provider, you should consider [activating caching](../../../reference/rest/overview/hal.md#caching-of-hal-relations) of
Users and Groups in the Operaton web application. In order to activate this, add the following
configuration to the `web.xml` file of the Operaton web application
(`operaton-webapp-wildfly-$PLATFORM_VERSION.war/WEB-INF/lib` or `operaton-webapp-jboss-$PLATFORM_VERSION.war/WEB-INF/lib`):
Expand Down Expand Up @@ -129,7 +129,7 @@ configuration to the `web.xml` file of the Operaton web application
```

The `module.xml` file is included in the Operaton distribution. If you install Operaton on a vanilla WildFly container, this file needs to be created manually.
3. [Configure the process engine plugin](../user-guide/runtime-container-integration/jboss.md#extend-a-process-engine-using-process-engine-plugins) in the standalone.xml/domain.xml configuration file
3. [Configure the process engine plugin](../../../user-guide/runtime-container-integration/jboss.md#extend-a-process-engine-using-process-engine-plugins) in the standalone.xml/domain.xml configuration file

## Session Cookie in Webapps

Expand Down Expand Up @@ -197,4 +197,4 @@ You can change the default behavior by adding configuration parameters to the se
```

Please also see the detailed overview about the
[HTTP Header Security configuration settings](../webapps/shared-options/header-security.md#how-to-configure).
[HTTP Header Security configuration settings](../../../webapps/shared-options/header-security.md#how-to-configure).
2 changes: 1 addition & 1 deletion docs/documentation/installation/full/wildfly/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ menu:

---

This document describes the installation of the [Full Distribution](../introduction/downloading-operaton.md#full-distribution) for [WildFly Application Server](http://www.wildfly.org).
This document describes the installation of the [Full Distribution](../../../introduction/downloading-operaton.md#full-distribution) for [WildFly Application Server](http://www.wildfly.org).

There are different options for installing the Full Distribution:
4 changes: 2 additions & 2 deletions docs/documentation/installation/full/wildfly/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ The below example also configures the default process engine.
By default, the database schema is automatically created in an H2 database when the engine starts up for the first time. If you do not want to use the H2 database, you have to

* Create a database schema for Operaton yourself.
* Install the database schema to create all required tables and default indices using our [database schema installation guide](../installation/database-schema.md).
* Install the database schema to create all required tables and default indices using our [database schema installation guide](../../database-schema.md).

When you create the tables manually, then you can also configure the engine to **not** create tables at startup by setting the `isAutoSchemaUpdate` property to `false` (or, in case you are using Oracle, to `noop`). In WildFly, this is done in the `standalone.xml`, located in the `$WILDFLY_DISTRIBUTION\server\wildfly-$WILDFLY_VERSION\standalone\configuration\` folder.

Expand Down Expand Up @@ -207,7 +207,7 @@ To activate Operaton Connect functionality for a process engine, a process engin

### Operaton Spin

You can use the Operaton Spin plugin to extend the engine functionality to de-/serialize object variables from and to JSON and XML. For more information, see the [Spin Reference](../reference/spin/index.md).
You can use the Operaton Spin plugin to extend the engine functionality to de-/serialize object variables from and to JSON and XML. For more information, see the [Spin Reference](../../../reference/spin/index.md).

#### Setup Spin

Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/introduction/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 30

Operaton is a Java-based framework. The main components are written in Java and we have a general focus on providing Java developers with the tools they need for designing, implementing and running business processes and workflows on the JVM. Nevertheless, we also want to make the process engine technology available to non-Java developers. This is why Operaton also provides a REST API which allows you to build applications connecting to a remote process engine.

Operaton can be used both as a standalone process engine server or embedded inside custom Java applications. The embeddability requirement is at the heart of many architectural decisions within Operaton. For instance, we work hard to make the process engine component a lightweight component with as little dependencies on [third-party libraries](../introduction/third-party-libraries/index.md) as possible. Furthermore, the embeddability motivates programming model choices such as the capabilities of the process engine to participate in Spring Managed or JTA [transactions and the threading model](../user-guide/process-engine/transactions-in-processes.md).
Operaton can be used both as a standalone process engine server or embedded inside custom Java applications. The embeddability requirement is at the heart of many architectural decisions within Operaton. For instance, we work hard to make the process engine component a lightweight component with as little dependencies on [third-party libraries](./third-party-libraries/index.md) as possible. Furthermore, the embeddability motivates programming model choices such as the capabilities of the process engine to participate in Spring Managed or JTA [transactions and the threading model](../user-guide/process-engine/transactions-in-processes.md).


# Process Engine Architecture
Expand All @@ -23,7 +23,7 @@ Operaton can be used both as a standalone process engine server or embedded insi

## Required Third-Party Libraries

See the section on [third-party libraries](../introduction/third-party-libraries/index.md).
See the section on [third-party libraries](./third-party-libraries/index.md).


# Operaton Architecture
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/introduction/downloading-operaton.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ menu:
# Prerequisites

Before downloading Operaton, make sure you have a JRE (Java Runtime Environment), or better, a JDK
(Java Development Kit) installed. Please check the supported [Java versions](../introduction/supported-environments.md#java).
(Java Development Kit) installed. Please check the supported [Java versions](./supported-environments.md#java).

[Download JDK][get-jdk]

Expand Down Expand Up @@ -67,7 +67,7 @@ from the [community download page][community-download-page].
[get-jdk]: https://www.oracle.com/technetwork/java/javase/downloads/index.html
[community-download-page]: https://camunda.com/download/
[enterprise-download-page]: /enterprise/download
[shared-engine]: ../introduction/architecture.md#shared-container-managed-process-engine
[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
[run-with-docker]: ../installation/docker.md
2 changes: 1 addition & 1 deletion docs/documentation/introduction/implemented-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Operaton supports the 1.1 version of DMN.


[OMG]: http://www.omg.org/
[modelers]: ../modeler/index.md
[modelers]: ../modeling-bpmn/index.md
[BPMN Modeling Tutorial]: https://operaton.org/bpmn/tutorial/
[BPMN Modeling Reference]: https://operaton.org/bpmn/reference/
[Quick Start (Java / JS)]: /get-started/quick-start/
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1
---
# Introduction

Welcome to the Operaton Manual! Operaton is a Java-based framework supporting BPMN for workflow and process automation, CMMN for Case Management and DMN for Business Decision Management. Also see: [Implemented Standards](../introduction/implemented-standards.md).
Welcome to the Operaton Manual! Operaton is a Java-based framework supporting BPMN for workflow and process automation, CMMN for Case Management and DMN for Business Decision Management. Also see: [Implemented Standards](./implemented-standards.md).

Operaton inherited its source code from the legacy of Camunda, Activiti and their predecessors. Camunda 7 was an important contribution to the open-source BPMN community. Building on this legacy, we aim to create a thriving future for a truly free and open-source BPMN engine.

Expand All @@ -30,7 +30,7 @@ To give you an overview of Operaton, the following illustration shows the most i

# Modeler

* [Camunda Modeler](../modeler/index.md): Modeling tool for BPMN 2.0 and CMMN 1.1 diagrams as well as DMN 1.3 decision tables.
* [Camunda Modeler](../modeling-bpmn/index.md): Modeling tool for BPMN 2.0 and CMMN 1.1 diagrams as well as DMN 1.3 decision tables.
* [bpmn.io](http://bpmn.io/): Open-source project for the modeling framework and toolkits.

# Web Applications
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/introduction/licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ If you are using Operaton, the entire software is provided under various open so
Operaton includes libraries developed by third parties. See the following resources:

* [Third-Party Libraries][third-party-libraries]: An overview of the dependencies Operaton distributes. Additionally, this page points out particularly important third-party licenses to be aware of.
* [HTML License Book Operaton](../introduction/third-party-libraries/Operaton-bpm-platform-license-book.md): A list of all dependencies Operaton distributes with the Operaton 7 artifacts, including their licenses and notices.
* [HTML License Book Operaton](./third-party-libraries/index.md#operaton-bpm-platform-license-book): A list of all dependencies Operaton distributes with the Operaton 7 artifacts, including their licenses and notices.
* [Plain text license book Operaton][license-book]: A plain text version of the license book.

[third-party-libraries]: ../introduction/third-party-libraries/index.md
[third-party-libraries]: ./third-party-libraries/index.md
<!--
[license-book]: https://artifacts.Operaton.com/artifactory/Operaton-bpm/org/Operaton/bpm/license-book/{{< minor-version >}}.0/license-book-{{< minor-version >}}.0.txt
-->
Expand Down
4 changes: 2 additions & 2 deletions docs/documentation/introduction/supported-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Run Operaton in every Java-runnable environment. Operaton is supported with our
* Apache Tomcat 9.0 / 10.1
* JBoss EAP 7.4 / 8.0
* WildFly Application Server 23.0 / 26.0 / 33.0
see [Installation guide](../installation/full/was/manual-liberty.md))
see [Installation guide](../installation/full/wildfly/index.md))

# Databases

Expand All @@ -52,7 +52,7 @@ Run Operaton in every Java-runnable environment. Operaton is supported with our
* SQL Server on Azure Virtual Machines
* Azure SQL Managed Instance
* Azure SQL Database
* H2 2.3 (not recommended for [Cluster Mode](../introduction/architecture.md#clustering-model) - see [Deployment Note](../user-guide/process-engine/deployments.md))
* H2 2.3 (not recommended for [Cluster Mode](./architecture.md#clustering-model) - see [Deployment Note](../user-guide/process-engine/deployments.md))

## Database Clustering & Replication

Expand Down
Loading