Merge branch 'sales_2001454_checklistdoku' into '2021.2'

Sales 2001454 checklistdoku

See merge request xrm/basic!1455

entity/ChecklistEntryValue_entity/ChecklistEntryValue_entity.aod

@@ -3,6 +3,7 @@
   <name>ChecklistEntryValue_entity</name>
   <title>Checklist</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/ChecklistEntryValue_entity/documentation.adoc</documentation>
   <icon>NEON:MQL</icon>
   <titlePlural>Checklists</titlePlural>
   <recordContainer>jDito</recordContainer>

entity/ChecklistEntryValue_entity/documentation.adoc

+= ChecklistEntryValue_entity
+
+== Overview
+
+ChecklistEntryValue_entity defines the value of a ChecklistEntry_entity
+
+== Relation to other entities
+
+Every ChecklistEntry corresponds to one row in the Checklist.
+Values of the ChecklistEntry_entity are stored in ChecklistEntryValue_entity.
+
+== Best Practice
+
+- See Checklist_entity documentation
+
+== FAQ
+
+- See Checklist_entity documentation

entity/ChecklistEntry_entity/ChecklistEntry_entity.aod

@@ -3,6 +3,7 @@
   <name>ChecklistEntry_entity</name>
   <title>Checklist entries</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/ChecklistEntry_entity/documentation.adoc</documentation>
   <icon>NEON:MQL</icon>
   <recordContainer>db</recordContainer>
   <entityFields>

entity/ChecklistEntry_entity/documentation.adoc

+= ChecklistEntry_entity
+
+== Overview
+
+ChecklistEntry_entity defines an automatic or manual checklist entry.
+
+== Relation to other entities
+
+Every ChecklistEntry corresponds to one row in the Checklist.
+Values of the ChecklistEntry_entity are stored in ChecklistEntryValue.
+
+== Best Practice
+
+- See Checklist_entity documentation
+
+== FAQ
+
+- See Checklist_entity documentation

entity/Checklist_entity/Checklist_entity.aod

@@ -3,6 +3,7 @@
   <name>Checklist_entity</name>
   <title>Checklists</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Checklist_entity/documentation.adoc</documentation>
   <icon>NEON:MQC</icon>
   <siblings />
   <onValidation>%aditoprj%/entity/Checklist_entity/onValidation.js</onValidation>

entity/Checklist_entity/documentation.adoc

+= Checklist_entity
+
+== Overview
+
+To add a new checklist, simply create a new entry in the Checklist context.
+
+3 types of checklists:
+1. Manuals that only have a title
+2. Automatic via customizing process (ChecklistEntryRegistry)
+3. Automatic by filter
+
+(2 and 3 cannot be set to done by the user but are automatically set to done as soon as the condition applies)
+
+2. have to be implemented once via customizing, almost everything is possible here, you only have to spend the time to implement it once.
+The automatic ones come from the ChecklistEntryRegistry_basic -> you can orientate yourself very well on the existing ones, you only build one object together with name, title, type, objectType and define functions for value and displayvalue.
+3. work in a similar way to 2. except that no customizing effort is necessary here, since the filters can be evaluated dynamically.
+
+== Relation to other entities
+
+The checklist entity is a list of ChecklistEntry_entity rows.
+ChecklistEntryValue_entity saves the values of the checklist.
+
+== Best Practice
+
+- Be careful with automatic checklists, too many automatic checklists slow down the system!
+
+== FAQ
+
+How to add a manual checklist entry:
+Simply add an entry in the Checklist context to the corresponding checklist.
+
+How to add a automatic checklist entry:
+Register the check process (see ChecklistEntryRegistry_basic),
+and choose the process name in the dropdown,
+while adding an entry in the checklist context.
+Also see "Best Practice" when planning to add an automatic checklist entry.