From 07dd1daef58b2d5a640f793354f6c500f467a02e Mon Sep 17 00:00:00 2001
From: "b.ulrich" <b.ulrich@adito.de>
Date: Fri, 8 May 2020 10:23:56 +0200
Subject: [PATCH] [Projekt: Entwicklung - Neon][TicketNr.:
1057236][Dokumentation der Export-Fields]
---
.../ExportTemplateField_entity.aod | 1 +
.../documentation.adoc | 5 ++++
.../entityfields/field/documentation.adoc | 5 ++++
.../entityfields/field/dropDownProcess.js | 6 +++++
.../ExportTemplatePlaceOfUse_entity.aod | 1 +
.../documentation.adoc | 8 ++++--
.../placeofuse/documentation.adoc | 4 +++
.../ExportTemplate_entity/documentation.adoc | 25 ++++++++++++++++---
8 files changed, 49 insertions(+), 6 deletions(-)
create mode 100644 entity/ExportTemplateField_entity/entityfields/field/documentation.adoc
create mode 100644 entity/ExportTemplatePlaceOfUse_entity/entityfields/placeofuse/documentation.adoc
diff --git a/entity/ExportTemplateField_entity/ExportTemplateField_entity.aod b/entity/ExportTemplateField_entity/ExportTemplateField_entity.aod
index 84396f573e..2691c9556a 100644
--- a/entity/ExportTemplateField_entity/ExportTemplateField_entity.aod
+++ b/entity/ExportTemplateField_entity/ExportTemplateField_entity.aod
@@ -25,6 +25,7 @@
</entityField>
<entityField>
<name>FIELD</name>
+ <documentation>%aditoprj%/entity/ExportTemplateField_entity/entityfields/field/documentation.adoc</documentation>
<title>Field</title>
<mandatory v="true" />
<dropDownProcess>%aditoprj%/entity/ExportTemplateField_entity/entityfields/field/dropDownProcess.js</dropDownProcess>
diff --git a/entity/ExportTemplateField_entity/documentation.adoc b/entity/ExportTemplateField_entity/documentation.adoc
index 12a981536f..5e0969dbcc 100644
--- a/entity/ExportTemplateField_entity/documentation.adoc
+++ b/entity/ExportTemplateField_entity/documentation.adoc
@@ -1,4 +1,9 @@
= ExportTemplateField_entity
Entity to store all the Fields from the ExportTemplates, linked to the Template via the ExportTemplateId.
+
+The selection of Exportfields is created by using the Placeholder function "PlaceholderUtils.getPlaceholders()".
+If you want to add more fields, you just have to add the function "CustomPlaceholderUtils.getPlaceholders()" to the dropDownProcess
+and add the desired Fields as placeholders in the CustomPlaceholder_lib.
+
Own dbTable Entity is needed to make it possible to store multiple fields for one template
\ No newline at end of file
diff --git a/entity/ExportTemplateField_entity/entityfields/field/documentation.adoc b/entity/ExportTemplateField_entity/entityfields/field/documentation.adoc
new file mode 100644
index 0000000000..6144ef2d4a
--- /dev/null
+++ b/entity/ExportTemplateField_entity/entityfields/field/documentation.adoc
@@ -0,0 +1,5 @@
+= FIELD
+
+The selection of Exportfields is created by using the Placeholder function "PlaceholderUtils.getPlaceholders()".
+If you want to add more fields, you just have to add the function "CustomPlaceholderUtils.getPlaceholders()" to the dropDownProcess
+and add the desired Fields as placeholders in the CustomPlaceholder_lib.
diff --git a/entity/ExportTemplateField_entity/entityfields/field/dropDownProcess.js b/entity/ExportTemplateField_entity/entityfields/field/dropDownProcess.js
index 08ec960569..f5b8c99880 100644
--- a/entity/ExportTemplateField_entity/entityfields/field/dropDownProcess.js
+++ b/entity/ExportTemplateField_entity/entityfields/field/dropDownProcess.js
@@ -2,6 +2,12 @@ import("system.result");
import("Placeholder_lib");
import("system.text")
+
+//The current selection of Exportfields is created by using the Placeholder function "PlaceholderUtils.getPlaceholders()".
+//if you want to add more fields, you just have to add the function "CustomPlaceholderUtils.getPlaceholders()" to the dropDownProcess
+//and add the desired Fields as placeholders in the CustomPlaceholder_lib.
+
+
var placeholders = PlaceholderUtils.getPlaceholders(null, true).map(function (placeholder){
return [placeholder.placeholderName, placeholder.title || placeholder.placeholderName];
})
diff --git a/entity/ExportTemplatePlaceOfUse_entity/ExportTemplatePlaceOfUse_entity.aod b/entity/ExportTemplatePlaceOfUse_entity/ExportTemplatePlaceOfUse_entity.aod
index 62ae13223c..3409d00b66 100644
--- a/entity/ExportTemplatePlaceOfUse_entity/ExportTemplatePlaceOfUse_entity.aod
+++ b/entity/ExportTemplatePlaceOfUse_entity/ExportTemplatePlaceOfUse_entity.aod
@@ -24,6 +24,7 @@
</entityField>
<entityField>
<name>PLACEOFUSE</name>
+ <documentation>%aditoprj%/entity/ExportTemplatePlaceOfUse_entity/entityfields/placeofuse/documentation.adoc</documentation>
<title>Place of use</title>
<consumer>ContextExportTemplatePlaceOfUse</consumer>
<mandatory v="true" />
diff --git a/entity/ExportTemplatePlaceOfUse_entity/documentation.adoc b/entity/ExportTemplatePlaceOfUse_entity/documentation.adoc
index 33f229e05d..a61ae5a651 100644
--- a/entity/ExportTemplatePlaceOfUse_entity/documentation.adoc
+++ b/entity/ExportTemplatePlaceOfUse_entity/documentation.adoc
@@ -1,5 +1,9 @@
= ExportTemplatePlaceOfUse_entity
Entity to select all Modules where the created template should be useable (to limit the availability in the modules).
-Linked via the ExportTemplateID
-Own dbTable and Entity are to make it possible to store multiple fields for one template.
\ No newline at end of file
+
+The selection of Places Of usage is created via the link to the context_entity and limiting it
+by the Blacklist_param (which is being inverted to an whitelist thanks to the invertBlacklist_param).
+
+Linked via the ExportTemplateID to ExportTemplates.
+Own dbTable and Entity are to make it possible to store multiple fields for one template.
diff --git a/entity/ExportTemplatePlaceOfUse_entity/entityfields/placeofuse/documentation.adoc b/entity/ExportTemplatePlaceOfUse_entity/entityfields/placeofuse/documentation.adoc
new file mode 100644
index 0000000000..38a9ff1a0f
--- /dev/null
+++ b/entity/ExportTemplatePlaceOfUse_entity/entityfields/placeofuse/documentation.adoc
@@ -0,0 +1,4 @@
+= PlaceOfuse
+
+The selection of Places Of usage is created via the link to the context_entity and limiting it
+by the Blacklist_param (which is being inverted to an whitelist thanks to the invertBlacklist_param).
\ No newline at end of file
diff --git a/entity/ExportTemplate_entity/documentation.adoc b/entity/ExportTemplate_entity/documentation.adoc
index 7ff3082082..740f4ae68f 100644
--- a/entity/ExportTemplate_entity/documentation.adoc
+++ b/entity/ExportTemplate_entity/documentation.adoc
@@ -1,9 +1,26 @@
= ExportTemplate_entity
-Entity to store all the ExportTemplates.
-Exporttemplates are used to give the user an easy way to export Data from an table.
+Entity to store all the Export templates.
+Export templates are used to give the user an easy way to export Data from an table.
+The template gets configured once (by an system-admin) and the user can easily use these template
+via the action without having to worry about the fields and their sorting.
-linked via the ExportTemplateId to:
+Process:
+ 1. The System-admin configures a Export template with the desired specification (title, description,
+ places of use, separators, language, fields and sorting)
+ 2. The User is located in the Filterview of the context specified in the place of use of the template.
+ 3. Selects the records manually or uses the filter function to limit the data he wants to export
+ 4. And presses on the action (Located at the top of the Table)
+ 5. Selects the desired template and an fitting Name for the exported Data (If none: "templateTitle_dd.MM.yyyy.HH:mm:ss")
+ 6. Download of the CSV-file starts automatically
+ Appendix: The CSV is arranged like this: every field gets one column, which has the translated columntitle
+ at the top and the data in the cells underneath in the same sorting as the filterview.
+ fields which don't have any data to show are just left blank.
+
+PlaceOfUse is used to configure where the template can be used. (Only Options at the moment are the Contact and the Organisation Context)
+ISOLanguage is used to translate the columntitles in the correct language. (Not the data itself!)
+
+Linked via the ExportTemplateId to:
-ExportTemplateField_entity to make it possible to store multiple fields for one template
-ExportTemplatePlaceOfUse_entity to make it possible to store multiple places of usage for one template
--ExportTemplateSelection_entity entity for the selection of the template
\ No newline at end of file
+-ExportTemplateSelection_entity entity for the selection of the template you want to use to export the table.
--
GitLab