Best Practice SAPERION SQL-Methoden

Transkript

1 Best Practice SAPERION SQL-Methoden

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 Regeln und Funktionen Abfragen Platzhalter Multivalue-Felder... Beispiele....1 Beispiel Beispiel... Implementierung einer eigenen Suche in SAPERION....1 Funktionsbeschreibung der Standardsuche im Rich Client.... Erweiterung der Standardsuche eines Formulars um eigene Bedingungen.

4 Best Practice SAPERION SQL-Methoden Die Methoden "Application.SelectSQL" bzw. "Mask.SearchSQL" ermöglichen es, in einer Anwendung Abfragen direkt an die Datenbank zu senden. Da SAPERION keinerlei Syntax-Prüfungen durchführt, besteht eine Fehleranfälligkeit - insbesondere, wenn die Abfragen aufgrund von Benutzereingaben erzeugt werden. Des Weiteren bieten unterschiedliche Datenbank-Systeme (z.b. ORACLE, SQL Server) eine weitere Fehlerquelle für die unterschiedliche Syntax. 1 Regeln und Funktionen Um diesen bekannten Problemen entgegen zu wirken, sollten Sie folgende Regeln und Funktionen von SAPERION berücksichtigen: 1.1 Abfragen Eine Abfrage in SAPERION besteht aus den Teilen: SELECT <columns>from <tables> WHERE <conditions> ORDER BY <columns> 1. Platzhalter Mit "SelectSQL" und "SearchSQL" können Sie den Teil "<conditions> ORDER BY <columns>" beeinflussen. Bitte verwenden Sie folgende Platzhalter bei den Bedingungen: Platzhalter Platzhalter Beschreibung [@<ddc column name>] Wird durch den tatsächlichen Spaltennamen in der Tabelle in der jeweiligen DB Syntax ersetzt, der korrekte Name für XHDOC ist $HDOC also [@$HDOC] [$yyyy-mm-dd$hh:mm:ss] Abfrage eines Zeitstempelwertes [$yyyy-mm-dd$] Abfrage eine Datumswertes [$$hh:mm:ss] Abfrage eines Zeitwertes [SYSDATE] Wird durch das aktuelle Datum ersetzt. [SYSTIME] Wird durch die aktuelle Uhrzeit ersetzt. [SYSDATETIME] Wird durch den aktuellen Zeitstempel ersetzt. [ U] Wird durch UPPER Umwandlungsfunktion, sofern diese definiert ist, ersetzt. [ )] Wird durch UPPER Umwandlungsfunktion, sofern diese definiert ist, ersetzt.

