Integration in andere Systeme
Gültig für: enaio webclient Version 8.50 SP1
Sie können enaio in andere Systeme bzw. Web-Anwendungen integrieren: Überall dort, wo URLs ausgewertet werden, also in erster Linie in Web-Seiten, können Links auf eine enaio-URL integriert werden.
Sie können auch direkt nach der Anmeldung an enaio 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.
Folgende Aktionen stehen zur Verfügung:

Sie können die Startseite von enaio einbinden.
Die URL ist wie folgt aufgebaut:
http://<DOMAIN>/osweb/
Wenn bei der Installation anstelle von osweb ein anderer Name für die Webanwendung vergeben wurde, ist die URL wie folgt:
http://<DOMAIN>/<Name_der_Webanwendung>/
Wenn enaio gateway den Standardport verwendet, ist die Angabe des Ports in der URL optional.

Sie können die ID eines Objekts angeben, das per Klick auf die eingebettete URL geöffnet wird.
Ob das Objekt oder dessen Indexdaten geöffnet werden, hängt von der Einstellung des Parameters com.os.osdrt.hitlist.document.default.action ab.
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
Optional können Sie auch den Parameter activeVariant mit angeben. Dieser Parameter bewirkt, dass eine inaktive Variante, die von außen angefragt wird, zur aktuell aktiven Variante aufgelöst wird. Ist der Parameter auf true gesetzt, wird geprüft, ob es sich bei dem Objekt um die aktive Variante des Objektes handelt. Ist das Objekt keine aktive Variante, so wird die aktive Variante des gewünschten Objektes geöffnet. Ist der Parameter nicht gesetzt oder false, so wird genau das Objekt mit der angefragten OSID geöffnet.
Parameter: /#/entry?osid=<Objekt-ID>&activeVariant=<Wert>
http://<DOMAIN>/osweb/#/entry?osid=478645961&activeVariant=true
Ergebnis: Die aktive Variante des angefragten Objektes mit der ID 478645961 wird geöffnet.
http://<DOMAIN>/osweb/#/entry?osid=478645961&activeVariant=false
Ergebnis: Das angefragte Objekt mit der ID 478645961 wird geöffnet.

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
Optional können Sie auch den Parameter activeVariant mit angeben. Dieser Parameter bewirkt, dass eine inaktive Variante, die von außen angefragt wird, zur aktuell aktiven Variante aufgelöst wird. Ist der Parameter auf true gesetzt, wird geprüft, ob es sich bei dem Objekt um die aktive Variante des Objektes handelt. Ist das Objekt keine aktive Variante, so werden die Indexdaten der aktiven Variante des gewünschten Objektes geöffnet. Ist der Parameter nicht gesetzt oder false, so werden die Indexdaten des Objektes mit der angefragten OSID geöffnet.
Parameter: /#/entry?indexdata=<Objekt-ID>&activeVariant=<Wert>
http://<DOMAIN>/osweb/#/entry?indexdata=478645961&activeVariant=true
Ergebnis: Die Indexdaten der aktiven Variante des angefragten Objektes mit der ID 478645961 werden geöffnet.
http://<DOMAIN>/osweb/#/entry?indexdata=478645961&activeVariant=false
Ergebnis: Die Indexdaten des angefragten Objektes mit der ID 478645961 werden geöffnet.

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 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.

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 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>
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.
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 eines Dokuments angeben, deren Dokumentdatei mit einem Klick auf die eingebettete URL heruntergeladen wird.
Parameter: /#/entry?download=<ID des Dokuments>
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
Des Weiteren können Sie statt der originalen Dokumentdatei eine PDF der Dokumentdatei herunterladen.
Parameter: /#/entry?download=<ID des Dokuments>&rendition=pdf
http://<DOMAIN>/osweb/#/entry?download=4421&rendition=pdf
Optional können Sie auch den Parameter activeVariant mit angeben. Dieser Parameter bewirkt, dass eine inaktive Variante, die von außen angefragt wird, zur aktuell aktiven Variante aufgelöst wird. Ist der Parameter auf true gesetzt, wird geprüft, ob es sich bei dem Objekt um die aktive Variante des Objektes handelt. Ist das Objekt keine aktive Variante, so wird die aktive Variante des gewünschten Objektes heruntergeladen. Ist der Parameter nicht gesetzt oder false, so wird genau das Objekt mit der angefragten OSID heruntergeladen.
Parameter: /#/entry?download=<Objekt-ID>&activeVariant=<Wert>
http://<DOMAIN>/osweb/#/entry?download=478645961&activeVariant=true
Ergebnis: Die aktive Variante des angefragten Objektes mit der ID 478645961 wird heruntergeladen.
http://<DOMAIN>/osweb/#/entry?download=478645961&activeVariant=false
Ergebnis: Das angefragte Objekt mit der ID 478645961 wird heruntergeladen.
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.
© Copyright OPTIMAL SYSTEMS 2020. | Impressum und Datenschtz