Erste Schritte und Einrichtung

Schnellstart

Nur für Geschäftskunden: Registriere Dein Unternehmen einmalig und kostenlos – nicht jeden Entwickler einzeln. Ist Dein Unternehmen bereits registriert, lass Dich vom Unternehmensadministrator einladen. Nach der Registrierung werden alle weiteren Entwickler eingeladen und erhalten jeweils einen eigenen API-Key. Pro Unternehmen sind beliebig viele Entwickler erlaubt. Verbinde Deine Extension mit dem Unternehmenskonto; gemeinsame Templates, Styles und Presets unterstützen Euch im Team.

Registriere Dein Unternehmen einmalig und kostenlos und verbinde die Extension mit Deinem Unternehmenskonto. Im Kundenportal siehst Du die verfügbaren Funktionen und Credits. Gemeinsame Templates, Styles und Presets unterstützen die Zusammenarbeit im Team.

Nach Installation des AL Report Creator stehen einige Funktionen sofort zur Verfügung, während für den Preview und die Dataset-Ansicht noch eine Companion-App auf dem Business Central Service Tier erforderlich ist. AL Report Creator stellt selbstständig fest, ob die App noch fehlt oder eine falsche Version installiert ist und versucht auf Wunsch die Installation bzw. das Update automatisch durchzuführen.

Die Companion-App wird nicht über den AppSource bereitgestellt sondern von AL Report Creator ggf. durch automatischen Download bereitgestellt. Bei Installation oder Update startet ein Wizard, der die Eingabe der Basis-Id für die Objekte erlaubt und die Objekt-Ids der Companion-App automatisch auf diesen Bereich anpasst. Die Installation kann dabei entweder automatisch oder durch Bereitstellung des Source Codes als VS Code Workspace und manuelles Deployment erfolgen. Auf diese Weise ist vollkommen transparent, was auf dem Service Tier installiert wird und der Source Code kann bei Bedarf noch erweitert werden.

Als Installationsziel wird das in der Launch-Konfiguration hinterlegte Service Tier verwendet. Sind mehrere Launch-Konfigurationen in der launch.json hinterlegt, fragt der Wizard nach dem zu verwendenden Endpunkt.

Sobald die Installation erfolgt ist, muss abschließend der zu verwendende Mandant ausgewählt werden. Danach sind Preview und Dataset vollumfänglich nutzbar.

Vielfältige Einstellungsmöglichkeiten erlauben es, die Konfiguration nachträglich auch manuell zu ändern. Eine Dokumentation der Einstellungen findet sich unter Einstellungen.

Im AL-File eines Reports gibt es nun weitere Befehle, wie z.B.

• Preview Report (Alt+⇧+P) oder Befehl "ALRC: Preview Report"
• Show Dataset (Alt+⇧+S) oder Befehl "ALRC: Show Dataset"
• Open Layout Externally (Alt+⇧+L) oder Befehl "ALRC: Open Layout Externally"

Diese Operationen sind ebenfalls im Kontextmenü der Layout-Files im VS Code File Explorer zu finden.

Weitere Befehle sind in der Befehlsliste unter "ALRC:" oder auch in der nachstehenden Dokumentation zu finden. Die meisten Operationen stehen zudem über die Toolbar im Preview-Fenster zur Verfügung und beziehen sich dann automatisch auf den aktuell betrachteten Report.

Ersteinrichtung

Für den Wizard ist ein AL-Workspace mit app.json erforderlich. Preview und DataSet Viewer benötigen zusätzlich die Preview Service App in der verwendeten Business-Central-Testumgebung.

Allgemein

Die Extension liest Tabellen- und Feldmetadaten aus den AL-Dateien des Workspaces und aus verfügbaren Symbolpaketen. Halte deshalb .alpackages beziehungsweise die über al.packageCachePath konfigurierten Paketverzeichnisse aktuell.

Die Preview-Verbindung wird bevorzugt aus einer AL-Konfiguration in .vscode/launch.json abgeleitet. Fehlende Preview-Werte werden unter al-report-creator.preview.launchOverrides ergänzt. Geheimnisse werden in VS Code SecretStorage und nicht in settings.json oder launch.json gespeichert.

Begleit-App installieren

Starte ALRC: Manage Preview Service. Wähle die Testinstanz und anschließend Schnellinstallation oder die quellbasierte Variante. Bei der quellbasierten Installation legst Du den verfügbaren Objektnummernbereich fest und kannst das erzeugte Projekt vor dem manuellen Deployment bearbeiten.

Weise Preview-Benutzern nach der Installation den Berechtigungssatz SPO ARC PREVIEW zu. Die App veröffentlicht den erforderlichen OData-Webservice selbst; ein manueller Eintrag auf der Seite Webdienste ist nicht erforderlich.

ALRC: Manage Preview Service

Die AL Report Creator Preview Service App muss auf der verwendeten Testinstanz von Business Central installiert sein. Die App ist zwingende Voraussetzung für das Rendern im Preview und für den Abruf des Datasets.

ALRC: Manage Preview Service prüft die installierte Version und führt durch Installation oder Aktualisierung. Du kannst die App automatisch per Schnellinstallation publishen lassen oder das erzeugte AL-Projekt in VS Code öffnen, um es anzupassen und manuell zu deployen. Bei der quellbasierten Installation kann der zu verwendende Objektnummernbereich vorgegeben werden; die enthaltenen Objekte werden entsprechend umnummeriert.