Integration in andere Systeme

enaio® webclient • 11.10 »

Sie können enaio® webclient in andere Systeme und in Web-Anwendungen integrieren: Überall dort, wo URLs ausgewertet werden, also in erster Linie in Web-Seiten, können Links auf eine enaio® webclient-URL integriert werden.

Sie können auch direkt nach der Anmeldung an enaio® webclient automatisch eine bestimmte Aktion durchführen lassen, beispielsweise das Öffnen eines enaio®-Dokuments oder das Ausführen einer gespeicherten Anfrage. Die durchzuführende Aktion sowie gegebenenfalls das enaio®-Objekt, mit dem die Aktion durchgeführt werden soll, legen Sie über Parameter in der URL fest.

Diese URL ist folgendermaßen aufgebaut:

http://<DOMAIN>/<Name_der_Webanwendung>/#/entry?<Parameter>=<Parameterwert>

Diese URL fügen Sie beispielsweise in Ihre Web-Anwendung ein. Bei einem Klick auf die URL wird die Aktion durchgeführt, z. B. ein enaio®-Dokument angezeigt.

Zeichenfolgen für Parameterwerte, beispielsweise Filterfelder und Suchbegriffe, dürfen nur Zeichen enthalten, die in einer URL erlaubt sind.

Folgende Aktionen stehen zur Verfügung:

Sie können die Startseite von enaio® webclient einbinden.

Die URL ist wie folgt aufgebaut:

http://<DOMAIN>/<Name_der_Webanwendung>/

Wenn enaio® gateway den Standardport 80 verwendet, ist die Angabe des Ports in der URL optional.

Einzelne Objekte

Sie können die ID eines Objekts angeben, das per Klick auf die eingebettete URL geöffnet wird.

Bei Ordnern und Registern wird immer der Standort geöffnet.

Bei Dokumenten legt der Parameter config.webclient.hitlist.singleHitAction fest, ob das Dokument oder dessen Indexdaten geöffnet werden oder beispielsweise der Dokumentinhalt zum Herunterladen angeboten wird.

Parameter: /#/entry?osid=<Objekt-ID>

http://<DOMAIN>/osweb/#/entry?osid=4300

Ergebnis: Das Objekt mit der ID 4300 wird geöffnet.

Optional können Sie auch die ID des Objekttyps mit angeben. Dadurch wird das Objekt schneller geöffnet.

Parameter: /#/entry?osid=<Objekt-ID>&objecttypeid=<Objekttyp-ID>

http://<DOMAIN>/osweb/#/entry?osid=478645961&objecttypeid=262144

Falls es sich um ein Dokument mit Varianten handelt, dann kann auch die aktive Variante geöffnet werden.

Parameter: /#/entry?osid=<Objekt-ID>&activeVariant=true

http://<DOMAIN>/osweb/#/entry?osid=478645961&activeVariant=true

Mehrere Objekte

Sie können mehrere Objekt-IDs angeben, geöffnet wird eine Trefferliste mit den Objekten.

Parameter: /#/entry?hitlist=<Objekt-ID1,Objekt-ID2,Objekt-IDn>&title=<text>&subtitle=<text>

Für die Trefferliste können ein Titel und ein Untertitel angegeben werden.

Sie können die ID eines Objekts angeben, dessen Indexdaten per Klick auf die eingebettete URL geöffnet werden. Das Objekt kann ein Ordner, ein Register oder ein Dokument sein.

Parameter: /#/entry?indexdata=<Objekt-ID>

http://<DOMAIN>/osweb/#/entry?indexdata=4300

Ergebnis:

Die Indexdaten des Objekts mit der ID 4300 werden geöffnet.

Optional können Sie auch die ID des Objekttyps mit angeben. Dadurch werden die Indexdaten des Objekts schneller geöffnet.

Parameter: /#/entry?indexdata=<Objekt-ID>&objecttypeid=<Objekttyp-ID>

http://<DOMAIN>/osweb/#/entry?indexdata=478645961&objecttypeid=262144

Falls es sich um ein Dokument mit Varianten handelt, dann können auch die Indexdaten der aktiven Variante geöffnet werden.

Parameter: /#/entry?indexdata=<Objekt-ID>&activeVariant=true

http://<DOMAIN>/osweb/#/entry?indexdata=478645961&activeVariant=true

Sie können die ID eines Objekts angeben, dessen Standort per Klick auf die eingebettete URL geöffnet wird. Wenn das angegebene Objekt ein Ordner oder ein Register ist, wird dessen Inhalt geöffnet.

Parameter: /#/entry?location=<Objekt-ID>

http://<DOMAIN>/osweb/#/entry?location=4300

Ergebnis: Der Standort des Objekts mit der ID 4300 wird geöffnet.

Optional können Sie auch die ID des Objekttyps mit angeben. Dadurch wird der Standort des Objekts schneller geöffnet.

Parameter: /#/entry?location=<Objekt-ID>&objecttypeid=<Objekttyp-ID>

http://<DOMAIN>/osweb/#/entry?location=478645961&objecttypeid=262144

Wenn ein Objekt mehrere Standorte besitzt, können Sie durch Angabe der ID des Objekts und der ID des Registers, den Standort bestimmen, der per Klick auf die eingebettete URL geöffnet werden soll.

Parameter: /#/entry?location=<Objekt-ID>&parentid=<Parent-ID>

http://<DOMAIN>/osweb/#/entry?location=4300&parentid=110

Ergebnis: Der Register mit der ID 110 mit dem Objekt mit der ID 4300 wird geöffnet.

Optional können Sie auch die ID des Registertyps mit angeben. Dadurch wird der Standort des Objekts schneller geöffnet.

Parameter: /#/entry?location=<Objekt-ID>&parentid=<Register-ID>&parenttypeid=<Registertyp-ID>

http://<DOMAIN>/osweb/#/entry?location=478645961&parentid=55632&parenttypeid=110

Des weiteren können Sie neben der ID des Registertyps zusätzlich noch die ID des Objekttyps mit angeben. Dadurch wird der Standort des Objekts noch schneller geöffnet.

Parameter: /#/entry?location=<Objekt-ID>&objecttypeid=<Objekttyp-ID>&parentid=<Register-ID>&parenttypeid=<Registertyp-ID>

http://<DOMAIN>/osweb/#/entry?location=478&objecttypeid=264&parentid=532&parenttypeid=110

Außerdem können Sie auch den Parameter 'flat' mit angeben. Dieser Parameter ermöglicht den Einsprung in eine flache Ordneransicht. Er bewirkt, dass die Registerstruktur ausgeschaltet wird und alle Dokumente in einem Ordner in einer Trefferliste angezeigt werden. Ist der Parameter auf 'true' gesetzt, wird die Registerstruktur ausgeschaltet. Ist der Parameter nicht gesetzt oder 'false', so wird die Registerstruktur angezeigt.

Parameter: /#/entry?location=<Objekt-ID>&flat=<Wert>

http://<DOMAIN>/osweb/#/entry?location=478645961&flat=true

Ergebnis: Die Registerstruktur des angefragten Objektes mit der ID 478645961 wird ausgeschaltet.

 

http://<DOMAIN>/osweb/#/entry?location=478645961&flat=false

Ergebnis: Die Registerstruktur des angefragten Objektes mit der ID 478645961 wird angezeigt.

Filter

Ein geöffneter Standort wird mit einem Filterfeld angezeigt, über das die Trefferliste gefiltert werden kann. Die Zeichenfolge für das Filterfeld muss mindestens drei Zeichen lang sein. Zeichenfolgen für das Filterfeld können mit übergeben werden.

Parameter: /#/entry?location=<Objekt-ID>&filter=<filter value>

Sie können die ID eines Workflow-Arbeitsschritts angeben, der per Klick auf die eingebettete URL geöffnet wird.

Die IDs von Arbeitsschritten können Sie mit Hilfe von Programmbibliotheken wie die Java-Workflow-API ermitteln.

Parameter: /#/entry?workflow=<ID des Arbeitsschritts>

http://<DOMAIN>/osweb/#/entry?workflow=0A3F88A13FA4445AA5D0CFE062B941E

Ergebnis: Der Workflow-Arbeitsschritt mit der ID 0A3F88A13FA4445AA5D0CFE062B941E wird geöffnet. Wenn Sie zu den Bearbeitern des Arbeitsschritts gehören, erscheint dieser wenig später in Ihrem Eingangskorb.

Sie können die ID einer gespeicherten Anfrage angeben, die per Klick auf die eingebettete URL ausgeführt wird.

Gespeicherte Anfragen werden in enaio® client eingerichtet.

Parameter: /#/entry?search=<Anfrage-ID>

http://<DOMAIN>/osweb/#/entry?search=26889

Ergebnis: Das Ergebnis der Suche mit der ID 26889 wird in einer Trefferliste angezeigt.

Die Trefferliste einer gespeicherten Anfrage wird mit einem Filterfeld angezeigt, über das die Trefferliste gefiltert werden kann. Die Zeichenfolge für das Filterfeld muss mindestens drei Zeichen lang sein. Zeichenfolgen für das Filterfeld können mit übergeben werden.

Parameter: /#/entry?search=<Anfrage-ID>&filter=<filter value>

