Skip to content

Commit d6432b2

Browse files
First documentation
1 parent 6199516 commit d6432b2

2 files changed

Lines changed: 260 additions & 326 deletions

File tree

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ It provides
2020

2121
* A farm of runtime, all are managed from one single page
2222

23-
![Cherry Runtime Overview](doc/images/architecture.png)
23+
* For developpers, a library is avaiable to generate element-templates for Connectors and Workers
24+
25+
![Cherry Runtime Overview](doc/images/Architecture.png)
2426

2527
The Cherry runtime accepts any OUTBOUND connector.
2628

@@ -31,7 +33,7 @@ This documentation gives information:
3133
* For developers, which information can be added during the development, to propose more information for administrators and BPM Designer
3234

3335

34-
# Administrator
36+
# For Administrator
3537
Any connectors OUTBOUND can be executable by the runtime. INBOUND connectors are not supported for the moment.
3638

3739
A connector can be available:
@@ -94,7 +96,7 @@ camunda:
9496
prefer-rest-over-grpc: false
9597
```
9698
97-
## Self-manage with Identity
99+
### Self-manage with Identity
98100
99101
````yaml
100102
camunda:
@@ -143,7 +145,8 @@ Connect to the Administration page and navigate to the `Content` page. Upload a
143145
![LoadConnector.png](doc/images/CherryPageContent.png)
144146

145147

146-
# BPMN Designer
148+
149+
# For BPMN Designer
147150
Connectors can be accessible via the Cherry `Definition` page.
148151

149152
Multiple functions are available if the connectors come from the marketplace or additional Cherry methods are implemented.
@@ -169,27 +172,22 @@ Open the ZIP file, and upload content on the Desktop modeler, path `resources\el
169172

170173
It's possible to upload the file on the Web Modeler.
171174

172-
# For the Developer
173175

174-
Cherry runtime can run any connector.
175-
The connector must include some extra methods to allow the Business Developers to access new functions, like the documentation.
176176

177-
The second advantage of implementing this method is element-template generation.
178-
When Inputs and Outputs are explained, the Cherry runtime can generate the element template and hide the complexity.
177+
# For Developers
179178

180-
Cherry runtime has more critical features for the developers:
181-
* 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.
182-
* if the connector declares a BPMN Error, the glue between the code and the throw is taken in charge by the Cherry runtime.
179+
The Cherry runtime can run any connector or worker. This execution host is called a runner.
183180

184-
The Cherry runtime manages execution, and many administrative functions are included: starting/stopping, changing the number of threads, and getting statistics on execution.
181+
A runner extends the base connector/worker with extra capabilities aimed at Business Developers: built-in documentation access and, critically, element-template generation.
182+
Once Inputs and Outputs are declared on a connector, the runner can generate the corresponding element template automatically, hiding that complexity entirely.
185183

186-
Check the [Developer guide](doc/DeveloperGuide/README.md)
184+
Read the [Developer guide](doc/DeveloperGuide/README.md)
187185

188186

189187
# Internal tip
190188

191189
## Create the Docker image
192-
Because the library contains Java and React script, to deploy it, the machine must have two environments
190+
The library contains Java and React script. To deploy it, the machine must have two environments
193191

194192
.github/workflows/mvn-build.yml
195193

0 commit comments

Comments
 (0)