sql cockpit - anwenderdokumentation - cadaxo.com sql... · x sql cockpit 2.0 –...

12
x SQL Cockpit 2.0 – Anwenderdokumentation Seite 1 SQL Cockpit – Anwenderdokumentation Version 2.0.1

Upload: truongtruc

Post on 06-Feb-2018

227 views

Category:

Documents


1 download

TRANSCRIPT

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 1

SQL Cockpit – Anwenderdokumentation

Version 2.0.1

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 2

Inhaltsverzeichnis

Einleitung ................................................................................................................................................ 3

Userinterface .......................................................................................................................................... 3

Toolbar ................................................................................................................................................ 3

SQL Eingabe Panel ............................................................................................................................. 5

Welche SQL Befehle werden unterstützt? .................................................................................... 5

Mehrere SELECTs ........................................................................................................................... 6

Teilbereich markieren .................................................................................................................... 6

Kommentare ................................................................................................................................... 6

Information Panel ............................................................................................................................... 6

Startschirm ..................................................................................................................................... 7

Ergebnisse ...................................................................................................................................... 7

My History ....................................................................................................................................... 8

Jobmonitor ...................................................................................................................................... 8

Gespeicherte Listen ....................................................................................................................... 9

Listen speichern ............................................................................................................................. 9

Symbol Panel ...................................................................................................................................... 9

Denkzettel – der Platz für Ihre Notizen ............................................................................................. 9

Persönliche Einstellungen................................................................................................................ 10

Spaltenüberschrift ........................................................................................................................ 10

ALV Ergebnisliste .......................................................................................................................... 10

Trace .............................................................................................................................................. 10

Fensteranordnung ........................................................................................................................ 10

Symbole......................................................................................................................................... 10

Editor ............................................................................................................................................. 10

Initiale Datumsauswahl................................................................................................................ 11

Varianten ........................................................................................................................................... 11

Variante sichern ............................................................................................................................ 11

Varianten auswählen/Varianten pflegen .................................................................................... 12

Copyright ............................................................................................................................................... 12

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 3

Einleitung

Vielen Dank, dass Sie sich für das SQL Cockpit von Cadaxo entschieden haben. Sie halten nun ein

mächtiges Tool in der Hand, das Sie bei Entwicklungstätigkeiten und bei Supportaufgaben in

Zukunft unterstützen wird. Außerdem können Sie mit Hilfe des Cadaxo SQL Cockpits nun

unvergleichlich schnell einfache Auswertungen erstellen.

In dieser Dokumentation möchten wir Ihnen nun – frei nach unserem Motto „ … es geht auch

einfach“ – die Verwendung und die Möglichkeiten des SQL Cockpits näher bringen.

Manchmal können komplexe Sachverhalte durch Videos einfacher und leichter erklärt werden,

deshalb haben wir auf unserer Homepage mehrere Tutorial Videos bereitgestellt.

Userinterface

Wir haben uns viele Gedanken über ein einfaches, intuitives Userinterface gemacht. Nach dem

Aufruf des SQL Cockpits mit der Transaktion /CADAXO/SQL gelangen Sie in die zentrale

Benutzeroberfläche des SQL Cockpits:

Die Oberfläche gliedert sich in vier Unterbereiche. Die Begrenzer dieser Bereiche sind flexibel, Sie

können deren Größe ganz nach Ihren Bedürfnissen anpassen. Der SQL Eingabe Panel und der

Information Panel sind immer eingeblendet. Symbol Panel und unser Denkzettel können über

einen Button eingeblendet werden.

Toolbar

Bei der Gestaltung der Toolbar, haben wir großen Wert auf übersichtliche Gliederung gelegt.

Nachfolgend die Funktionen im Überblick:

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 4

Zurück, Vor

Innerhalb einer Transaktion merkt sich das Cockpit

jedes SQL Kommando. Mit diesen

Navigationstasten kann zwischen den

ausgeführten SQL Abfragen navigiert werden.

Syntaxprüfung

Führt eine Syntaxprüfung des eingegebenen SQL

Kommandos durch. Die Syntaxprüfung wird auch

bei jedem Ausführen implizit vorgenommen.

Ausführen

Mit diesen drei Schaltflächen werden die SQL

Kommandos ausgeführt. Die erste Schaltfläche

