diff --git a/entity/ExportTemplateField_entity/ExportTemplateField_entity.aod b/entity/ExportTemplateField_entity/ExportTemplateField_entity.aod index 84396f573ecbeabfe825ea1fb6eb34e59f81aed8..2691c9556a61bc2768eb9b06c15f183356afdacc 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 12a981536f07b090008f49b7462d5ec16c7c5d6c..5e0969dbcc58b6eda7bed398b37b8c2a955fdcfa 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 0000000000000000000000000000000000000000..6144ef2d4a9e1092004a6c876a516666207c53b7 --- /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 08ec9605693f96322c16424b5da5990bbf9a9b11..f5b8c998801e7aafdb45582d7a566614367a30a2 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 62ae13223cf74fa95420336c7956d8aa21222179..3409d00b6689ce9ef6297c0d3d7659b285afd20a 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 33f229e05ddc227b08ebb4f7eb4d91dada61a9b6..a61ae5a651de0f753557aa094ba139dc5c3957a5 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 0000000000000000000000000000000000000000..38a9ff1a0f6494d732d9d7fe50d771885f7496fa --- /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 7ff3082082e4138fb3e2b25da143e3099646eb9e..740f4ae68f9ba3857df31085446ce60a2c3f4897 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.