docs: 📝 added fixed domain values documentation

miggi92 · Apr 24, 2024 · fe21880 · fe21880
1 parent e32410d
commit fe21880
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -108,7 +108,8 @@ function sidebarDocumentation() {
             { text: 'Create namespace', link: '/documentation/customizing/create-namespace' },
             { text: 'Define entity', link: '/documentation/customizing/define-entity' },
             { text: 'Define properties', link: '/documentation/customizing/define-properties' },
-            { text: 'Define navigation properties', link: '/documentation/customizing/define-associations' }
+            { text: 'Define navigation properties', link: '/documentation/customizing/define-associations' },
+            { text: 'Define search/value helps', link: '/documentation/customizing/define-searchhelps' }
           ]
         }
       ],

diff --git a/docs/documentation/customizing/attachments/fixed_domain_vh.png b/docs/documentation/customizing/attachments/fixed_domain_vh.png
diff --git a/docs/documentation/customizing/attachments/search_help_tree.png b/docs/documentation/customizing/attachments/search_help_tree.png
diff --git a/docs/documentation/customizing/define-searchhelps.md b/docs/documentation/customizing/define-searchhelps.md
@@ -0,0 +1,24 @@
+---
+title: Define search/value helps
+---
+
+#  {{ $frontmatter.title }}
+
+Search helps are currently ment to be global available. But the search help entity will only be generated if any property has an value in the "search help" column.
+
+![customizing tree search helps](./attachments/search_help_tree.png)
+
+Every search help entity will have 2 properties:
+- value
+- description
+
+## Fixed domain values
+
+The fixed domain values can be created as a value help with following customizing:
+![fixed domain value help](./attachments/fixed_domain_vh.png)
+
+So to get it to work you only need to enter the data element into the "data_element" column.
+
+The framework automatically propergates the values.
+
+In the example the value help enity will be: **fixedDomainValueHelpSet**