startet die normale Verarbeitung. Für eine

Ausführung mit Fortschrittsanzeige wählen Sie die

zweite Schaltfläche und für eine Ausführung im

Hintergrund die dritte Schaltfläche

Listen

Am Bildschirm dargestellte Listen können mit Hilfe

dieser Funktion innerhalb des SQL Cockpits

gespeichert werden.

SQL Trace

Mit dieser Funktion kann der ABAP SQL Trace

aktiviert werden. Solange dieser aktiviert ist, wird

jedes ausgeführte SQL Kommando

mitprotokolliert.

Varianten

Wenn man oft mit gleichen oder ähnlichen SELECT

Kommandos arbeitet, können diese auch als

Variante abgespeichert und wiederverwendet

werden. Es können private oder globale Varianten

erstellt werden. Globale Varianten stehen auch

anderen Anwendern zur Verfügung.

Templates

Mit dieser Funktion können auf Basis der SQL

Kommandos auf Basis von Templates

verschiedene Objekte wie Reports generiert

werden. Templates werden als Add-on zum SQL

Cockpit angeboten.

Einstellungen

Mit der ersten Funktion kann jeder Anwender

seine persönlichen Einstellungen vornehmen, die

zweite Funktion steht nur Administratoren zur

Verfügung.

Feedbackmail

Sie haben zum SQL Cockpit Anmerkungen,

Wünsche oder Beschwerden? Mit dieser Funktion

wird Ihr Mailclient geöffnet, ein CADAXO eMail-

Empfänger vorbelegt und das aktuelle SQL

Kommando in den Mailbody aufgenommen.

Hilfe Öffnet direkt die SAP Standardhilfe für SELECT.

Komplexe Statements können durch den Pretty

Printer neu gegliedert werden.

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 5

SQL Eingabe Panel

Um Ihre verschiedenen Select Befehle einzugeben, steht Ihnen das SQL Eingabe Panel zur

Verfügung. Damit Ihnen die Eingabe leichter fällt und auch übersichtlicher ist, haben wir den

neuen modernen SAP ABAP Editor integriert. Die herausragenden Eigenschaften sind die

syntaktische Erkennung von Befehlen (wenn Sie nach einem Tabellennamen ein i eingeben, so

schlägt er Ihnen sofort „INNER JOIN“ vor, da dies hier der wahrscheinlich nächste Befehl sein

dürfte) sowie die farbliche Hervorhebung von Schlüsselbegriffen (SELECT, FROM,…).

Außerdem haben wir die – aus verschiedensten Bereichen innerhalb von SAP Systemen bekannte

– Vorwärtsnavigation eingebaut. Mit einem Doppelklick auf einen Tabellennamen navigieren Sie

direkt ins Data Dictionary (SE11) durch.

Welche SQL Befehle werden unterstützt?

Die eingegebenen SQL Befehle sind im SAP eigenen OPEN-SQL anzugeben. Dadurch können die

Abfragen unabhängig von der dahinterliegenden Datenbank definiert werden. Der Syntax der

eingegeben Befehle muss dem eines ABAP Programmes entsprechen. Dadurch funktionieren

auch nur SQL Befehle, die in ABAP Programmen erlaubt werden (z. B. können UNION Befehle oder

andere datenbankspezifische Angaben nicht interpretiert werden).

Bei der Notation sind ein paar Eigenheiten aus dem ABAP SQL zu berücksichtigen. (Klammerung,

~, Punkt nach dem Statement):

SELECT count( distinct a~kunnr ) as zz a~name1

FROM kna1 as a group by a~name1.

Ein wesentlicher Punkt – der Entwicklern sofort auffallen dürfte – ist das Fehlen des INTO Teils.

Den Aufbau des INTO Teils übernimmt das SQL Cockpit und Sie müssen sich nicht darum

kümmern.

Wenn Sie Probleme mit der Notation haben, so konsultieren Sie bitte die entsprechende SAP Hilfe

(über die Toolbar) oder schauen Sie auf unserer Homepage www.cadaxo.com vorbei. Dort werden

wir verschiedene Problemstellungen im Bereich Tipps und Tricks hinterlegen.

Das SQL Cockpit unterstützt die ganze Breite der möglichen SQL SELECT Abfragen: SELECTs,

