• Konfiguration REST Modul
  • PHP Variante
  • ASP Variante
• Konfiguration SOAP Modul

Konfiguration REST Modul

PHP Variante

Entpacken Sie zunächst die ZIP Datei:

• Inhalt der Archiv Datei

  iwwb-REST-PHP-1_0.zip
  |   README.txt		//Konfigurationsanleitung
  |   xmlexport.php	//Skript, das vom IWWB Cache aufgerufen wird
  |   
  \---include
          connect.php 	//Enthält individuelle Konfiguration
          mysql_tools.php //Funktionsbibiliothek für MySQL
  			//eventuell weitere xxx_tools.php Dateien für weitere Datenbanken !
  

• Konfigurationsparameter in der connect.php

  Öffnen Sie die Datei connect.php in einem Texteditor Ihrer Wahl.
  Dort können Sie folgende Einstellungen vornehmen:

  • Sektion "Define Database Connection"
    
    In diesem Bereich können Sie alle Einstellungen zu Ihrer Datenbank vornehmen.
    Sollte Ihr Datenbanksystem noch nicht unterstützt werden, setzen Sie sich bitte mit uns in Verbindung ! Wir werden dann für Ihre Datenbank eine Erweiterung implementieren.
    Beachten Sie auch die Anforderungen an die Datenbank des Betreibers.
    
    
    • DB_TYPE
      Definiert den Datenbanktyp. Zur Zeit werden MySQL und Oracle unterstützt. Mögliche Werte:
      • mysql
        In diesem Fall wird die Funktionsbibliothek include/msql_tools.php für den Datenbankzugriff benutzt.
      • oracle
        In diesem Fall wird die Funktionsbibliothek include/oracle_tools.php für den Datenbankzugriff benutzt.

      Syntax: define ("DB_TYPE","mysql");

    • DB_SERVER
      Rechnername, auf dem die Datenbank läuft. Z.B. "localhost".

      Syntax: define ("DB_SERVER","localhost");

    • DB_USER
      Name des Datenbankbenutzers, mit dem Sie sich an dem DBMS anmelden.

      Syntax: define ("DB_USER","username");

    • DB_PASS
      Passwort des Datenbankbenutzers

      Syntax: define ("DB_PASS","password");

    • DB_NAME
      Name der Datenbank, in der die Kursinformationen abgelegt sind

      Syntax: define ("DB_NAME","database name");

    • CHARACTER_ENCODING
      Wie werden Zeichen von der Datenbank encodiert.
      z.B.:
      • "ISO-8859-1" //MySQL
      • "UTF-8"
      • "UTF-16"

      Syntax: define ("CHARACTER_ENCODING","ISO-8859-1");

    
    
  • Sektion "Define Database SQL Statements"
    
    Hier werden die SQL Statements für Ihre Datenbank definiert. Je nach Datenbankmodell können diese sehr kompliziert werden, daher sollten diese Konfigurationen von einem Fachmann durchgeführt werden.
    Wir erstellen diese Konfigurationen auch für Sie, wenn Sie uns alle notwendigen Informationen zu Ihrem Datenbankmodell zuschicken.
    In dieser Dokumentation werden SQL Beispiele in der Syntax des MySQL Datenbanksystems notiert.
    
    
    • $strIDFeld1Name
      Name der Datenbankspalte, die die erste eindeutige ID enthält.

      Syntax: $strIDFeld1Name = "Spaltenname ID1";

    • $strIDFeld2Name
      Name der Datenbankspalte, die die zweite eindeutige ID enthält. Dieses Feld bleibt meistens leer, es wird nur benötigt, wenn in Ihrer Datenbank zwei Spalten einen eindeutigen Schlüssel pro Datensatz liefern. In diesem Fall muss hier der Name der zweiten ID Spalte eingegeben werden.

      Syntax: $strIDFeld2Name = "Spaltenname ID2";

    • $strLastChangedFeldName
      Dieses Feld gibt den Name der Spalte an, welche das Datum der letzten Änderung an diesem Datensatz enthält. Für MySQL wäre dies ein Datenbankfeld des Typs TIMESTAMP.

      Syntax: $strLastChangedFeldName = "Spaltenname Datum letzte Änderung";

    • $strSQLChangedCount
      Dieser SQL Befehl soll die Anzahl der seit dem letzten Update erfolgten Änderungen zurückliefern.
      Folgende Platzhalter werden verwendet:
      • [%DATUM%]
        Datum der letzten Abfrage
      • [%ID1%]
        Letzte abgefragte ID Nummer, wenn es z.B. einen unerwarteten Abbruch gab.
      • [%ID2%]
        Zweite ID Nummer, nur wenn der eindeutige Schlüssel aus zwei ID Feldern besteht.
      • RETURN: cnt
        Dieses Feld im Ergebnis muss die Anzahl der geänderten Kurse enthalten.
      
      Beispiel:

      $strSQLChangedCount="SELECT count(*) AS cnt FROM courses WHERE lastChanged>'[%DATUM%]' AND pid>[%ID1%]";
      

      In diesem Beispiel enthält die Tabelle courses alle Kursangebote. Den Kursen werden über das Feld pid eindeutige Schlüssel zugewiesen, lastChanged ist ein Datumsfeld, welches das Datum der letzten Änderung enthält.
      Dem Feld cnt wird über die SQL Funktion count(*) die Anzahl der geänderten Kurse übergeben.
      
      
    • $strSQLChangedXML
      Dieser SQL Befehl soll die geänderten Kurse seit dem Letzten Update und der letzen Abfrage zurückliefern.
      Folgende Platzhalter werden verwendet:
      • [%DATUM%]
        Datum der letzten Abfrage
      • [%ID1%]
        Letzte abgefragte ID Nummer.
      • [%ID2%]
        Zweite ID Nummer, nur wenn der eindeutige Schlüssel aus zwei ID Feldern besteht.
      • [%TOP%]
        Anzahl der Kurse, die bei dieser Abfrage zurückgegeben werden sollen.
      • RETURN: *
        Hier werden alle Datenbankfelder zurückgegeben.
      
      Beispiel:

      $strSQLChangedXML="SELECT * FROM courses WHERE lastChanged>'[%DATUM%]' AND pid>[%ID1%] LIMIT [%TOP%]";
      

      Es werden [%TOP%] Datensätze seit dem letzten Update [%DATUM%] und ab [%ID%] zurückgegeben.
      Wenn weitere Felder aus anderen Tabellen mit einem JOIN integriert werden sollen, muß diesen Feldern explizit ein Name mit AS vergebenen werden, der keinen "." Punkt enthält.
      
