Einrichtung
In diesem Kapitel werden alle zur Einrichtung einer Standard-Instanz von itm:CONNECT Konnektor benötigten Arbeitsschritte vorgestellt.
Vorbereitung
Firewall/Proxy-Einstellungen
itm:CONNECT Konnektor kommuniziert verschlüsselt (Stand 2022-06: TLS 1.0) über einen AMQP-Server (derzeit: RabbitMQ) mit den web-basierten itm:CONNECT-Komponenten. Mehr zum Thema "RabbitMQ" siehe rabbitmq.com.
Abbildung: Vereinfachte Darstellung der itm:CONNECT-Plattform
Bitte stellen Sie vor der Installation sicher, dass der ausgehende TCP-Port nicht von der Firewall blockiert wird. Die Verbindung wird durch einen https-Connect-Tunnel aufgebaut. Hierfür müssen die benötigen Zugangsdaten für den Proxy-Server bereitgestellt werden. Ggf. muss der Host „proxy.meine-bildungseinrichtung.de“ auf eine White-List eingepflegt werden.
SMTP-Versand
Zum Versand der Bestätigungs-E-Mails benötigt der Webdienst Zugriff auf einen SMTP-Server. Bitte stellen Sie ein Konto zum SMTP-Versand auf einem Exchange- oder einem anderen Mail-Server bereit. Die Anmeldeinformationen müssen im Verlauf der Installation in die itm:CONNECT Konnektor-Konfiguration übernommen werden.
itm:CONNECT-Zugangsdaten
itm:CONNECT Konnektor benötigt vor dem ersten Start Zugangsdaten für:
- Message Broker im Rechenzentrum (derzeit: RabbitMQ-Server)
- itm:CONNECT-Kursimport
Beide Zugangsdaten werden von der ITEM KG bereitgestellt.
Datenbanktreiber
Bei Verwendung einer Oracle-Datenbank muss sichergestellt werden, dass der Oracle Data Provider for .NET (ODP.NET) in der 32-bit Version auf dem System installiert ist. Beim Einsatz eines Microsoft SQL-Servers muss kein Treiber installiert werden, itm:CONNECT.Webservice greift hier auf den im .Net-Framework enthaltenen ADO.NET-Treiber zurück.
Programmdateien
itm:CONNECT Konnektor wird nicht über ein Setup-Programm installiert. Die Programmdateien können per XCopy-Deployment in einen beliebigen Ordner auf der lokalen Festplatte kopiert werden.
Abbildung: Screenshot von itm:CONNECT Konnektor-Programmverzeichnis in
Windows-Explorer
Achtung: Stellen Sie sicher, dass auf dem Laufwerk genügend freier Speicherplatz (10-20 GB) zur Verfügung steht, wenn der Webdienst alle eingehenden Internetanmeldungen und ausgehenden Bestätigungs-E-Mails archivieren soll.
Konfiguration bearbeiten
Der itm:CONNECT Konnektor-Ordner enthält das Administrations-Tool „itm:CONNECT.Configuration.exe“, das eine Oberfläche zur Verwaltung der Webservice-Einstellungen bereitstellt. Das Tool kann aus dem Windows-Explorer per Doppelklick gestartet werden:
Abbildung: itm:CONNECT Konnektor-Konfigurationstool
In den folgenden Abschnitten werden diejenigen Einträge beschrieben, die für den ersten Programmstart des Webdienstes auf jeden Fall benötigt werden.
Verbindung zur Datenbank
Der Zugriff auf die Datenbank des Kursverwaltungsprogramms muss in der Sektion „TargetSystemOptions“ konfiguriert werden:
| Name | Wert |
|---|---|
| ConnectionString | Verbindungszeichenfolge/ConnectionString zur Datenbank |
| DbType | Typ der Datenbank |
| TargetType | Typ des Kursverwaltungsprogramms |
Verbindung zu RabbitMQ
Die Konfiguration der Anbindung an die webbasierten itm:CONNECT-Komponenten erfolgt in der Sektion „RabbitMqConfig“.
Direkte Verbindung
Im Normalfall wird die Verbindung zum RabbitMQ-Server im Rechenzentrum über Port 5671 hergestellt.
| Name | Wert |
|---|---|
| Username | Benutzername, z.B. bildungseinrichtung-demohausen |
| VirtualHost | Ebenfalls Benutzername, z.B. bildungseinrichtung-demohausen |
| Password | Passwort |
| Host | Fester Wert: mq.meine-bildungseinrichtung.de |
| Port | Fester Wert: 5671 |
| EnableSSL | True (Verschlüsselung per SSL) |
| HeartBeatInterval | 45 [Sekunden]; Heartbeat-Signal, um Firewall zu signalisieren, dass TCP-Verbindung genutzt wird und nicht geschlossen werden darf. |
Die Werte für UserName, VirtualHost und Password werden von einem Mitarbeiter der ITEM KG bereitgestellt.
Einsatz mit http-Proxy:
Falls die Verbindung zum RabbitMQ-Server durch einen http-Proxy erfolgen soll, müssen folgende Einträge gesetzt werden:
| Name | Wert |
|---|---|
| Username | Benutzername, z.B. bildungseinrichtung-demohausen |
| VirtualHost | Ebenfalls Benutzername, z.B. bildungseinrichtung-demohausen |
| Password | Passwort |
| Host | Fester Wert: proxy.meine-bildungseinrichtung.de |
| Port | Fester Wert: 443 |
| ProxyHost | IP/Hostname des Proxy-Servers |
| ProxyPort | Port des Proxy-Servers, z.B. 8080 |
| ProxyUsername | Benutzername auf Proxy |
| ProxyPassword | Passwort auf Proxy |
| EnableSSL | True (Verschlüsselung per SSL) |
| HeartBeatInterval | 45 [Sekunden]; Heartbeat-Signal, um Firewall zu signalisieren, dass TCP-Verbindung genutzt wird und nicht geschlossen werden darf. |
SMTP-Server
Die Zugriffsdaten des zum Versand der Emailbenachrichtigungen benötigten SMTP-Servers müssen in der Sektion „SmtpConfig“ eingetragen werden
| Name | Wert |
|---|---|
| Server | Hostname/IP des SMTP-Server, z.B. smtp.meinserver.de. |
| User | Benutzername, z.B. internetanmeldungen\@bildungseinrichtung-demohausen.de |
| Password | Passwort |
Zugangsdaten für Kurs-Export
Zur Übertragung der Kursdaten müssen die „meine-bildungseinrichtung.de“-Benutzerdaten in die Sektion „ExportOptions“ eingetragen werden.
| Name | Wert |
|---|---|
| UploadUser | Benutzername |
| UploadPassword | Passwort |
Alle anderen Einstellungen, z.B. die zur Aktivierung des zeitgesteuerten Kursexports („EnableScheduledFullCourseUpdate“) sollten vorerst deaktiviert bleiben. Diese Einstellungen können nach dem Studium der Kapitel Kursexport und Kapitel Internetanmeldung vorgenommen werden.
Programmstart per CMD
itm:CONNECT Konnektor wird standardmäßig als Dienst ausgeführt. Zur Überprüfung der Grundfunktionalität kann das Programm aber auch über die Kommandozeile gestartet werden. Im Kommando-Zeilenmodus werden alle auftretenden Fehler direkt im Konsolen-Fenster ausgegeben.
Öffnen Sie daher die Windows-Kommandozeile cmd als Administrator und navigieren Sie in das itm:CONNECT Konnektor-Programmverzeichnis. Der Webdienst kann über den Aufruf von „itm:CONNECT.exe“ gestartet werden:
Abbildung: Start von itm:CONNECT Konnektor per Kommandozeile
Nach dem erfolgreichen Start sieht das Konsolenfenster wie folgt aus:
Abbildung: itm:CONNECT nach Start über Kommandozeile
Falls in der letzten Zeile der Kommandozeilenausgabe der Text „service is now running“ enthalten ist, konnte der Webservice erfolgreich hochgefahren werden.
Falls während des Programmstarts gelb- oder rot-hinterlegte Fehlermeldungen in der Kommandozeile ausgegeben werden, kann möglicherweise keine Verbindung zur lokalen Datenbank oder dem RabbitMQ-Server hergestellt werden. Zur detaillierteren Untersuchung sollte die Log-Datei („Logs\itm.Connect.Rolling.log“) herangezogen werden.
Der laufende itm:CONNECT Konnektor stellt ein lokales Web-Interface bereit, über das einige Wartungsfunktionen angesprochen werden können. Öffnen Sie dazu in Ihrem Browser die Adresse http://localhost:1337:
Abbildung: Lokale Weboberfläche von itm:CONNECT Konnektor
Zur Prüfung der Funktionalität können alle Links unter „Wichtige Links“ einmal betätigt werden. Klick auf den Link „Status“ gibt beispielweise ein XML-Dokument zurück, das Informationen zum aktuellen Programmstatus enthält:
Abbildung: Statusabfrage über lokales Web-Interface
Ein Blick auf das Fenster der Kommandozeile zeigt, dass bei Ausführung des Webservices als Konsolenanwendung alle eingehenden Abfragen in der Kommandozeile ausgegeben werden:
Abbildung: Ausgabe einer Statusanfrage in Kommandozeile
Das Ergebnis der Statusanfrage wird ebenfalls in die Ausgabe geschrieben. Die in XML-Form dargestellte Antwort (s. Abbildung) auf die Status-Abfrage wird im Konsolen-Fenster im JSON-Format ausgegeben.
Zugriff auf Kursdaten prüfen
Als nächster Schritt sollte über den Link „Zufälligen Kurs ausgeben“ geprüft werden, ob itm:CONNECT Konnektor korrekt auf die Kursdaten zugreifen kann.
Die Abfrage sucht einen zufälligen Kurs aus der Datenbank des Kursverwaltungsprogramms heraus und gibt dessen Daten in einer XML-Repräsentation der von itm:CONNECT Konnektor genutzten Datenstruktur aus:
Abbildung: Ausgabe der Kursdaten eines zufällig gewählten Kurses
Die Anfrage kann im Browser über die F5-Taste bzw. den „Aktualisieren“-Button des Browsers beliebig wiederholt werden. Es wird jeweils ein neuer Kurs ausgegeben.
itm:CONNECT als Dienst installieren
Nach der Ausgabe der Kursdaten kann die Überprüfung der Grundfunktionalität abgeschlossen und das Programm über die Tastenkombination „STRG+C“ beendet werden.
Abbildung: itm:CONNECT Konnektor beenden
Achtung: Beim Beenden des Programms kann eine rot hinterlegte Warnmeldung erscheinen, die beim Schließen der Verbindungen zum MQ-Server ausgelöst wird. Dieser Meldung zu diesem Zeitpunkt muss keine weitere Aufmerksamkeit geschenkt werden.
Nun kann itm:CONNECT Konnektor als Dienst installiert werden, in dem die Datei itm.Connect.exe mit dem Parameter install aufgerufen wird:
Abbildung: Installation als Dienst
Nach der erfolgreichen Installation sollte folgende Ausgabe in der Konsole erscheinen:
Abbildung: Ausgabe bei Installation als Dienst
Achtung: Der Dienst wird standardmäßig als lokales System-Konto ausgeführt. Es ist möglich, in der Dienste-Verwaltung ein anderes Konto zu erfassen. Bitte prüfen Sie in jedem Fall, ob der Benutzer auf den SQL-Server (insbesondere bei der Nutzung von Windows-Authentifizierung) zugreifen darf.
Anschließend kann der Dienst mit dem Kommando „itm.Connect.exe start“ aktiviert werden:
Abbildung: Start von itm:CONNECT Konnektor-Dienst über Kommandozeile
Alternativ kann der Dienst auch über die Windows-Diensteverwaltung („services.msc“) gestartet werden:
Abbildung: Start von itm:CONNECT Konnektor-Dienst über Diensteverwaltung
In den Eigenschaften des Dienstes kann zudem unter „Wiederherstellung“ eingestellt werden, dass der Dienst im Fall eines automatisch neu gestartet wird.
Abbildung: Wiederherstellungoptionen in Dienste-Verwaltung
Nach dem Start des Dienstes kann das lokale Web-Interface auf http://localhost:1337 zur Kontrolle noch einmal geöffnet werden. Sollte eine itm:CONNECT-Website auf den Webdienst zugreifen, könnten zu diesem Zeitpunkt bereits (Test-)Internetanmeldungen durchgeführt werden.