From a3dd82a957db42510efd31b5dc34c15541687f98 Mon Sep 17 00:00:00 2001 From: Johanna Ott Date: Thu, 31 Oct 2024 15:10:33 +0100 Subject: [PATCH] docs: adapt documentation on metadata default values Default values configured in the metadata configuration of a theme are overwritten by values copied over from the source data if a dataset is created from an online transformation. WGS-2973 --- .../edit-metadata-config/2015-02-10-theme-edit-metadata.md | 2 +- docs/tutorials/2018-04-30-metadata-tutorial.md | 2 +- .../edit-metadata-config/2015-02-10-theme-edit-metadata.md | 2 +- .../current/tutorials/2018-04-30-metadata-tutorial.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md b/docs/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md index c382fcb8f..b363b9679 100644 --- a/docs/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md +++ b/docs/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md @@ -54,7 +54,7 @@ Every category has a list of field objects. Every field object describes how the * **description:** A longer, explanatory text for the fields that is displayed on hovering over the label. * **type:** The primitive type of data this field expects. One of string, object, array, integer and float. * **schema:** The schema or format of the value to be inserted. One of email, enum, geojson, json, wkt and csv. For more information about enumeration fields, see [Working with Enumeration Fields](#working-with-enumeration-fields) -* **defaultValue:** A fixed default value that will always be assigned to the field. +* **defaultValue:** A fixed default value that will be assigned to the field if it does not contain a value yet. Please note that when transforming data, the metadata values of the source dataset are copied to the target dataset and in that case, a configured default value will not overwrite it. In on-premise deployments, the behaviour for the target dataset can be changed by setting the feature toggle `TRANSFORMATION_AUTOFILL_REPLACE_DEFAULTS` to `true`. * **autofillRule:** A dynamic default value that will be assigned to the field. This value is calculated from the current environment variables such as the user, the organisation context, the data set and the theme. When you click into a row with an ```autofillRule``` property key, an assistant for choosing a value appears in the upper right corner of the editor. For more information about autofill rules, see [Working with Autofill Rules](#working-with-autofill-rules) * **required:** Set to ```true``` if a type and schema compliant value must be provided. * **visibility:** Set to ```true``` to display the value to the data manager. diff --git a/docs/tutorials/2018-04-30-metadata-tutorial.md b/docs/tutorials/2018-04-30-metadata-tutorial.md index 05a7f6e2b..436a0bd7b 100644 --- a/docs/tutorials/2018-04-30-metadata-tutorial.md +++ b/docs/tutorials/2018-04-30-metadata-tutorial.md @@ -172,7 +172,7 @@ It is important to understand that the internal mapping is based on the ```name` * **description:** A longer, explanatory text for the fields that is displayed on hovering over the label. * **type:** The primitive type of data this field expects. One of string, object, array, integer and float. * **schema:** The schema or format of the value to be inserted. One of email, enum, geojson, json, wkt and csv. -* **defaultValue:** A fixed default value that will always be assigned to the field. +* **defaultValue:** A fixed default value that will be assigned to the field if it does not contain a value yet. Please note that when transforming data, the metadata values of the source dataset are copied to the target dataset and in that case, a configured default value will not overwrite it. In on-premise deployments, the behaviour for the target dataset can be changed by setting the feature toggle `TRANSFORMATION_AUTOFILL_REPLACE_DEFAULTS` to `true`. * **autofillRule:** A dynamic default value that will be assigned to the field. This value is calculated from the current environment variables such as the user, the organisation context, the data set and the theme. When you click into a row with an ```autofillRule``` property key, an assistant for choosing a value appears in the upper right corner of the editor. * **editable:** Set to ```true``` when the data manager should be able to edit the value in this field. * **targets:** This is a list with mapping rules to external services, such as metadata catalogues. By default, there should always be at least a ```bsp``` target defined. ```bsp``` is what hale»connect needs in order to publish services. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md b/i18n/de/docusaurus-plugin-content-docs/current/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md index 478ee2deb..521128ffd 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/setup-hc/edit-metadata-config/2015-02-10-theme-edit-metadata.md @@ -51,7 +51,7 @@ Jeder Kategorie wird eine Liste an Feldern (fields) zugeordnet. Jedes Feld-Objek * **description:** Ein erläuternder Text zu dem Eingabefeld. * **type:** Die Datenart des Feldes. Zulässig sind string, object, array, integer und float. * **schema:** Die Struktur des Wertes, der eingetragen werden soll. Zulässig sind email, enum, geojson, json, wkt und csv. Für weitere Informationen zu Aufzählungsfeldern, siehe auch [Mit Aufzählungsfeldern arbeiten](#mit-aufzählungsfeldern-arbeiten). -* **defaultValue:** Ein statischer Standard-Wert, der dem Feld zugewiesen werden soll. +* **defaultValue:** Ein festgeschriebener Standard-Wert, der dem Feld zugewiesen wird, wenn dieses noch keinen Wert enthält. Bei Datensätzen, die aus Online-Transformationen entstehen, werden die Metadaten-Werte des Quell-Datensatzes kopiert und werden in diesem Fall nicht von einem konfigurierten Standard-Wert überschrieben. Für On-Premise-Installationen kann dieses Verhalten für den Zieldatensatz geändert werden, indem das Feature-Toggle `TRANSFORMATION_AUTOFILL_REPLACE_DEFAULTS` auf `true` gesetzt wird. * **autofillRule:** Ein dynamischer Standard-Wert, der dem Feld zugewiesen werden soll. Der Wert wird aus den aktuellen Umgebungsvariablen (Benutzerin oder Benutzer, Organisation, Datensatz, Thema, Dienst) abgeleitet. Wenn sie in eine Zeile mit dem Schlüsselwort autofillRule klicken, erscheint in der oberen rechten Ecke des Editors der Autofill Assistent. Für mehr Informationen zu Autofill-Regeln, sieht auch [Mit Autofill-Regeln arbeiten](#mit-autofill-regeln-arbeiten). * **required:** wird auf true gesetzt, wenn in jedem Fall ein typ- und schemakonformer Wert einzutragen ist. * **visibility:** wird auf true gesetzt, wenn Nutzende mit der Rolle Datenmanager dieses Feld im GUI sehen können sollen. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/tutorials/2018-04-30-metadata-tutorial.md b/i18n/de/docusaurus-plugin-content-docs/current/tutorials/2018-04-30-metadata-tutorial.md index ba9ba0ea4..763e1fa42 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/tutorials/2018-04-30-metadata-tutorial.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/tutorials/2018-04-30-metadata-tutorial.md @@ -172,7 +172,7 @@ Die ```required```-, ```minOccurs```- und ```maxOccurs```-Felder geben die Kardi * **description:** Ein längerer, erklärender Text zu den Feldern, der angezeigt wird, wenn man die Maus über das «label» bewegt. * **type:** Der primitive Datentyp dieses Feldes. Dieser kann string, object, array, integer und float sein. * **schema:** Das Schema oder Format des einzugebenden Wertes. Dieses kann email, enum, geojson, json, wkt und csv sein. -* **defaultValue:** Ein festgeschriebener Standard-Wert, der dem Feld immer zugewiesen wird. +* **defaultValue:** Ein festgeschriebener Standard-Wert, der dem Feld zugewiesen wird, wenn dieses noch keinen Wert enthält. Bei Datensätzen, die aus Online-Transformationen entstehen, werden die Metadaten-Werte des Quell-Datensatzes kopiert und werden in diesem Fall nicht von einem konfigurierten Standard-Wert überschrieben. Für On-Premise-Installationen kann dieses Verhalten für den Zieldatensatz geändert werden, indem das Feature-Toggle `TRANSFORMATION_AUTOFILL_REPLACE_DEFAULTS` auf `true` gesetzt wird. * **autofillRule:** Ein dynamischer Standard-Wert, der dem Feld zugewiesen wird. Dieser Wert wird aus den aktuellen Umgebungsvariablen, wie beispielsweise der Benutzerin oder dem Benutzer, dem Organisations-Kontext, den Daten oder dem Thema berechnet. Wenn sie in eine Reihe mit einem ```autofillRule```-Eigenschaften-Schlüssel klicken, erscheint ein Assistent zur Auswahl eines Wertes in der operen rechten Ecke des Editors. * **editable:** Wird auf ```true``` gesetzt, wenn Nutzende mit der Rolle «Datenmanager» in der Lage sein sollen, den Wert in diesem Feld zu verändern. * **targets:** Ist eine Liste mit Abbildungs-Regeln zu externen Diensten wie beispielsweise Metadaten-Katalogen. Standardmäßig sollte dort zumindest ein ```bsp```-Ziel definiert werden. ```bsp``` ist die Angabe, die hale»connect für die Veröffentlichung der Dienste benötigt.