Selbstdokumentierende Berichte im Jitterbit App Builder

Übersicht

App Builder verfügt über selbstdokumentierende Funktionen in Form von Berichten. Bestimmte Bereiche von App Builder verfügen über Berichtsangebote, die bei Ausführung Konfigurationsinformationen zu dem Bereich auflisten und beschreiben, in dem der Bericht verfügbar ist. Die Berichterstellung für diese Funktion ist in den folgenden Bereichen verfügbar: App Builder: API Dokument nach Endpoint, Versionshinweise nach Anwendung, Auditberichte nach App Builder Schicht (UI-Schicht, Geschäftslogikschicht, Datenspeicherschicht).

Einzelheiten zu bestimmten neuen verfügbaren Berichten folgen:

API Dokument nach Endpoint

Wenn Sie Ihre Anwendung als API verfügbar machen, steht ein neuer Bericht „API Dokument nach Endpoint“ zur Verfügung, der alle API Schlüssel und-Benutzer sowie externe Verbindungen (Liste der URLs, die zur Verbindung mit externen Systemen verwendet werden) einschließlich Endpoints und REST- Endpoints auflistet. Die in diesem Bericht enthaltene Dokumentation generiert auch Beispiel API Aufrufe und Beispiel-CURL in einem Format, das Sie kopieren und einfügen und direkt aus der Berichtsausgabe mit dem Testen beginnen können. Unterstützte Vorgänge sind ebenfalls in diesem Bericht enthalten.

So führen Sie das API Dokument nach Endpoint aus

Navigieren Sie zu App Builder IDE
Klicken Sie im Menü „Verbinden“ auf Unternehmen erweitern
Wählen Sie die Navigationsmenüoption Veröffentlichen
Klicken Sie für die Anwendung, für die Sie einen Bericht ausführen, unter „Dokument“ auf das PDF-Symbol:
Die resultierenden Crystal Report-Informationen umfassen die oben beschriebenen Informationen sowie eine Liste der unterstützten Vorgänge:

Versionshinweise nach Anwendung

Wenn Sie eine Veröffentlichung in App Builder gibt es ein neues Dokumentsymbol, das einen Release Notes nach Anwendung-Bericht für das Paket generiert. Der Release Notes-Bericht listet alle Datenquellen, Änderungsmanagementanforderungen, Übersetzungspakete und Tabellenexportkonfigurationen auf. Die in diesem Bericht enthaltenen Informationen stammen aus Informationen, die Sie beim Durchlaufen des Release Template Builders erhalten.

So führen Sie den Bericht „Versionshinweise nach Anwendung“ aus

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

Prüfberichte von App Builder Schicht - Benutzeroberfläche, Geschäftslogik und Datenspeicherungsschichten

Neue Auditberichte sind für alle Ebenen verfügbar App Builder- UI-Schicht, Business-Logik-Schicht und Datenspeicherschicht. Außerdem wurden die Rollen und Bridge-Berichte aktualisiert, um den anderen zu entsprechen App Builder Schichten und einheitliches Aussehen.

Bericht zu Menüs und Seiten der Benutzeroberfläche

Es gibt einen neuen Bericht zu Menüs und Seiten der UI-Ebene, der einen druckbaren Bericht zur Anwendungskonfiguration auf der UI-Ebene bereitstellt. Die Berichtsinformationen umfassen: Menüs, eine Aufschlüsselung aller Seiten in der App, einschließlich Informationen zu Seitendetails, Bedienfeldern und Steuerelementen auf jeder Seite, ob die Seite aktiv ist oder nicht, und eine Überprüfung, wer der letzte Benutzer war, der Änderungen vorgenommen hat.

So führen Sie den Bericht zu Menüs und Seiten der UI-Ebene aus

Navigieren Sie zu App Builder IDE
Klicken Sie im Menü „Erstellen“ auf Anwendung erstellen
Suchen Sie Ihre App im Anwendungsfenster in der UI-Ebene
Klicken Sie unter „Dokument“ auf das PDF-Symbol:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen:

Geschäftslogikberichte

Auf der Business-Logik-Ebene sind zwei neue Berichte verfügbar. Der Bericht Objekte und Regeln nach Tabelle listet alle nach Tabelle basierenden Business-Objekte auf und enthält den Status. Der Bericht Ereignisausführung nach Tabelle bietet Informationen zu intrinsischen und benutzerdefinierten Ereignissen, die auf Tabellen in der App ausgeführt werden.

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

Navigieren Sie zu App Builder IDE
Klicken Sie im Menü „Erstellen“ auf „Anwendung erstellen“.
Wählen Sie im Navigationsmenü die Business Logic Layer
Suchen Sie Ihre Business-Layer-Datenquelle. Beispiel: MySQL - Northwinds
Klicken Sie unter „Dokument“ auf das PDF-Symbol:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen:

So führen Sie den Bericht „Ereignisausführung nach Tabelle“ aus

Navigieren Sie zu App Builder IDE
Klicken Sie im Menü „Erstellen“ auf „Anwendung erstellen“.
Wählen Sie im Navigationsmenü die Business Logic Layer
Suchen Sie Ihre Business-Layer-Datenquelle. Beispiel: MySQL - Northwinds
Klicken Sie unter „Ausführungsdokument“ auf das Nummerierungslistensymbol:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen:

Datenspeicherungsebene nach Tabellenbericht

Es gibt einen neuen Bericht für den Datenspeicher, genannt Datenspeicherebene nach Tabelle. Dieser Bericht enthält Informationen zum grundlegenden Schema der Datenbank nach Tabelle. Informationen im Bericht umfassen: Tabellenkonfiguration, Schlüsseleinschränkungen, Schlüsselbeziehungen und Spalten, die für die Tabelle vorhanden sind. Zu den im Bericht erfassten Spalteninformationen gehören Index, Name, logischer Typ, Speichertyp, Nutzung, Audit, automatische Generierung und ob die Spalte erforderlich ist.

So führen Sie den Bericht zur Datenspeicherungsebene nach Tabelle aus

Navigieren Sie zu App Builder IDE
Klicken Sie im Menü „Erstellen“ auf „Anwendung erstellen“.
Wählen Sie im Navigationsmenü die Datenspeicherebene
Suchen Sie Ihre Business-Layer-Datenquelle. Beispiel: MySQL - Northwinds
Klicken Sie unter „Dokument“ auf das PDF-Symbol:
Der resultierende Crystal Report enthält die oben beschriebenen Informationen: