Workflow entities documentation

entity/WorkflowInstanceHistory_entity/WorkflowInstanceHistory_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.14" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.14">
   <name>WorkflowInstanceHistory_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/WorkflowInstanceHistory_entity/documentation.adoc</documentation>
   <title>History</title>
   <grantCreate v="false" />
   <grantUpdate v="false" />

entity/WorkflowInstanceHistory_entity/documentation.adoc

+= WorkflowInstanceHistory_entity
+
+IMPORTANT: All workflow-related entities require the process engine to be running, it must be activated in the system-configuration.
+
+The WorkflowInstanceHistory_entity loads historic activities related to a workflow instance. These can be of different types like some kinds of tasks or gateways (refer to the keyword "WorkflowActivityType").
+This history can give information about the current status of a workflow instance and shows when the activities started and ended.
\ No newline at end of file

entity/WorkflowSignal_entity/WorkflowSignal_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.14" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.14">
   <name>WorkflowSignal_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/WorkflowSignal_entity/documentation.adoc</documentation>
   <title>Signal</title>
   <titlePlural>Signals</titlePlural>
   <recordContainer>db</recordContainer>

entity/WorkflowSignal_entity/documentation.adoc

+= WorkflowSignal_entity
+
+IMPORTANT: All workflow-related entities require the process engine to be running, it must be activated in the system-configuration.
+
+A workflow signal can be sent to notify workflow instances that a specific event has happened and can trigger the further execution of the workflow or even start a new instance, if defined by
+the process. This entity is used for connecting signals that exists in a workflow definition to events in the Adito system, so that the signal is thrown if the event happens.
+The events that can be defined include creating, updating or deleting datasets and they are saved in the database table "WORKFLOWSIGNAL".
\ No newline at end of file

entity/WorkflowStartConfig_entity/WorkflowStartConfig_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.14" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.14">
   <name>WorkflowStartConfig_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/WorkflowStartConfig_entity/documentation.adoc</documentation>
   <title>Usage</title>
   <titlePlural>Usage</titlePlural>
   <recordContainer>db</recordContainer>

entity/WorkflowStartConfig_entity/documentation.adoc

+= WorkflowStartConfig_entity
+
+IMPORTANT: All workflow-related entities require the process engine to be running, it must be activated in the system-configuration.
+
+The WorkflowStartConfig defines at what places in the application a new instance of a workflow definition can be started. For this configuration, the db-table "WORKFLOWSTARTCONFIG" is used.
\ No newline at end of file

entity/WorkflowVariableValue_entity/WorkflowVariableValue_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.14" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.14">
   <name>WorkflowVariableValue_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/WorkflowVariableValue_entity/documentation.adoc</documentation>
   <title>Variable</title>
   <titlePlural>Variables</titlePlural>
   <recordContainer>jdito</recordContainer>

entity/WorkflowVariableValue_entity/documentation.adoc

+= WorkflowVariableValue_entity
+
+IMPORTANT: All workflow-related entities require the process engine to be running, it must be activated in the system-configuration.
+
+The purpose of this entity is to display the current variables and their values of a workflow instance.
\ No newline at end of file