JOINs, Aggregatsfunktionen, Sub-SELECTs, Having, Order, DB-Hints, BYPASSING BUFFER,

DISCINCT, … - Es existieren zwei wesentliche Einschränkungen:

- Es können keine modifizierenden SQL Statements wie INSERT, UPDATE oder DELETE

eingegeben werden.

- Aus Security Gründen wird die explizite Angabe eines Mandanten mit CLIENT SPECIFIED

nicht unterstützt.

Innerhalb einer SQL Cockpit Session können nur 35 Abfragen mit Sub-SELECTs ausgeführt

werden. Dies ist leider eine Einschränkung des SAP Basis Releases für dynamische Aufrufe.

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 6

Mehrere SELECTs

Einer der großen Vorteile des SQL Cockpits ist die Möglichkeit mehr als einen SELECT gleichzeitig

auszuführen und damit auch mehrere Ergebnisse gleichzeitig angezeigt zu bekommen. Die

Anzahl der dargestellten Ergebnislisten ist somit fast nur von der Bildschirmgröße abhängig.

Mehrere SELECT Statements sind wie in einem normalen ABAP mit einem „.“ (Punkt) zu trennen.

Es können beliebig viele parallele SELECT Abfragen gestartet werden, der Administrator kann

jedoch ein Limit definieren. Bei großen Ergebnismengen sollte man allerdings den

Speicherverbrauch des SAP Systems nicht vergessen!

Teilbereich markieren

Sobald Sie im SELECT Panel einen Teilbereich mit der Maus markieren, wird nur dieser

Teilbereich, sofern dieser syntaktisch korrekt ist, ausgeführt. Die Markierung kann auch über

mehrere SELECT Statements reichen.

Kommentare

Ähnlich wie im normalen ABAP Editor können Kommentare verwendet werden. Auskommentierte

Zeilen oder Bereiche werden bei der Ausführung ignoriert.

Dies ist beispielsweise sehr praktisch, um Varianten zu dokumentieren.

Information Panel

Unterhalb des Eingabe Panels sehen Sie den Information Panel. Dieser gliedert sich in die fünf

Teilbereiche Startschirm, Ergebnisse, My History, Jobmonitor und gespeicherte Listen. Nach dem

Start des SQL Cockpits wird zunächst der Startschirm mit einigen hilfreichen Informationen

angezeigt. Mit den Drucktasten oberhalb des Information Panels können die vier Bereiche

gewechselt werden:

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 7

Startschirm

Neben einigen Informationen zur Anwendung des SQL Cockpits finden Sie im Startbildschirm

auch immer die aktuellen Release-Notes und diese Dokumentation. Sie erreichen diese über die

beiden entsprechenden Links im oberen Bereich des Startschirms.

Ergebnisse

Nach Ausführen eines oder mehrerer SQL Kommandos wechselt das SQL Cockpit automatisch in

den Ergebnisbereich und zeigt die Listen an.

Die Anordnung der Ergebnisfenster bei mehreren parallelen SELECTs kann in den persönlichen

Einstellungen angepasst werden. Die Listen können untereinander, nebeneinander oder als

Matrix wie in obiger Abbildung dargestellt werden.

Jede Ergebnisliste besteht aus einer

Funktionsleiste, einer Überschrift mit der

Information über die Anzahl der Treffer bzw.

Laufzeit und aus der ALV Tabelle mit den Ergebnissen. Die Funktionsleiste bietet verschiedene

Möglichkeiten zur Interaktion und Weiterverarbeitung der Ergebnisliste. Beispielsweise kann die

Liste ausgedruckt werden, in ein File exportiert werden, oder nach einem String durchsucht

werden. Für Betrags- oder Mengenspalten können Summen, Mittelwerte oder Durchschnittswerte

ermittelt werden.

Mit der Refresh-Funktion kann die für die Liste zugrundliegende Select-Abfrage erneut

ausgeführt werden.

Per Drag&Drop oder Doppelklick können Werte aus Zellen in den Editor-Bereich oder in den

Denkzettel abgelegt werden. Die Doppelklick-Funktion kann jeder Benutzer in seinen

persönlichen Einstellungen aktivieren. Ein Doppelklick auf die Spaltenüberschrift fügt an der

