Documentation

README.md

@@ -4,85 +4,128 @@
 
 # What is the Cherry Runtime?
 
-The Cherry Runtime is dedicated to execute Camunda 8 Connectors and Workers. It proved
+The Cherry Runtime is dedicated to executing Camunda 8 Connectors and Workers.
 It provides administrative pages to administrators and business developers.
 
-![Cherry Runtime Overview](src/main/resources/static/img/CherryFrameworkOverview.png?raw=true)
+![Cherry Runtime Overview](doc/images/architecture.png)
 
-For a quick execution, access the Tutorial chapter.
+The Cherry runtime accepts any OUTBOUND connector. The definition can be downloaded from the MarketPlace or any GitHub repository (SOON).
+It provides an Administrator page where
+* a connector can be stop/start
+* execution statistics are available to size the cluster: Are multiple runtimes necessary to handle the load?
 
-Collections of connectors/workers can be integrated in the Cherry Runtime. A collection is an application ready to execute.
 
 This documentation gives information:
-* for administrators, to start and administrate a Collection
-* for BPM Designer,to access documentation, and download Element-Template in your modeler
-* for developers, to develop a connector or a worker in the framework, to create a Collection.
+* for administrators to start and administrate a Collection
+* for BPM Designer, to access documentation and download Element-Template in your modeler
+* For developers, which information can be added during the development, to propose more information for administrators and BPM Designer
 
 
-## Administrator
-Multiple collections used the Cherry Runtime (Office PDF, CMIS). Each collection embedded multiple connectors or runners.
+# Administrator
+Any connectors OUTBOUND can be executable by the runtime. INBOUND connectors are not supported for the moment.
 
-Each collection is an application, available as a Java application, a JAR file or as a Docker image.
+A connector can be available:
+* as a JAR file, downloaded from a GitHub repository
+* from the Camunda Marketplace. Then, it's possible to access the JAR file or to download the connector directly from the Cherry administration page (SOON)
 
-You can
-* start a runtime, and upload inside any JAR
-* start directly a collection.
+What do you need to do to start the runtime?
 
+Check the [Installation guide](doc/InstallationGuide/README.md) for more information.
 
-Provide the information to connect the Zeebe engine, and start the application.
-The framework provides then an administrative page to monitor execution.
-![Cherry Main Page](doc/CherryMainPage.png?raw=true)
+In a short overview, to enable a Cherry runtime in your cluster:
 
-On this page, connectors/workers are visible with statistics. The administrator can stop a connector/worker 
-and change the number of threads dedicated to the pool of execution.
+## Download the application
 
+Download the Docker Image, or use the docker-compose given in the [docker-Cherry](docker-cherry/README.md)
+The image is available here.
 
-## BPMN Designer
-A Cherry collection is a set of connectors/workers. Within the administrative page, the designer can access 
-all the different artifacts.
+```
+ghcr.io/camunda-community-hub/zeebe-cherry-runtime:latest
+````
 
-He can access the type of connector/worker and information about the input and the output of the connector. A list of BPMN errors thrown by the connector/worker is available.
-![Documentation](doc/InputOutputDocumentation.png?raw=true)
+## Configure the application
 
+Cherry needs:
+* to connect to Zeebe to get jobs
+* to save connectors and statistics
 
-He can download the Element-Templates of the collection to load it in the Modeler or in the Web Modeler. The design becomes very easy.
+Check the [application.yaml](src/main/resources/application.yaml) file to see all parameters.
+It is possible to pass parameters as a variable, for example.
 
-![Template Modeler](doc/DeveloperGuide/TemplateModeler.png?raw=true)
+``
+environment:
+- ZEEBE_CLIENT_BROKER_GATEWAY_ADDRESS=zeebe:26500
+  ``
+  To connect a local engine in the same cluster.
 
-## For the Developer
+An H2 database is configured by default to save information. Use a SQL database for a robust database.
+Looks [docker-compose-cherry-postgres.yaml](docker-cherry/docker-compose-cherry-postgres.yaml) to see an example.
 
+Using an SQL database allows you to configure not only one Cherry pod but a farm of pods. Each pod accesses the same database, and through Connectors, statistics are shared between all pots.
 
-The developer can focus on the connector development. He has to declare Input and Output in the description. 
-These have different advantages:
+## Start the application
 
-* The Cherry runtime will manage documentation, and it doesn't need to worry about it
-* the Template Modeler will be generated by the Cherry runtime.
-* The Cherry runtime controls the contract. If a variable is mandatory, the Framework controls its existence. On the Execute() method, the developer does not need to worry about the variable.
-* if the connector / runner declare a BPMN Error, the glue between the code and the throw is take in charge by the Cherry runtime.
-
-Execution is managed by the Cherry runtime, and a lot of administrative function is included: start/stop, change the number of thread, and get statistics on the execution.
+Start the application, and check the main page. The port number is 9081 by default in the application.yaml file
+
+![Cherry Main Page](doc/images/CherryPageDashboard.png)
+
+On this page, connectors/workers are visible with statistics. The administrator can stop a connector/worker
+and change the number of threads dedicated to the execution pool.
+
+## Loads connectors
+
+Connect to the Administration page and navigate to the `Content` page. Upload a JAR file via the page.
+
+![LoadConnector.png](doc/images/CherryPageContent.png)
+
+
+# BPMN Designer
+Connectors can be accessible via the Cherry `Definition` page.
 
+Multiple functions are available if the connectors come from the marketplace or implement the Cherry additional methods.
 
+##  Documentation
 
-# Installation
+Access the `Definition` page
+![CherryDefinitionPage.png](doc/images/CherryPageDefinition.png)
 
-Check the [Installation guide](doc/InstallationGuide/README.md) 
+Click on a connector.
+Different tabs are visible.
+If the connector defines the additional Cherry method, Inputs, Outputs, and Errors are visible in the tab.
 
-# Developer guide
+![Input tab](doc/images/InputOutputDocumentation.png)
 
-To start, visit the [Tutorial](doc/Tutorial/README.md)
 
-Access the [Developer guide](doc/DeveloperGuide/README.md)
+## Element template
 
-If you want to create your collection, visit [Create my collection](doc/CreateMyCollection/README.md) 
+The element template can be downloaded if the connector defines the additional Cherry methods or comes from the MarketPlace.
 
+Open the ZIP file, and upload content on the Desktop modeler, path `resources\element-templates.
+![ModelerElementTemplate.png](doc/Fimages/ModelerElementTemplate.png)
 