5 Beispiele 1. Multivalue-Felder Multivalue-Felder dürfen in den Bedingungen nur als Subqueries oder mit EXISTS verwendet werden. Eine Suche, die einen JOIN voraussetzt ist nicht möglich. Die automatischen Feldersetzungen funktionieren hier nicht. Beispiel = ( SELECT HDOC FROM <DDC>SYSACLUSERLIST WHERE (MULTIVAL = 0) Wenn "Application.SelectSQL" auf einem Multivalue-Feld angewandt wird, darf folgendes Statement nicht verwendet werden: Set ocursor = Application.SelectSQL("<DDCNAME","<MultivalueField> = 1") Bitte verwenden Sie anstelle dessen folgendes Statement: Set ocursor = Application.SelectSQL("<DDCNAME>"," (EXISTS (SELECT HDOC FROM <DDCNAME><Multivaluefield> WHERE HDOC = XHDOC AND MULTIVAL = '1')) order by zeichen desc") i Bitte beachten Sie, dass Sie in diesem Fall SYSINDEXSTATE und SYSOUTLINERDATA selbst hinzufügen müssen. SYSACLUSERLIST wird automatisch hinzugefügt. Beispiele.1 Beispiel 1 selectsql( "exampleszenario", "[ U(][@DOCNAME][ )] = 'TEST' AND [@ARCHIVINGDATE] = [$ $] AND [@SYSTIMESTAMP] >= [SYSDATETIME]" ) Daraus wird z.b. bei SQL Server: [DOCNAME] = 'TEST' AND [ARCHIVINGDATE] = '009/0/01' AND [SYSTIMESTAMP] >= '009/01/01 1:00' Oder bei Oracle : Upper("DOCNAME") = 'TEST' AND.... Beispiel Abfragemaske mit zwei Suchfeldern zu einem Datumsfeld: Das erste bildet die obere Grenze, das andere die untere Grenze der Suchkriterien. Richten Sie eine [Makro]-Schaltfläche mit einem Makro, das den obigen Aufruf beinhaltet, ein. Query = "(([@Belegdatum] >= [$ " & Format(mask.field("Belegdatum",1), "yyyy-mm-dd") &"$])

6 AND <= [$" & Format(mask.field("Belegdatum",), "yyyy-mm-dd") &"$]))" Mask.SearchSQL squery Der Aufruf bewirkt im einzelnen Folgendes: "mask.field("belegdatum",1)" liest das für die untere Grenze definierte Datumsfeld aus (z.b. " ") "mask.field("belegdatum",)" liest das für die obere Grenze definierte Datumsfeld aus (z.b. " ") "Format(<ausgelesener Feldinhalt>, "yyyy-mm-dd")" wandelt das ausgelesene Feld in das angegebene Format um. (hier " " bzw. " ") Durch die voran- und nachgestellten [$... $] wird ein datenbankunabhängiges Suchformat erzeugt (hier "[$ $]" bzw. "[$ $]"). Steht z.b. in dem String des Maskenfeldes "Belegdatum" " ", wird nach der Umformung (hier "[$ $]" bzw. "[$ $]"). "Mask.SearchSQL" schickt den in squery abgelegten SQL-String an die Datenbank >= [$ $] AND <= [$ $] ))" Implementierung einer eigenen Suche in SAPERION.1 Funktionsbeschreibung der Standardsuche im Rich Client Wenn eine Anwendung über die Navigation aktiviert wird, öffnet oder aktiviert SAPERION das Formular und sendet den "Sofort suchen"-befehl an die Ergebnisliste. Ist die Option "Sofort suchen" der Ergebnisliste eingeschaltet, führt SAPERION eine Standardsuche aus, indem es den "Ausführen"-Befehl an die [Ergebnis]-Schaltfläche sendet (BUTTON CLICK). Dies impliziert, dass SAPERION das OnButtonClick-Ereignis auswertet. Ist die Option "Sofort suchen" der Ergebnisliste deaktiviert, ist der Anwendungsentwickler bzw. der Anwender dafür verantwortlich eine Suche auszuführen. Eine Suche kann durch das Drücken der [Ergebnis]-Schaltfläche, bzw. der [Aktualisieren]-Schaltfläche im Ribbon oder über die COM-API Methoden des Masks.Search ausgeführt werden. In all diesen Fällen sendet SAPERION den "Ausführen"-Befehl an die [Ergebnis]-Schaltfläche und wertet das OnButtonClick-Ereignis aus.. Erweiterung der Standardsuche eines Formulars um eigene Bedingungen Für die Erweiterung der Standardsuche kann der Befehl Mask.SearchSQL verwendet werden: Beispiel Mask.SearchSQL "<column>=<value> AND ", True

7 Implementierung einer eigenen Suche in SAPERION Parameter Mask.SearchSQL Parameter Beschreibung Mask.SearchSQL "<column>=<value> AND " TRUE: SAPERION filtert die Daten mit der freien SQL-Bedingung und berücksichtigt auch alle gefüllten Felder des Formulars. FALSE: SAPERION ignoriert die Felder in dem Formular; die Bedingung kann daher komplett per Skript gebaut werden. Um sicherzustellen, dass diese erweiterte Suche immer ausgeführt wird, sobald die Suche für ein Formular aufgerufen wird (unabhängig davon, ob dies über Navigation, Skript, Schaltfläche im Ribbon, Schaltfläche in der Maske ausgelöst wird), können Sie folgendes Skript an das OnButtonClick-Ereignis der [Ergebnis]-Schaltfläche des Formulars anhängen und die Option "Sofort suchen" der Ergebnisliste aktivieren: Function Search_OnButtonClick( controlid As Long ) As Boolean Mask.SearchSQL "<column>=<value> AND ", True Search_OnButtonClick = FALSE ' set to False if event is handled by you End Function Indem die Funktion FALSE zurückgibt, führt SAPERION nicht mehr die normale Formular-Suche aus. Damit haben Sie ihre Suche erfolgreich als Standard für dieses Formular implementiert. i Häufig wird in Formularen auch das OnInitDialog-Ereignis verwendet, um eine erste Suche auszuführen. Dies funktioniert mit der Version 7 nur, wenn die Option "Sofort suchen" deaktiviert ist. Wenn also die Systemlast etwas gesenkt werden soll, empfiehlt es sich, ohne die Option "Sofort suchen" zu arbeiten und sowohl das OnIntDialog- als auch OnButtonClick-Ereignis mit den passenden Skripten zu versorgen. Die gewünschte Suche wird nun genau einmal beim Öffnen des Formulars ausgeführt und wann immer der Anwender explizit eine Aktualisierung anfordert, aber nicht wenn auf das Formular über die Navigation fokussiert wird. 5