SAPERION Web Client Portal Integration

Transkript

1 SAPERION Web Client Portal Integration

2 Copyright 016 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Inhaltsverzeichnis 1 Suchen und Anzeigen von Dokumenten "portal.zul" Vierwerclass Sprungmarken Vorbelegung der Indexfelder Konfiguration der Service Komponente... Zugriff auf die Workflow-Inbox... Archivieren neuer Dokumente....1 "archiver.zul".... Ereignisse... 5

4 SAPERION Web Client Portal Integration Der SAPERION Web Client lässt sich in Portale und andere Webseiten einbinden. Hierfür werden die Dateien "portal.zul" und "archiver.zul" mit der SAPERION-CD zur Verfügung gestellt. Die Datei "portal.zul" bietet die Möglichkeit, eine bestimmte Maske zu öffnen und eine Suche mit bestimmten vordefinierten n zu starten. Mit der Datei "archiver.zul" lassen sich neue Dateien archivieren. Die Anmeldung am SAPERION-Backend erfolgt über die normale Anmeldemaske des Web Clients oder über die Single-Sign-On Funktion, sofern das System entsprechend konfiguriert wurde. In diesem Kapitel erfahren Sie, wie Sie den Web Client in Ihr Portal bzw. Ihre Webseite integrieren können. 1 Suchen und Anzeigen von Dokumenten 1.1 "portal.zul" Die Steuerung der Datei "portal.zul" erfolgt mit den folgenden URL-n: "portal.zul" mask Name der zu öffnenden Abfrage-Maske (ohne.qbe Endung) doquery Wenn dieser vorhanden ist (ohne Wert), wird automatisch eine Abfrage gestartet. selectsingleresult Wenn dieser vorhanden ist (ohne Wert), wird automatisch das gefundene Dokument selektiert. Wenn mehrere Dokumente gefunden wurden, hat dieser keine Auswirkung. viewerclass Mit diesem lässt sich festlegen, welcher Viewer in der Maske verwendet wird. Dazu muss der voll qualifizierte Klassenname der Viewer-Implementierung angegeben werden. Wichtig: Groß-Kleinschreibung muss beachtet werden. 1. Vierwerclass Für den optionalen "viewerclass" stehen folgende Werte zur Verfügung: Viewerclass Wert com.saperion.ngc.viewer.simple.simpleviewerimpl Platzhalter, der nur einen Download-Link für das Dokument anzeigt. com.saperion.ngc.viewer.virtualviewer.clientserver.csvirtualviewerapplet Implementierung des mit gelieferten Snowbound Virtual Viewer (Standardwert).

5 1 Suchen und Anzeigen von Dokumenten 1. Sprungmarken Mit Hilfe einer Sprungmarke in der URL können Sie zusätzlich Vorbelegungen für die Suche festlegen. Dabei ist folgendes zu beachten: Die Sprungmarke wird in der URL hinter einem # angegeben. Für jedes Feld kann dabei ein Paar aus Feldname und Wert angegeben werden, wobei Feldname und Wert mit "=" getrennt werden. Mehrere Paare werden mit "&" getrennt. Felder, die eine untere bzw. obere Grenze für die Suche bestimmen, werden mit [0] bzw. [1] identifiziert. Angaben mit Fließkommazahlen müssen mit einem Punkt (nicht mit einem Komma) angegeben werden. Beispiel =com.saperion.ngc.viewer.simple.mediaviewerimpl#ex7_docnr[0]=&ex7_docnr[1]=&ex7_docname=.%0og Mit dieser URL wird die Maske "examplev7_q" geöffnet. Es soll gleich nach dem Öffnen eine Suche gestartet, und, sofern nur ein Dokument gefunden wurde, dieses gleich ausgewählt werden. Der verwendete Viewer wird auf den zu Testzwecken mitgelieferten Media Viewer eingestellt. Für die Suche wird das Feld EX7_DOCNR (untere Grenze) mit "", das Feld EX7_DOCNR (obere Grenze) mit "" und das Feld EX7_DOCNAME mit dem Wert ". OG" vorbelegt werden. 1. Vorbelegung der Indexfelder Bei der Vorbelegung der Indexfelder sind bestimmte Formate für die Werte einzuhalten: Fließkomma-Zahlen: Dezimaltrennzeichen ist ein Punkt (Bsp.: 17.) Datum: ISO-8601 Format (Bsp.: T18::.000Z) Mehrere Werte für Multi-Value-Felder können mit ";" getrennt angegeben werden. Wenn in einem Feld ein Semikolon im Wert enthalten sein soll, kann es mit einem zweiten Semikolon maskiert werden (Bsp: "Ein;;einziger;;Wert" wird zu "Ein;einziger;Wert". 1;; gibt die drei Werte 1, und an) Bei Volltext-Feldern muss die datenbankabhängige Syntax der Volltext-Suchfunktion verwendet werden. Zum Beispiel muss ein Ausdruck mit Leerzeichen in Anführungszeichen gesetzt werden. Weiteres entnehmen Sie bitte der Dokumentation der Datenbank. 1.5 Konfiguration der Service Komponente In der "portal.zul" haben Sie die Möglichkeit, weitere Konfigurationen vorzunehmen. Das Abschalten der Meldung "Möchten Sie zu dieser Seite wechseln?" bei einem Seitenwechsel erfolgt durch folgenden Eintrag: <spnservice logoffwarningdisabled="true"/>

