Docs  /  App  /  NAVAX Help Builder  /  Vorbereitungen

 AL-Extension einrichten

2023/12/30 • 3 Min. Lesedauer

In diesem Thema

• app.json
• Page-Ebene
• Weitere Informationen

Damit die Onlinehilfe vom Benutzer einer Business Central Extension aufgerufen werden kann, müssen in der app.json der Extension die Links zur Onlinehilfe angegeben werden. Für die Zuordnung der Extension-Aufrufe zu einem Hilfeprojekt muss in allen Links der Parameter AppID angegeben werden. Diese AppID wird vom NAVAX App Team vergeben bzw. muss mit dem NAVAX App Team abgestimmt und am Server eingerichtet werden. NVXYZ ist z.B. der Abracadabra Beispiel-Erweiterung zugeordnet. Sobald eine AppID vergeben und eingerichtet wurde, ist ein Aufruf mit der GUID der Extension ebenfalls möglich. Diese Methode sollte aber nur für spezielle interne Calls verwendet werden.

app.json

Folgende Angaben müssen auf App-Ebene in der app.json hinzugefügt werden:

• "help": "https://www.navax.app/help.php?AppID=TODO",

• "contextSensitiveHelpUrl": "https://www.navax.app/contextSensitiveHelpUrl.php?AppID=TODO&L={0}&ObjID=",

Wichtig

TODO muss durch die AppID der Extension ersetzt werden.

• "supportedLocales": [
    "en-US", "de-DE", "de-AT", "de-CH"
  ],

  Über supportedLocales wird festgelegt, für welche Sprachen die Hilfe grundsätzlich geplant ist bzw. welche Sprachen Business Central im Onlinehilfe-Aufruf explizit mitsenden soll. Die erste angegebene Sprache (hier en-US) wird als default-Wert verwendet und sollte fix auf en-US gesetzt werden, auch wenn keine englische Hilfe geplant ist. Alle weiteren Sprachen müssen danach angegeben werden, damit Business Central die entsprechende Sprache auch im Onlinehilfe-Aufruf mitsendet.

Hinweis

Ob die Hilfe in der angeforderten Sprache später auch tatsächlich verfügbar ist, spielt hier noch keine Rolle. Hier geht es nur darum, welche Sprachen Business Central generell beim Aufruf der Onlinehilfe berücksichtigen soll. In der hier verwendeten Einstellung sind z.B. zusätzlich alle deutschen Sprachen definiert. Daraus ergibt sich folgendes:

• Hat der Benutzer die Sprache German (Austria) eingestellt, wird die Onlinehilfe mit dem Parameter de-AT aufgerufen.
• Hat der Benutzer die Sprache Danish (Denmark) eingestellt, wird der Aufruf zur Onlinehilfe mit en-US erfolgen, da da-DK nicht Teil der supportedLocales ist.

Page-Ebene

Folgende Angaben müssen auf Page-Ebene hinzugefügt werden:

• ContextSensitiveHelpPage = 'TODO';

  Über das ContextSensitiveHelpPage Property in den page bzw. requestpage Objekten wird die Verbindung zu den einzelnen Hilfethemen hergestellt. TODO muss durch den Dateinamen vom Hilfethema ersetzt werden und wird beim Aufruf der Onlinehilfe als ObjID Parameter mitgegeben. Es wird empfohlen für ContextSensitiveHelpPage (und damit für den Dateinamen des Hilfethemas) den Namen der Page (bzw. den Objektnamen) zu verwenden. Beispiel: Für den Fall, dass das selbe Hilfethema aus verschiedenen Pages aufgerufen werden soll, sollten Themenumleitungen verwendet werden. Es ist zwar möglich, den selben Namen im ContextSensitiveHelpPage Property in allen Pages anzugeben, es wird aber nicht empfohlen. Der Vorteil der Themenumleitungen besteht darin, dass diese erst am Server und somit unabhängig von der Extension aufgelöst werden. Sollte es sich später herausstellen, dass für die Pages doch verschiedene Hilfen notwendig sind, kann das (ohne Änderungen an der Extension) später jederzeit geändert werden und alle Kunden haben sofort Zugriff auf die geänderte/erweiterte Hilfe. Weitere Informationen dazu finden Sie unter Hilfe schreiben, Basics, Themenumleitungen.

Weitere Informationen

• Hilfe schreiben, Basics, Themenumleitungen
  Umleitungen von Hilfethemen können realisiert werden, indem man in der ersten Zeile einer Hilfedatei eine andere Hilfedatei angibt. Damit der Help Builder die Umleitung erkennt, muss die Dateiendung .nchb mitangegeben werden...