aktuellen Stelle des Editors den Spaltennamen ein.

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 8

My History

Alle ausgeführten SELECT Statements werden vom System protokolliert und können in diesem

Bereich angezeigt werden. Als Zusatzinformation werden die Trefferanzahl und die Laufzeit des

SQL Kommandos ausgegeben. Eine grüne Ampel in der Spalte Status informiert, dass der Befehl

ohne Fehler ausgeführt wurde, wohingegen eine gelbe Ampel signalisiert, dass das SQL

Kommando noch ausgeführt wird oder nicht erfolgreich abgearbeitet wurde. Die letzte Spalte

informiert, ob das Kommando im Dialog oder im Batch ausgeführt wurde.

Gleich wie bei der Ergebnisliste können die SELECT Aufrufe aus der Liste per Drag&Drop oder

Doppelklick in den Editorbereich übernommen werden.

In den persönlichen Einstellungen kann definiert werden, wie viele Tage standardmäßig angezeigt

werden sollen. Mit dem Button kann dieser voreingestellte Datumsfilter geändert werden.

Jobmonitor

Der Jobmonitor informiert über im Hintergrund gestartete SQL Abfragen. In der Spalte Status ist

ersichtlich, ob der Job noch läuft oder bereits fertig ist. Sobald ein Job fertig ist, erscheint in der

vorletzten Spalte ein Button mit dem die Ergebnislisten angezeigt werden können. Ähnlich wie im

Bereich My History kann in den persönlichen Einstellungen definiert werden, wie viele Tage

standardmäßig angezeigt werden sollen. Mit dem Datums-Button in der Funktionsliste kann

dieser Datumsfilter geändert werden.

Jobs & Listen, die nicht mehr benötigt werden, können mit dem Löschbutton gelöscht werden.

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 9

Gespeicherte Listen

Mit dieser Funktion erhält man eine Übersicht über die gesicherten Listen. Jeder Benutzer sieht

natürlich nur seine eigenen Listen. Zusätzlich zu den manuell erstellten Listen, werden auch

Listen, die über die Batchverarbeitung erstellt wurden, angezeigt.

Listen speichern

Das Speichern von Listen funktioniert sehr einfach. Sobald eine oder

mehrere Listen am Bildschirm angezeigt werden, ist die Funktion „Liste(n)“

aktiv. Nach Auswahl der Funktion erscheint ein Pop-up in dem für die Liste/die Listen eine

Bezeichnung vergeben werden muss.

Symbol Panel

In diesem Bereich können eigene Symbole

definiert werden, die dann in den SELECTs

verwendet werden können. So kann man z. B.

ein neues Symbol &MY_SYMBOL& anlegen

und in den SELECTs auf dieses Symbol

referenzieren.

Neben den eigenen Symbolen stehen auch Systemsymbole zur Verfügung. Die Inhalte von

Systemsymbolen werden zur Ausführungszeit ermittelt/berechnet. Die derzeit in Ihrem System

zur Verfügung stehenden Systemsymbole können mit dem Button eingeblendet werden.

Symbole können auch per Drag/Drop aus dem Symbol Panel in den SQL Editor Panel eingefügt

werden.

Denkzettel – der Platz für Ihre Notizen

Für die Ablage von Bemerkungen oder Notizen haben

wir unseren Denkzettel erstellt. Der Denkzettel kann

ein- bzw. ausgeblendet werden. Zelleninhalte von

Ergebnislisten können einfach per Drag&Drop in den

Denkzettel gezogen werden. Der Inhalt der Aktion wird

am Anfang der Notiz in der Form FELDNAME …..

FELDINHALT hinzugefügt.

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 10

Der Denkzettel wird nach jeder Benutzerinteraktion gespeichert, die Inhalte stehen auch nach

dem Verlassen und neuerlichem Start des SQL Cockpits zur Verfügung. Mit dem Löschbutton am

linken Rand kann der Denkzettel geleert werden.

Persönliche Einstellungen

Um das Verhalten des SQL Cockpits an eigene

Bedürfnisse optimal anzupassen, können in den

persönlichen Einstellungen verschiedenste

Parameter gesetzt werden.

Spaltenüberschrift

Feldname oder Feldtext: Im Zuge des Erstellens von

komplexen Abfragen sind sicherlich die technischen

