Web Client

Copyright © 2016 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.

Inhaltsverzeichnis 1 Listener ................................................................................................................ 2 Darstellung der Workflow-Inbox ........................................................................ 3 Web Client Komponenten ................................................................................... 4 Portal Integration ................................................................................................ 4.1 Suchen und Anzeigen von Dokumenten ....................................................... 4.1.1 "portal.zul" ....................................................................................................... 4.1.2 Filter ................................................................................................................. 4.1.3 Viewerclass ...................................................................................................... 4.1.4 Vorbelegung der Indexfelder ........................................................................... 4.1.5 Konfiguration der Service Komponente ......................................................... 4.2 Zugriff auf die Workflow-Inbox ....................................................................... 4.3 Archivieren neuer Dokumente ........................................................................ 4.3.1 "archiver.zul" .................................................................................................... 4.3.2 Ereignisse .........................................................................................................

2 2 3 4 4 4 5 5 6 6 6 7 7 7

2

Web Client 1

Listener

ZK stellt verschiedene Listener zur Verfügung, mit denen eine Anwendung auf bestimmte Ereignisse reagieren kann:

+

DesktopCleanup

+

Desktopinit

+

SessionCleanup

+

Sessioninit

+

WebAppCleanup

+

WebAppinit

Der SAPERION Web Client implementiert eignene Listener für diese Ereignisse:

+

NGDesktopCleanup

+

NGDesktopInit

+

NGSessionCleanup

+

NGSessionInit

+

NGWebAppCleanup

+

NGWebAppInit

Wenn zusätzliche Aktionen bei einem der Ereignisse ausgeführt werden sollen, kann ein eigener Listener für das Ereignis implementiert werden. Der neue Listener muss eine Erweiterung des jeweiligen Web Client-Listeners sein.

i

Bitte achten Sie darauf, dass in der zu implementierenden Methode die Methode des Web Client-Listeners aufgerufen wird.

Der neue Listener kann dann in der "zk.xml"-Datei registriert werden

2

Darstellung der Workflow-Inbox