• Installation

  Wenn die Konfiguration abgeschlossen ist, müssen nur noch alle Dateien in ein Verzeichnis auf Ihrem Webserver geschoben werden. Bitte lesen Sie vorher die Sicherheitshinweise in den FAQ !
  Danach können Sie Den REST Service testen.

ASP Variante

Entpacken Sie zunächst die ZIP Datei:

• Inhalt der Archiv Datei

  iwwb-REST-ASP-1_0.zip
  |   README.txt		//Konfigurationsanleitung
  |   xmlexport.asp	//Skript, das vom IWWB Cache aufgerufen wird
  |   
  \---include
          Connect.asp //Enthält individuelle Konfiguration
          Tools.asp 	//Funktionsbibiliothek
  

• Konfigurationsparameter in der Connect.asp

  Öffnen Sie die Datei connect.asp in einem Texteditor Ihrer Wahl.
  Dort können Sie folgende Einstellungen vornehmen:

  • Sektion "Angaben für Connection-Setting"
    
    In diesem Bereich können Sie alle Einstellungen zu Ihrer Datenbank vornehmen.
    Sollte Ihr Datenbanksystem noch nicht unterstützt werden, setzen Sie sich bitte mit uns in Verbindung ! Wir werden dann für Ihre Datenbank eine Erweiterung implementieren.
    Beachten Sie auch die Anforderungen an die Datenbank des Betreibers.
    
    
    • gConnectionString
      
      Der OLE Connection String für Ihre Datenbank.
      Gewöhnlich können Sie hier den gleichen Connection String verwenden, den Sie bei Ihrer Webanwendung auch benutzen.
      Weitere Informationen zum Aufbau des OLE Connection Strings finden Sie hier:
      ADO Connection String Samples
      MSDN, Connection String Syntax
      
      Beispiele :

      Access Datenbank:
      
      gConnectionString = "PROVIDER=Microsoft.Jet.OLEDB.4.0;" & _
      					"DATA SOURCE=" & Server.MapPath ("./") & "<Dateiname>.mdb;" & _
      					"Jet OLEDB:Database Password=<passwort>;"
      
      FoxPro Datenbank über ODBC:
      
      gConnectionString = "PROVIDER=MSDASQL.1;" & _
      					"DRIVER={Microsoft Visual FoxPro Driver};" & _
      					"SourceType=DBF;" & _
      					"SOURCEDB=" & Server.MapPath ("./") & "<pfad zur datenbank>;" & _
      					"Exclusive=No;"
      					
      Microsoft SQL Server:
      
      gConnectionString = "PROVIDER=SQLOLEDB.1;" & _
      					"Persist Security Info=False;User ID=<user>;Password=<passwort>;" & _
      					"Data Source=<db host>;" & _ 
      					"Initial Catalog=<db name>;"
      
      

    • strCharEncoding
      Wie werden Zeichen von der Datenbank encodiert.
      z.B.:
      • "ISO-8859-1"
      • "UTF-8"
      • "UTF-16"
    
    
  • Sektion "Define Database SQL Statements"
    
    Hier werden die SQL Statements für Ihre Datenbank definiert. Je nach Datenbankmodell können diese sehr kompliziert werden, daher sollten diese Konfigurationen von einem Fachmann durchgeführt werden.
    Wir erstellen diese Konfigurationen auch für Sie, wenn Sie uns alle notwendigen Informationen zu Ihrem Datenbankmodell zuschicken.
    In dieser Dokumentation werden SQL Beispiele in der Syntax von Microsoft Access notiert.
    
    
    • strIDFeld1Name
      Name der Datenbankspalte, die die erste eindeutige ID enthält.

      Syntax: strIDFeld1Name = "Spaltenname ID1";

    • strIDFeld2Name
      Name der Datenbankspalte, die die zweite eindeutige ID enthält. Dieses Feld bleibt meistens leer, es wird nur benötigt, wenn in Ihrer Datenbank zwei Spalten einen eindeutigen Schlüssel pro Datensatz liefern. In diesem Fall muss hier der Name der zweiten ID Spalte eingegeben werden.

      Syntax: strIDFeld2Name = "Spaltenname ID2";

    • strLastChangedFeldName
      Dieses Feld gibt den Name der Spalte an, welche das Datum der letzten Änderung an diesem Datensatz enthält.

      Syntax: strLastChangedFeldName = "Spaltenname Datum letzte Änderung";

    • strSQLChangedCount
      Dieser SQL Befehl soll die Anzahl der seit dem letzten Update erfolgten Änderungen zurückliefern.
      Folgende Platzhalter werden verwendet:
      • [%DATUM%]
        Datum der letzten Abfrage
      • [%ID1%]
        Letzte abgefragte ID Nummer, wenn es z.B. einen unerwarteten Abbruch gab.
      • [%ID2%]
        Zweite ID Nummer, nur wenn der eindeutige Schlüssel aus zwei ID Feldern besteht.
      • RETURN: cnt
        Dieses Feld im Ergebnis muss die Anzahl der geänderten Kurse enthalten.
      
      Beispiel:

      strSQLChangedCount="SELECT Count(*) AS cnt FROM courses WHERE lastChanged>'[%DATUM%]' AND pid>[%ID1%]";

      In diesem Beispiel enthält die Tabelle courses alle Kursangebote. Den Kursen werden über das Feld pid eindeutige Schlüssel zugewiesen, lastChanged ist ein Datumsfeld, welches das Datum der letzten Änderung enthält.
      Dem Feld cnt wird über die SQL Funktion count(*) die Anzahl der geänderten Kurse übergeben.
      
      
    • strSQLChangedXML
      Dieser SQL Befehl soll die geänderten Kurse seit dem Letzten Update und der letzen Abfrage zurückliefern.
      Folgende Platzhalter werden verwendet:
      • [%DATUM%]
        Datum der letzten Abfrage
      • [%ID1%]
        Letzte abgefragte ID Nummer.
      • [%ID2%]
        Zweite ID Nummer, nur wenn der eindeutige Schlüssel aus zwei ID Feldern besteht.
      • [%TOP%]
        Anzahl der Kurse, die bei dieser Abfrage zurückgegeben werden sollen.
      • RETURN: *
        Hier werden alle Datenbankfelder zurückgegeben.
      
      Beispiel:

      strSQLChangedXML="SELECT TOP [%TOP%] * FROM courses WHERE lastChanged>'[%DATUM%]' AND pid>[%ID1%]";

      Es werden [%TOP%] Datensätze seit dem letzten Update [%DATUM%] und ab [%ID%] zurückgegeben. Wenn weitere Felder aus anderen Tabellen mit einem JOIN integriert werden sollen, muß diesen Feldern explizit ein Name mit AS vergebenen werden, der keinen "." Punkt enthält.
      
• Installation

  Wenn die Konfiguration abgeschlossen ist, müssen nur noch alle Dateien in ein Verzeichnis auf Ihrem Webserver geschoben werden.Bitte lesen Sie vorher die Sicherheitshinweise in den FAQ !
  Danach können Sie Den REST Service testen.

Konfiguration SOAP Modul

Die SOAP Variante befindet sich zur Zeit noch in Arbeit.
Wenn Sie SOAP für die Anbindung einsetzen möchten, können Sie jetzt schon mit uns Kontakt aufnehmen. Sie erhalten dann ausführliche Informationen, welche Anforderungen an den Webserver gestellt werden.