Benutzer-Werkzeuge

Webseiten-Werkzeuge


primus:checkparentsstatus

CheckParentsStatus

Die Funktion CheckParentStatus überprüft ob die auf ein Dokument verlinkenden Dokumente, einen bestimmten Status haben. Dies kann Beispielsweise beim Ungültig machen von Dokumenten als Bedingung benutzt werden, um zu prüfen ob das Dokument noch irgendwo in einem gültigen Dokument verwendet wird. In dem Fall wird dem Anwender ein Hinweistext angezeigt. Die Funktion geht alle übergeordneten Dokumente (Parents), nacheinander durch, hat ein Dokument nicht den gewünschten Status, dann wird eine definierte Meldung ausgegeben und als Rückgabewert FALSE zurückgegeben. Für die Prüfung jedes Parents werden die betreffenden Werte in speziellen Platzhaltern abgelegt und können für Bedingungen und Meldungen benutzt werden.

Rückgabewert

Der Rückgabewert der Funktion ist:

Wert Bedeutung
TRUEAlle verknüpfenden Dokumente haben den angegebenen Status
FALSEMindestens eines der verknüpfenden Dokumente hat nicht den gesuchten Status

Attribute

Der Befehl wird über folgende Attribute gesteuert.

Attribut Reihenfolge Wert Funktion
condition TRUE/FALSE Es werden nur Dokumente geprüft, die diese Bedingung erfüllen
parameter 1 %FILEPATH% Pfad zum zu prüfenden Dokument
2 <FELDNAME> Name des zu prüfenden Datenfelds
3 <WERT> Mit diesem Wert wird der Inhalt von <FELDNAME> verglichen, Soll mit mehreren Werten möglichen Werten verglichen werden, dann sind diese durch Punkte (.) voneinander zu trennen („.003.004.005.“)
4 <Bedingung> Gibt eine Bedingung an mit der die zu prüfenden Parentdokumente eingegrenzt werden können
5 <MELDUNGSTEXT> Text der im Fehlerfall dem Anwender angezeigt werden soll. Die Angabe mittels Elementtext ist möglich

Die Übergabewerte von parameter werden durch ein | voneinander getrennt und müssen in der angegebenen Reihenfolge übergeben werden.

Spezielle Platzhalter

Diese Funktion stellt spezielle Platzhalter zur Verfügung.

Platzhalter Bedeutung
Parent_Extension Enthält die Dateiendung des übergeordneten Dokuments
Parent_Filename Enthält den Dateinamen ohne Dateiendung …
Parent_Filepath Enthält den kompletten Pfad mit Dateinamen und Dateiendung …

Beispiel

  • Die übergeordneten Dokumente des Dokuments %FILEPATH% werden geprüft
  • Der Inhalt des Felds WorkflowStatus
  • Muß 005 sein
  • Die Dateiendung des übergeordneten Dokuments darf nicht .dft sein
  • Im Fehlerfall wird die Meldung aus $Primus.MSG_ATLEAST_ONE_PARENT_IS_VALID ergänzt um %PARENT_FILEPATH% ausgegeben.
<Call method="CheckParentsStatus" parameter="%FILEPATH%|WorkflowStatus|.005.|%PARENT_EXTENSION%!=.dft|$Primus.MSG_ATLEAST_ONE_PARENT_IS_VALID %PARENT_FILEPATH%" condition="$(Condition.isSEDocument)" />

Siehe auch

primus/checkparentsstatus.txt · Zuletzt geändert: von mgras