Damit im Web Client Workflow Aufgaben (Geschäftsfälle) differenziert nach "Wiedervorlage" und "Eingang" dargestellt werden können, müssen Sie die "getInbox"mit folgendem Filterstring ergänzen: public enum Filter { /** default - no filter. */ NONE("(HOLDDATE = NULL or HOLDDATE < current_timestamp())"), /** */

3

Web Client Komponenten

3

DUE_TASKS("(ESCALATIONID > 1)"), /** */ REMINDERS("(HOLDDATE >= current_timestamp() and HOLDDATE NULL)"), /** */ DELEGATED_TASKS("(OWNERID = %ID%)"), // and USERID %ID%)"), /** */ COMPLETED_TASKS("(LASTUSERID = %ID%)");

3

Web Client Komponenten

In diesem Kapitel stellen wir Ihnen eine Übersicht über die im Web Client vorhandenen Komponenten dar. Alle Komponenten sind Ableitungen verschiedener Standard ZK-Komponenten, weshalb die üblichen ZK-Parameter und Events für alle Komponenten zur Verfügung stehen. Weitere Parameter und Events werden - sofern vorhanden - zu den Komponenten aufgelistet.

i

Eine genaue Auflistung der zur Verfügung stehenden Methoden findet sich in der JavaDoc des Web Clients. Dazu wird der Name der Klasse der Komponente mit angegeben.

Alle Komponenten werden im Normalfall über Events gesteuert. Um in den Ablauf der Event-Verarbeitung einzugreifen, können eigene Event Listener auf den Komponenten registriert werden. Die von den einzelnen Komponenten empfangenen Events lassen sich ebenfalls mit der JavaDoc des Web Clients ermitteln, da es für jedes empfangene Event eine Methode mit dem Namen des Events gibt. Zum Beispiel würde ein Event mit dem Namen „onLogon“ von einer Methode namens „onLogon“ behandelt werden. Das ZK-Framework stellt dabei sicher, dass die registrierten Event Listener benachrichtigt werden, bevor die jeweilige on-Methode aufgerufen wird. Web Client Komponenten Komponente

Beschreibung

spnservice [com.saperion.ngc.service.ServiceView]

Unsichtbare Service-Komponente, die Funktionen wie das An- und Abmelden sowie das Logging übernimmt.

viewer [com.saperion.ngc.viewer.DocumentViewImpl]

Dient zur Anzeige von Dokumenten. Die Viewer-Komponente enthält den eigentlichen Viewer als eigenständige interne Komponente. Welcher Viewer verwendet wird, kann in der "web.xml" konfiguriert werden.

mashup [com.saperion.ngc.iform.mashup.FormMashup]

Das Mashup dient zum Einbinden externer Web-Anwendungen wie z.B. Google Maps oder XING.

logging

Dient zur Anzeige von Log-Einträgen in der Oberfläche.

[com.saperion.ngc.logging.LogViewImpl] navigation [com.saperion.ngc.navigation.NavigationViewImpl]

Stellt den Navigationsbaum dar und ermöglicht Operationen auf Ordner-Ebene wie das Hinzufügen und Löschen von Ordnern, das Archivieren und Einordnen von Dokumenten und das Öffnen von Anwendungen.

resultset [com.saperion.ngc.resultset.ResultSetViewImpl]

Stellt das Ergebnis einer Abfrage als Liste dar und bietet Funktionen zur Arbeit mit den einzelnen gefundenen Elementen. Außerdem enthält die Komponente die UI-Elemente zum Wechseln der Seiten eines Suchergebnisses und für das clientseitige Filtern.

4 Komponente

Beschreibung

spntoolbar [com.saperion.ngc.toolbar.SaperionToolbarView]

Die Toolbar enthält einen frei wählbaren Namen für die Applikation, den Namen des aktuell angemeldeten Benutzers, eine Dropdown-Box zur Sprachauswahl und den Logout-Button.

tabview [com.saperion.ngc.maintab.MainTabViewImpl]

Die Tabview-Komponente dient dazu, mehrere Masken oder andere Elemente in Tabs anzuzeigen.

iform [com.saperion.ngc.iform.IntelligentFormViewImpl]

Das iForm ist die Entsprechung einer Maske im Rich Client. Mit Hilfe der anderen Komponenten wird in einer iForm der Inhalt der Maske so dargestellt, wie im Masken Designer des Rich Clients festgelegt wurde. Eine iForm kann auch in einer anderen iForm eingebettet sein.

iformlabel [com.saperion.ngc.iform.label.FormLabel]

Stellt einen Text einer Maske dar.

iformbutton [com.saperion.ngc.iform.button.FormButton]

Stellt einen Button einer Maske dar.

itextfield [com.saperion.ngc.iform.field.TextField]

Stellt ein Text-Eingabefeld einer Maske dar.

itristatefield [com.saperion.ngc.iform.field.TristateField]

Stellt ein Eingabefeld für die drei Werte “keins”, “alle” und “manche” einer Maske dar.

icheckboxfield [com.saperion.ngc.iform.field.CheckboxField]

Stellt ein Eingabefeld für “ja” und “nein” einer Maske dar.

idatefield [com.saperion.ngc.iform.field.DateField]

Stellt ein Datums-Eingabefeld einer Maske dar.

ifloatfield [com.saperion.ngc.iform.field.FloatField]

Stellt ein Fließkomma-Eingabefeld einer Maske dar.

iintfield [com.saperion.ngc.iform.field.IntField]

Stellt ein Ganzzahl-Eingabefeld einer Maske dar.

ilookuptextfield [com.saperion.ngc.iform.field.LookupTextField]

Stellt ein Text-Eingabefeld mit einer Lookup-Tabelle einer Maske dar.

itimefield [com.saperion.ngc.iform.field.TimeField]

Stellt ein Zeit-Eingabefeld einer Maske dar.

4

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

4.1

Suchen und Anzeigen von Dokumenten

"portal.zul" Die Steuerung der Datei "portal.zul" erfolgt mit den folgenden URL-Parametern:

4

Portal Integration

5

"portal.zul" Parameter

Beschreibung

mask

Name der zu öffnenden Abfrage-Maske (ohne .qbe Endung)

doquery

Wenn dieser Parameter vorhanden ist (ohne Wert), wird automatisch eine Abfrage gestartet.

filter

Wenn "doquery" verwendet wird, kann zusätzlich der Parameter "filter" benutzt werden, um nach bestimmte Werte in den Feldern zu filtern.

selectsingleresult

Wenn dieser Parameter vorhanden ist (ohne Wert), wird automatisch das gefundene Dokument selektiert. Wenn mehrere Dokumente gefunden wurden, hat dieser Parameter keine Auswirkung.

viewerclass

Mit diesem Parameter 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.

Filter Mit Hilfe des optionalen Parameters "filter" in der URL können Sie zusätzliche Werte für die Suche definieren. Dabei ist folgendes zu beachten:

+

Das Parameter "filter" 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.

Das Format der URL mit dem Parameter "filter" sieht dann beispielsweise so aus:

http://:8080/scr-webclient/portal.zul?mask=&doquery&filter==;