Daten über den Tricentis Notification Service senden

Der Tricentis Notification Service ist die Datenschnittstelle zwischen Tricentis Tosca und anderen Applikationen. Er ist eine wichtige Komponente, wenn Sie Tricentis Tosca mit qTest, SAP Solution Manager oder Tosca Dashboards integrieren.

Setup-Vorgang

Um den Tricentis Notification Service für Ihre Integrationen einzurichten, führen Sie die folgenden Aktionen aus. Die folgenden Kapitel beschreiben jeden Schritt im Detail.

Bereiten Sie die Datenbank des Tricentis Notification Service vor.
Installieren und konfigurieren Sie den Tricentis Notification Service.
Führen Sie optional zusätzliche Konfigurationen für die Datenübertragung zwischen dem Tosca-Client, dem Tricentis Notification Service und den konsumierenden Applikationen durch.
Aktivieren Sie den Tricentis Notification Service für Ihr Projekt.

Sobald das Setup abgeschlossen ist, sendet der Tricentis Notification Service automatisch Daten an Ihre Integrationen, wenn Sie Ihr Projekt einchecken.

Der Tricentis Notification Service protokolliert alle von ihm gesendeten Nachrichten.

Datenbank vorbereiten

Der Tricentis Notification Service sendet Daten, wenn Sie einchecken. Er sammelt alle Daten, speichert sie in einer Datenbank und sendet sie dann. Nach dem Senden der Daten löscht der Tricentis Notification Service die gesendeten Daten aus der Datenbank.

Diese Datenbank ist nicht Teil der Tricentis Tosca- oder Tosca Server-Installation. Sie müssen sie auf Ihrer Seite vorbereiten und hosten. Die von Ihnen vorbereitete Datenbank muss folgende Anforderungen erfüllen:

Es handelt sich um eine MS SQL-Datenbank. Stellen Sie sicher, dass der Rechner, auf dem Sie sie hosten, die MS SQL-Systemanforderungen erfüllt.
Der Datenbankbenutzer ist db_owner.
Der Benutzer verfügt über folgende Rechte: CREATE, ALTER, SELECT, INSERT, UPDATE und DELETE.
Die Größe der Datenbank ist ausreichend für Ihr Projekt. Die Datenbank ist ein Buffer zwischen Tosca und der konsumierenden Applikation. Der Notification Service löscht die Daten nach dem erfolgreichen Senden, sodass die Datenbank im Laufe der Zeit nicht anwächst. Sie muss nur groß genug sein, um die Daten während der Übertragung zu verarbeiten.

Sie brauchen keine Datenbanktabellen zu erstellen. Der Tricentis Notification Service erstellt sie, wenn er zum ersten Mal gestartet wird.

Tricentis Notification Service installieren und konfigurieren

Der Tricentis Notification Service ist ein Tricentis Tosca Server-Feature.

Sein Setup ist Teil der Installation und Konfiguration des Tricentis Tosca Server:

Installationsvorgang des Tosca Server
Konfigurieren Sie den Tricentis Notification Service und die Tricentis Tosca Administration Console in der Tricentis Service Configuration.

Sie benötigen die Administration Console, um den Notification Service nutzen zu können.

Zusätzliche Konfigurationen vornehmen

Sie können das Verhalten der Datenübertragung zwischen dem Tosca-Client, dem Tricentis Notification Service und den konsumierenden Applikationen anpassen. Sie können beispielsweise die Anzahl der Wiederholungen, die Batch-Größen oder die Sendestrategie ändern.

Zusätzliche Konfigurationen: Tosca-Client an Notification Service

Sie können festlegen, wie viele Common Repository-Objekte Tosca laden soll, wie viele es pro HTTP-Anforderung sendet und wie lange eine HTTP-Anforderung dauern darf. Führen Sie hierzu diese Schritte aus:

Erstellen Sie eine Kopie der Datei TCShell.exe.config mit Schreibzugriff wie hier beschrieben.
Ändern Sie die hier beschriebenen Einstellungen.
Speichern und schließen Sie die Datei.

Zusätzliche Konfigurationen: Notification Service an Consumer

Sie können festlegen, wie oft der Tricentis Notification Service versuchen soll, Daten an den Consumer zu senden, sowie die Batch-Größe und die Sendestrategie festlegen. Führen Sie hierzu diese Schritte aus:

Öffnen Sie die Datei appsettings.json. Bei einer Standardinstallation befindet sich die Datei unter C:\Programme (x86)\TRICENTIS\Tosca Server\NotificationService.
Ändern Sie im Abschnitt NotificationHub die folgenden Einstellungen:

Einstellung	Beschreibung
MaxRetries	Standardmäßig versucht der Tricentis Notification Service fünfmal, Daten zu senden. Schlägt die Übertragung bei jedem Versuch fehl, beispielsweise aufgrund von Timeouts, löscht der Notification Service die Daten aus der Datenbank und bricht ab. Geben Sie eine positive ganze Zahl ein, um eine andere Anzahl von Wiederholungen zu definieren. Hinweis: Je höher die Zahl, desto länger dauert das Einchecken, wenn der Notification Service die Daten nicht senden kann.
BatchSize	Diese Einstellung gilt nur für die Tosca Dashboards-Integration. Standardmäßig sendet der Tricentis Notification Service Tosca Dashboards-Daten in Batches. Jedes Batch enthält maximal 150 000 Objekte. Wenn dies zu Speicherproblemen für den Notification Service führt, können Sie eine geringere Anzahl von Objekten pro Batch angeben.
SendingStrategy	Diese Einstellung gilt, wenn Sie Tricentis Tosca mit mehr als einer Applikation integrieren. Der Standardwert ist Parallel. Dies bedeutet, dass der Tricentis Notification Service die Daten parallel an mehrere Applikationen überträgt, was der schnellste Weg ist, Daten zu senden. Die Übertragungen starten gleichzeitig und laufen in getrennten Threads. Um diesen Übertragungstyp voll auszunutzen, benötigt Ihr Rechner mehrere Kernel, die mehrere Threads verarbeiten können. Wenn Ihr Rechner nicht über mehrere Kernel verfügt, können Sie einen anderen Übertragungstyp definieren: Geben Sie den Wert Async ein. In diesem Fall starten die Übertragungen gleichzeitig, aber das Betriebssystem des Rechners verteilt den Speicher zwischen den Übertragungsaufgaben. Auch wenn der Notification Service Daten nicht vollständig parallel an mehrere Applikationen sendet, kann die asynchrone Übertragung den Prozess dennoch beschleunigen. Geben Sie den Wert Sequential ein. In diesem Fall sendet der Notification Service Daten sequenziell. Er sendet alle Daten an eine Applikation. Sobald diese Übertragung abgeschlossen ist, sendet der Notification Service Daten an die nächste Applikation.

Einstellung

Beschreibung

MaxRetries

Standardmäßig versucht der Tricentis Notification Service fünfmal, Daten zu senden. Schlägt die Übertragung bei jedem Versuch fehl, beispielsweise aufgrund von Timeouts, löscht der Notification Service die Daten aus der Datenbank und bricht ab.

Geben Sie eine positive ganze Zahl ein, um eine andere Anzahl von Wiederholungen zu definieren.

Hinweis: Je höher die Zahl, desto länger dauert das Einchecken, wenn der Notification Service die Daten nicht senden kann.

BatchSize

Diese Einstellung gilt nur für die Tosca Dashboards-Integration.

Standardmäßig sendet der Tricentis Notification Service Tosca Dashboards-Daten in Batches. Jedes Batch enthält maximal 150 000 Objekte. Wenn dies zu Speicherproblemen für den Notification Service führt, können Sie eine geringere Anzahl von Objekten pro Batch angeben.

SendingStrategy

Diese Einstellung gilt, wenn Sie Tricentis Tosca mit mehr als einer Applikation integrieren.

Der Standardwert ist Parallel. Dies bedeutet, dass der Tricentis Notification Service die Daten parallel an mehrere Applikationen überträgt, was der schnellste Weg ist, Daten zu senden. Die Übertragungen starten gleichzeitig und laufen in getrennten Threads.

Um diesen Übertragungstyp voll auszunutzen, benötigt Ihr Rechner mehrere Kernel, die mehrere Threads verarbeiten können. Wenn Ihr Rechner nicht über mehrere Kernel verfügt, können Sie einen anderen Übertragungstyp definieren:

Geben Sie den Wert Async ein. In diesem Fall starten die Übertragungen gleichzeitig, aber das Betriebssystem des Rechners verteilt den Speicher zwischen den Übertragungsaufgaben. Auch wenn der Notification Service Daten nicht vollständig parallel an mehrere Applikationen sendet, kann die asynchrone Übertragung den Prozess dennoch beschleunigen.
Geben Sie den Wert Sequential ein. In diesem Fall sendet der Notification Service Daten sequenziell. Er sendet alle Daten an eine Applikation. Sobald diese Übertragung abgeschlossen ist, sendet der Notification Service Daten an die nächste Applikation.

Speichern und schließen Sie die Datei.
Wenn der Tricentis Notification Service bereits ausgeführt wurde, als Sie die Datei appsettings.json geändert haben, starten Sie den Service neu.

Tricentis Notification Service aktivieren

Um den Tricentis Notification Service zu aktivieren, führen Sie diese Schritte aus:

Öffnen Sie die Tosca Administration Console.
Gehen Sie in der Übersicht Projects Overview zum Projekt, für das Sie den Tricentis Notification Service aktivieren möchten, und klicken Sie auf das Symbol Edit.
Dadurch öffnet sich der Dialog Project details. Aktivieren Sie im Abschnitt Notification Service das Kontrollkästchen Enabled.
Klicken Sie zur Bestätigung auf Yes.
Klicken Sie auf Save.

ProjectA hat den Tricentis Notification Service aktiviert

Um den Tricentis Notification Service für ein Projekt zu deaktivieren, klicken Sie auf das Symbol Edit des Projekts und deaktivieren Sie das Kontrollkästchen Enabled im Abschnitt Notification Service.

Logs überprüfen

Der Tricentis Notification Service protokolliert alle von ihm gesendeten Nachrichten. Wenn Sie Probleme mit Ihren Datenübertragungen haben, überprüfen Sie die Logs, um zu sehen, was der Tricentis Notification Service wann gesendet hat.

Greifen Sie dazu auf den Rechner zu, auf dem sich der Tosca Server befindet, und gehen Sie zu C:\ProgramData\TRICENTIS\Logs\NotificationService.

Standardmäßig erstellt der Notification Service eine Log-Datei pro Tag und speichert maximal sieben Log-Dateien. Um dieses Verhalten zu ändern, führen Sie diese Schritte aus:

Gehen Sie auf dem Rechner, auf dem der Tosca Server eingerichtet ist, zu C:\Programme (x86)\TRICENTIS\Tosca Server\NotificationService.
Öffnen Sie die Datei appsettings.json.
Gehen Sie zum Abschnitt Serilog.
Geben Sie einen neuen Wert für retainedFileCountLimit ein. Sie können eine beliebige positive Ganzzahl eingeben, um die Anzahl der Log-Dateien anzugeben, die der Tricentis Notification Service speichern soll.
Speichern und schließen Sie die Datei.