diff --git a/entity/ChecklistEntryValue_entity/ChecklistEntryValue_entity.aod b/entity/ChecklistEntryValue_entity/ChecklistEntryValue_entity.aod index 2eb878e8a508ae477f8bf474c5a7a8c04dab20c0..e71941c3ad1c74b08a54672a74c3362fcd27154c 100644 --- a/entity/ChecklistEntryValue_entity/ChecklistEntryValue_entity.aod +++ b/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> diff --git a/entity/ChecklistEntryValue_entity/documentation.adoc b/entity/ChecklistEntryValue_entity/documentation.adoc new file mode 100644 index 0000000000000000000000000000000000000000..d2bb91e764f3fdea775321deff8e5c57f892aba4 --- /dev/null +++ b/entity/ChecklistEntryValue_entity/documentation.adoc @@ -0,0 +1,18 @@ += 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 diff --git a/entity/ChecklistEntry_entity/ChecklistEntry_entity.aod b/entity/ChecklistEntry_entity/ChecklistEntry_entity.aod index eb4a62d98a7ad332797e187d8017588abc33c141..f23b5715636069898abc3c808c6afb154684aa88 100644 --- a/entity/ChecklistEntry_entity/ChecklistEntry_entity.aod +++ b/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> diff --git a/entity/ChecklistEntry_entity/documentation.adoc b/entity/ChecklistEntry_entity/documentation.adoc new file mode 100644 index 0000000000000000000000000000000000000000..173e787e0ea0c3ec4b8ce9ab9428670f28e96d64 --- /dev/null +++ b/entity/ChecklistEntry_entity/documentation.adoc @@ -0,0 +1,18 @@ += 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 diff --git a/entity/Checklist_entity/Checklist_entity.aod b/entity/Checklist_entity/Checklist_entity.aod index 6be48a259796713e7daf96420e286ba28617779c..d638a5d306947304dc42fc3e292659aa6ab0a065 100644 --- a/entity/Checklist_entity/Checklist_entity.aod +++ b/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> diff --git a/entity/Checklist_entity/documentation.adoc b/entity/Checklist_entity/documentation.adoc new file mode 100644 index 0000000000000000000000000000000000000000..a432d130213fca1a14f54b397b2108bbcacb15d2 --- /dev/null +++ b/entity/Checklist_entity/documentation.adoc @@ -0,0 +1,36 @@ += 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.