Workflow entities documentation

entity/WorkflowDefinition_entity/WorkflowDefinition_entity.aod

@@ -2,6 +2,7 @@
 <entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.13" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.13">
   <name>WorkflowDefinition_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/WorkflowDefinition_entity/documentation.adoc</documentation>
   <title>Workflow definition</title>
   <grantCreateProcess>%aditoprj%/entity/WorkflowDefinition_entity/grantCreateProcess.js</grantCreateProcess>
   <grantDelete v="false" />

entity/WorkflowDefinition_entity/documentation.adoc

+= WorkflowDefinition_entity
+
+IMPORTANT: All workflow-related entities require the process engine to be running, it must be activated in the system-configuration.
+
+This entity is used for managing the workflow definitions in the system. New definitions can be created by deploying a BPMN2.0-XML file to the process engine,
+the workflow itself has to be modeled in an external BPMN-editor like the flowable-modeler and then exported.
+The data is managed by the process engine and the communication with the engine is handled in the jdito-recordContainer.
+
+Deploying a workflow definition does not start the workflow. To start it, a new workflow instance has to be created (those are managed by the WorkflowInstance_entity).
+Where the workflow can be started is defined by WorkflowStartConfig_entity.
\ No newline at end of file

entity/WorkflowInstance_entity/WorkflowInstance_entity.aod

@@ -2,6 +2,7 @@
 <entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.13" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.13">
   <name>WorkflowInstance_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/WorkflowInstance_entity/documentation.adoc</documentation>
   <title>Workflow instance</title>
   <contentTitleProcess>%aditoprj%/entity/WorkflowInstance_entity/contentTitleProcess.js</contentTitleProcess>
   <titlePlural>Workflow instances</titlePlural>

entity/WorkflowInstance_entity/documentation.adoc

+= WorkflowInstance_entity
+
+IMPORTANT: All workflow-related entities require the process engine to be running, it must be activated in the system-configuration.
+
+A workflow instance is a workflow being executed. The instance can contain muliple variables to store data that is being used for the execution, for example variables that control the behaviour of service tasks.
+Normally, a workflow instance contains at least the two variables "targetId" and "targetContext" specifying the dataset that is associated with the instance. A common component
+that is used inside a workflow definition is the user task. If user tasks are created from a workflow instance, these will be displayed inside the instance they belong to.
+It is also possible to suspend the execution of the workflow, rendering the instance inactive. While the execution remains inactive, it can't be continued
+until the execution is resumed.
+
+The jdito-recordContainer uses two sources of data:
+. running workflow instances
+. historic workflow instances
+Because of that, it is possible to load instances that are already finished and not executed anymore.
\ No newline at end of file

entity/WorkflowTask_entity/WorkflowTask_entity.aod

@@ -2,6 +2,7 @@
 <entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.13" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.13">
   <name>WorkflowTask_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/WorkflowTask_entity/documentation.adoc</documentation>
   <title>Task</title>
   <grantCreate v="false" />
   <grantUpdateProcess>%aditoprj%/entity/WorkflowTask_entity/grantUpdateProcess.js</grantUpdateProcess>

entity/WorkflowTask_entity/documentation.adoc

+= WorkflowTask_entity
+
+A WorkflowTask represents a user task of a workflow instance. It can be assigned to a single user, or have candidates defined, then these candidates can see the task and
+one person can claim it to assign himself. Some tasks can contain a form definition, if that's the case the form data has to be filled by the user in order to
+complete the task.
\ No newline at end of file