Feldnamen (z. B. KUNNR) von Vorteil. In der Anwendung von fertiggestellten Abfragen und

Varianten auch durch Endbenutzer bieten sich die Feldbezeichnungen (z. B. Debitor) an.

ALV Ergebnisliste

Die Einstellungen im Bereich ALV Ergebnisliste beeinflussen die Ausgabe und das Verhalten der

Ergebnislisten. Wenn Buttonzeile anz. deaktiviert ist, wird die Funktionsleiste über den

Ergebnislisten nicht ausgegeben. Wenn Sie mit den Inhalten der Ergebnisliste arbeiten wollen, um

Ihr SQL Statement zu verändern, dann können Sie – sofern die Einstellung „Double Click“

aktiviert ist – mittels Doppelklick den angeklickten Feldwert sofort an die Cursorposition im Editor

übernehmen. Und mit Konvertierungsexit bestimmen Sie, ob Ihre Konvertierungsexits

(automatische Umrechnungen von Feldwerten auf DB Ebene) berücksichtigt werden sollen, oder

ob der „echte“ Wert in der DB angezeigt werden soll.

Trace

Im Bereich Trace wird eingestellt, ob bei der Aktivierung des SQL Traces der DB SQL Trace

und/oder der Tablebuffer Trace aktiviert werden soll. Der Tablebuffer Trace protokolliert die

Zugriffe auf gepufferte Tabellen.

Fensteranordnung

Die Anordnung der Ergebnislisten von mehreren SELECTs wird im Bereich Fensteranordnung

definiert. Die Ausgabelisten können vertikal, horizontal oder als Matrix ausgegeben werden.

Symbole

Der Bereich Symbole definiert, ob das Symbol-Panel oder die Programmsymbole initial

eingeblendet werden sollen.

Editor

Hier sind folgende Einstellungen möglich:

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 11

Front-End Editor (new)

Front-End Editor (old)

Editor SE80 User-Specific Settings

Front-End Editor (new) Front-End Editor (old)

Initiale Datumsauswahl

Die initiale Datumswahl für die Bereiche My History und Jobmonitor kann hier voreingestellt

werden.

Varianten

Damit gleiche oder ähnliche Abfragen nicht immer neu eingegeben werden müssen, besteht die

Möglichkeit eine SQL Abfrage als Variante zu sichern und wieder zu verwenden.

Variante sichern

Sobald Sie die Funktion „Variante sichern“ in der Header Funktionsliste auswählen, erscheint ein

Pop-up in dem folgende Informationen einzugeben sind:

- Variante Eindeutiger Name der Variante

- Gruppe Gruppenzuordnung

- Bezeichnung Längere Bezeichnung

- Public Privat oder Public

Die verfügbaren Gruppen werden vom Administrator eingestellt. Wenn keine Gruppe ausgewählt

ist, wird die Variante automatisch der Gruppe [keine Gruppe] zugeordnet. Durch Aktivieren von

Public erhalten auch alle anderen SQL Cockpit Benutzer Zugriff auf diese Variante.

x

SQL Cockpit 2.0 – Anwenderdokumentation Seite 12

Varianten auswählen/Varianten pflegen

Durch diese Funktion können Varianten ausgewählt und in den Editor

übertragen werden. Des Weiteren können einzelne Varianten per

Drag&Drop in den Favoriten-Ordner gezogen werden.

Über das Kontext-Menü im Varianten-Baum können folgende Funktionen gewählt werden:

- Variante entfernen Entfernt die Variante aus dem Favoriten-Ordner

- Public setzen/Private setzen Setzt den Private oder Public Status der Variante

- Variante löschen Löscht eine Variante

- In Transportauftrag aufnehmen Nimmt eine Variante in einen Transportauftrag auf

Copyright

© 2009–2013 Cadaxo GesmbH. Alle Rechte vorbehalten.

Die Vervielfältigung bzw. Übersetzung dieses Dokumentes oder Teilen daraus ist ohne

ausdrückliche Genehmigung durch die Cadaxo GesmbH nicht zulässig.

SAP®, ABAP™, R/3®, SAP NetWeaver® sind Marken oder eingetragene Marken der SAP AG.

Alle anderen Produkte sind Marken oder eingetragene Marken der jeweiligen Firmen.