taSoapClient v3.2

Was ist taSoapClient?
Multi Sprache
Daten eingeben und organisieren
Daten finden
Anfrage ausführen
Massenanfragen ausführen
Fehlersuche und -behebung

Was ist taSoapClient?

Dieses Programm ist ein generischer XML Webservice Klient mit welchem Sie XML basierte Webservices konsumieren können.
Es basiert auf der Eve VM 1.42 ( http://www.ewesoft.com).

Das Programm hat folgende Leistungsmerkmale:

• Läuft auf Win32 Desktops, Pocket PCs (PPC 2003, Windows Mobile 5, Windows Mobile 6), Windows Mobile Smartphones, Linux und Systemen mit einer Java VM.
• Mehrsprachige Benutzeroberfläche
• Die grafische Benutzeroberfläche zur Eingabe der Webservice Eingabedaten wird dynamisch erstellt aufgrund der benutzer-definierten XML Anfrage Dateien.
• Unterstützt SOAP und REST Webservices.
• Unterstützt HTTP Proxys mit Basic Authorization
• Unterstützt HTTP Proxys mit HTTPS Tunneling (HTTP CONNECT)
• Unterstützt Webservices mit Basic Authorization
• Unterstützt WSHttpBinding
• Unterstützt HTTP Custom Header Felder
• Unterstützt Massenanfragen
• Kann mit HTTPS Servern kommunizieren, kann aber nicht prüfen, ob das Zertifikat gültig und vertrauenswürdig ist.
• Webservice Definitionsdateien (*.ws) werden verschlüsselt gespeichert (aber nicht die Anfragedateien)
• Webservice Definitionen können importiert und exportiert werden.
• Die XML Antwort des Webservice wird als Baum, benutzerfreundlichen Text oder als Tabelle ausgegeben. Selektionen in der Baum-, Text- und Tabellenansicht können in die Zwischenablage kopiert werden. Der Tabelleninhalt ist im Tabulator-getrennten Format, sodass er in ein Tabellenkalkulationsprogramm eingefügt werden kann.
• Die Anfrage und die Antwort können im XML Format geloggt werden (manuell oder automatisch mit der Auto-Log Option). Die Log-Dateien werden im Unterverzeichnis 'Log' desjenigen Verzeichnisses gespeichert, in welchem die Anfragedatei liegt.
• In der Antwort kann nach Texten gesucht werden.
• Inhalte, welche referenziert sind (XML href) können de-referenziert werden, so dass der Inhalt beim zugehörigen XML Element angezeigt wird.
• Eingebauter Texteditor zum Modifizieren der Webservice Anfragedateien
• Zeigt gespeicherte Logdateien oder XML Daten aus der Zwischenablage an
• Zur Fehlersuche und -behebung kann der Debug Modus aktiviert werden, in welchem Informationen gesammelt werden, welche helfen können das Problem zu beseitigen.

Zum Anfang

Multi Sprache

Das Programm wird in deutsch und englisch ausgeliefert, ist aber so konzipiert, dass es eine beliebige Anzahl Sprachen unterstützt. Um das Programm in Ihre Sprache zu übersetzen oder um die bestehenden deutschen / englischen Texte abzuändern, folgen Sie bitte den Anweisungen im 'Custom Language Package' (taSoapClient-Custom.zip).

top

Daten eingeben und organisieren

Proxy Einstellungen definieren

Beim obersten Eintrag können Sie die http Proxy Einstellungen definieren:

• Name: Der Name des obersten Eintrages. Sie können hier einen beliebigen Namen eingeben.
• Beschreibung: Geben Sie eine beliebige Beschreibung ein. Sie wird unten im Fenster angezeigt, wenn Sie den obersten Eintrag selektieren.
• Proxy verwenden: Markieren Sie diese Option, wenn Sie den http Proxy verwenden wollen. Dies ist eine globale Einstellung: Der Proxy wird nur dann verwendet, wenn Sie auch beim Webservice 'Proxy verwenden' (siehe unten) markieren.
• Proxy Server: Die Adresse des Proxy Servers, z.B. http://proxy.local:9090 oder http://192.168.100.1:8080
• Proxy Benutzer: Ihr Benutzername beim Proxy.
• Proxy Passwort: Ihr Passwort beim Proxy

Hinzufügen eines neuen Webservice

Wenn Sie einen neuen Webservice hinzufügen, müssen Sie folgende Informationen definieren:

• Name: Der Name des Webservice. Sie können hier einen beliebigen Namen eingeben.
• Beschreibung: Geben Sie eine beliebige Beschreibung ein. Sie wird unten im Fenster angezeigt, wenn Sie den Webservice selektieren.
• URL: Dies ist der SOAP Service Endpunkt bzw. die REST Basis URL, z.B. http://www.webservicex.net/country.asmx
• Kodierung: Zeichenkodierung, welche der Webservice verwendet.
• REST verwenden: Markieren Sie diese Option für REST Webservices. Für SOAP Webservices lassen Sie diese Option unmarkiert.
• WSHttpBinding verwenden: Markieren Sie diese Option für SOAP Webservices, welche WSHttpBinding anstelle von BasicHttpBinding verwenden. Für REST Webservices hat Option keine Wirkung.
• Benutzername: Ihr Benutzername für den Zugriff auf den Webservice.
• Passwort: Ihr Passwort für den Zugriff auf den Webservice.
• Proxy verwenden: Markieren Sie diese Option, wenn Sie den Proxy Server für diesen Webservice verwenden wollen.

Hinzufügen einer neuen Anfrage

Wenn Sie eine neue Anfrage zu einem Webservice hinzufügen, müssen Sie folgende Informationen definieren:

• Name: Der Name der Anfrage. Sie können hier einen beliebigen Namen eingeben.
• Beschreibung: Geben Sie eine beliebige Beschreibung ein. Sie wird unten im Fenster angezeigt, wenn Sie Anfrage selektieren.
• Benutzername: Ihr Benutzername für den Zugriff auf den Webservice. Wenn dieses Feld leer ist, werden Benutzer und Passwort verwendet, welche beim Webservice definiert sind.
• Passwort: Ihr Passwort für den Zugriff auf den Webservice.
• SOAP Aktion: Geben Sie hier die SOAP Aktion ein (für SOAP Webservices).
• HTTP Befehl: Wählen Sie hier den HTTP Befehl (für REST Webservices).
• HTTP Custom Header Felder: Hier können Sie neue HTTP Header Felder hinzufügen oder bestehende überschreiben. Geben Sie pro Zeile 1 Feld in folgendem Format ein: Feldname:Wert
• href ersetzen: Markieren Sie diese Option, wenn Sie referenzierte Elemente und Werte de-referenzieren möchten. Wenn Sie in der Webservice Antwort anstelle von sinnvollen Daten href="#id1" oder dergleichen sehen, sollten Sie diese Option markieren.
• Dateipfad: Dateipfad der Anfragedatei. Sie können den vollständigen Pfad eingeben oder den Pfad relativ zum Datenverzeichnis (Verzeichnis der Webservice Definitionsdatei).
• Startelement: Gibt das Element an, welches nach der Anzeige der Antwort im Baum vorselektiert ist. Das Element wird mittels der Xpath Notation definiert.
  Beispiel: /doc/pag[1]/lin[2] selektiert das zweite lin-Element des ersten pag-Elements innerhalb des Wurzel-Elements doc.
• Standardansicht: Ansicht, welche standardmässig für die Anzeige der Antwort verwendet wird.
• Auto-Log: Anfrage und Antwort werden automatisch geloggt (auf Disk gespeichert).
• Anfrage speichern: Aktualisiert die Anfragedatei mit den Werten, welche beim Aufruf eingegeben wurden.

Anfragedateien erstellen

Am Anfang der Anfragedatei können Sie das XML Encoding definieren. Dieses Encoding wird verwendet beim Lesen und Aktualisieren der Anfragedatei und braucht nicht zwingend übereinzustimmen mit demjenigen Encoding, welches bei der Kommunikation mit dem Webservice verwendet wird. Für Windows Systeme (mit nativer VM oder Java VM) empfehlen wir folgende Definition: <?xml version="1.0" encoding="ISO-8859-1"?>. Für Linux Systeme empfehlen wir <?xml version="1.0" encoding="UTF-8"?>. Falls kein XML Encoding definiert ist, wird ISO-8859-1 (=Windows1252, "ANSI") verwendet.

Anfragedateien für SOAP Webservices zu erstellen ist manchmal nicht ganz einfach, weil sie genau konform zur WSDL des Webservice sein müssen. Wir empfehlen, dass Sie ein SOAP Programm wie das freie soapUI verwenden, um sich diese XML Dateien erstellen zu lassen. Wenn Sie die Datei einmal haben, müssen Sie taSoapClient mitteilen, welches die Daten-Eingabefelder sind. Sie tun dies, indem Sie bei diesen Feldern beim Feldinhalt ???+ eingeben. Nach dieser Zeichenfolge können Sie einen zusätzlichen Text eingeben, der bei der Eingabe dann als Vorgabetext erscheint. Wenn ein Feld zwar ein Eingabefeld ist, dieses beim Speichern der Abfragedatei aber nicht zurückgeschrieben werden soll (z.B. bei Passwort Feldern), dann verwenden Sie ein Minus, also ???- anstatt ???+

Anfragedateien erstellen für REST Webservices, ist einfach: Alle Felder, welche übergeben werden müssen, werden als XML Elemente definiert und müssen alle Kinder des gleichen obersten XML Elementes sein. Der Name des obersten Elementes ist beliebig. Wenn die Anfragedatei ein Element relativeURL enthält, wird dieses Element dem REST Basis Pfad (siehe weiter oben) angehängt. Wenn Sie Daten POSTen müssen, dann verwenden Sie ein POSTdata Element, welches nur ein Kind enthält, nämlich das Stammelement der zu POSTenden Daten.
Hier ist ein Beispiel für das API des Pivotal Trackers:

<?xml version="1.0" encoding="ISO-8859-1"?>
<PivotalTracker>
  <relativeURL>/projects</relativeURL>
  <token>???-</token>
    <POSTdata>
      <story>
        <story_type>???+feature</story_type>
        <name>???-</name>
        <description>???-</description>
      </story>
    </POSTdata>
</PivotalTracker>

top

Daten finden

Sie können nach Webservices / Anfragen suchen, welche einen Suchtext enthalten. Die Suche unterscheidet nicht nach Gross- und Kleinschreibung und durchsucht alle Textfelder aller Einträge.
'Finden' sucht immer ausgehend vom obersten Eintrag im Baum. 'Finde nächsten' fährt mit der Suche bei der letzten Fundstelle fort (nicht beim aktuell selektierten Eintrag).

top

Anfrage ausführen

Um eine Anfrage auszuführen, müssen Sie eine Anfrage selektieren und 'Anfrage ausführen' wählen. Das Programm erstellt nun dynamisch eine Eingabemaske, basierend auf der definierten Anfragedatei. Geben Sie alle Eingaben ein und drücken sie OK. Das Programm übernimmt nun Ihre Eingaben in die Anfrage, schickt diese an den Webservice und stellt die Antwort in einem neuen Reiter am Schirm dar. Bei SOAP Webservices wird auch die Anfrage in einem Reiter angezeigt.

top

Massenanfrage ausführen

Wenn Sie eine Anfrage mehrmals mit unterschiedlichen Daten machen wollen, können Sie dies mit der Funktion Massenanfrage automatisieren:

• Dateipfad: Wählen Sie die Datei mit den Eingabedaten. Die Datei muss eine Tab-getrennte Textdatei im ANSI Format sein. Jede Zeile enthält die Daten der Eingabefelder für eine Anfrage. In den Datenfeldern können Sie ^t für Tabulatoren und ^n für Zeilenumbrüche verwenden.
• Zeige Antwort im GUI: Wenn markiert, wird jede Antwort in einem Reiter des GUIs angezeigt.
• Auto-Log: Dieses Nur-Lese Kontrollkästchen zeigt die Auto-Log-Option der Anfrage. Wenn markiert, werden alle Antworten automatisch protokolliert.
• Anfrage speichern: Dieses Nur-Lese Kontrollkästchen zeigt die Anfrage-Speichern-Option der Anfrage. Wenn markiert, werden alle Anfragedateien nach der Anfrage aktualisiert. Aus Performancegründen sollten Sie diese Option bei Massenanfragen nicht markieren.
• Start: Startet die Massenanfrage. Durch nochmaliges Drücken des Knopfes kann die Massenanfrage abgebrochen werden.

Diese Funktion hängt vom Typ der Lizenz ab, die Sie gekauft haben und ist daher möglicherweise für Sie nicht verfügbar.

top

Fehlersuche und -behebung

Wenn Sie beim Arbeiten mit dem Programm Probleme feststellen, können Sie den Debug Modus aktivieren. In diesem Modus sammelt das Programm bei gewissen Operationen zusätzliche Informationen, welche Sie sich danach anzeigen lassen können. Diese Informationen können Ihnen helfen, herauszufinden wo das Problem liegt.
Wenn das Programm startet, ist der Debug Modus immer inaktiv. Das Programm merkt sich den Zustand des Debug Modus nicht.

top