Universal-Plugin

Das Universal-Plugin bietet eine standardisierte Schnittstelle zum Wiener Testsystem (WTS) und ermöglicht:

• Personenverwaltung (Anlegen, Aktualisieren, Suchen und Versenden von Einladungen zu einer Onlinetestung)

• Export von Testergebnissen in den Formaten PDF, CSV und SPSS

• Verschiedene weitere Vorgänge wie das Abrufen des Teststatus oder das Auslösen eines Archivierungsvorgangs

Die Kommunikation erfolgt über einen SOAP 1.2 Web Service, wodurch die Kompatibilität mit offenen Standards und eine flexible Integration gewährleistet sind.

Übersicht über die Funktionen

SOAP (Simple Object Access Protocol) ist ein Standard für den Austausch von Nachrichten zwischen Systemen und Anwendungen. Er bietet eine zuverlässige Möglichkeit zum Austausch von Informationen. Das Universal-Plugin enthält einen SOAP Web Service, der verschiedene Nachrichtentypen unterstützt, sodass externe Systeme das WTS steuern oder Daten daraus abrufen können. Obwohl SOAP verschiedene Transportmethoden unterstützt, verwendet das Universal-Plugin für die Kommunikation ausschließlich HTTPS.

Der Webdienst des Universal-Plugins ist passiv, d. h. er reagiert nur auf eingehende Nachrichten. Er initiiert keine eigene Kommunikation und ist vollständig auf externe Systeme angewiesen, um Anfragen oder Befehle zu senden.

Authentifizierung

Das Universal-Plugin erfordert eine WS-Security-Authentifizierung mithilfe eines UsernameToken über HTTPS. Alle SOAP-Anfragen müssen über eine sichere HTTPS-Verbindung gesendet werden und der WS-Security-Header muss einen UsernameToken mit dem gültigen Benutzernamen und Passwort enthalten. Es sind keine Client-Zertifikate erforderlich. Stellen Sie beim Testen mit Tools wie SoapUI sicher, dass WS-Security mit UsernameToken aktiviert ist, und legen Sie den Passworttyp entsprechend Ihrer Umgebung auf Klartext (PasswordText) fest. Der Benutzername und das Passwort für die Authentifizierung werden in der Plugin-Konfigurationsdatei festgelegt, siehe auch Universal-Plugin | UP-VIS-Settings-file.

Einrichtung und Konfiguration

Damit der SOAP-Webdienst verfügbar ist, muss das Universal-Plugin in der VIS-Konfigurationsdatei aktiviert werden. Standardmäßig kommuniziert das Plugin über den Port 9010. Wenn dieser Port nicht verfügbar ist oder bereits von einer anderen Anwendung verwendet wird, kann er in der Konfigurationsdatei geändert werden.

Hier finden Sie eine kurze Schritt-für-Schritt-Anleitung zum Einrichten einer minimalen Arbeitsumgebung. Erweiterte Konfigurationsmöglichkeiten finden Sie in den nachfolgenden Abschnitten beschrieben.

1. Anpassen der VIS-Konfigurationsdatei

Das Universal-Plugin muss standardmäßig in der VIS-Konfigurationsdatei aktiviert und eingerichtet sein, die sich unter C:\Program Files\SCHUHFRIED GmbH\Wiener Testsystem 8\IntegrationService\appsettings.json
Hinweis: Dies ist der Standard-Installationspfad. Wenn das Wiener Testsystem an einem anderen Ort installiert wurde, kann der tatsächliche Pfad entsprechend abweichen.

Diese Datei enthält die Konfiguration aller verfügbaren VIS-Plugins. Alle für das Universal-Plugin relevanten Einstellungen finden Sie im Abschnitt, der mit UniversalPlugin beginnt.

"UniversalPlugin": {
  //...
}

1.1. Aktivieren des Universal Plugins

Um das Universal Plugin zu aktivieren, setzen Sie den Wert des Enabled Eintrags auf true (das Universal-Plugin ist standardmäßig aktiviert).

"Enabled": "true", 

1.2. (Optional) Festlegen eines benutzerdefinierten Ports

Wenn ein anderer Port als der Standardport zum Empfangen eingehender Anfragen verwendet werden soll, muss dies im Eintrag namens „Urls“ außerhalb des Abschnitts „UniversalPlugin“ geändert werden.

"Urls": "https://localhost:9010",

1.3. Änderungen übernehmen

Nachdem Sie die Änderungen an der Konfigurationsdatei gespeichert haben, müssen Sie den Windows-Dienst WTS Service neu starten, damit die Aktualisierungen übernommen werden und das Plugin mit der neuen Konfiguration geladen wird. Eine Beschreibung, wie Sie den Dienst neu starten können, finden Sie auf der Seite: Das WTS startet nicht im Abschnitt zur Fehlerbehebung. Wenn Sie sich nicht sicher sind, wie Sie einen Windows-Dienst neu starten, können Sie auch Ihren Computer neu starten.

2. Prüfen der Konfiguration

2.1. Prüfen der Service-Verfügbarkeit

Um zu überprüfen, ob das Universal-Plugin ordnungsgemäß funktioniert, öffnen Sie einen Webbrowser und navigieren Sie zum Metadata Exchange (MEX)-Endpunkt des Plugins:

https://[machineName]:[port]/mex

Beispiel bei lokaler Ausführung auf dem Standardport:

https://localhost:9010/mex

Dieser Endpunkt stellt Metadaten zum Dienst bereit und sollte zugänglich sein, wenn das Plugin ordnungsgemäß konfiguriert und betriebsbereit ist. Der folgende Screenshot zeigt, wie er im Webbrowser aussehen sollte:

Zu beachten, dass der Endpunkt „singleWsdl” nicht funktioniert, aber aus Kompatibilitätsgründen mit älteren WTS-Versionen weiterhin vorhanden ist.

Beispiele

Ein Beispielprojekt kann unter folgendem Link heruntergeladen werden: https://dev.azure.com/SchuhfriedGmbh/SchuhfriedPublic/_git/VisSamples.

Lesen Sie vor der Ausführung des Projekts die README.md-Datei.

2.3. Fehlersuche

In allen Fällen können Sie die Protokolldateien (Log-Dateien) auf Hinweise zu möglichen Fehlern überprüfen (siehe: Universal-Plugin | UP-Logging)

• Der MEX-Dienstendpunkt kann im Browser nicht erreicht werden

  • Eine Firewall blockiert möglicherweise eingehende Verbindungen zum konfigurierten Port. Stellen Sie sicher, dass eingehende Verbindungen auf dem angegebenen Port akzeptiert werden.

  • Überprüfen Sie, ob der konfigurierte Port mit dem in der URL verwendeten Port übereinstimmt.

  • Stellen Sie sicher, dass der WTS Service neu gestartet wurde und alle Einstellungen korrekt übernommen wurden.

• Nachrichten werden mit den HTTP-Statuscodes 401 oder 403 beendet

  • Stellen Sie sicher, dass Nachrichten ordnungsgemäß authentifiziert sind (siehe oben).

• Nachrichten werden mit Fehlerstatuscodes beendet

  • Stellen Sie sicher, dass Ihre Daten keine Inkonsistenzen aufweisen, z. B. fehlerhafte Felder oder Verweise auf nicht vorhandene Testbatterien.

  • Überprüfen Sie die Protokolldateien (Log-Dateien) auf Informationen zu möglichen Problemen.

Weiterführende Informationen

Die folgenden Abschnitte enthalten detaillierte Informationen zu verschiedenen Themen im Zusammenhang mit dem Universal-Plugin und dessen Funktionen.

VIS-Konfigurationsdatei

Das Universal-Plugin muss in der VIS-Konfigurationsdatei konfiguriert und aktiviert sein, die sich standardmäßig unter C:\Program Files\SCHUHFRIED GmbH\Wiener Testsystem 8\IntegrationService\appsettings.json befindet.
Hinweis: Dies ist der Standard-Installationspfad. Wenn das Wiener Testsystem an einem anderen Ort installiert wurde, kann der tatsächliche Pfad entsprechend abweichen.

Diese Datei enthält die Konfiguration aller verfügbaren VIS-Plugins. Alle für das Universal-Plugin relevanten Einstellungen finden Sie im Abschnitt, der mit UniversalPlugin beginnt.

Einstellungsoptionen

Urls

UniversalPlugin.Enabled

UniversalPlugin.DefaultTestBattery

UniversalPlugin.CertificateSearchKind

UniversalPlugin.CertificateSearchValue

UniversalPlugin.UsernameToVisService

UniversalPlugin.PasswordToVisService

AppSettings.Service.MandantName

AppSettings.Service.Language

Beispiel

"Urls": "https://localhost:9010",
"UniversalPlugin": {
  "Enabled": "true",
  "DefaultTestBattery": "",
  "CertificateSearchKind": "FindBySubjectName",
  "CertificateSearchValue": "SchuhfriedSelfSignedCertificate",
  "UsernameToVisService": "customUsername",
  "PasswordToVisService": "customPassword"
},

Beschreibung der Schnittstelle

Eine vollständige Beschreibung der Schnittstelle finden Sie in der WSDL-Datei, die über den Metadata Exchange (MEX)-Endpunkt der Schnittstelle (https://[Maschinenname]:[Port]/mex) verfügbar ist.

Nachfolgend finden Sie eine Übersicht über die verfügbaren Endpunkte:

Endpunkte

IMex Schnittstelle

IUniversalPluginService Funktionen

IUniversalPluginServiceStreamed Funktionen

IUniversalPluginSpecialCaseService Funktionen

Datentypen

Die in den verfügbaren Operationen verwendeten Datentypen sind im WSDL-Dokument angegeben. Die Namen der Felder sollten selbsterklärend sein.

Logging

Das VIS und das Universal-Plugin generieren Protokolldaten (Log-Dateien), die zur Analyse ihrer Funktionalität verwendet werden können. Diese Daten werden in den folgenden Protokolldateien aufgezeichnet:

C:\ProgramData\Schuhfried\Logs\VTS.Integration.Service.log

Bitte beachten Sie: Das Verzeichnis C:\ProgramData ist standardmäßig ausgeblendet. Sie können ausgeblendete Elemente in Ihrem Windows Explorer einblenden oder einfach den Pfad zur Datei in die Adressleiste einfügen.