diff --git a/docs/documentation/introduction/implemented-standards.md b/docs/documentation/introduction/implemented-standards.md index 7eb61e4..307991c 100644 --- a/docs/documentation/introduction/implemented-standards.md +++ b/docs/documentation/introduction/implemented-standards.md @@ -51,10 +51,10 @@ Operaton supports the 1.1 version of DMN. [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/ +[Quick Start (Java / JS)]: /docs/get-started/quick-start/ [BPMN Implementation Reference]: ../reference/bpmn20/index.md [CMMN Implementation Reference]: ../reference/cmmn11/index.md -[DMN Getting Started]: /get-started/dmn/ +[DMN Getting Started]: /docs/get-started/dmn/ [DMN Implementation Reference]: ../reference/dmn/index.md [DMN Modeling Tutorial]: https://operaton.org/dmn/tutorial/ [Process Engine]: ../user-guide/process-engine/index.md diff --git a/docs/documentation/reference/connect/index.md b/docs/documentation/reference/connect/index.md index edc62ee..782bd93 100644 --- a/docs/documentation/reference/connect/index.md +++ b/docs/documentation/reference/connect/index.md @@ -4,4 +4,75 @@ title: 'Connectors' sidebar_position: 70 layout: "single" ---- \ No newline at end of file +--- + +Operaton Connect provides a simple API for connecting HTTP services and other +things. It aims at two usage scenarios: usage in a generic system such as the +Operaton process engine and standalone usage via API. + +## Connectors + +Operaton Connect provides a HTTP and a SOAP HTTP connector. If you want to +add an own connector to Connect please have a look at the [extending Connect](/docs/documentation/reference/connect/extending-connect.md) +section. This section also describes the usage of a `ConnectorConfigurator` to +configure the connector instances. + +During the request invocation of a connector an interceptor chain is passed. +The user can add own interceptors to this chain. The interceptor is called for +every request of this connector. + +```java +connector.addRequestInterceptor(interceptor).createRequest(); +``` + +## Maven Coordinates + +Connect can be used in any Java-based application by adding the following maven +dependency to your `pom.xml` file: + +:::info[Operaton BOM] +If you use other Operaton projects please import the +[Operaton BOM](/docs/get-started/apache-maven/) +to ensure correct versions for every Operaton project. +::: + +```xml + + + + org.operaton.connect + operaton-connect-bom + import + pom + ${version.operaton} + + + +``` + +```xml + + + org.operaton.connect + operaton-connect-core + + + + org.operaton.connect + operaton-connect-connectors-all + + +``` + +Operaton Connect is published to [maven central](https://central.sonatype.com/search?q=org.operaton+connect). + +:::info[Process engine plugin] +If you are using Connect in the Operaton process engine, you also need the `operaton-engine-plugin-connect` dependency. For more information, refer to the [Connectors guide](/docs/documentation/user-guide/process-engine/connectors.md). +::: + +# Logging + +Operaton Connect uses [operaton-commons-logging](https://github.com/operaton/operaton-bpm-platform/tree/master/commons/logging) which itself uses [SLF4J](http://slf4j.org) as a logging backend. To enable logging a SLF4J implementation has to be part of +your classpath. For example `slf4j-simple`, `log4j12` or `logback-classic`. + +Apache HTTP Client 5.x has built-in SLF4J support, so no additional bridges are required for HTTP client logging. \ No newline at end of file diff --git a/docs/documentation/user-guide/dmn-engine/embed.md b/docs/documentation/user-guide/dmn-engine/embed.md index a45ca0b..ebbf58a 100644 --- a/docs/documentation/user-guide/dmn-engine/embed.md +++ b/docs/documentation/user-guide/dmn-engine/embed.md @@ -22,7 +22,7 @@ project. It then shows how to configure and build a new DMN engine instance. The Operaton DMN engine is released to Maven Central. -Start by importing the [`operaton-engine-dmn` BOM](/get-started/apache-maven.md#operaton-dmn-engine-bom) +Start by importing the [`operaton-engine-dmn` BOM](/get-started/apache-maven.md#operaton-bom-bill-of-materials) to ensure correct dependency management. Next, include the [`operaton-engine-dmn`](/get-started/apache-maven.md#operaton-dmn) diff --git a/docs/documentation/webapps/admin/auditing.md b/docs/documentation/webapps/admin/auditing.md index d675e4d..e7a65ec 100644 --- a/docs/documentation/webapps/admin/auditing.md +++ b/docs/documentation/webapps/admin/auditing.md @@ -32,5 +32,5 @@ To only display Operations performed by a specific User, click in the Search fie You can filter the results by a timespan in which the operation occurred. Click in the Search field and select `Timestamp` from the dropdown. By clicking on the operator, you can select if you want to see results `before` or `after` the specified time. ### Operations of a specific Entity -If you are only interested in operations concerning Authorizations, you can use the `Entity Type` filter. For a complete list of logged operations, check out [History and Audit Event Log](/user-guide/process-engine/history/#glossary-of-operations-logged-in-the-user-operation-log). +If you are only interested in operations concerning Authorizations, you can use the `Entity Type` filter. For a complete list of logged operations, check out [History and Audit Event Log](../../user-guide/process-engine/history/#glossary-of-operations-logged-in-the-user-operation-log). ![Example img](./img/admin-audit-entity.png)Filter by Type diff --git a/docs/documentation/webapps/cockpit/auditing.md b/docs/documentation/webapps/cockpit/auditing.md index 4b6d275..174b1fe 100644 --- a/docs/documentation/webapps/cockpit/auditing.md +++ b/docs/documentation/webapps/cockpit/auditing.md @@ -30,7 +30,7 @@ You can limit Results the time the operation occurred. Click in the Search field ![Example img](./img/cockpit-audit-timestamp.png)Filter by Timestamp ### Operations of a specific Type -If you are only interested in a specific operation, for example, every time a process instance was manually modified, you can use the `operation` filter. Select the desired operation from the dropdown or start to type the name to filter through the list. For a complete list of logged operations, check out [History and Audit Event Log](/user-guide/process-engine/history/#glossary-of-operations-logged-in-the-user-operation-log). +If you are only interested in a specific operation, for example, every time a process instance was manually modified, you can use the `operation` filter. Select the desired operation from the dropdown or start to type the name to filter through the list. For a complete list of logged operations, check out [History and Audit Event Log](../../user-guide/process-engine/history/#glossary-of-operations-logged-in-the-user-operation-log). ![Example img](./img/cockpit-audit-type.png)Filter by Type ### Annotating Operation Logs diff --git a/docs/get-started/archive/java-process-app/forms.md b/docs/get-started/archive/java-process-app/forms.md index 5f5ab39..c801dea 100644 --- a/docs/get-started/archive/java-process-app/forms.md +++ b/docs/get-started/archive/java-process-app/forms.md @@ -71,7 +71,7 @@ Adjust the `META-INF/processes.xml` deployment descriptor file by adding the for ## Re-Build and Deploy -When you are done, save all resources, [perform a Maven build](../deploy/#build-the-web-application-with-maven) and [redeploy](../deploy/#deploy-to-apache-tomcat) the process application. +When you are done, save all resources, [perform a Maven build](deploy#build-the-web-application-with-maven) and [redeploy](deploy#deploy-to-apache-tomcat) the process application. :::note[Maven] Before selecting the pom.xml in the Package Explorer of Eclipse and performing a right-click and select Run As / Maven Install, it is best practice to perform a right-click and select Run As / Maven Clean to make sure all resources are replaced with their newest version. diff --git a/docs/get-started/archive/java-process-app/project-setup.md b/docs/get-started/archive/java-process-app/project-setup.md index 5d76e05..6cbae33 100644 --- a/docs/get-started/archive/java-process-app/project-setup.md +++ b/docs/get-started/archive/java-process-app/project-setup.md @@ -137,7 +137,7 @@ This file needs to be added to the `src/main/resources/META-INF` folder of the M ``` :::note[Empty META-INF/processes.xml] -You can leave the `META-INF/processes.xml` file empty. In that case, default values are used. See the [Empty Processes.xml](/docs/documentation/user-guide/process-applications/the-processes-xml-deployment-descriptor/#empty-processes-xml) section of the [User Guide](/docs/documentation/user-guide) for more information +You can leave the `META-INF/processes.xml` file empty. In that case, default values are used. See the [Empty Processes.xml](/docs/documentation/user-guide/process-applications/the-processes-xml-deployment-descriptor/#empty-processesxml) section of the [User Guide](/docs/documentation/user-guide) for more information ::: At this point you have successfully set up the process application and you can start modeling the first process. diff --git a/docs/get-started/archive/java-process-app/service-task.md b/docs/get-started/archive/java-process-app/service-task.md index cac2305..3de5a80 100644 --- a/docs/get-started/archive/java-process-app/service-task.md +++ b/docs/get-started/archive/java-process-app/service-task.md @@ -54,7 +54,7 @@ Use the properties view to reference the service task in the process (see screen ![Example image](./img/modeler-service-task3.png) -Save the process model and update it in Eclipse. [Build](../deploy/#build-the-web-application-with-maven), [deploy](../deploy/#deploy-to-apache-tomcat) and [execute](../forms/#re-build-and-deploy) the process application. After completing the *Approve Loan* step, check the logfile of the Apache Tomcat server: +Save the process model and update it in Eclipse. [Build](deploy#build-the-web-application-with-maven), [deploy](deploy#deploy-to-apache-tomcat) and [execute](forms#re-build-and-deploy) the process application. After completing the *Approve Loan* step, check the logfile of the Apache Tomcat server:
 INFO org.operaton.bpm.getstarted.loanapproval.ProcessRequestDelegate.execute
diff --git a/docs/get-started/archive/javaee7/complete-process.md b/docs/get-started/archive/javaee7/complete-process.md
index fce52f6..147bf4e 100644
--- a/docs/get-started/archive/javaee7/complete-process.md
+++ b/docs/get-started/archive/javaee7/complete-process.md
@@ -59,7 +59,7 @@ A new conversation is started again before the view is rendered and the task is
 
 Open the process with Camunda Modeler. Click on the prepare pizza user task. In the properties view, set the `Form Key` property to `app:preparepizza.jsf`.
 
-When you are done, save all resources, [perform a Maven build](../deploy/#build-the-process-application), and [redeploy](../deploy/#deploy-to-wildfly) the process application.
+When you are done, save all resources, [perform a Maven build](deploy#build-the-process-application), and [redeploy](deploy#deploy-to-wildfly) the process application.
 
 ### Add Send Rejection Email Service Task
 
@@ -100,7 +100,7 @@ public class OrderBusinessLogic {
 
 Open the process with Camunda Modeler. Click on the reject email service task. In the properties view, set the `Expression` property to `${orderBusinessLogic.rejectOrder(execution)}`.
 
-When you are done, save all resources, [perform a Maven build](../deploy/#build-the-process-application) and [redeploy](../deploy/#deploy-to-wildfly) the process application. You can now approve and reject an order in [Tasklist](http://localhost:8080/operaton/app/tasklist). The output of the `Send Rejection Email` task can be checked by looking into the logfile of the WildFly server. It should state that a rejection email has been sent:
+When you are done, save all resources, [perform a Maven build](deploy#build-the-process-application) and [redeploy](deploy#deploy-to-wildfly) the process application. You can now approve and reject an order in [Tasklist](http://localhost:8080/operaton/app/tasklist). The output of the `Send Rejection Email` task can be checked by looking into the logfile of the WildFly server. It should state that a rejection email has been sent:
 
 
   Sending Email:
diff --git a/docs/get-started/archive/javaee7/service-task.md b/docs/get-started/archive/javaee7/service-task.md
index dc9076b..bcef271 100644
--- a/docs/get-started/archive/javaee7/service-task.md
+++ b/docs/get-started/archive/javaee7/service-task.md
@@ -167,7 +167,7 @@ public class OrderBusinessLogic {
 
 Use the properties view of the Persist Service Task in the process (see screenshot). You need to enter `${orderBusinessLogic.persistOrder(execution)}` as the `Expression` property. This will call the `persistOrder` method of the named EJB with the current execution as parameter.
 
-[Build](../deploy/#build-the-process-application), [deploy](../deploy/#deploy-to-wildfly) and start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Now the *Persist Order* step should have been completed automatically. Check that by looking into the logfile of the WildFly server. It will show an entry for the new order entity:
+[Build](deploy#build-the-process-application), [deploy](deploy#deploy-to-wildfly) and start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Now the *Persist Order* step should have been completed automatically. Check that by looking into the logfile of the WildFly server. It will show an entry for the new order entity:
 
 
   INFO  [stdout] Hibernate: insert into OrderEntity (address, approved, customer, pizza, version, id) values (?, ?, ?, ?, ?, ?)
diff --git a/docs/get-started/archive/javaee7/task-form.md b/docs/get-started/archive/javaee7/task-form.md
index c133e80..42d9b0d 100644
--- a/docs/get-started/archive/javaee7/task-form.md
+++ b/docs/get-started/archive/javaee7/task-form.md
@@ -174,4 +174,4 @@ Open the process with the modeler. Click on the *Approve Order* user task. In th
 
 Open the process with the modeler. In the properties view, set the `Condition` property of the conditional sequence flows after the exclusive gateway to `${orderBusinessLogic.getOrder(orderId).approved}` respectively `${not orderBusinessLogic.getOrder(orderId).approved}`.
 
-When you are done, save all resources, [perform a Maven build](../deploy/#build-the-process-application), and [redeploy](../deploy/#deploy-to-wildfly) the process application. Start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Select the `All Tasks` element on the left side of Tasklist. An `Approve Order` task should then be listed in the tasklist. Go to the task and press on Claim. Now you can approve the pizza order.
\ No newline at end of file
+When you are done, save all resources, [perform a Maven build](deploy#build-the-process-application), and [redeploy](deploy#deploy-to-wildfly) the process application. Start the process `Order Pizza` in [Tasklist](http://localhost:8080/operaton/app/tasklist). Fill out the emerging form. Select the `All Tasks` element on the left side of Tasklist. An `Approve Order` task should then be listed in the tasklist. Go to the task and press on Claim. Now you can approve the pizza order.
\ No newline at end of file
diff --git a/docs/get-started/dmn/deploy.md b/docs/get-started/dmn/deploy.md
index c269815..d723822 100644
--- a/docs/get-started/dmn/deploy.md
+++ b/docs/get-started/dmn/deploy.md
@@ -103,8 +103,8 @@ Congratulations, you have now successfully set up a project with your first DMN
 
 Next,
 
-* see how you can evaluate the decision using the [REST API](/docs/documentation/reference/rest/decision-definition/post-evaluate/),
+* see how you can evaluate the decision using the [REST API](https://docs.operaton.org/reference/latest/rest-api/#tag/Condition/operation/evaluateCondition),
 * learn more about DMN by reading the [DMN Reference](/docs/documentation/reference/dmn/),
 * learn more about the [Decision API exposed by Operaton Process Engine](/docs/documentation/user-guide/process-engine/decisions/),
 * check how you can invoke the decision from a [BPMN Business Rule Task](/docs/documentation/reference/bpmn20/tasks/business-rule-task/),
-* Bonus Step: [Decision Requirements Graph](../drg)
+* Bonus Step: [Decision Requirements Graph](drg.md)
diff --git a/docs/get-started/dmn/model.md b/docs/get-started/dmn/model.md
index 9a347fa..3c79814 100644
--- a/docs/get-started/dmn/model.md
+++ b/docs/get-started/dmn/model.md
@@ -96,6 +96,5 @@ When you are done, save your changes by clicking *File > Save File As..*. In the
 
 Return to Eclipse. Right-click the project folder and click *Refresh*. This synchronizes the new DMN file with Eclipse.
 
-For Eclipse to automatically synchronize the workspace with the filesystem, consider [configuring auto-sync in eclipse][auto-sync].
+For Eclipse to automatically synchronize the workspace with the filesystem, consider configuring auto-sync in eclipse.
 
-[auto-sync]: /docs/documentation/modeler/tips/#eclipse-project-synchronization