Externer Aufruf von Vorgängen und Dokumenten

Diese Funktionen werden genutzt, um aus einem ERP-System oder einem anderen Fremdsystem Vorgänge und Dokumente aufzurufen:

http://{client-url}?record={id} ruft den Webclient auf und öffnet den Vorgang mit der angegebenen ID.

http://{client-url}?attachment={id} zeigt das Dokument mit der ID {id} direkt an, ohne die Benutzeroberfläche des Webclients zu laden, mit Ausnahme der ggf. notwendigen Login-Maske. Dabei wird das Dokument, wenn möglich, im Browser angezeigt. Ist der Browser nicht in der Lage, den Dateityp des gewählten Dokuments anzuzeigen, wird das Dokument automatisch heruntergeladen.

http://{client-url}?archive={Kurzname} ruft den Webclient auf und öffnet das Archiv mit dem angegebenen Kurznamen.

Filtersprache

In verschiedenen Bereichen von docs365 documents kann ein Filter angegeben werden, der auf die Vorgänge des Archivs angewandt und in der Spalten-Suchleiste angezeigt wird: Zuerst richtet man sich die Spaltenfilter so ein, dass nur noch die gewünschten Vorgänge angezeigt werden, und kopiert dann den Filtertext.

../_images/extern-filtersprache.png

Dieser Filtertext kann nun im benötigten Feld gespeichert werden (z. B. „Bedingungen“ im Workflow-Editor).

Da der Parameter selbst normalerweise in doppelten Anführungszeichen übergeben werden muss, müssen Anführungszeichen innerhalb des Filtertexts mit einem Backslash vorangestellt werden. Dazu stehen zwei verschiedene Formate zur Verfügung, die auch in Kombination verwendet werden können:

  • Zum einfachen Vergleich einzelner Felder mit bestimmten Werten können beliebig viele Parameter im Format q_{Feld}={wert} werden. Beispielsweise öffnet archive=rechnungen&q__city=filter&q_release_version=1 ein Archiv mit Kurznamen rechnungen und filtert darin alle Datensätze, deren Spalte _city den Wert Wuppertal enthält und deren Spalte release_version den Wert 1 enthält. Der Spalte mit Kurznamen city wird dabei im Namen ein Unterstrich vorangestellt. Dadurch werden in den Filtern Archiv-spezifische Spalten (definiert im Archiv-Datensatz in der Administrationsoberfläche) von allgemeinen, für alle Archive gültigen Spalten unterschieden (im Beispiel die Spalte release_version = Vorgangsversion).

  • Zur Definition komplexerer Filter kann ein Parameter filter übergeben werden, der einen Ausdruck in der Filtersprache von docs365 documents enthält und zusätzlich URL-kodiert werden muss. Beispielsweise öffnet archive=rechnungen&filter=_city%20%3D%20“Wuppertal“%20AND%20_payable_until%20>%3D%20<today> ein Archiv mit Kurznamen rechnungen und filtert darin alle Datensätze, in denen die Spalte _city den Wert Wuppertal enthält und die Spalte _payable_until ein Datum, das größer oder gleich dem heutigen Datum ist.

Weiterhin stehen bei Verwendung des Parameters archive mit Spezifikation eines Filters (wie zuletzt beschrieben) die Parameter record=true und attachment=true zur Verfügung.

record=true führt dazu, dass für den Fall, dass der Filter nur einen einzelnen Vorgang ergibt, dieser Vorgang direkt geöffnet wird. Liefert der Filter mehrere Vorgänge, wird nur das Archiv geöffnet, so als wäre der Parameter record nicht vorhanden. Beispielsweise öffnet archive=rechnungen&q__customer=Max Mustermann&q_release_version=1&record=true den Vorgang mit der Version 1 und dem Wert “Max Mustermann” im Feld customer, sofern es nur einen einzelnen solchen Vorgang gibt. Andernfalls werden alle Datensätze angezeigt, die dem Filter entsprechen.

attachment=true führt analog dazu, dass das erste Dokument des gefilterten Vorgangs angezeigt wird. Das Verhalten entspricht dabei dem Verhalten von http://{client-url}?attachment={id} d.h. das Dokument wird ohne die Benutzeroberfläche geladen und je nach Dateityp und Möglichkeiten des Browsers entweder im Browser angezeigt oder heruntergeladen. Entsprechen dem Filter mehrere Vorgänge, wird die Oberfläche mit dem Archiv geladen, so als wäre der Parameter attachment nicht vorhanden.

In Filtern wird eine Funktion lookup unterstützt, ähnlich den STAR-Events. Dadurch lassen sich deutlich dynamischere Filter umsetzen.

Die lookup-Funktion liefert dabei eine Liste von Werten (eine Spalte aus einer Datentabelle oder einem Archiv) zurück, die mit einem Datenfeld oder einer Untertabellen-Spalte des Vorgangs abgeglichen wird. Der Filter liefert den Vorgang dann zurück, wenn: 1. Der Wert des angegebenen Datenfelds mindestens einmal in der Ergebnis-Liste der lookup-Funktion vorkommt. 2. Oder mindestens einer der Werte der angegebenen Untertabellen-Spalte in der Ergebnis-Liste vorkommt.

Für die lookup-Funktion muss der in-Operator verwendet werden.

Beispiele: # _field ist ein reguläres Datenfeld _field in lookup(„table“, „column“, _filterfield1=value, _filterfield2=value)

# _subtable.field ist ein Datenfeld einer Untertabelle _subtable.field in lookup(„table“, „column“, _filterfield1=value, _filterfield2=value)