From 3b955c3020d787fb75e2bcf91b7532d97149d870 Mon Sep 17 00:00:00 2001
From: "S.Listl" <S.Listl@SLISTL.aditosoftware.local>
Date: Fri, 13 Dec 2019 10:23:27 +0100
Subject: [PATCH] Attribute_entity and JditoFilter_lib documentation
---
entity/Attribute_entity/documentation.adoc | 20 +++++++++++++++++++-
process/JditoFilter_lib/JditoFilter_lib.aod | 1 +
process/JditoFilter_lib/documentation.adoc | 3 +++
3 files changed, 23 insertions(+), 1 deletion(-)
create mode 100644 process/JditoFilter_lib/documentation.adoc
diff --git a/entity/Attribute_entity/documentation.adoc b/entity/Attribute_entity/documentation.adoc
index c791a9b9cea..b51e812c57f 100644
--- a/entity/Attribute_entity/documentation.adoc
+++ b/entity/Attribute_entity/documentation.adoc
@@ -4,4 +4,22 @@
an entity for the definition of attributes
----
-The Attribute entity is for creating new attributes that can be used in different other entitys.
\ No newline at end of file
+The Attribute entity is for creating new attributes that can be used in different other entitys. Attributes are stored in the database table "AB_ATTRIBUTE".
+
+== Data Structure
+
+An Attribute can have a parent attribute, the id of it is saved in the field "ATTRIBUTE_PARENT_ID". With that, attributes can be structured in groups and
+there is no limit to the depth of the tree-structure.
+
+== Difference to "AttributeRelation_entity"
+
+Don't confuse this entity with the "AttributeRelation_entity". The Attribute_entity defines the attributes that can be used in the AttributeRelation_entity,
+while an AttributeRelation represents the value set for one attribute and dataset.
+
+== Attribute types
+
+There are different types of attributes that can hold different kinds of values, like text, dates or numbers. Besides these also exist special types like groups, selections or
+object selections. These types are defined by the keyword "AttributeType". Behind every keyword entry of that keyword lies an entry in the object "$AttributeTypes" in the Attribute_lib,
+where properties such as the content type, the database field to store the value or other special properties are defined. In that library there also are functions to get these properties
+in AttributeTypeUtil. This logic makes it possible to handle attributes in the code in a generic way. Because of this, new attribute types could be added without
+too much effort.
\ No newline at end of file
diff --git a/process/JditoFilter_lib/JditoFilter_lib.aod b/process/JditoFilter_lib/JditoFilter_lib.aod
index 39f93d7408b..e6721ea4e24 100644
--- a/process/JditoFilter_lib/JditoFilter_lib.aod
+++ b/process/JditoFilter_lib/JditoFilter_lib.aod
@@ -2,6 +2,7 @@
<process xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.2.1" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/process/1.2.1">
<name>JditoFilter_lib</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
+ <documentation>%aditoprj%/process/JditoFilter_lib/documentation.adoc</documentation>
<process>%aditoprj%/process/JditoFilter_lib/process.js</process>
<variants>
<element>LIBRARY</element>
diff --git a/process/JditoFilter_lib/documentation.adoc b/process/JditoFilter_lib/documentation.adoc
new file mode 100644
index 00000000000..468297887c2
--- /dev/null
+++ b/process/JditoFilter_lib/documentation.adoc
@@ -0,0 +1,3 @@
+= JditoFilter_lib
+
+This library provides functions to make it easier to use the filter in entities with a jdito-recordcontainer.
\ No newline at end of file
--
GitLab