Mit JSON-Konfigurationsdateien arbeiten

Abgeschlossen

JSON bedeutet „JavaScript Object Notation“. Es handelt sich um ein leichtes Datenaustauschformat, das häufig zum Speichern und Übermitteln von Daten verwendet wird. Eine AL-Erweiterung enthält zwei JSON-Dateien: „App.json“ und „launch.json“. Diese Dateien werden beim Starten einer neuen AL-Erweiterung automatisch erstellt und zum Speichern von Konfigurationsdaten verwendet.

Datei „launch.json“

„Launch.json“ ist eine Konfigurationsdatei, die Informationen zu dem Server enthält, auf dem die Erweiterung zum Testen und Debuggen bereitgestellt wird. Je nachdem, ob die Erweiterung auf einem lokalen Server oder in der Cloud veröffentlicht wird, können zwei Konfigurationen verwendet werden.

Screenshot der Cloud-Sandbox-Datei „Launch.json“

In der nächsten Tabelle werden wichtige und erforderliche Eigenschaften der Datei launch.json beschrieben. Es ist jedoch wichtig, zuerst etwas über die Eigenschaften startupObjectId und startupObjectType in dieser Datei launch.json zu lernen.

Wann immer Sie Ihre Erweiterung innerhalb von Visual Studio Code starten, wird die Datei launch.json geprüft, um festzustellen, mit welchem Objekt sie beginnen soll. Die vorherige Abbildung zeigt, dass es auf Seite 22, der Seite Debitorenliste, beginnt. Wenn Sie Ihre eigenen Seiten entwickeln und mit ihnen beginnen möchten, ersetzen Sie die Eigenschaft startupObjectId mit Ihrer eigenen Seitenzahl.

Über diesen Link finden Sie weitere Informationen zu allen Einstellungen in der Datei Launch.json: launch.json-Datei.

App.json-Datei

Die Datei „app.json“ enthält Informationen zu der Erweiterung, die Sie erstellen, z. B. Herausgeberinformationen, Name und die minimal unterstützte Version. Oft wird die Datei „app.json“ als das Manifest bezeichnet.

Screenshot einer beispielhaften App.json-Datei in Business Central

Über diesen Link finden Sie weitere Informationen zu allen Einstellungen in der Datei App.json: app.json-Datei.

App-Identität

Apps, die mit AL erstellt wurden, erweitern die Funktionen von Business Central. Wenn Sie ein neues AL-Projekt erstellen, wird die Datei App.json zusammen mit der Datei launch.json automatisch generiert. Die Datei „app.json“ enthält Informationen zu der App, die Sie erstellen, z. B. Herausgeberinformationen, Name und die minimal unterstützte Version von Basisanwendungsobjekten, auf denen die Erweiterung erstellt wurde. Oft wird die Datei „app.json“ als das Manifest bezeichnet. Die Datei „App.json“ enthält zahlreiche Projekteinstellungen, aber einige davon bilden die tatsächliche Identität der App, die Sie erstellen.

Seit dem Business Central 2021 Veröffentlichungszyklus 2 gelten Name und Herausgeber nicht mehr als Teil der App-Identität und können daher bearbeitet werden, um zum Beispiel Branding oder Akquisition widerzuspiegeln. Wenn die Informationen für Name und/oder Herausgeber geändert werden, muss die Version ebenfalls erhöht werden. Wenn Sie Arbeitsbereiche mit mehreren Projekten verwenden, und Name oder Herausgeber einer Erweiterung im Arbeitsbereich verändern, müssen die Abhängigkeiten in der app.json-Datei mit dem neuen Namen und Herausgeber aktualisiert werden, da es sonst zu Problemen mit der Referenzauflösung kommen kann.

Die ID einer App wird automatisch von der AL Language-Erweiterung generiert, wenn Sie eine neue App erstellen oder wenn Sie den Befehl AL: Manifest erstellen verwenden.

Wenn Sie die App oder das Manifest von einer anderen App kopiert haben, müssen Sie die ID vor der Veröffentlichung im Onlinedienst als Erweiterung pro Mandant oder in der AppSource-App ändern.

Nachdem die App veröffentlicht wurde, sollten Sie nur noch die ID ändern, wenn Sie beabsichtigen, die Codebasis zum Entwickeln einer neuen App zu verwenden. Sie können die App nicht von der mit der alten ID zur App mit der neuen ICH WÜRDE aktualisieren, da das System die Korrespondenz nicht kennt.

Wenn Sie Ihre App als pro-Mandanten-Erweiterung veröffentlicht haben, aber jetzt erwägen, sie zu AppSource zu veröffentlichen, müssen Sie der AppSource-App eine neue ID zuweisen und sicherstellen, dass sie alle technischen Anforderungen für die Veröffentlichung zu AppSource erfüllt.

Es wird empfohlen, für eine andere ID für die App zu verwenden, die Sie von Visual Studio Code oder zu einem Container veröffentlichen. Es wird empfohlen, eine andere ID zu verwenden, sobald Sie mit der Qualität Ihrer App zufrieden sind und bereit sind, sie zu AppSource zu veröffentlichen. Wenn Sie diesem Ansatz nicht folgen, wird die App, die Sie von Visual Studio Code für eine Entwickler-Sandbox veröffentlicht haben, automatisch unveröffentlicht, wenn ein anderer Benutzer versucht, die AppSource-App zu installieren.

Wenn Sie nur auf den Business Central 2021 Veröffentlichungszyklus 2 oder höher abzielen, kann der Name und der Herausgeber einer App jederzeit geändert werden, auch nachdem sie veröffentlicht wurde. Wenn der Name verändert wird, muss auch die Version erhöht werden.

Wenn Sie nur auf die Versionen vor dem Business Central 2021 Veröffentlichungszyklus 2 oder abzielen, kann der Name und Herausgeber einer App geändert werden, auch nachdem sie veröffentlicht wurde.

Die Version muss jedes Mal erhöht werden, wenn eine neue Version Ihrer App in AppSource oder als Erweiterung pro Mandant hochgeladen wird. Während der Entwicklung in Visual Studio Code können Sie weiterhin dieselbe Version verwenden und Ihren Code durchlaufen.