+It's possible to upload the file on the Web Modeler.
+
+# For the Developer
+
+Cherry runtime can run any connector.
+The connector must include some extra methods to allow the Business Developers to access new functions, like the documentation.
+
+The second advantage of implementing this method is element-template generation.
+When Inputs and Outputs are explained, the Cherry runtime can generate the element template and hide the complexity.
+
+Cherry runtime has more critical features for the developers:
+* The Cherry runtime controls the contract. If a variable is mandatory, the Framework controls its existence. On the Execute() method, the developer does not need to worry about the variable.
+* if the connector declares a BPMN Error, the glue between the code and the throw is taken in charge by the Cherry runtime.
+
+The Cherry runtime manages execution, and many administrative functions are included: starting/stopping, changing the number of threads, and getting statistics on execution.
+
+Check the [Developer guide](doc/DeveloperGuide%2FREADME.md)
 
 
 # Internal tip
 
 ## Create the Docker image
-Because the library contains Java and React script, to deploy it, the machine must have two environement
+Because the library contains Java and React script, to deploy it, the machine must have two environments
 
 .github/workflows/mvn-build.yml
 
@@ -100,17 +143,17 @@ Because the library contains Java and React script, to deploy it, the machine mu
       run:  CI=false mvn --batch-mode --update-snapshots package
 `````
 
-CI=false, else any warning will stop the construction
+CI=false, else any warning will stop the construction.
 
-Docker image is then available in the package
+The docker image is then available in the package
 `https://github.com/camunda-community-hub/zeebe-cherry-runtime/pkgs/container/zeebe-cherry-runtime`
 
 
 
 
 
 # Build
-The project is configured to publish automatically to maven central the JAR file, and to docker package a Docker image
+The project is configured to publish the JAR file automatically to Maven Central and to docker package a Docker image.
 
 If you want to build a local maven image, use
 
@@ -124,7 +167,3 @@ See .github/workflows/mvn-release.yml
 
 Visit
 https://github.com/camunda-community-hub/community-action-maven-release/tree/main
-
-
-Error
-Error: Resource not accessible by integration

doc/DeveloperGuide/README.md

@@ -7,7 +7,7 @@ The developer can choose two different pattern:
 * worker
 
 The connector pattern embed the Connector SDK
-![Architecture](../Architecture.png?raw=true)
+![Architecture](../images/Architecture.png?raw=true)
 
 In the next part of the documentation, we use the term of **Runner**. A Runner is a Connector or a Worker.
 

doc/todo.md

@@ -38,7 +38,7 @@ This should be the correct information, but does not work
 # Inbound connector
 Cherry handle Inbound connector
 
-# Upload connector JAR
+
 
 ## PVC
 Documentation: via a PVC, upload the JAR and Cherry load it at the beginning.

src/main/resources/application.yaml

@@ -90,9 +90,9 @@ spring2.datasource:
   username: "camunda"
   password: "camunda"
   driver-class-name: "org.postgresql.Driver"
-spring.jpa.database-platform: "org.hibernate.dialect.PostgreSQL94Dialect"
+spring2.jpa.database-platform: "org.hibernate.dialect.PostgreSQL94Dialect"
 
-org.hibernate.dialect: "PostgreSQL94Dialect"
+org2.hibernate.dialect: "PostgreSQL94Dialect"
 
 # spring.datasource.validation-query: SELECT 1;
 # --------------------- H2
@@ -101,8 +101,8 @@ spring.datasource:
   driver-class-name: "org.h2.Driver"
   username: "sa"
   password: "password"
-spring2.jpa.database-platform: "org.hibernate.dialect.H2Dialect"
-org2.hibernate.dialect: "H2Dialect"
+spring.jpa.database-platform: "org.hibernate.dialect.H2Dialect"
+org.hibernate.dialect: "H2Dialect"
 
 # allow CLOB in Postgres
 spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation: true