Arbeitskopien übernehmen

Interne ID: agorum.versioning.checkIn

Sie können mit diesem Knoten die Änderungen an den Arbeitskopien in die zugehörigen originalen Dokumente übernehmen.

Verhaltensweise

---

Erreicht das System den Knoten im Workflow, prüft das System die Eingangsvariable. In dieser befinden sich die Dokumente, deren Arbeitskopien übernommen werden sollen. Das System erstellt einen neuen Eintrag in der Historie des Dokuments mit dem Stand vor Bearbeitung, löscht anschließend die Arbeitskopie und übergibt die geänderten Dokumente in der Ausgangsvariable.

Bei der Übernahme von Änderungen können Sie einen Kommentar angeben (Parameter Checkin Kommentar) sowie manuell eine Versionsnummer setzen. In der Regel erfolgt die Versionierung jedoch automatisch durch Hochzählen von Hauptversion (1.0 -> 2.0) oder Nebenversion (1.0 -> 1.1). Das System schreibt sowohl den Kommentar als auch die Version als Metadatum auf die Dokumente.

Endpoints

---

Standard	Veränderbar?	Weitere Endpoints möglich?
Default (Inlet)	Nein, kann nur ausgeblendet werden.	nicht nötig
Default (Outlet)

Parameter

---

Parameter	Beschreibung	Beispiel
Eingangsvariable	Definiert, welche Dokumente / Arbeitskopien übernommen werden. Wenn Sie die Variable nicht angeben, verwendet das System automatisch die Anhänge des Workflows aus der internen Variable sys_acw_attachments.	Eingangsvariable
Checkin Kommentar	Definiert einen Kommentar, der beim Einchecken als Metadatum auf die neue Versionsnummer geschrieben wird.	Checkin Kommentar
Automatische Versionierung: Als Hauptversion hochzählen	Definiert, ob die Haupt- oder Nebenversion des geänderten Dokuments hochgezählt wird.	Als Hauptversion hochzählen
Manuell vergebene Versionsnummer	Definiert eine manuelle Versionsnummer.	Manuell vergebene Versionsnummer
Ausgangsvariable	Definiert die Variable, in der die geänderten Dokumente enthalten sind. Der Aufbau einer Ausgangsvariable ist identisch zum Aufbau einer Eingangsvariable.	–
Rechte	Definiert, mit welchen Rechten die Aktion des Knotens ausgeführt wird.	Rechte auf Knoten vergeben

Eingangsvariable

Die folgenden Beispiele für die Eingangsvariable gelten auch für eine Ausgangsvariable.

Für generelle Schreibweise von Variablen im Editor oder als Expression siehe Schreibweise von Variablen.
 

Im Editor

Im Editor geben Sie den Namen der Workflow-Variable an. Das System platziert die Variable automatisch in der Variable des Tokens (token.variables).

inputVariable

Als Expression

Wenn Sie diesen Parameter als Expression angeben, geben Sie den vollständigen Pfad zur Variable an, von der das System den eigentlichen Namen der gewünschten Variable lesen soll.

'token.variables.nameOfInputVariable'

Checkin Kommentar
 

Im Editor

Angabe eines Checkin-Kommentars im Editor:

Die Datei wurde geändert.

Sie können ebenfalls eine Datumsangabe inklusive Uhrzeit im Kommentar verwenden. Die Angabe führt dazu, dass später in der Bedienoberfläche im Kommentar ersichtlich wird, wann die Datei geändert wurde:

Angabe eines Checkin-Kommentars im Editor mit Datumsangabe:

Die Datei wurde am ${date:dd.MM.yyyy HH-mm} geändert.

Meistens ist es nicht sinnvoll, einen festen Kommentar über den Editor zu setzen. Der Kommentar würde bei jeder Übernahme gesetzt werden. Stattdessen sollten Sie den Benutzer über die Bedienoberfläche selbst einen Kommentar beim Einchecken verfassen lassen. Verwenden Sie daher für den Checkin-Kommentar eine Expression.
 

Als Expression

Angabe einer Variablen als Expression:

token.variables.checkInKommentar

In diesem Fall liest das System den Inhalt der Variable checkInKommentar aus. Sie können etwa in einem UI-Knoten eine solche Variable dynamisch befüllen lassen, indem der Benutzer über die Bedienoberfläche einen eigenen Kommentar in einem Feld verfasst. Die Variable checkInKommentar enthält dann diesen Kommentar als String.

Das Skript des ui-Knotens könnte etwa folgendermaßen aussehen:

let aguila = require('common/aguila');

// Create form for workflow step.
// This sample contains some common elements, feel free to use or remove them
let form = aguila.create({
  type: 'agorum.composite.form.basic',
  labelPosition: 'top',
  elements: [
    
    {
      type: 'agorum.composite.form.element.text',
      name: 'checkinKommentar', //gesetzte Variable im Parameter "Checkin Kommentar"
      label: 'Kommentar',
      validation: [
        {
          required: true
        }
      ]
    },

Für das Erstellen von Skripten mit aguila, um Schaltflächen und mehr darzustellen, siehe agorum.composite.form.

Als Hauptversion hochzählen

Die automatische Versionierung basiert auf der Vergabe von Haupt- und Nebenversionsnummern. D. h., dass die Version aus zwei Zahlen besteht, die durch einen Punkt getrennt sind (etwa 10.0). Dabei gibt die vordere Nummer die Hauptversion und die hintere Nummer die Nebenversion an.

• Wird ein Dokument als Hauptversion eingecheckt, erhöht sich die vordere Nummer (etwa 11.0).
• Wird ein Dokument als Nebenversion eingecheckt, erhöht sich die hintere Nummer (etwa 10.1).

Meistens ist es nicht sinnvoll, alle Dokumente stets als Haupt- oder Nebenversion einzuchecken. Stattdessen sollte dynamisch entschieden werden, welches Dokument als Haupt- und welches als Nebenversion eingecheckt wird. Verwenden Sie daher eine Expression.
 

Als Expression

Angabe einer Variable als Expression:

token.variables.checkInVersion

In diesem Fall liest das System den Inhalt der Variable checkInVersion aus. Das System erwartet einen Wahrheitswert:

• true = Hauptversion
• false = Nebenversion

Manuell vergebene Versionsnummer
 

Im Editor

Angabe einer Versionsnummer im Editor:

11.0

Meistens ist es nicht sinnvoll, eine feste Versionsnummer manuell zu vergeben. Die Versionsnummer wird bei jedem Dokument verwendet, unabhängig davon, ob das Dokument in einer Haupt- oder Nebenversion vorliegt, es findet keine Prüfung statt, und die Verantwortlichkeit liegt beim Benutzer. Stattdessen sollten Sie auf eine Expression zurückgreifen.
 

Als Expression

Angabe einer Variablen als Expression:

token.variables.checkInVersion

In diesem Fall liest das System den Inhalt der Variable checkInVersion aus. Die Variable muss zuvor existieren, bevor Sie sie hier verwenden können, etwa könnten Sie die Variable in einem Skript-Knoten erstellen. Das System erwartet in der Variable als Wert die Versionsnummer (etwa 10.0 RC1)