Docs  /  App  /  NAVAX Help Builder  /  Preparations

 How the Help Builder works

2023/12/30 • 2 min. to read

In this topic

• AppID
• ObjID
• Folder Structure and Languages

Every help project basically consists of a collection of normal text files in which the help text for the different help topics is stored. These files are stored or uploaded on the Help Builder server (i.e. on navax.app). If the online help for a help topic is then called, the Help Builder prepares the help topic accordingly and the result is displayed in the browser. Example of an online help call: https://www.navax.app/contextSensitiveHelpUrl.php?AppID=NVXYZ&L=de&ObjID=HelloWorld

AppID

To assign the online help call to a help project, the AppID parameter must be specified in the call. This AppID is assigned by the NAVAX App Team or has to be coordinated with the NAVAX App Team and must be set up on the server. NVXYZ is assigned to the Abracadabra sample extension, for example.

ObjID

The ObjID parameter is used to specify the help topic or more precisely the file name of the help topic.

Folder Structure and Languages

Every help project on navax.app has the following folder structure: AppID\help\Language For each language, the individual help files are grouped together in one folder (2 characters, lower case). Example: When calling the online help (e.g. from Business Central), the corresponding help topic is first searched in the folder of the requested language (parameter L). If no language is specified in the call, the search is performed using the language set in the browser. If the help topic is not available in the language, the folders of the other languages are searched, if available. If the help topic cannot be found here either, the table of contents of the help project is displayed. Example for the call https://www.navax.app/contextSensitiveHelpUrl.php?AppID=NVXYZ&L=de&ObjID=HelloWorld: Each page is prepared by the Help Builder before being displayed. Among other things, actions such as Feedback and Print are added to the page. Settings like the feedback email address are configured on the server by the NAVAX App Team for the help project. In addition, the Help Builder automatically adds an action for the Manual to the table of contents. This allows the user to print out the entire Help or save it as a PDF.