6 Wenn der Benutzer nach Abmeldung weiterhin auf der Seite bleiben soll, tragen Sie folgendes ein: <spnservice redirectafterlogoffdisabled="true"/> Zugriff auf die Workflow-Inbox Mit der Datei "portal.zul" ist es ebenfalls möglich, auf die Workflow-Inbox eines Benutzers zuzugreifen. Dazu steht ein eigener bereit: Zugriff auf Workflow-Inbox openinbox Öffnet die Inbox des aktuell angemeldeten Benutzers. Bis auf den "mask" stehen alle anderen oben aufgeführten ebenfalls zur Verfügung (siehe Kapitel "portal.zul" oben). Damit ist es möglich, die Felder in der Maske für die Workflow-Inbox vorzubelegen. Beispiel Wenn ein Benutzer auf die obige Beispiel-URL klickt und sich gegenüber dem System authentifiziert hat, wird die Maske für die Workflow-Inbox geladen. Das Feld "Subject" ist mit dem Wert "Invoice" vorbelegt und eine Suche wird gestartet. i Aktuell ist der Zugriff auf Gruppen- und Stellvertreter-Boxen mit der "portal.zul" nicht möglich. Archivieren neuer Dokumente.1 "archiver.zul" Die Datei "archiver.zul" wird mit über ein http-post-request gesteuert. In diesem POST-Request werden sowohl die zu verwendende Index-Maske als auch der Inhalt des Dokuments sowie dessen Metadaten (sofern vordefiniert) übertragen. Vorbelegungen für die Indexfelder können als zusätzliche im POST-Request übertragen werden. Dazu werden jeweils der Feldname und der gewünschte Wert verknüpft. Folgende sind vordefiniert: "archiver.zul" ngc_archivemask Der Name der Index-Maske (ohne.qbe Endung) ngc_archivedocument Enthält den Inhalt des Dokuments.

7 Archivieren neuer Dokumente 5 ngc_workflowdefinition Optional: Der Name der Workflow-Definition, die nach erfolgreicher Archivierung mit dem neuen Dokument gestartet werden soll. ngc_workflowactor Optional: Der Name des ersten Benutzers für die Workflow-Definition. Mit den optionalen n "ngc_workflowdefinition" und "ngc_workflowactor" kann nach einer erfolgreichen Archivierung automatisch ein Workflow mit dem neuen Dokument gestartet werden. Geben sie dafür einfach den Namen der Workflow-Definition an. Wenn die Definition keinen festgelegten Empfänger beinhaltet, können sie den Empfänger mit dem "ngc_workflowactor" festlegen.. Ereignisse Die Datei "archiver.zul" ermöglicht es außerdem, auf bestimmte Ereignisse zu reagieren: Ereignisse Ereignis onarchivercancel Wird ausgelöst, wenn der Benutzer in der Maske auf eine [Abbrechen]-Schaltfläche klickt. onarchivererror Wird ausgelöst, wenn der Archiver das Dokument nicht archivieren kann. Dabei ist zu beachten, dass nur Fehler behandelt werden, die im Archiver selbst auftreten können. Das sind z.b. falsche Request- oder ungenügende Benutzer-Rechte. Systemfehler beim Archivieren werden bereits von der Fehlerbehandlung der Web Client-Komponenten abgefangen. Das Ereignis enthält die Fehlermeldung in seinem "Data"-Feld. onarchiversuccess Wird ausgelöst, nachdem ein Dokument archiviert wurde. Das Ereignis enthält die in die Indexfelder eingegebenen Werte als Liste von FieldResultBeans in seinem "Data"-Feld. In den vorbereiteten Event-Listenern in der ".zul"-datei kann auf jedes dieser Events gesondert reagiert werden. In der mitgelieferten Beispiel-Implementierung wird dem Benutzer jeweils eine Nachricht angezeigt. Nachdem er die Nachricht bestätigt hat, wird er vom System abgemeldet und auf die Testseite umgeleitet.