Die ID einer gespeicherten Anfrage können Sie über den enaio® appconnector ermitteln. Rufen Sie dazu die folgende URL im Browser auf: http://<DOMAIN>/osrest/api/documents/storedqueries?showglobal=true. In der im Browser ausgegebenen JSON können Sie dann nach dem Namen der Anfrage suchen und so die ID der gespeicherten Anfrage ermitteln.

Sie können die ID einer gespeicherten Anfrage mit Variablen angeben, die per Klick auf die eingebettete URL ausgeführt wird.

Die Aktion ist beschränkt auf gespeichert Anfragen mit dynamischen Variablen. Gespeicherte Anfragen mit statischen Variablen und/oder Spezialwerten (#Benutzer#, #Datum# usw.) können nicht per URL ausgeführt werden.

Parameter: /#/entry?search=<Anfrage-ID>&var1=<Variablenwert>

Die ID einer gespeicherten Anfrage können Sie über den enaio® appconnector ermitteln. Rufen Sie dazu die folgende URL im Browser auf: http://<DOMAIN>/osrest/api/documents/storedqueries?showglobal=true. In der im Browser ausgegebenen JSON können Sie dann nach dem Namen der Anfrage suchen und so die ID der gespeicherten Anfrage ermitteln.

Mehrere Variablen

Mehrere Variablen werden mit dem &-Zeichen kombiniert.

http://<DOMAIN>/osweb/#/entry?search=26889&var1=a&var2=100077

Ergebnis: Das Ergebnis der Suche mit der ID 26889, Variable 1=a und Variable 2=100077 wird in einer Trefferliste angezeigt.

Filterfeld

Die Trefferliste einer gespeicherten Anfrage wird mit einem Filterfeld angezeigt, über das die Trefferliste gefiltert werden kann. Die Zeichenfolge für das Filterfeld muss mindestens drei Zeichen lang sein. Zeichenfolgen für das Filterfeld können mit übergeben werden.

Parameter: /#/entry?search=<Anfrage-ID>&var1=<Variablenwert>&filter=<filter value>

Kontrollkästchen und Optionsschaltflächen

Falls in der gespeicherten Anfrage Kontrollkästchen oder Optionsschaltflächen als Variablen eingebunden sind, dann werden diesen Dialogelementen folgende Werte zugeordnet:

  • Kontrollkästchen
    aktiviert: 1, nicht aktiviert: 0

  • Optionsschaltfläche
    erste Option des Gruppenfelds, welches bei der Konfiguration der gespeicherten Anfrage in enaio® client als Variable angegeben wird, markiert: 0, zweite Option des Gruppenfelds: 1, dritte Option des Gruppenfelds: 2, ...

Sie können die ID eines Dokuments angeben, deren Dokumentdatei mit einem Klick auf die eingebettete URL heruntergeladen wird.

Parameter: /#/entry?download=<Objekt-ID>

http://<DOMAIN>/osweb/#/entry?download=4421

Ergebnis: Die Dokumentdatei des Dokuments mit der ID 4421 wird heruntergeladen.

Optional können Sie auch die ID des Objekttyps mit angeben. Dadurch wird das Herunterladen der Dokumentdatei schneller gestartet.

Parameter: /#/entry?download=<Objekt-ID>&objecttypeid=<Objekttyp-ID>

http://<DOMAIN>/osweb/#/entry?download=4421&objecttypeid=2621

Falls es sich um ein Dokument mit Varianten handelt, dann kann auch die aktive Variante heruntergeladen werden.

Parameter: /#/entry?download=<Objekt-ID>&activeVariant=true

http://<DOMAIN>/osweb/#/entry?download=478645961&activeVariant=true

Des Weiteren können Sie statt der originalen Dokumentdatei eine PDF der Dokumentdatei herunterladen.

Parameter: /#/entry?download=<Objekt-ID>&rendition=pdf

http://<DOMAIN>/osweb/#/entry?download=4421&rendition=pdf

Wenn ein Dokument mehrere Dokumentdateien enthält, werden diese zusammengepackt in einer ZIP-Datei heruntergeladen. Ebenso werden mehrere Dokumentdateien eines Dokuments beim Herunterladen mit Hilfe des Parameters rendition=pdf zu einer PDF zusammengefasst.

Sie können eine Volltextsuche ausführen.

Parameter: /#/entry?fulltextsearch=<search term>

Als Suchbegriff sind alle Suchbegriffe, Platzhalter und Kombinationen gültig, die auch bei der Volltextsuche aus Clients erlaubt sind.

Die Trefferliste einer Volltextanfrage wird mit einem Filterfeld angezeigt, über das die Trefferliste gefiltert werden kann. Die Zeichenfolge für das Filterfeld muss mindestens drei Zeichen lang sein. Zeichenfolgen für das Filterfeld können mit übergeben werden.

Parameter: /#/entry?fulltextsearch=<search term>&filter=<filter value>