Schnittstelle
Es empfiehlt sich, vor Anlage einer Site folgende Dokumentation zu konsultieren:Was vor Ausführung der Funktion zu beachten ist.
Die Hauptfunktion der Parameterdaten 'Schnittstelle' ist es, einen X3-Webservice zu lokalisieren und folgende Daten zu liefern:
- den Namen oder Alias, unter dem der Webservice veröffentlicht wurde
- die Webservice-Serveradresse, die den Service liefert
Bei den Interaktionen zwischen einer XTEND-Webapplikation und dem X3-Backoffice kommen zwei Service-Kategorien zum Tragen:
- Services vom Typ 'Zugriff', mit denen die Datenzugriffe beschrieben werden
- Services vom Typ 'Aktion', mit denen die Benutzeraktionen beschrieben werden
Die Anzahl von Parametern der Webservices vom Typ Zugriff oder 'Unterprogrammaktion' ist auf 50 begrenzt.
Im Webservice-Modus enthält die globale X3-Variable GUSER den X3-Benutzercode, der beim Aufruf des Webservices als Parameter übergeben wurde.
XTEND weist den X3-Benutzercode in Abhängigkeit davon zu, ob der Benutzer eine Signatur besitzt:
- Ein XTEND-Benutzer ohne Signatur verwendet den standardmäßig im Webservice-Pool definierten X3-Benutzercode.
- Ein XTEND-Benutzer mit Signatur verwendet den X3-Benutzercode, der von der Anmeldefunktion zurückgegeben wird.
Schnittstellen vom Typ 'Zugriff'
Der XTEND-Server greift nicht direkt mit einem Datenbank-Konnektor auf die X3-Datenbank zu, sondern über einen speziellen Webservice-Aufruf vom Typ Unterprogramm oder Auswahlliste links.
Mit den Schnittstellen vom Typ 'Zugriff' können solche Webservices definiert werden; ihre Funktionsweise entspricht der der Data Provider.
Diese Webservices werden von den Tokens vom Typ Blockaufgerufen.
Generierter Tabellenzugriff
Automatische Generierung eines Webservices, um auf die Datensätze einer X3-Datenbank zuzugreifen:
1. Generierung einer 4GL-Verarbeitung
2. Anlage eines Datenblatts in der Tabelle der Unterprogramme
3. Veröffentlichung des Webservices
Der generierte Webservice steht sofort auf sämtlichen Webservice-Webservern zur Verfügung, die den Ordner veröffentlichen.
Generierter View-Zugriff
Analog zu 'Generierter Tabellenzugriff', jedoch für X3-Views.
Zugriff Auswahlliste links
Verwendung des Webservice 'Auswahlliste links' eines X3-Objekts als Datenquelle.
Zugriff 'Unterprogramm'
Der Typ 'Zugriff Unterprogramm' wird in der Regel zum Hinzufügen von berechneten Felder zu den Tabellen- / Viewfeldern verwendet, auf die zugegriffen werden soll.
Beispiel : Hinzufügen der Verfügbarkeit und des Preises von Artikeln zu einem Katalog.
Zur Berechnung der Werte der 'berechneten' Felder müssen der 4GL-Verarbeitung zusätzlich zu den standardmäßig vom XTEND-Server über die Parameter AXPARCOD und AXPARVAL (siehe Benutzeraktionen) weitere Kontextparameter übergeben werden.
Beispiel : Kundencode oder Menge / Datum, vom Benutzer erfasst.
Parametertabelle 'Zugriff Unterprogramm'
Mit dieser Tabelle kann die Liste der Zusatzparameter definiert werden.
Der Wert der Parameter vom Typ 'Erfassung' wird in den Daten des Tokens dynamischer Link oder Blockerfasst.
Anders als bei den Benutzeraktionen erlaubt der Zugriff auf das Unterprogramm keine Erfassung des Parametermappings.
Die Parametertabelle kann als Mapping auf die Liste der AXPARCOD- / AXPARVAL-Parameter interpretiert werden.
Optimierungen
Wie beim generierten Tabellenzugriff ist es gelegentlich notwendig, zur Verbesserung der Antwortzeiten den Webservice-Aufruf zu optimieren.
- Mit dieser Tabelle kann der Benutzer seine eigenen Optimierungstypen definieren (erfassen).
- Der XTEND-Server belegt den $OPTIMIZE-Parameter beim Webservice-Aufruf.
- Dem 4GL-Entwickler fällt es zu, die Optimierungsverarbeitung in Abhängigkeit vom Parameterwert zu entwickeln.
Schnittstellen vom Typ 'Aktion'
Mit den Schnittstellen vom Typ 'Benutzeraktion'können Webservices (4GL-Verarbeitungen) definiert werden, die mit den Daten aus dem X3-Backoffice arbeiten.
Die Schnittstelle 'Aktion' ist Webaktionsdaten zugeordnet, mit denen das Parametermapping beschrieben werden kann.
Diese Webaktionen sind wiederum Tokens vom Typ dynamischer Link zugeordnet, damit sie in die grafischen Schnittstellenelemente wie Buttons (input type="button" onClick="">) oder Anker (<a href="button" onClick="">) eingefügt werden können.
Benutzeraktion
Eine XTEND-Benutzeraktion XTEND resultiert immer aus einem Aufruf eines X3-Webservices. Bei diesem Webservice handelt es sich entweder um ein Unterprogramm oder um eine Aktion in Verbindung mit einem X3-Objekt.
Eine XTEND-Aktion erwartet Parameter als Eingaben, führt eine Verarbeitung aus und belegt eine bestimmte Anzahl von Parametern als Rückgabewerte, wie z. B. beim Aufruf eines 4GL-Unterprogramms.
Im Falle einer XTEND-Applikation werden die Parametereingaben in der Regel vom Benutzer in einem HTML-Formular vorgenommen; die vom Unterprogramm zurückgegebenen Werte werden in der Benutzersitzung im Speicher gehalten (Mapping), um auf einer HTML-Seite angezeigt werden oder als Parameter für weitere Aktionen verwendet werden zu können.
Aktion Unterprogramm
Zuvor müssen die 4GL-Verarbeitung programmiert und die Unterprogrammdaten angelegt worden sein.
Nach Anlage der Schnittstelle, kann der Webservice mit dem Button "Zugriff generieren" veröffentlicht werden.
Aktion X3-Objekt
Der Code der X3-Aktion (Aktionsbutton des Objekts) wird in den Daten der Webaktion erfasst.
Nach Anlage der Schnittstelle, kann der Webservice mit dem Button "Zugriff generieren" veröffentlicht werden.
Maskenverwaltung
Kopfzeile
Felder
In diesem Register befinden sich die folgenden Felder :
| Schnittstellencode. |
| Aktuelle Website. |
| Ermöglicht die Definition einer Bezeichnung für jeden Datensatz. |
Schließen
Register Allgemeine Angaben
Übersicht
Allgemeine Schnittstellenparameter
Die zu erfassenden Parameter hängen vom gewählten Schnittstellentyp ab
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
Typ Schnittstelle
| Schnittstellen vom Typ Datenzugriff:
Schnittstellen vom Typ 'Aktion':
|
Tabelle/Ansicht
| Tabellencode für einen 'Zugriff generierte Tabelle'. |
| Ansichtscode für einen 'Zugriff generierte Ansicht'. |
Objekt
| Objektcode für die Schnittstellentypen 'Aktion Objektbenutzer' und 'Aktion Daten Explorerliste'. |
| Code der Transaktion für die Schnittstellen vom Typ 'Datenzugriff Explorerliste' und 'Aktion Benutzer Objekt'. |
| Dieses Feld ermöglicht die Berücksichtigung der verborgenen Bereiche für das Webservice-Objekt im Fall der Schnittstellen 'Zugriff Explorerliste' und 'Aktion Objektbenutzer'. |
|
|
Unterprogramme
| Name der vom Webservice aufgerufenen Verarbeitung. Dieses Feld muss nur für die Schnittstellen 'Zugriff Daten Unterprogramm' und ' Aktion Benutzer Unterprogramm' angegeben werden.
|
| Name des vom Webservice aufgerufenen Unterprogramms. Dieses Feld muss nur für die Schnittstellen 'Zugriff Daten Unterprogramm' und ' Aktion Benutzer Unterprogramm' angegeben werden.
|
Veröffentlichung
| Veröffentlichungs-Name des X3-Webservice. |
| Maximale Anzahl an Datensätzen, die vom Webservice zurückgesendet wurden und über den Button 'Zugriff generieren' geändert werden können. |
|
|
|
|
Schließen
Register Erweitert...
Felder
In diesem Register befinden sich die folgenden Felder :
Anzeige der Meldungen vom Typ
| Ein X3-Webservice kann Meldungen von folgendem Typ zurücksenden:
Die Auswahl eines Meldungstyps gibt dem XTEND-Server an, dass er diesen Meldungstyp bei der Rückgabe des Webservice-Aufrufs berücksichtigen muss, um den Namen AMSGUSER über den Feldtoken anzuzeigen. |
|
|
|
|
| Die Schnittstellen vom Typ 'Zugriff' sind die am meisten verwendeten der XTEND-Engine; die 'Flüssigkeit' der Webseite hängt stark von der Anwortzeit der aufgerufenen Webseitenantworten auf. Diese Tabelle schlägt für jeden Zugriffscode die Liste der möglichen Optimierungen vor, die zum Zeitpunkt des Aufrufs in Blocktoken ausgewählt sind. |
Pool
| Der Webservice-Pool ermöglicht die Lokalisierung des Webservices:
|
| XTEND-Poolcode, wenn dieser sich vom Standardpool unterscheidet, der auf Ebene des Parameters 'Webseite' erfasst ist. Die Verwendung eines bestimmten XTEND-Pools für eine Schnittstelle ermöglicht die Aufteilung der Belastung auf die verschiedenen Verbindungspools, wenn nur wenige Webservice-Lizenzen vorhanden sind. Beispiel: Der Standardpool kann für den Aufruf der interaktiven Webservices mit geringer Antwortzeit verwendet werden. |
Zugriff
| Dieser Parameter ermöglicht die Zugriffsprüfung auf die Webservices über die Profile:
Dieser Parameter wird in der Regel von den Anwendungen verwendet, die die Bibliothek AJAX von XTEND verwenden. |
|
|
Tabelle Param. Zugriff Unterprogramm
| Parametercode. |
| Typ des Wertes für den Parameter:
|
| Wert eines Parameters vom Typ 'Konstante'. |
Schließen
Berichte
Standardmäßig sind der Funktion folgende Reports zugeordnet :
PRTSCR : Druck Maske
Dies kann durch geeignete Parameter geändert werden.
Spezielle Buttons
Mit diesem Button kann eine Schnittstelle kopiert werden. |
Im über diese Schaltfläche geöffneten Fenster befinden sich die folgenden Felder: : Blocknummer 1
Tabelle Schnittstelle
Schließen 'In dieser Dokumentation wird der Icon-Button [Zugriff generieren] beschrieben. Mit diesem Button kann automatisch der Webservice generiert werden, dessen Veröffentlichungsname in der Schnittstelle definiert ist. Der generierte Webservice steht sofort auf sämtlichen Webservice-Webservern zur Verfügung, die den Ordner veröffentlichen.
Der Button 'Zugriff generieren' führt folgende Bearbeitungsschritte durch:
Für Schnittstellen vom Typ Zugriff Tabellendaten und Zugriff View-Daten werden Verarbeitung und Unterprogrammdaten automatisch generiert. Zugriff Unterprogrammdaten, Benutzeraktion Unterprogramm Verarbeitung und Unterprogrammdaten müssen vor der Zugriffsgenerierung manuell angelegt werden. Benutzeraktion Objekt, Datenzugriff Auswahlliste links Es sind weder eine Verarbeitung noch Unterprogrammdaten anzulegen. |
Menüleiste
Tools / Kopie Webservice
Mit diesem Werkzeug können eine oder mehrere (Feld Schnittstelle = leer) Schnittstellen einer XTEND-Website aus dem aktuellen X3-Ordner ausgewählt und die Webservices dieser Schnittstelle(n) in einen / einem anderen Ordner kopiert / veröffentlicht werden.
Zur Aktivierung der Kopie muss mindestens eine Schnittstelle aus der Liste ausgewählt werden.
Kopie eines Unterprogramms:
- Kopie eines 4GL-Webservice
- Anlage eines Datenblattes 'Unterprogramm'
- Veröffentlichung des Webservices
Kopie eines objektorientierten X3-Webservices:
- Veröffentlichung des Webservices
Quelle / Ordner : aktueller Ordner.
Quelle / Website : Code der XTEND-Site, mit dem die Schnittstellenliste angezeigt werden kann (standardmäßig aktuelle Site).
Quelle / Schnittstelle : Schnittstellencode zur Anzeige des Webservices dieser Schnittstelle.
Ziel / Ordner : Zielordner für die Kopie.
Tools / Anlage Field-Token
Mit diesem Werkzeug werden Field-Tokens angelegt:
- auf Basis der Feldliste einer X3-Tabelle
- auf Basis der Feldliste eines X3-Views
- auf Basis der einer Schnittstelle zugeordneten Webservice-Parameter
Spalte | Beschreibung |
Parameter | Code des Tabellenfelds oder des Webservice-Parameters |
Titel | Feldtitel |
Field-Token | XTEND-Code des Parameters (standardmäßig derselbe Code) |
Existiert | Aktiviert, wenn das Feld bereits im Dictionary vorhanden ist |
Typ | Feldtyp (XTEND) |
Menü | Menü-Id des Typs LokalesMenue |
Größe | Maximal Anzahl von Parameter- oder Feldwerten |
Generierung | Gibt für Felder mit Länge > 1 an, ob ein Index zu generieren ist (NOMCHAMP + INDICE) |
Index | Feldindex zur Berechnung des Namens. |
Damit der XTEND-Server die Felder berücksichtigt, müssen diese nach der Generierung freigegeben werden.
Bei Freigabe wird ein neues XML-Dictionary der XTEND-Parameter angelegt.
Wenn die Option 'Technik\Aktualisierung\ Prüfen\Web-Dictionary' der Site aktiviert ist, wird das neue Dictionary bei Aktualisierung / F5 der HTML-Seite im Browser nicht automatisch berücksichtigt.
Sonst muss die Dictionary-Aktualisierung mithilfe folgender URL erzwungen werden:
'http://hostname:port/xtend/svc/SolutionX3/DossierX3/SiteXtend/admin/reposit/reload'