Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for transformed data section and variables #132

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ sidebar_position: 8

The Transformed data section displays transformation projects associated with this data set. Click the project name or the chevron to view general properties and the current status of the transformation.

Under Project, click the transformation project name to edit project properties.
<img src={require("/images/help/en/dataset_transformed_data.png").default} alt="" title="The Transformed data section " className="img-responsive img-inline-help"/>

Under Target data set, click the data set name to edit data set properties. Click the arrow button to download the transformed data set.
The page provides links to the transformation project and to the transformed dataset ("Target dataset"). The result of the last transformation run is shown near the bottom, together with a link to show the log output of the transformation run. "The Transformed types" table lists the number of occurrences of each type in the source data and the number of occurrences of each type in the target data.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to add an information on that is sometimes not working as expected? See https://wetransform.atlassian.net/browse/ING-1693 and https://wetransform.atlassian.net/browse/ING-1693


Under Last transformation result, you can view the status of the last transformation, the time it started, the time it finished and how long the transformation took to execute.
In case the transformation project contains variables, the "Project variables:" section gives access to these. The values of the variables can be changed here so that subsequent transformation runs (which can be triggered via the "Start transformation" button) will use the new values.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Click the Log output link to view a summary of transformation process steps.
By clicking the button next to the input fields, an Autofill assistant can be opened. It can be used to insert special placeholders into the project variable that will be replaced by their specific value before being passed to the transformation engine. For example can the placeholder `{{dataset.name}}` be used to pass the name of the dataset to the transformation engine.

The Transformed types table lists the number of occurrences of each type in the source data and the number of occurrences of each type in the target data.
Another practical example for this feature is to pass the hale»connect dataset ID placholder `{{dataset.id}}` to the variable `DATASET_ID` of a XPlanung to INSPIRE transformation which is used to generate unique identifiers for `OfficialDocumentation` elements if the project variable `FORCE_UNIQUE_OFFICIALDOCUMENTATION_ID` is set to `true`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

placholder --> placeholder

Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ sidebar_position: 8

---

Im &laquo;Abgeleitete Daten&raquo;-Bereich werden die Transformations-Projekte angezeigt, die mit dem ausgewählten Datensatz verbunden sind. Klicken sie auf den Namen des Transformations-Projektes oder das Pfeilsymbol um grundlegende Eigenschaften und den aktuellen Status der Transformation angezeigt zu bekommen.
Der Bereich Transformierte Daten zeigt die Transformationsprojekte an, die mit diesem Datensatz verbunden sind. Klicken Sie auf den Projektnamen, um allgemeine Eigenschaften und den aktuellen Status der Transformation anzuzeigen.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sie --> sie

There is an agreement to write sie with a lower case s in the documentation.


Klicken sie unter &laquo;Projekt&raquo; auf den Namen des Transformations-Projektes, um die Eigenschaften des Projektes zu bearbeiten.
<img src={require("/images/help/de/dataset_transformed_data.png").default} alt="" title="The Transformed data section " className="img-responsive img-inline-help"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

title of the image to be translated too?


Klicken sie auf den Namen des Datensatzes unter &laquo;Ziel-Datensatz&raquo; um die Eigenschaten des Datensatzes zu bearbeiten.Klicken sie auf das Pfeilsymbol um die transformierten Daten herunterzuladen.
Die Seite enthält Links zum Transformationsprojekt und zum transformierten Datensatz ("Ziel-Datensatz"). Das Ergebnis des letzten Transformationslaufs wird im unteren Bereich angezeigt, zusammen mit einem Link zur Anzeige der Protokollausgabe des Transformationslaufs. Die Tabelle "Transformierte Typen" listet die Anzahl der Vorkommen jedes Typs in den Quelldaten und die Anzahl der Vorkommen jedes Typs in den Zieldaten auf.

Unter &laquo;Letztes Transformations-Ergebnis&raquo; können sie den Status, den Startzeitpunkt, den Abschlusszeitpunkt und die Dauer der Transformation einsehen.
Falls das Transformationsprojekt Projektvariablen enthält, können im Abschnitt "Projektvariablen" die zu verwendenden Werte gesetzt werden, so dass nachfolgende Transformationsläufe (die über die Schaltfläche "Transformation starten" ausgelöst werden können) diese Werte verwenden.

Klicken sie &laquo;Protokoll&raquo; um eine Zusammenfassung der durchgeführten Schritte im Transformations-Prozess anzeigen zu lassen.
Durch Anklicken der Schaltfläche neben den Eingabefeldern kann ein Autofill-Assistent geöffnet werden. Mit diesem Assistenten können spezielle Platzhalter in die Eingabefelder für Projektvariablen eingefügt werden, die vor der Übergabe an die Transformation durch ihren tatsächlichen Wert ersetzt werden. Beispielsweise kann der Platzhalter `{{dataset.name}}` verwendet werden, um den Namen des Datensatzes an die Transformation zu übergeben.

Die Tabelle &laquo;Transformierte Typen&raquo; enthält die Anzahl der Instanzen aller im Quell-Datensatz und im Ziel-Datensatz vorkommenden Objektarten.
Ein weiteres praktisches Beispiel für diese Funktion ist die Übergabe des Platzhalters für die Datensatz-ID `{{dataset.id}}` an die Projektvariable `DATASET_ID` einer XPlanung-nach-INSPIRE-Transformation, die zur Erzeugung eindeutiger Bezeichner für `OfficialDocumentation`-Elemente verwendet wird, wenn die Projektvariable `FORCE_UNIQUE_OFFICIALDOCUMENTATION_ID` auf `true` gesetzt ist.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading