Selbstdokumentierende Berichte im Jitterbit App Builder

Übersicht

Der App Builder verfügt über selbstdokumentierende Funktionen in Form von Berichten. Bestimmte Bereiche des App Builders bieten Berichte an, die, wenn sie ausgeführt werden, Konfigurationsinformationen zu dem Bereich auflisten und beschreiben, für den der Bericht verfügbar ist. Die Berichterstattung für diese Funktion ist in den folgenden Bereichen des App Builders verfügbar: API-Dokument nach Endpunkt, Versionshinweise nach Anwendung, Prüfberichte nach App Builder-Schicht (UI-Schicht, Geschäftslogikschicht, Datenspeicherschicht).

Details zu spezifischen neuen Berichten folgen:

API-Dokument nach Endpunkt

Wenn Sie Ihre Anwendung als API bereitstellen, steht ein neuer Bericht API-Dokument nach Endpunkt zur Verfügung, der alle API-Schlüssel und Benutzer sowie externe Verbindungen auflistet (listet URLs auf, die zur Verbindung mit externen Systemen verwendet werden), einschließlich Benachrichtungsserver und REST-Endpunkte. Die in diesem Bericht enthaltene Dokumentation generiert auch Beispiel-API-Aufrufe und Beispiel-CURL in einem Format, das Sie kopieren und einfügen können, um direkt aus der Berichtsausgabe mit dem Testen zu beginnen. Unterstützte Operationen sind ebenfalls in diesem Bericht enthalten.

So führen Sie den Bericht API-Dokument nach Endpunkt aus

Navigieren Sie zur App Builder IDE
Klicken Sie im Menü "Connect" auf Erweitern Sie Ihr Unternehmen
Wählen Sie die Navigationsmenüoption Veröffentlichen
Klicken Sie für die Anwendung, für die Sie einen Bericht ausführen, auf das PDF-Symbol unter Doc:
Die resultierenden Crystal Report-Informationen enthalten die oben beschriebenen Informationen sowie eine Liste der unterstützten Operationen:

Versionshinweise nach Anwendung

Wenn Sie in App Builder eine Version erstellen, gibt es ein neues Doc-Symbol, das einen Bericht Versionshinweise nach Anwendung für das Paket generiert. Der Bericht über die Versionshinweise listet alle Datenquellen, Änderungsmanagementanfragen, Übersetzungsbündel und Tabellenexportkonfigurationen auf. Die in diesem Bericht enthaltenen Informationen stammen aus den Informationen, die Sie bereitstellen, während Sie durch den Release-Template-Builder gehen.

Um den Bericht über die Versionshinweise nach Anwendung auszuführen

Navigieren Sie zum App Builder IDE
Klicken Sie im Build-Menü auf Ihre Anwendung bereitstellen
Nachdem Sie Ihr Release-Paket mit der Release Builder-Vorlage konfiguriert haben, klicken Sie auf das PDF-Symbol unter Doc:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen:

Prüfberichte nach App Builder-Schicht – UI, Geschäftslogik und Datenspeicherungsschichten

Neue Prüfberichte sind für alle Schichten des App Builders verfügbar – UI-Schicht, Geschäftslogikschicht und Datenspeicherungsschicht. Außerdem haben die Rollen- und Brückenberichte ein UI-Update erhalten, um mit den anderen App Builder-Schichten übereinzustimmen und konsistent auszusehen.

Bericht über Menüs und Seiten der UI-Schicht

Ein neuer Bericht über Menüs und Seiten der UI-Schicht existiert, um einen druckbaren Bericht über die Anwendungs-Konfiguration in der UI-Schicht bereitzustellen. Die Berichtsinformationen umfassen: Menüs, eine Aufschlüsselung aller Seiten in der App einschließlich Informationen zu Seiten-Details, Panels und Steuerelementen auf jeder Seite, ob die Seite aktiv ist oder nicht und eine Prüfung, wer der letzte Benutzer war, der Änderungen vorgenommen hat.

Um den Bericht über Menüs und Seiten der UI-Schicht auszuführen

Navigieren Sie zum App Builder IDE
Klicken Sie im Build-Menü auf Ihre Anwendung erstellen
Suchen Sie Ihre App im Anwendungsbereich in der UI-Schicht
Klicken Sie auf das PDF-Symbol unter Doc:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen:

Geschäftslogikberichte

Auf der Geschäftslogikschicht sind zwei neue Berichte verfügbar. Der Bericht Objekte und Regeln nach Tabelle listet alle Geschäftsobjekte nach Tabelle auf und enthält den Status. Der Bericht Ereignisausführung nach Tabelle liefert Informationen über intrinsische und benutzerdefinierte Ereignisse, die in der App auf Tabellen ausgeführt werden.

So führen Sie den Bericht über Objekte und Regeln nach Tabelle aus

Navigieren Sie zur App Builder IDE
Klicken Sie im Build-Menü auf Ihre Anwendung erstellen
Wählen Sie im Navigationsmenü die Geschäftslogikschicht aus
Suchen Sie Ihre Datenquelle der Geschäftsschicht. Zum Beispiel: MySQL - Northwinds
Klicken Sie auf das PDF-Symbol unter Doc:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen:

So führen Sie den Bericht über die Ereignisausführung nach Tabelle aus

Navigieren Sie zur App Builder IDE
Klicken Sie im Build-Menü auf Ihre Anwendung erstellen
Wählen Sie im Navigationsmenü die Geschäftslogikschicht aus
Suchen Sie Ihre Datenquelle der Geschäftsschicht. Zum Beispiel: MySQL - Northwinds
Klicken Sie auf das Symbol für nummerierte Liste unter Ausführungsdokument:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen:

Bericht über die Datenspeicherschicht nach Tabelle

Ein neuer Bericht für die Datenspeicherung existiert, der Datenspeicherschicht nach Tabelle genannt wird. Dieser Bericht gibt Ihnen Informationen über das grundlegende Schema der Datenbank, nach Tabelle. Die Informationen im Bericht umfassen: Tabellenkonfiguration, Schlüsselbeschränkungen, Schlüsselbeziehungen und Spalten, die für die Tabelle existieren. Die im Bericht erfassten Spalteninformationen umfassen Index, Name, logischen Typ, Speichertyp, Verwendung, Audit, Auto-Generierung und ob die Spalte erforderlich ist.

Um die Datenspeicherschicht nach Tabellenbericht auszuführen

Navigieren Sie zum App Builder IDE
Klicken Sie im Build-Menü auf Bauen Sie Ihre Anwendung
Wählen Sie im Navigationsmenü die Datenspeicherschicht aus
Suchen Sie Ihre Datenquelle der Geschäftsschicht. Zum Beispiel: MySQL - Northwinds
Klicken Sie auf das PDF-Symbol unter Doc:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen: