Dateispeicherorte
Der Einsprungspunkt für die Definition von Webservices ist die Datei „CustomWebServices.xml“, welche entweder direkt im Hauptverzeichnis der Webanwendung oder im Unterordner „Custom“ (empfohlen) liegen muss. Diese Datei kann sowohl direkt Webservices definieren als auch weitere Dateien mit weiteren Definitionen einbinden. Wird kein Pfad angegeben, müssen diese zusätzlichen Dateien im selben Verzeichnis wie die „CustomWebServices.xml“-Datei liegen (s.Tag: <Include>).
Neuladen der XML-Definitionen ohne Neustart
Die XML-Definitionen werden grundsätzlich beim Anwendungsstart geladen und ausgewertet. Zur einfacheren Anpassung existierender und Entwicklung neuer Webservice-XML-Definitionen ist es möglich, die XML-Dateien im laufenden Betrieb nach Änderungen erneut auswerten zu lassen. Dies passiert nicht automatisch sondern nur auf Anforderung und wird über eine Schaltfläche auf der Service-Seite der Anwendung initiiert. Dort werden Sie dann auch über etwaige Fehler in der XML-Struktur hingewiesen.
XSD-Schema und Validierung
Alle XML-Dateien werden über ein XML-Schema validiert. Dieses Schema liegt als xsd-Datei vor. Der Quellcode des Schemas ist in einem Unterpunkt beigefügt, so dass Sie dieses, wenn Sie möchten, schon während der Entwicklung neuer Webservice-Definitionen verwenden können, um gröbere Fehler und Zeitaufwände bei der Implementierung in einer Anwendung zu vermeiden.
Toplevel-XML-Knoten und Namespaces
Der Grundaufbau aller XML-Definitionsdateien ist identisch. Auf die erste Zeile, welche immer die XML-Deklaration darstellt folgt das einzig gültige Top-Level-Tag „BAWebServiceDefinitions“, welches als Dokumenten-Namespace „https://www.business-app.com/WebServices“ und den Standard-xsi-Namespace deklariert.
Beispiel:
<?xml version="1.0" encoding="utf-8"?>
<BAWebServiceDefinitions xmlns="https://www.business-app.com/WebServices" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
</BAWebServiceDefinitions>